wxThread::Sleep() is the same as wxMilliSleep() on all platforms but Mac (and maybe...

[wxWidgets.git] / interface / gauge.h

diff --git a/interface/gauge.h b/interface/gauge.h
index b9a3fd1cb455eea13605c0b3c091ec1d0f36e3f6..9585cba4ad76ee1b632c7a40b49bdfcf23d42597 100644 (file)
--- a/interface/gauge.h
+++ b/interface/gauge.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        gauge.h
-// Purpose:     documentation for wxGauge class
+// Purpose:     interface of wxGauge
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -27,11 +27,11 @@
     There are no user commands for the gauge.
 
     @beginStyleTable
-    @style{wxGA_HORIZONTAL}:
+    @style{wxGA_HORIZONTAL}
            Creates a horizontal gauge.
-    @style{wxGA_VERTICAL}:
+    @style{wxGA_VERTICAL}
            Creates a vertical gauge.
-    @style{wxGA_SMOOTH}:
+    @style{wxGA_SMOOTH}
            Creates smooth progress bar with one pixel wide update step (not
            supported by all platforms).
     @endStyleTable
@@ -40,8 +40,7 @@
     @category{ctrl}
     @appearance{gauge.png}
 
-    @seealso
-    wxSlider, wxScrollBar
+    @see wxSlider, wxScrollBar
 */
 class wxGauge : public wxControl
 {
@@ -49,7 +48,7 @@ public:
     //@{
     /**
         Constructor, creating and showing a gauge.
-        
+
         @param parent
             Window parent.
         @param id
@@ -65,7 +64,7 @@ public:
             Gauge style. See wxGauge.
         @param name
             Window name.
-        
+
         @see Create()
     */
     wxGauge();
@@ -95,41 +94,41 @@ public:
 
     /**
         Returns the width of the 3D bezel face.
-        
+
         @remarks This method is not implemented (returns 0) for most platforms.
-        
+
         @see SetBezelFace()
     */
-    int GetBezelFace();
+    int GetBezelFace() const;
 
     /**
         Returns the maximum position of the gauge.
-        
+
         @see SetRange()
     */
-    int GetRange();
+    int GetRange() const;
 
     /**
         Returns the 3D shadow margin width.
-        
+
         @remarks This method is not implemented (returns 0) for most platforms.
-        
+
         @see SetShadowWidth()
     */
-    int GetShadowWidth();
+    int GetShadowWidth() const;
 
     /**
         Returns the current position of the gauge.
-        
+
         @see SetValue()
     */
-    int GetValue();
+    int GetValue() const;
 
     /**
         Returns @true if the gauge is vertical (has @c wxGA_VERTICAL style) and
         @false otherwise.
     */
-    bool IsVertical();
+    bool IsVertical() const;
 
     /**
         Switch the gauge to indeterminate mode (if required) and makes the gauge move
@@ -142,10 +141,10 @@ public:
 
     /**
         Sets the 3D bezel face width.
-        
+
         @remarks This method is not implemented (doesn't do anything) for most
                  platforms.
-        
+
         @see GetBezelFace()
     */
     void SetBezelFace(int width);
@@ -153,14 +152,14 @@ public:
     /**
         Sets the range (maximum value) of the gauge.
         This function makes the gauge switch to determinate mode, if it's not already.
-        
+
         @see GetRange()
     */
     void SetRange(int range);
 
     /**
         Sets the 3D shadow width.
-        
+
         @remarks This method is not implemented (doesn't do anything) for most
                  platforms.
     */
@@ -171,11 +170,12 @@ public:
         range as returned by GetRange(), inclusive.
         This function makes the gauge switch to determinate mode, if it was in
         indeterminate mode before.
-        
+
         @param pos
             Position for the gauge level.
-        
+
         @see GetValue()
     */
     void SetValue(int pos);
 };
+