115% line height on lists is more than enough, especially for the class hierarchy...

[wxWidgets.git] / interface / gauge.h

diff --git a/interface/gauge.h b/interface/gauge.h
index 27df9b9fee8d4579d28f7d984046b192c42f938c..94bda71bfef9b554a6589d56e93a66318be220cc 100644 (file)
--- a/interface/gauge.h
+++ b/interface/gauge.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        gauge.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        gauge.h

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

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


@@ -40,8 +40,7 @@
     @category{ctrl}
     @appearance{gauge.png}
 
     @category{ctrl}
     @appearance{gauge.png}
 

-    @seealso
-    wxSlider, wxScrollBar
+    @see wxSlider, wxScrollBar

 */
 class wxGauge : public wxControl
 {
 */
 class wxGauge : public wxControl
 {


@@ -49,30 +48,24 @@ public:
     //@{
     /**
         Constructor, creating and showing a gauge.
     //@{
     /**
         Constructor, creating and showing a gauge.

-        
+

         @param parent
         @param parent

-        Window parent.
-        
+            Window parent.

         @param id
         @param id

-        Window identifier.
-        
+            Window identifier.

         @param range
         @param range

-        Integer range (maximum value) of the gauge. It is ignored when the gauge is
+            Integer range (maximum value) of the gauge. It is ignored when the gauge is

         used in indeterminate mode.
         used in indeterminate mode.

-        

         @param pos
         @param pos

-        Window position.
-        
+            Window position.

         @param size
         @param size

-        Window size.
-        
+            Window size.

         @param style
         @param style

-        Gauge style. See wxGauge.
-        
+            Gauge style. See wxGauge.

         @param name
         @param name

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

     */
     wxGauge();
     wxGauge(wxWindow* parent, wxWindowID id, int range,
     */
     wxGauge();
     wxGauge(wxWindow* parent, wxWindowID id, int range,


@@ -101,46 +94,45 @@ public:
 
     /**
         Returns the width of the 3D bezel face.
 
     /**
         Returns the width of the 3D bezel face.

-        
+

         @remarks This method is not implemented (returns 0) for most platforms.
         @remarks This method is not implemented (returns 0) for most platforms.

-        
-        @sa SetBezelFace()
+
+        @see SetBezelFace()

     */
     */

-    int GetBezelFace();
+    int GetBezelFace() const;

 
     /**
         Returns the maximum position of the gauge.
 
     /**
         Returns the maximum position of the gauge.

-        
-        @sa SetRange()
+
+        @see SetRange()

     */
     */

-    int GetRange();
+    int GetRange() const;

 
     /**
         Returns the 3D shadow margin width.
 
     /**
         Returns the 3D shadow margin width.

-        
+

         @remarks This method is not implemented (returns 0) for most platforms.
         @remarks This method is not implemented (returns 0) for most platforms.

-        
-        @sa SetShadowWidth()
+
+        @see SetShadowWidth()

     */
     */

-    int GetShadowWidth();
+    int GetShadowWidth() const;

 
     /**
         Returns the current position of the gauge.
 
     /**
         Returns the current position of the gauge.

-        
-        @sa SetValue()
+
+        @see SetValue()

     */
     */

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

 
     /**
         Returns @true if the gauge is vertical (has @c wxGA_VERTICAL style) and
         @false otherwise.
     */
 
     /**
         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
         a bit to indicate the user that some progress has been made.
 
     /**
         Switch the gauge to indeterminate mode (if required) and makes the gauge move
         a bit to indicate the user that some progress has been made.

-        

         Note that after calling this function the value returned by GetValue()
         is undefined and thus you need to explicitely call SetValue() if you
         want to restore the determinate mode.
         Note that after calling this function the value returned by GetValue()
         is undefined and thus you need to explicitely call SetValue() if you
         want to restore the determinate mode.


@@ -149,41 +141,41 @@ public:
 
     /**
         Sets the 3D bezel face width.
 
     /**
         Sets the 3D bezel face width.

-        
+

         @remarks This method is not implemented (doesn't do anything) for most
         @remarks This method is not implemented (doesn't do anything) for most

-                   platforms.
-        
-        @sa GetBezelFace()
+                 platforms.
+
+        @see GetBezelFace()

     */
     void SetBezelFace(int width);
 
     /**
         Sets the range (maximum value) of the gauge.
         This function makes the gauge switch to determinate mode, if it's not already.
     */
     void SetBezelFace(int width);
 
     /**
         Sets the range (maximum value) of the gauge.
         This function makes the gauge switch to determinate mode, if it's not already.

-        
-        @sa GetRange()
+
+        @see GetRange()

     */
     void SetRange(int range);
 
     /**
         Sets the 3D shadow width.
     */
     void SetRange(int range);
 
     /**
         Sets the 3D shadow width.

-        
+

         @remarks This method is not implemented (doesn't do anything) for most
         @remarks This method is not implemented (doesn't do anything) for most

-                   platforms.
+                 platforms.

     */
     void SetShadowWidth(int width);
 
     /**
     */
     void SetShadowWidth(int width);
 
     /**

-        Sets the position of the gauge. The @e pos must be between 0 and the gauge
+        Sets the position of the gauge. The @a pos must be between 0 and the gauge

         range as returned by GetRange(), inclusive.
         range as returned by GetRange(), inclusive.

-        

         This function makes the gauge switch to determinate mode, if it was in
         indeterminate mode before.
         This function makes the gauge switch to determinate mode, if it was in
         indeterminate mode before.

-        
+

         @param pos
         @param pos

-        Position for the gauge level.
-        
-        @sa GetValue()
+            Position for the gauge level.
+
+        @see GetValue()

     */
     void SetValue(int pos);
 };
     */
     void SetValue(int pos);
 };

+