pyface.i_progress_dialog module

The interface for a dialog that allows the user to display progress of an operation.

class pyface.i_progress_dialog.IProgressDialog(adaptee, default=<class 'traits.adaptation.adaptation_error.AdaptationError'>)

Bases: pyface.i_dialog.IDialog

A simple progress dialog window which allows itself to be updated

message = Str()

The message to display in the dialog

min = Int()

The minimum progress value

max = Int()

The maximum progress value

margin = Int(5)

The margin around the progress bar

can_cancel = Bool(False)

Whether the operation can be cancelled

show_time = Bool(False)

Whether to show progress times

show_percent = Bool(False)

Whether to show progress percent

cancel_button_label = Str()

Label for the ‘cancel’ button

update(value)

Update the progress bar to the desired value

If the value is >= the maximum and the progress bar is not contained in another panel the parent window will be closed.

Parameters

value – The progress value to set.

change_message(message)

Change the displayed message in the progress dialog

Parameters

message (str or unicode) – The new message to display.

class pyface.i_progress_dialog.MProgressDialog

Bases: traits.has_traits.HasTraits

The mixin class that contains common code for toolkit specific implementations of the IProgressDialog interface.

Implements: update()

open()

Open the dialog

update(value)

Update the progress bar to the desired value

If the value is >= the maximum and the progress bar is not contained in another panel the parent window will be closed.

Parameters

value – The progress value to set.

change_message(message)

Change the displayed message in the progress dialog

Parameters

message (str or unicode) – The new message to display.