update for bakefile 0.2.6

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

diff --git a/interface/wx/gauge.h b/interface/wx/gauge.h
index f583c15c1050c9016bd899ee9909d4b600cec88a..b096e0b5e5c24b20e23152aa42d881eae3d94421 100644 (file)
--- a/interface/wx/gauge.h
+++ b/interface/wx/gauge.h
@@ -48,6 +48,7 @@ public:
         Default constructor.
     */
     wxGauge();
+
     /**
         Constructor, creating and showing a gauge.
 
@@ -56,14 +57,17 @@ 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
             Window size.
         @param style
             Gauge style.
+        @param validator
+            Window validator.
         @param name
             Window name.
 
@@ -74,7 +78,7 @@ public:
             const wxSize& size = wxDefaultSize,
             long style = wxGA_HORIZONTAL,
             const wxValidator& validator = wxDefaultValidator,
-            const wxString& name = "gauge");
+            const wxString& name = wxGaugeNameStr);
 
     /**
         Destructor, destroying the gauge.
@@ -87,10 +91,9 @@ public:
     */
     bool Create(wxWindow* parent, wxWindowID id, int range,
                 const wxPoint& pos = wxDefaultPosition,
-                const wxSize& size = wxDefaultSize,
-                long style = wxGA_HORIZONTAL,
+                const wxSize& size = wxDefaultSize, long style = wxGA_HORIZONTAL,
                 const wxValidator& validator = wxDefaultValidator,
-                const wxString& name = "gauge");
+                const wxString& name = wxGaugeNameStr);
 
     /**
         Returns the width of the 3D bezel face.
@@ -154,6 +157,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);