Add documentation of wxFileSelectorEx() and wx{Load,Save}FileSelector().

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

diff --git a/interface/wx/gauge.h b/interface/wx/gauge.h
index d617d7489bfe2e57dd9d92e787dcc2ae6c94f07f..c17a9ea04b6e8b18baa7ae5ac648d44433bf5047 100644 (file)
--- a/interface/wx/gauge.h
+++ b/interface/wx/gauge.h
@@ -3,12 +3,22 @@
 // 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
-    @wxheader{gauge.h}
 
     A gauge is a horizontal or vertical bar which shows a quantity (often
     time).
@@ -38,7 +48,7 @@
 
     @library{wxcore}
     @category{ctrl}
-    <!-- @appearance{gauge.png} -->
+    @appearance{gauge.png}
 
     @see wxSlider, wxScrollBar
 */
@@ -49,6 +59,7 @@ public:
         Default constructor.
     */
     wxGauge();
+
     /**
         Constructor, creating and showing a gauge.
 
@@ -57,14 +68,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.
 
@@ -75,12 +89,12 @@ 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.
     */
-    ~wxGauge();
+    virtual ~wxGauge();
 
     /**
         Creates the gauge for two-step construction. See wxGauge() for further
@@ -88,10 +102,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.
@@ -136,10 +149,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
-              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.
     */
-    void Pulse();
+    virtual void Pulse();
 
     /**
         Sets the 3D bezel face width.
@@ -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);