]> git.saurik.com Git - wxWidgets.git/commitdiff
Document wxSpinCtrlDouble in correct header file.
authorVadim Zeitlin <vadim@wxwidgets.org>
Sat, 19 Dec 2009 12:00:16 +0000 (12:00 +0000)
committerVadim Zeitlin <vadim@wxwidgets.org>
Sat, 19 Dec 2009 12:00:16 +0000 (12:00 +0000)
The public header for this class is wx/spinctrl.h, but it was documented in
wx/generic/spinctrg.h which didn't even correspond to an existing real header
file (which is called spinctlg.h). Move the documentation to wx/spinctrl.h and
remove the old file.

Closes #11548.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@62945 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/wx/generic/spinctrg.h [deleted file]
interface/wx/spinctrl.h

diff --git a/interface/wx/generic/spinctrg.h b/interface/wx/generic/spinctrg.h
deleted file mode 100644 (file)
index a18f122..0000000
+++ /dev/null
@@ -1,137 +0,0 @@
-/////////////////////////////////////////////////////////////////////////////
-// Name:        spinctrg.h
-// Purpose:     interface of wxSpinCtrlDouble
-// Author:      wxWidgets team
-// RCS-ID:      $Id$
-// Licence:     wxWindows license
-/////////////////////////////////////////////////////////////////////////////
-
-/**
-    @class wxSpinCtrlDouble
-
-    wxSpinCtrlDouble combines wxTextCtrl and wxSpinButton in one control and
-    displays a real number. (wxSpinCtrl displays an integer.)
-
-    @beginStyleTable
-    @style{wxSP_ARROW_KEYS}
-           The user can use arrow keys to change the value.
-    @style{wxSP_WRAP}
-           The value wraps at the minimum and maximum.
-    @endStyleTable
-
-    @library{wxcore}
-    @category{ctrl}
-    @appearance{spinctrldouble.png}
-
-    @see wxSpinButton, wxSpinCtrl, wxControl
-*/
-class wxSpinCtrlDouble : public wxControl
-{
-public:
-    /**
-       Default constructor.
-    */
-    wxSpinCtrlDouble();
-    
-    /**
-        Constructor, creating and showing a spin control.
-
-        @param parent
-            Parent window. Must not be @NULL.
-        @param value
-            Default value (as text).
-        @param id
-            Window identifier. The value wxID_ANY indicates a default value.
-        @param pos
-            Window position. 
-            If ::wxDefaultPosition is specified then a default position is chosen.
-        @param size
-            Window size. 
-            If ::wxDefaultSize is specified then a default size is chosen.
-        @param style
-            Window style. See wxSpinButton.
-        @param min
-            Minimal value.
-        @param max
-            Maximal value.
-        @param initial
-            Initial value.
-        @param inc
-            Increment value.
-        @param name
-            Window name.
-
-        @see Create()
-    */
-    wxSpinCtrlDouble(wxWindow* parent, wxWindowID id = -1,
-               const wxString& value = wxEmptyString,
-               const wxPoint& pos = wxDefaultPosition,
-               const wxSize& size = wxDefaultSize,
-               long style = wxSP_ARROW_KEYS,
-               double min = 0, double max = 100,
-               double initial = 0, double inc = 1,
-               const wxString& name = wxT("wxSpinCtrlDouble"));
-
-    /**
-        Creation function called by the spin control constructor.
-        See wxSpinCtrlDouble() for details.
-    */
-    bool Create(wxWindow* parent, wxWindowID id = wxID_ANY,
-                const wxString& value = wxEmptyString,
-                const wxPoint& pos = wxDefaultPosition,
-                const wxSize& size = wxDefaultSize,
-                long style = wxSP_ARROW_KEYS, double min = 0, double max = 100,
-                double initial = 0, double inc = 1,
-                const wxString& name = "wxSpinCtrlDouble");
-
-    /**
-        Gets the number of digits in the display.
-    */
-    unsigned int GetDigits() const;
-
-    /**
-        Gets the increment value.
-    */
-    double GetIncrement() const;
-
-    /**
-        Gets maximal allowable value.
-    */
-    double GetMax() const;
-
-    /**
-        Gets minimal allowable value.
-    */
-    double GetMin() const;
-
-    /**
-        Gets the value of the spin control.
-    */
-    double GetValue() const;
-
-    /**
-        Sets the number of digits in the display.
-    */
-    void SetDigits(unsigned int digits);
-
-    /**
-        Sets the increment value.
-    */
-    void SetIncrement(double inc);
-
-    /**
-        Sets range of allowable values.
-    */
-    void SetRange(double minVal, double maxVal);
-
-    /**
-        Sets the value of the spin control. Use the variant using double instead.
-    */
-    virtual void SetValue(const wxString& text);
-
-    /**
-        Sets the value of the spin control.
-    */
-    void SetValue(double value);
-};
-
index fe320093354b3833374b82935b773cf9119a7d72..e135d0cad2c371f917a5ce66d6d077ffcefa69b7 100644 (file)
@@ -146,3 +146,131 @@ public:
     void SetValue(int value);
 };
 
