document recently added enums

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

diff --git a/interface/wx/progdlg.h b/interface/wx/progdlg.h
index 89db9197ef8dad056c22d0dd6246e5b30163f9bf..a6c412737097b089266272f989f27a99c92e8d6b 100644 (file)
--- a/interface/wx/progdlg.h
+++ b/interface/wx/progdlg.h
@@ -57,6 +57,8 @@ public:
             Message displayed above the progress bar.
         @param maximum
             Maximum value for the progress bar.
+            In the generic implementation the progress bar is constructed
+            only if this value is greater than zero.
         @param parent
             Parent window.
         @param style
@@ -70,7 +72,32 @@ public:
     /**
         Destructor. Deletes the dialog and enables all top level windows.
     */
-    ~wxProgressDialog();
+    virtual ~wxProgressDialog();
+
+    /**
+        Returns the last value passed to the Update() function or
+        @c wxNOT_FOUND if the dialog has no progress bar.
+
+        @since 2.9.0
+    */
+    int GetValue() const;
+
+    /**
+        Returns the maximum value of the progress meter, as passed to
+        the constructor or @c wxNOT_FOUND if the dialog has no progress bar.
+
+        @since 2.9.0
+    */
+    int GetRange() const;
+
+    /**
+        Returns the last message passed to the Update() function;
+        if you always passed wxEmptyString to Update() then the message
+        set through the constructor is returned.
+
+        @since 2.9.0
+    */
+    wxString GetMessage() const;
 
     /**
         Works like Update() but makes the gauge control run in indeterminate mode
@@ -78,8 +105,7 @@ public:
         (if present) to "Unknown" or to @a newmsg (if it's non-empty); moves the progress
         bar a bit to indicate that some progress was done.
     */
-    virtual bool Pulse(const wxString& newmsg = "",
-                       bool* skip = NULL);
+    virtual bool Pulse(const wxString& newmsg = wxEmptyString, bool* skip = NULL);
 
     /**
         Can be used to continue with the dialog, after the user had clicked the "Abort" button.
@@ -106,7 +132,7 @@ public:
             If "Skip" button was pressed since last Update() call,
             this is set to @true.
     */
-    virtual bool Update(int value, const wxString& newmsg = "",
+    virtual bool Update(int value, const wxString& newmsg = wxEmptyString,
                         bool* skip = NULL);
 };