be more precise about range in indeterminate-mode wxGauges (fixes #10125)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56901 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/gauge.h b/interface/wx/gauge.h
index 2ac9e8934c36f47f80f6c4d99ccb09c8b50e864d..b096e0b5e5c24b20e23152aa42d881eae3d94421 100644 (file)
--- a/interface/wx/gauge.h
+++ b/interface/wx/gauge.h
@@ -48,6 +48,7 @@ public:
         Default constructor.
     */
     wxGauge();
         Default constructor.
     */
     wxGauge();

+

     /**
         Constructor, creating and showing a gauge.
 
     /**
         Constructor, creating and showing a gauge.
 


@@ -56,8 +57,9 @@ public:
         @param id
             Window identifier.
         @param range
         @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
         @param pos
             Window position.
         @param size


@@ -155,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.
 
         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);
         @see GetRange()
     */
     void SetRange(int range);