Implement wxCalendarCtrl::SetDateRange() in the native GTK version.

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

diff --git a/interface/wx/gauge.h b/interface/wx/gauge.h
index 2cb391e1b2ee97df85e52f5f99df75d1f1dcb47d..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

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


@@ -37,7 +37,7 @@
 
     @library{wxcore}
     @category{ctrl}
 
     @library{wxcore}
     @category{ctrl}

-    <!-- @appearance{gauge.png} -->
+    @appearance{gauge.png}

 
     @see wxSlider, wxScrollBar
 */
 
     @see wxSlider, wxScrollBar
 */


@@ -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,12 +78,12 @@ 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.
     */

-    ~wxGauge();
+    virtual ~wxGauge();

 
     /**
         Creates the gauge for two-step construction. See wxGauge() for further
 
     /**
         Creates the gauge for two-step construction. See wxGauge() for further


@@ -87,10 +91,9 @@ public:
     */
     bool Create(wxWindow* parent, wxWindowID id, int range,
                 const wxPoint& pos = wxDefaultPosition,
     */
     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 wxValidator& validator = wxDefaultValidator,

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

 
     /**
         Returns the width of the 3D bezel face.
 
     /**
         Returns the width of the 3D bezel face.


@@ -135,10 +138,10 @@ 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.
     */
               want to restore the determinate mode.
     */

-    void Pulse();
+    virtual void Pulse();

 
     /**
         Sets the 3D bezel face width.
 
     /**
         Sets the 3D bezel face width.


@@ -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.
 
         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);