Applied patch #15286: documentation and col/rowspan demo by dghart

[wxWidgets.git] / interface / wx / gauge.h

diff --git a/interface/wx/gauge.h b/interface/wx/gauge.h
index 2ac9e8934c36f47f80f6c4d99ccb09c8b50e864d..7d5ecd7db6af621bdc5bfb0f57315ddae396cc1b 100644 (file)
--- a/interface/wx/gauge.h
+++ b/interface/wx/gauge.h
@@ -3,9 +3,20 @@
 // Purpose:     interface of wxGauge
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
+
+// ----------------------------------------------------------------------------
+// wxGauge style flags
+// ----------------------------------------------------------------------------
+
+#define wxGA_HORIZONTAL      wxHORIZONTAL
+#define wxGA_VERTICAL        wxVERTICAL
+
+// Win32 only, is default (and only) on some other platforms
+#define wxGA_SMOOTH          0x0020
+
 /**
     @class wxGauge
 
@@ -37,7 +48,7 @@
 
     @library{wxcore}
     @category{ctrl}
-    @appearance{gauge.png}
+    @appearance{gauge}
 
     @see wxSlider, wxScrollBar
 */
@@ -48,6 +59,7 @@ public:
         Default constructor.
     */
     wxGauge();
+
     /**
         Constructor, creating and showing a gauge.
 
@@ -56,8 +68,9 @@ public:
         @param id
             Window identifier.
         @param range
-            Integer range (maximum value) of the gauge. It is ignored when the
-            gauge is used in indeterminate mode.
+            Integer range (maximum value) of the gauge.
+            See SetRange() for more details about the meaning of this value
+            when using the gauge in indeterminate mode.
         @param pos
             Window position.
         @param size
@@ -136,7 +149,7 @@ public:
         gauge move a bit to indicate the user that some progress has been made.
 
         @note After calling this function the value returned by GetValue() is
-              undefined and thus you need to explicitely call SetValue() if you
+              undefined and thus you need to explicitly call SetValue() if you
               want to restore the determinate mode.
     */
     virtual void Pulse();
@@ -155,6 +168,10 @@ public:
         Sets the range (maximum value) of the gauge. This function makes the
         gauge switch to determinate mode, if it's not already.
 
+        When the gauge is in indeterminate mode, under wxMSW the gauge
+        repeatedly goes from zero to @a range and back; under other ports
+        when in indeterminate mode, the @a range setting is ignored.
+
         @see GetRange()
     */
     void SetRange(int range);