PyProgress is similar to wx.ProgressDialog in indeterminated mode, but with a different gauge appearance and a different spinning behavior. The moving gauge can be drawn with a single solid colour or with a shading gradient foreground. The gauge background colour is user customizable. The bar does not move always from the beginning to the end as in wx.ProgressDialog in indeterminated mode, but spins cyclically forward and backward.
__init__ | Default class constructor. |
CreateLabel | Creates the wx.StaticText that holds the elapsed time label. |
DisableAbort | Disables the Cancel button. |
EnableAbort | Enables or disables the Cancel button. |
EnableClose | Enables or disables the Close button. |
GetFirstGradientColour | Returns the gauge first gradient colour. |
GetGaugeBackground | Returns the gauge background colour. |
GetGaugeProportion | Returns the relative proportion between the sliding bar and the |
GetGaugeSteps | Returns the number of steps the gauge performs before switching from |
GetSecondGradientColour | Returns the gauge second gradient colour. |
OnCancel | Handles the wx.EVT_BUTTON event for the dialog. |
OnClose | Handles the wx.EVT_CLOSE event for PyProgress. |
OnDestroy | Handles the wx.EVT_WINDOW_DESTROY event for PyProgress. |
ReenableOtherWindows | Re-enables the other windows if using wx.WindowDisabler. |
SetFirstGradientColour | Sets the gauge first gradient colour. |
SetGaugeBackground | Sets the gauge background colour. |
SetGaugeProportion | Sets the relative proportion between the sliding bar and the whole gauge. |
SetGaugeSteps | Sets the number of steps the gauge performs before switching from forward to backward (or vice-versa) movement. |
SetSecondGradientColour | Sets the gauge second gradient colour. |
SetTimeLabel | Sets the elapsed time label. |
ShowDialog | Show the dialog. |
UpdatePulse | Updates the dialog, setting the progress bar to the new value and, if given changes the message above it. |
PyProgress is similar to wx.ProgressDialog in indeterminated mode, but with a different gauge appearance and a different spinning behavior. The moving gauge can be drawn with a single solid colour or with a shading gradient foreground. The gauge background colour is user customizable. The bar does not move always from the beginning to the end as in wx.ProgressDialog in indeterminated mode, but spins cyclically forward and backward.
Default class constructor.
Parameters: |
|
---|
Creates the wx.StaticText that holds the elapsed time label.
Parameters: |
|
---|
Enables or disables the Cancel button.
Parameters: | enable – True to enable the Cancel button, False to disable it. |
---|
Enables or disables the Close button.
Parameters: | enable – True to enable the Close button, False to disable it. |
---|
Returns the relative proportion between the sliding bar and the whole gauge.
Returns the number of steps the gauge performs before switching from forward to backward (or vice-versa) movement.
Handles the wx.EVT_BUTTON event for the dialog.
Parameters: | event – a wx.CommandEvent event to be processed. |
---|
Note
This method handles the Cancel button press.
Handles the wx.EVT_CLOSE event for PyProgress.
Parameters: | event – a wx.CloseEvent event to be processed. |
---|
Handles the wx.EVT_WINDOW_DESTROY event for PyProgress.
Parameters: | event – a wx.WindowDestroyEvent event to be processed. |
---|
Re-enables the other windows if using wx.WindowDisabler.
Sets the gauge first gradient colour.
Parameters: | colour – a valid wx.Colour object. |
---|
Sets the gauge background colour.
Parameters: | colour – a valid wx.Colour object. |
---|
Sets the relative proportion between the sliding bar and the whole gauge.
Parameters: | proportion – a floating point number representing the relative proportion between the sliding bar and the whole gauge. |
---|
Sets the number of steps the gauge performs before switching from forward to backward (or vice-versa) movement.
Parameters: | steps – the number of steps the gauge performs before switching from forward to backward (or vice-versa) movement. |
---|
Sets the gauge second gradient colour.
Parameters: | colour – a valid wx.Colour object. |
---|
Sets the elapsed time label.
Parameters: |
|
---|
Show the dialog.
Parameters: | show – True to show the dialog and re-enable all the other windows, False otherwise. |
---|
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.
Parameters: | newmsg – The new messages for the progress dialog text, if it is empty (which is the default) the message is not changed. |
---|