Package wx :: Package lib :: Package agw :: Module pyprogress :: Class PyProgress

[frames | no frames]

## Type PyProgress

    object --+
             |
        Object --+
                 |
        EvtHandler --+
                     |
                Window --+
                         |
            TopLevelWindow --+
                             |
                        Dialog --+
                                 |
                                PyProgress

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.

Method Summary
| ``__init__`(self, parent, id, title, message, style)` Default class constructor.
| ``CreateLabel`(self, text, sizer)` Creates the wx.StaticText that holds the elapsed time label.
| ``DisableAbort`(self)` Disables the Cancel button.
| ``EnableAbort`(self, enable)` Enables or disables the Cancel button.
| ``EnableClose`(self, enable)` Enables or disables the Close button.
| ``GetFirstGradientColour`(self)` Returns the gauge first gradient colour.
| ``GetGaugeBackground`(self)` Returns the gauge background colour.
| ``GetGaugeProportion`(self)` Returns the relative proportion between the sliding bar and the whole gauge.
| ``GetGaugeSteps`(self)` Returns the number of steps the gauge performs before switching from forward to backward (or vice-versa) movement.
| ``GetSecondGradientColour`(self)` Returns the gauge second gradient colour.
| ``OnCancel`(self, event)` Handles the wx.EVT_BUTTON event for the Cancel button.
| ``OnClose`(self, event)` Handles the wx.EVT_CLOSE event for PyProgress.
| ``OnDestroy`(self, event)` Handles the wx.EVT_WINDOW_DESTROY event for PyProgress.
| ``ReenableOtherWindows`(self)` Re-enables the other windows if using wx.WindowDisabler.
| ``SetFirstGradientColour`(self, colour)` Sets the gauge first gradient colour.
| ``SetGaugeBackground`(self, colour)` Sets the gauge background colour.
| ``SetGaugeProportion`(self, proportion)` Sets the relative proportion between the sliding bar and the whole gauge.
| ``SetGaugeSteps`(self, steps)` Sets the number of steps the gauge performs before switching from forward to backward (or vice-versa) movement.
| ``SetSecondGradientColour`(self, colour)` Sets the gauge second gradient colour.
| ``SetTimeLabel`(self, val, label)` Sets the elapsed time label.
| ``ShowDialog`(self, show)` Show the dialog.
| ``UpdatePulse`(self, newmsg)` Update the progress dialog with a (optionally) new message.

Property Summary

Class Variable Summary

Instance Method Details

### __init__(self, parent=None, id=-1, title='', message='', style=6)
(Constructor)

Default class constructor.

  Overrides:
    `wx.Dialog.__init__`

### CreateLabel(self, text, sizer)

Creates the wx.StaticText that holds the elapsed time label.

### DisableAbort(self)

Disables the Cancel button.

### EnableAbort(self, enable=True)

Enables or disables the Cancel button.

### EnableClose(self, enable=True)

Enables or disables the Close button.

### GetFirstGradientColour(self)

Returns the gauge first gradient colour.

### GetGaugeBackground(self)

Returns the gauge background colour.

### GetGaugeProportion(self)

Returns the relative proportion between the sliding bar and the whole gauge.

### GetGaugeSteps(self)

Returns the number of steps the gauge performs before switching from forward to backward (or vice-versa) movement.

### GetSecondGradientColour(self)

Returns the gauge second gradient colour.

### OnCancel(self, event)

Handles the wx.EVT_BUTTON event for the Cancel button.

### OnClose(self, event)

Handles the wx.EVT_CLOSE event for PyProgress.

### OnDestroy(self, event)

Handles the wx.EVT_WINDOW_DESTROY event for PyProgress.

### ReenableOtherWindows(self)

Re-enables the other windows if using wx.WindowDisabler.

### SetFirstGradientColour(self, colour)

Sets the gauge first gradient colour.

### SetGaugeBackground(self, colour)

Sets the gauge background colour.

### SetGaugeProportion(self, proportion)

Sets the relative proportion between the sliding bar and the whole gauge.

### SetGaugeSteps(self, steps)

Sets the number of steps the gauge performs before switching from forward to backward (or vice-versa) movement.

### SetSecondGradientColour(self, colour)

Sets the gauge second gradient colour.

### SetTimeLabel(self, val, label=None)

Sets the elapsed time label.

### ShowDialog(self, show=True)

Show the dialog.

### UpdatePulse(self, newmsg='')

Update the progress dialog with a (optionally) new message.

Generated by Epydoc 2.1.20050511.rpd on Mon Feb 16 12:51:29 2009 | http://epydoc.sf.net