wx.ProgressDialog¶If supported by the platform this class will provide the platform’s native progress dialog, else it will simply be the ` wx.GenericProgressDialog ` .
Methods Summary¶__init__ |
|
GetMessage |
Returns the last message passed to the Update function; if you always passed “” to Update then the message set through the constructor is returned. |
GetRange |
Returns the maximum value of the progress meter, as passed to the constructor or NOT_FOUND if the dialog has no progress bar. |
GetValue |
Returns the last value passed to the Update function or NOT_FOUND if the dialog has no progress bar. |
Pulse |
Like Update but makes the gauge control run in indeterminate mode. |
Resume |
Can be used to continue with the dialog, after the user had clicked the “Abort” button. |
SetRange |
Changes the maximum value of the progress meter given in the constructor. |
Update |
Updates the dialog, setting the progress bar to the new value and updating the message if new one is specified. |
WasCancelled |
Returns True if the “Cancel” button was pressed. |
WasSkipped |
Returns True if the “Skip” button was pressed. |
Class API¶
Inheritance diagram for class ProgressDialog:
wx.ProgressDialog(GenericProgressDialog)¶Possible constructors:
ProgressDialog(title, message, maximum=100, parent=None,
style=PD_APP_MODAL|PD_AUTO_HIDE)
If supported by the platform this class will provide the platform’s native progress dialog, else it will simply be the GenericProgressDialog.
__init__(self, title, message, maximum=100, parent=None, style=PD_APP_MODAL|PD_AUTO_HIDE)¶| Parameters: |
|
|---|
GetMessage(self)¶Returns the last message passed to the Update function; if you always passed “” to Update then the message set through the constructor is returned.
| Return type: | string |
|---|
New in version 2.9.0.
GetRange(self)¶Returns the maximum value of the progress meter, as passed to the constructor or NOT_FOUND if the dialog has no progress bar.
| Return type: | int |
|---|
New in version 2.9.0.
GetValue(self)¶Returns the last value passed to the Update function or NOT_FOUND if the dialog has no progress bar.
| Return type: | int |
|---|
New in version 2.9.0.
Pulse(self, newmsg="")¶Like Update but makes the gauge control run in indeterminate mode.
In indeterminate mode the remaining and the estimated time labels (if present) are set to “Unknown” or to newmsg (if it’s non-empty). Each call to this function moves the progress bar a bit to indicate that some progress was done.
| Parameters: | newmsg (string) – |
|---|---|
| Return type: | tuple |
| Returns: | ( bool, skip ) |
See also
Resume(self)¶Can be used to continue with the dialog, after the user had clicked the “Abort” button.
SetRange(self, maximum)¶Changes the maximum value of the progress meter given in the constructor.
This function can only be called (with a positive value) if the value passed in the constructor was positive.
| Parameters: | maximum (int) – |
|---|
New in version 2.9.1.
Update(self, value, newmsg="")¶Updates the dialog, setting the progress bar to the new value and updating the message if new one is specified.
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.
If value is the maximum value for the dialog, the behaviour of the function depends on whether PD_AUTO_HIDE was used when the dialog was created. If it was, the dialog is hidden and the function returns immediately. If it was not, the dialog becomes a modal dialog and waits for the user to dismiss it, meaning that this function does not return until this happens.
Notice that you may want to call Fit to change the dialog size to conform to the length of the new message if desired. The dialog does not do this automatically.
| Parameters: |
|
|---|---|
| Return type: | tuple |
| Returns: | ( bool, skip ) |
WasCancelled(self)¶Returns True if the “Cancel” button was pressed.
Normally a Cancel button press is indicated by Update returning False but sometimes it may be more convenient to check if the dialog was cancelled from elsewhere in the code and this function allows to do it.
It always returns False if the Cancel button is not shown at all.
| Return type: | bool |
|---|
New in version 2.9.1.
WasSkipped(self)¶Returns True if the “Skip” button was pressed.
This is similar to WasCancelled but returns True if the “Skip” button was pressed, not the “Cancel” one.
| Return type: | bool |
|---|
New in version 2.9.1.
Message¶See GetMessage