store selected indices as unsigned int, not size_t, in wxSelectionStore, we don't...

[wxWidgets.git] / interface / spinctrl.h

diff --git a/interface/spinctrl.h b/interface/spinctrl.h
index e4b068516d116a57805287056f08c12a3a76f90e..046c98ccd231da957f86d5430129396c4d4def8b 100644 (file)
--- a/interface/spinctrl.h
+++ b/interface/spinctrl.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        spinctrl.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        spinctrl.h

-// Purpose:     documentation for wxSpinCtrl class
+// Purpose:     interface of wxSpinCtrl

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -24,9 +24,7 @@
     @category{ctrl}
     @appearance{spinctrl.png}
 
     @category{ctrl}
     @appearance{spinctrl.png}
 

-    @seealso
-    @ref overview_eventhandlingoverview "Event handling overview", wxSpinButton,
-    wxControl
+    @see @ref overview_eventhandlingoverview, wxSpinButton, wxControl

 */
 class wxSpinCtrl : public wxControl
 {
 */
 class wxSpinCtrl : public wxControl
 {


@@ -34,42 +32,32 @@ public:
     //@{
     /**
         )
     //@{
     /**
         )

-        

         Constructor, creating and showing a spin control.
         Constructor, creating and showing a spin control.

-        
+

         @param parent
         @param parent

-        Parent window. Must not be @NULL.
-        
+            Parent window. Must not be @NULL.

         @param value
         @param value

-        Default value.
-        
+            Default value.

         @param id
         @param id

-        Window identifier. The value wxID_ANY indicates a default value.
-        
+            Window identifier. The value wxID_ANY indicates a default value.

         @param pos
         @param pos

-        Window position. If wxDefaultPosition is specified then a default position
-        is chosen.
-        
+            Window position. If wxDefaultPosition is specified then a default
+        position is chosen.

         @param size
         @param size

-        Window size. If wxDefaultSize is specified then a default size is
-        chosen.
-        
+            Window size. If wxDefaultSize is specified then a default size
+        is chosen.

         @param style
         @param style

-        Window style. See wxSpinButton.
-        
+            Window style. See wxSpinButton.

         @param min
         @param min

-        Minimal value.
-        
+            Minimal value.

         @param max
         @param max

-        Maximal value.
-        
+            Maximal value.

         @param initial
         @param initial

-        Initial value.
-        
+            Initial value.

         @param name
         @param name

-        Window name.
-        
-        @sa Create()
+            Window name.
+
+        @see Create()

     */
     wxSpinCtrl();
     wxSpinCtrl(wxWindow* parent, wxWindowID id = -1,
     */
     wxSpinCtrl();
     wxSpinCtrl(wxWindow* parent, wxWindowID id = -1,


@@ -83,9 +71,7 @@ public:
 
     /**
         )
 
     /**
         )

-        

         Creation function called by the spin control constructor.
         Creation function called by the spin control constructor.

-        

         See wxSpinCtrl() for details.
     */
     bool Create(wxWindow* parent, wxWindowID id = -1,
         See wxSpinCtrl() for details.
     */
     bool Create(wxWindow* parent, wxWindowID id = -1,


@@ -99,17 +85,17 @@ public:
     /**
         Gets maximal allowable value.
     */
     /**
         Gets maximal allowable value.
     */

-    int GetMax();
+    int GetMax() const;

 
     /**
         Gets minimal allowable value.
     */
 
     /**
         Gets minimal allowable value.
     */

-    int GetMin();
+    int GetMin() const;

 
     /**
         Gets the value of the spin control.
     */
 
     /**
         Gets the value of the spin control.
     */

-    int GetValue();
+    int GetValue() const;

 
     /**
         Sets range of allowable values.
 
     /**
         Sets range of allowable values.


@@ -118,10 +104,9 @@ public:
 
     /**
         Select the text in the text part of the control between  positions
 
     /**
         Select the text in the text part of the control between  positions

-        @e from (inclusive) and @e to (exclusive). This is similar to
+        @a from (inclusive) and @a to (exclusive). This is similar to

         wxTextCtrl::SetSelection.
         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);
         of the control.
     */
     void SetSelection(long from, long to);


@@ -134,3 +119,4 @@ public:
     void SetValue(int value);
     //@}
 };
     void SetValue(int value);
     //@}
 };

+