+/**
+    @class wxSpinCtrlDouble
+
+    wxSpinCtrlDouble combines wxTextCtrl and wxSpinButton in one control and
+    displays a real number. (wxSpinCtrl displays an integer.)
+
+    @beginStyleTable
+    @style{wxSP_ARROW_KEYS}
+           The user can use arrow keys to change the value.
+    @style{wxSP_WRAP}
+           The value wraps at the minimum and maximum.
+    @endStyleTable
+
+    @library{wxcore}
+    @category{ctrl}
+    @appearance{spinctrldouble.png}
+
+    @see wxSpinButton, wxSpinCtrl, wxControl
+*/
+class wxSpinCtrlDouble : public wxControl
+{
+public:
+    /**
+       Default constructor.
+    */
+    wxSpinCtrlDouble();
+
+    /**
+        Constructor, creating and showing a spin control.
+
+        @param parent
+            Parent window. Must not be @NULL.
+        @param value
+            Default value (as text).
+        @param id
+            Window identifier. The value wxID_ANY indicates a default value.
+        @param pos
+            Window position.
+            If ::wxDefaultPosition is specified then a default position is chosen.
+        @param size
+            Window size.
+            If ::wxDefaultSize is specified then a default size is chosen.
+        @param style
+            Window style. See wxSpinButton.
+        @param min
+            Minimal value.
+        @param max
+            Maximal value.
+        @param initial
+            Initial value.
+        @param inc
+            Increment value.
+        @param name
+            Window name.
+
+        @see Create()
+    */
+    wxSpinCtrlDouble(wxWindow* parent, wxWindowID id = -1,
+               const wxString& value = wxEmptyString,
+               const wxPoint& pos = wxDefaultPosition,
+               const wxSize& size = wxDefaultSize,
+               long style = wxSP_ARROW_KEYS,
+               double min = 0, double max = 100,
+               double initial = 0, double inc = 1,
+               const wxString& name = wxT("wxSpinCtrlDouble"));
+
+    /**
+        Creation function called by the spin control constructor.
+        See wxSpinCtrlDouble() for details.
+    */
+    bool Create(wxWindow* parent, wxWindowID id = wxID_ANY,
+                const wxString& value = wxEmptyString,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxSP_ARROW_KEYS, double min = 0, double max = 100,
+                double initial = 0, double inc = 1,
+                const wxString& name = "wxSpinCtrlDouble");
+
+    /**
+        Gets the number of digits in the display.
+    */
+    unsigned int GetDigits() const;
+
+    /**
+        Gets the increment value.
+    */
+    double GetIncrement() const;
+
+    /**
+        Gets maximal allowable value.
+    */
+    double GetMax() const;
+
+    /**
+        Gets minimal allowable value.
+    */
+    double GetMin() const;
+
+    /**
+        Gets the value of the spin control.
+    */
+    double GetValue() const;
+
+    /**
+        Sets the number of digits in the display.
+    */
+    void SetDigits(unsigned int digits);
+
+    /**
+        Sets the increment value.
+    */
+    void SetIncrement(double inc);
+
+    /**
+        Sets range of allowable values.
+    */
+    void SetRange(double minVal, double maxVal);
+
+    /**
+        Sets the value of the spin control. Use the variant using double instead.
+    */
+    virtual void SetValue(const wxString& text);
+
+    /**
+        Sets the value of the spin control.
+    */
+    void SetValue(double value);
+};