X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/adaaa68635b4c8a4d8c5284add40366ea3eefb07..fcd209b6a20b41e7ddf9acf837311ac6779ea41f:/interface/wx/progdlg.h?ds=sidebyside diff --git a/interface/wx/progdlg.h b/interface/wx/progdlg.h index 808ffd7c23..a6c4127370 100644 --- 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,14 +74,38 @@ 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 (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); };