This class represents a dialog that shows a short message and a progress bar. Optionally, it can display ABORT and SKIP buttons, the elapsed, remaining and estimated time for the end of the progress.
Derived from
wxDialog
wxWindow
wxEvtHandler
wxObject
Include files
<wx/progdlg.h>
Window styles
| 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. |
| wxPD_AUTO_HIDE | Causes the progress dialog to disappear from screen as soon as the maximum value of the progress meter has been reached. |
| wxPD_SMOOTH | Causes smooth progress of the gauge control. |
| 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. |
| 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. |
| wxPD_ELAPSED_TIME | This flag tells the dialog that it should show elapsed time (since creating the dialog). |
| wxPD_ESTIMATED_TIME | This flag tells the dialog that it should show estimated time. |
| wxPD_REMAINING_TIME | This flag tells the dialog that it should show remaining time. |
wxProgressDialog::wxProgressDialog
wxProgressDialog::~wxProgressDialog
wxProgressDialog::Resume
wxProgressDialog::Update
wxProgressDialog::Pulse
wxProgressDialog(const wxString& title, const wxString& message, int maximum = 100, wxWindow * parent = NULL, int style = wxPD_AUTO_HIDE | wxPD_APP_MODAL)
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.
Parameters
title
message
maximum
parent
style
~wxProgressDialog()
Destructor. Deletes the dialog and enables all top level windows.
void Resume()
Can be used to continue with the dialog, after the user had chosen ABORT.
virtual bool Update(int value, const wxString& newmsg = "", bool *skip = NULL)
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 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.
Parameters
value
virtual bool Pulse(const wxString& newmsg = "", bool *skip = NULL)
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 Unknown and moves the progress bar a bit to indicate that some progress was done.