Navigation

Phoenix Logo

phoenix_title wx.GenericProgressDialog

This class represents a dialog that shows a short message and a progress bar.

Optionally, it can display ABORT and SKIP buttons, and the elapsed, remaining and estimated time for the end of the progress.

This class provides a generic implementation of the progress dialog. If the platform has a native progress dialog available then it will be accessible using the ` wx.ProgressDialog ` class, otherwise it will essentially be the same as this class.

Note that you must be aware that wx.ProgressDialog internally calls wx.EventLoopBase.YieldFor with wxEVT_CATEGORY_UI and wxEVT_CATEGORY_USER_INPUT and this may cause unwanted re-entrancies or the out-of-order processing of pending events (to help preventing the last problem if you’re using wx.ProgressDialog in a multi-threaded application you should be sure to use ThreadEvent for your inter-threads communications).

styles Window Styles

This class supports the following styles:

  • wx.PD_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.
  • wx.PD_AUTO_HIDE: Causes the progress dialog to disappear from screen as soon as the maximum value of the progress meter has been reached. If this style is not present, the dialog will become a modal dialog (see wx.Dialog.ShowModal ) once the maximum value has been reached and wait for the user to dismiss it.
  • wx.PD_SMOOTH: Causes smooth progress of the gauge control (uses a wx.Gauge with the GA_SMOOTH style).
  • wx.PD_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.
  • wx.PD_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.
  • wx.PD_ELAPSED_TIME: This flag tells the dialog that it should show elapsed time (since creating the dialog).
  • wx.PD_ESTIMATED_TIME: This flag tells the dialog that it should show estimated time.
  • wx.PD_REMAINING_TIME: This flag tells the dialog that it should show remaining time.

class_hierarchy Class Hierarchy

Inheritance diagram for class GenericProgressDialog:

sub_classes Known Subclasses

wx.ProgressDialog


method_summary Methods Summary

__init__ Constructor.
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.

property_summary Properties Summary

Message See GetMessage
Range See GetRange and SetRange
Value See GetValue

api Class API


class wx.GenericProgressDialog(Dialog)

Possible constructors:

GenericProgressDialog(title, message, maximum=100, parent=None,
                      style=PD_AUTO_HIDE|PD_APP_MODAL)

This class represents a dialog that shows a short message and a progress bar.


Methods


__init__(self, title, message, maximum=100, parent=None, style=PD_AUTO_HIDE|PD_APP_MODAL)

Constructor.

Creates the dialog, displays it and disables user input for other windows, or, if PD_APP_MODAL flag is not given, for its parent window only.

Parameters:
  • title (string) – Dialog title to show in titlebar.
  • message (string) – Message displayed above the progress bar.
  • maximum (int) – Maximum value for the progress bar. In the generic implementation the progress bar is constructed only if this value is greater than zero.
  • parent (wx.Window) – Parent window.
  • style (int) – The dialog style. See wx.ProgressDialog.

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

wx.Gauge.Pulse , Update


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:
  • value (int) – The new value of the progress meter. It should be less than or equal to the maximum value given to the constructor.
  • newmsg (string) – The new messages for the progress dialog text, if it is empty (which is the default) the message is not changed.
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.


Properties


Message

See GetMessage


Range

See GetRange and SetRange


Value

See GetValue