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).

Although wx.ProgressDialog is not really modal, it should be created on the stack, and not the heap, as other modal dialogs, e.g. use it like this:

progdlg = wx.ProgressDialog(...)
for i in range(100):
    if not progdlg.Update(i):
        # Cancelled by user.
        break

... do something time-consuming (but not too much) ...

Note that this becomes even more important if the dialog is instantiated during the program initialization, e.g. from wx.App.OnInit : the dialog must be destroyed before the main event loop is started in this case.

styles Window Styles

This class supports the following styles:

  • wx.PD_APP_MODAL: Make the progress dialog application-modal, i.e. disable all application windows while it is shown. If this flag is not given, it is only “locally” modal –

  • 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.

GetClassDefaultAttributes

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. It will be disabled while this dialog is shown if non-null (whether PD_APP_MODAL is specified or not). Note that if you specify null parent and don’t use PD_APP_MODAL , you need to take care to avoid reentrancies, i.e. avoiding showing the progress dialog again while this one is shown.

  • style (int) – The dialog style. See wx.ProgressDialog.



static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)
Parameters

variant (WindowVariant) –

Return type

wx.VisualAttributes



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 if newmsg is longer than the currently shown message, the dialog will be automatically made wider to account for it. However if the new message is shorter than the previous one, the dialog doesn’t shrink back to avoid constant resizes if the message is changed often. To do this and fit the dialog to its current contents you may call Fit explicitly. However the native MSW implementation of this class does make the dialog shorter if the new text has fewer lines of text than the old one, so it is recommended to keep the number of lines of text constant in order to avoid jarring dialog size changes. You may also want to make the initial message, specified when creating the dialog, wide enough to avoid having to resize the dialog later, e.g. by appending a long string of unbreakable spaces ( String (L’\u00a0’, 100)) to it.

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 doing 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