revised base64.h;bitmap.h

[wxWidgets.git] / interface / spinbutt.h

diff --git a/interface/spinbutt.h b/interface/spinbutt.h
index 2ad7a6b82ac4b3ab0209ea599ee2d4808559bc5e..0e9ff3967493eaa3ccd4502931219845656995c9 100644 (file)
--- a/interface/spinbutt.h
+++ b/interface/spinbutt.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        spinbutt.h
-// Purpose:     documentation for wxSpinEvent class
+// Purpose:     interface of wxSpinEvent
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,15 +9,14 @@
 /**
     @class wxSpinEvent
     @wxheader{spinbutt.h}
-    
-    This event class is used for the events generated by 
+
+    This event class is used for the events generated by
     wxSpinButton and wxSpinCtrl.
-    
+
     @library{wxcore}
     @category{events}
-    
-    @seealso
-    wxSpinButton and wxSpinCtrl
+
+    @see wxSpinButton and wxSpinCtrl
 */
 class wxSpinEvent : public wxNotifyEvent
 {
@@ -25,12 +24,12 @@ public:
     /**
         The constructor is not normally used by the user code.
     */
-    wxSpinEvent(wxEventType commandType = wxEVT_@NULL, int id = 0);
+    wxSpinEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
 
     /**
         Retrieve the current spin button or control value.
     */
-    int GetPosition();
+    int GetPosition() const;
 
     /**
         Set the value associated with the event.
@@ -39,21 +38,22 @@ public:
 };
 
 
+
 /**
     @class wxSpinButton
     @wxheader{spinbutt.h}
-    
+
     A wxSpinButton has two small up and down (or left and right) arrow buttons. It
     is often used next to a text control for increment and decrementing a value.
     Portable programs should try to use wxSpinCtrl instead
     as wxSpinButton is not implemented for all platforms but wxSpinCtrl is as it
     degenerates to a simple wxTextCtrl on such platforms.
-    
+
     @b NB: the range supported by this control (and wxSpinCtrl) depends on the
     platform but is at least @c -0x8000 to @c 0x7fff. Under GTK and
     Win32 with sufficiently new version of @c comctrl32.dll (at least 4.71 is
     required, 5.80 is recommended) the full 32 bit range is supported.
-    
+
     @beginStyleTable
     @style{wxSP_HORIZONTAL}:
            Specifies a horizontal spin button (note that this style is not
@@ -65,13 +65,12 @@ public:
     @style{wxSP_WRAP}:
            The value wraps at the minimum and maximum.
     @endStyleTable
-    
+
     @library{wxcore}
     @category{ctrl}
     @appearance{spinbutton.png}
-    
-    @seealso
-    wxSpinCtrl
+
+    @see wxSpinCtrl
 */
 class wxSpinButton : public wxControl
 {
@@ -80,34 +79,29 @@ public:
     /**
         Constructor, creating and showing a spin button.
         
-        @param parent 
-        Parent window. Must not be @NULL.
-        
-        @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 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 name
+            Window name.
         
-        @param size 
-        Window size. If wxDefaultSize is specified then a default size is
-        chosen.
-        
-        @param style 
-        Window style. See wxSpinButton.
-        
-        @param name 
-        Window name.
-        
-        @sa Create()
+        @see Create()
     */
     wxSpinButton();
-        wxSpinButton(wxWindow* parent, wxWindowID id,
-                     const wxPoint& pos = wxDefaultPosition,
-                     const wxSize& size = wxDefaultSize,
-                     long style = wxSP_HORIZONTAL,
-                     const wxString& name = "spinButton");
+    wxSpinButton(wxWindow* parent, wxWindowID id,
+                 const wxPoint& pos = wxDefaultPosition,
+                 const wxSize& size = wxDefaultSize,
+                 long style = wxSP_HORIZONTAL,
+                 const wxString& name = "spinButton");
     //@}
 
     /**
@@ -128,42 +122,42 @@ public:
     /**
         Returns the maximum permissible value.
         
-        @sa SetRange()
+        @see SetRange()
     */
-    int GetMax();
+    int GetMax() const;
 
     /**
         Returns the minimum permissible value.
         
-        @sa SetRange()
+        @see SetRange()
     */
-    int GetMin();
+    int GetMin() const;
 
     /**
         Returns the current spin button value.
         
-        @sa SetValue()
+        @see SetValue()
     */
-    int GetValue();
+    int GetValue() const;
 
     /**
         Sets the range of the spin button.
         
-        @param min 
-        The minimum value for the spin button.
+        @param min
+            The minimum value for the spin button.
+        @param max
+            The maximum value for the spin button.
         
-        @param max 
-        The maximum value for the spin button.
-        
-        @sa GetMin(), GetMax()
+        @see GetMin(), GetMax()
     */
     void SetRange(int min, int max);
 
     /**
         Sets the value of the spin button.
         
-        @param value 
-        The value for the spin button.
+        @param value
+            The value for the spin button.
     */
     void SetValue(int value);
 };
+