Add new sample project files.

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

diff --git a/interface/wx/gauge.h b/interface/wx/gauge.h
index a36e7a444ab2cc4f87355778e82dc91e421bd1dd..1abe6bca20653f7613d508b5ad4f52a2810c50c8 100644 (file)
--- a/interface/wx/gauge.h
+++ b/interface/wx/gauge.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxGauge
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxGauge
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -48,6 +48,7 @@ public:
         Default constructor.
     */
     wxGauge();
         Default constructor.
     */
     wxGauge();

+

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


@@ -56,14 +57,17 @@ 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
             Window size.
         @param style
             Gauge style.
         @param pos
             Window position.
         @param size
             Window size.
         @param style
             Gauge style.

+        @param validator
+            Window validator.

         @param name
             Window name.
 
         @param name
             Window name.
 


@@ -74,7 +78,7 @@ public:
             const wxSize& size = wxDefaultSize,
             long style = wxGA_HORIZONTAL,
             const wxValidator& validator = wxDefaultValidator,
             const wxSize& size = wxDefaultSize,
             long style = wxGA_HORIZONTAL,
             const wxValidator& validator = wxDefaultValidator,

-            const wxString& name = "gauge");
+            const wxString& name = wxGaugeNameStr);

 
     /**
         Destructor, destroying the gauge.
 
     /**
         Destructor, destroying the gauge.


@@ -134,7 +138,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
         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();
               want to restore the determinate mode.
     */
     virtual void Pulse();


@@ -153,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);