X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7c913512a4c9f36e11e07ea707002fab1608d324..838bfb19e02839b57778ef71963505b27a7ea758:/interface/progdlg.h diff --git a/interface/progdlg.h b/interface/progdlg.h index 22199fec75..45af3f8e81 100644 --- a/interface/progdlg.h +++ b/interface/progdlg.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: progdlg.h -// Purpose: documentation for wxProgressDialog class +// Purpose: interface of wxProgressDialog // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -15,29 +15,29 @@ the elapsed, remaining and estimated time for the end of the progress. @beginStyleTable - @style{wxPD_APP_MODAL}: + @style{wxPD_APP_MODAL} Make the progress dialog modal. If this flag is not given, it is only "locally" modal - that is the input to the parent window is disabled, but not to the other ones. - @style{wxPD_AUTO_HIDE}: + @style{wxPD_AUTO_HIDE} Causes the progress dialog to disappear from screen as soon as the maximum value of the progress meter has been reached. - @style{wxPD_SMOOTH}: + @style{wxPD_SMOOTH} Causes smooth progress of the gauge control. - @style{wxPD_CAN_ABORT}: + @style{wxPD_CAN_ABORT} This flag tells the dialog that it should have a "Cancel" button which the user may press. If this happens, the next call to Update() will return @false. - @style{wxPD_CAN_SKIP}: + @style{wxPD_CAN_SKIP} This flag tells the dialog that it should have a "Skip" button which the user may press. If this happens, the next call to Update() will return @true in its skip parameter. - @style{wxPD_ELAPSED_TIME}: + @style{wxPD_ELAPSED_TIME} This flag tells the dialog that it should show elapsed time (since creating the dialog). - @style{wxPD_ESTIMATED_TIME}: + @style{wxPD_ESTIMATED_TIME} This flag tells the dialog that it should show estimated time. - @style{wxPD_REMAINING_TIME}: + @style{wxPD_REMAINING_TIME} This flag tells the dialog that it should show remaining time. @endStyleTable @@ -49,27 +49,23 @@ class wxProgressDialog : public wxDialog public: /** Constructor. Creates the dialog, displays it and disables user input - for other windows, or, if wxPD_APP_MODAL flag is not given, for its parent - window only. - + for other windows, or, if @c wxPD_APP_MODAL flag is not given, for its + parent window only. + @param title - Dialog title to show in titlebar. - + Dialog title to show in titlebar. @param message - Message displayed above the progress bar. - + Message displayed above the progress bar. @param maximum - Maximum value for the progress bar. - + Maximum value for the progress bar. @param parent - Parent window. - + Parent window. @param style - The dialog style. See wxProgressDialog. + The dialog style. See wxProgressDialog. */ wxProgressDialog(const wxString& title, const wxString& message, int maximum = 100, - wxWindow * parent = @NULL, + wxWindow* parent = NULL, int style = wxPD_AUTO_HIDE | wxPD_APP_MODAL); /** @@ -78,44 +74,40 @@ public: ~wxProgressDialog(); /** - Just 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 @c Unknown and - moves - the progress bar a bit to indicate that some progress was done. + 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); + bool* skip = NULL); /** - Can be used to continue with the dialog, after the user had chosen - ABORT. + Can be used to continue with the dialog, after the user had clicked the "Abort" button. */ void Resume(); /** Updates the dialog, setting the progress bar to the new value and, if - given changes the message above it. Returns @true unless the Cancel button + given changes the message above it. Returns @true unless the "Cancel" button has been pressed. - + If @false is returned, the application can either immediately destroy the - dialog - or ask the user for the confirmation and if the abort is not confirmed the - dialog may be resumed with Resume() function. - + dialog or ask the user for the confirmation and if the abort is not confirmed + the dialog may be resumed with Resume() function. + @param value - The new value of the progress meter. It should be less than or - equal to the maximum value given to the constructor and the dialog is closed if - it is equal to the maximum. - + The new value of the progress meter. It should be less than or equal to + the maximum value given to the constructor and the dialog is closed if + it is equal to the maximum. @param newmsg - The new messages for the progress dialog text, if it is - empty (which is the default) the message is not changed. - + The new messages for the progress dialog text, if it is + empty (which is the default) the message is not changed. @param skip - If "Skip" button was pressed since last - Update call, this is set to @true. + If "Skip" button was pressed since last Update() call, + this is set to @true. */ virtual bool Update(int value, const wxString& newmsg = "", - bool * skip = @NULL); + bool* skip = NULL); }; +