X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/23324ae1c7938ba904770fc456d3c07764b9c5e9..3f16e52c1396f7d58b29b2eea22d7715f0f4596b:/interface/spinctrl.h

diff --git a/interface/spinctrl.h b/interface/spinctrl.h
index 5513dbb06e..06d29a3647 100644
--- a/interface/spinctrl.h
+++ b/interface/spinctrl.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        spinctrl.h
-// Purpose:     documentation for wxSpinCtrl class
+// Purpose:     interface of wxSpinCtrl
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,83 +9,69 @@
 /**
     @class wxSpinCtrl
     @wxheader{spinctrl.h}
-    
-    wxSpinCtrl combines wxTextCtrl and 
+
+    wxSpinCtrl combines wxTextCtrl and
     wxSpinButton in one control.
-    
+
     @beginStyleTable
-    @style{wxSP_ARROW_KEYS}:
+    @style{wxSP_ARROW_KEYS}
            The user can use arrow keys to change the value.
-    @style{wxSP_WRAP}:
+    @style{wxSP_WRAP}
            The value wraps at the minimum and maximum.
     @endStyleTable
-    
+
     @library{wxcore}
     @category{ctrl}
-    @appearance{spinctrl.png}
-    
-    @seealso
-    @ref overview_eventhandlingoverview "Event handling overview", wxSpinButton,
-    wxControl
+    <!-- @appearance{spinctrl.png} -->
+
+    @see wxSpinButton, wxControl
 */
 class wxSpinCtrl : public wxControl
 {
 public:
-    //@{
     /**
-        )
-        
+       Default constructor.
+    */
+    wxSpinCtrl();
+    
+    /**
         Constructor, creating and showing a spin control.
-        
-        @param parent 
-        Parent window. Must not be @NULL.
-        
-        @param value 
-        Default value.
-        
-        @param id 
-        Window identifier. The value wxID_ANY indicates a default value.
-        
-        @param pos 
-        Window position. If wxDefaultPosition is specified then a default position
+
+        @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 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 name 
-        Window name.
-        
-        @sa Create()
+        @param style
+            Window style. See wxSpinButton.
+        @param min
+            Minimal value.
+        @param max
+            Maximal value.
+        @param initial
+            Initial value.
+        @param name
+            Window name.
+
+        @see Create()
     */
-    wxSpinCtrl();
-        wxSpinCtrl(wxWindow* parent, wxWindowID id = -1,
-                   const wxString& value = wxEmptyString,
-                   const wxPoint& pos = wxDefaultPosition,
-                   const wxSize& size = wxDefaultSize,
-                   long style = wxSP_ARROW_KEYS,
-                   int min = 0, int max = 100,
-                   int initial = 0);
-    //@}
+    wxSpinCtrl(wxWindow* parent, wxWindowID id = -1,
+               const wxString& value = wxEmptyString,
+               const wxPoint& pos = wxDefaultPosition,
+               const wxSize& size = wxDefaultSize,
+               long style = wxSP_ARROW_KEYS,
+               int min = 0, int max = 100,
+               int initial = 0);
 
     /**
-        )
-        
         Creation function called by the spin control constructor.
-        
         See wxSpinCtrl() for details.
     */
     bool Create(wxWindow* parent, wxWindowID id = -1,
@@ -99,17 +85,17 @@ public:
     /**
         Gets maximal allowable value.
     */
-    int GetMax();
+    int GetMax() const;
 
     /**
         Gets minimal allowable value.
     */
-    int GetMin();
+    int GetMin() const;
 
     /**
         Gets the value of the spin control.
     */
-    int GetValue();
+    int GetValue() const;
 
     /**
         Sets range of allowable values.
@@ -117,20 +103,22 @@ public:
     void SetRange(int minVal, int maxVal);
 
     /**
-        Select the text in the text part of the control between  positions 
-        @e from (inclusive) and @e to (exclusive). This is similar to 
+        Select the text in the text part of the control between  positions
+        @a from (inclusive) and @a to (exclusive). This is similar to
         wxTextCtrl::SetSelection.
-        
-        @b NB: this is currently only implemented for Windows and generic versions
+        @note this is currently only implemented for Windows and generic versions
         of the control.
     */
     void SetSelection(long from, long to);
 
-    //@{
     /**
-        Sets the value of the spin control.
+        Sets the value of the spin control. Use the variant using int instead.
     */
     void SetValue(const wxString& text);
-        void SetValue(int value);
-    //@}
+
+    /**
+        Sets the value of the spin control.
+    */
+    void SetValue(int value);
 };
+