wxprogressdialog

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

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.

members

wxprogressdialog::wxprogressdialog
wxprogressdialog::~wxprogressdialog
wxprogressdialog::resume
wxprogressdialog::update
wxprogressdialog::pulse

wxprogressdialog::wxprogressdialog

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

dialog title to show in titlebar.

message

message displayed above the progress bar.

maximum

maximum value for the progress bar.

parent

parent window.

style

wxprogressdialog

wxprogressdialog::~wxprogressdialog

~wxprogressdialog()

destructor. deletes the dialog and enables all top level windows.

wxprogressdialog::resume

void resume()

can be used to continue with the dialog, after the user had chosen abort.

wxprogressdialog::update

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

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.

newmsg

the new messages for the progress dialog text, if it is empty (which is the default) the message is not changed.

skip

update

wxprogressdialog::pulse

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.