document recently added enums

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

diff --git a/interface/wx/progdlg.h b/interface/wx/progdlg.h
index 7f229492c636497a746052c42a293d112ce52696..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
@@ -72,6 +74,31 @@ public:
     */
     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
         (see wxGauge documentation); sets the remaining and the estimated time labels