Module PyProgress :: Class PyProgress
[hide private]
[frames] | no frames]

Class PyProgress

source code

     object --+                    
              |                    
wx._core.Object --+                
                  |                
wx._core.EvtHandler --+            
                      |            
        wx._core.Window --+        
                          |        
 wx._windows.TopLevelWindow --+    
                              |    
             wx._windows.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.

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

Inherited from wx._windows.Dialog: Create, CreateButtonSizer, CreateSeparatedButtonSizer, CreateStdDialogButtonSizer, CreateTextSizer, EndModal, GetAffirmativeId, GetEscapeId, GetReturnCode, IsModal, SetAffirmativeId, SetEscapeId, SetReturnCode, ShowModal

Inherited from wx._windows.Dialog (private): _CreateButtonSizer

Inherited from wx._windows.TopLevelWindow: CenterOnScreen, CentreOnScreen, EnableCloseButton, GetDefaultItem, GetIcon, GetTitle, GetTmpDefaultItem, Iconize, IsActive, IsAlwaysMaximized, IsFullScreen, IsIconized, IsMaximized, MacGetMetalAppearance, MacSetMetalAppearance, Maximize, RequestUserAttention, Restore, SetDefaultItem, SetIcon, SetIcons, SetShape, SetTitle, SetTmpDefaultItem, ShowFullScreen, __repr__

Inherited from wx._core.Window: AcceptsFocus, AcceptsFocusFromKeyboard, AddChild, AdjustForLayoutDirection, AssociateHandle, CacheBestSize, CanSetTransparent, CaptureMouse, Center, CenterOnParent, Centre, CentreOnParent, ClearBackground, ClientToScreen, ClientToScreenXY, Close, ConvertDialogPointToPixels, ConvertDialogSizeToPixels, ConvertPixelPointToDialog, ConvertPixelSizeToDialog, DLG_PNT, DLG_SZE, Destroy, DestroyChildren, Disable, DissociateHandle, DragAcceptFiles, Enable, FindWindowById, FindWindowByName, Fit, FitInside, Freeze, GetAcceleratorTable, GetAdjustedBestSize, GetAutoLayout, GetBackgroundColour, GetBackgroundStyle, GetBestFittingSize, GetBestSize, GetBestSizeTuple, GetBestVirtualSize, GetBorder, GetCaret, GetCharHeight, GetCharWidth, GetChildren, GetClientAreaOrigin, GetClientRect, GetClientSize, GetClientSizeTuple, GetConstraints, GetContainingSizer, GetCursor, GetDefaultAttributes, GetDropTarget, GetEventHandler, GetExtraStyle, GetFont, GetForegroundColour, GetFullTextExtent, GetGrandParent, GetHandle, GetHelpText, GetHelpTextAtPoint, GetId, GetLabel, GetLayoutDirection, GetMaxHeight, GetMaxSize, GetMaxWidth, GetMinHeight, GetMinSize, GetMinWidth, GetName, GetParent, GetPosition, GetPositionTuple, GetRect, GetScreenPosition, GetScreenPositionTuple, GetScreenRect, GetScrollPos, GetScrollRange, GetScrollThumb, GetSize, GetSizeTuple, GetSizer, GetTextExtent, GetThemeEnabled, GetToolTip, GetUpdateClientRect, GetUpdateRegion, GetValidator, GetVirtualSize, GetVirtualSizeTuple, GetWindowStyle, GetWindowStyleFlag, GetWindowVariant, HasCapture, HasFlag, HasMultiplePages, HasScrollbar, HasTransparentBackground, Hide, HitTest, HitTestXY, InheritAttributes, InheritsBackgroundColour, InitDialog, InvalidateBestSize, IsBeingDeleted, IsDoubleBuffered, IsEnabled, IsExposed, IsExposedPoint, IsExposedRect, IsFrozen, IsRetained, IsShown, IsShownOnScreen, IsTopLevel, Layout, LineDown, LineUp, Lower, MakeModal, Move, MoveAfterInTabOrder, MoveBeforeInTabOrder, MoveXY, Navigate, OnPaint, PageDown, PageUp, PopEventHandler, PopupMenu, PopupMenuXY, PostCreate, PrepareDC, PushEventHandler, Raise, Refresh, RefreshRect, RegisterHotKey, ReleaseMouse, RemoveChild, RemoveEventHandler, Reparent, ScreenToClient, ScreenToClientXY, ScrollLines, ScrollPages, ScrollWindow, SendSizeEvent, SetAcceleratorTable, SetAutoLayout, SetBackgroundColour, SetBackgroundStyle, SetBestFittingSize, SetCaret, SetClientRect, SetClientSize, SetClientSizeWH, SetConstraints, SetContainingSizer, SetCursor, SetDimensions, SetDoubleBuffered, SetDropTarget, SetEventHandler, SetExtraStyle, SetFocus, SetFocusFromKbd, SetFont, SetForegroundColour, SetHelpText, SetHelpTextForId, SetId, SetLabel, SetLayoutDirection, SetMaxSize, SetMinSize, SetName, SetOwnBackgroundColour, SetOwnFont, SetOwnForegroundColour, SetPosition, SetRect, SetScrollPos, SetScrollbar, SetSize, SetSizeHints, SetSizeHintsSz, SetSizeWH, SetSizer, SetSizerAndFit, SetThemeEnabled, SetToolTip, SetToolTipString, SetTransparent, SetValidator, SetVirtualSize, SetVirtualSizeHints, SetVirtualSizeHintsSz, SetVirtualSizeWH, SetWindowStyle, SetWindowStyleFlag, SetWindowVariant, ShouldInheritColours, Show, Thaw, TransferDataFromWindow, TransferDataToWindow, UnregisterHotKey, Update, UpdateWindowUI, UseBgCol, Validate, WarpPointer

Inherited from wx._core.EvtHandler: AddPendingEvent, AllowReentrance, Bind, Connect, Disconnect, GetEvtHandlerEnabled, GetNextHandler, GetPreviousHandler, IsEventHandlingInProgress, IsReentranceAllowed, ProcessEvent, ProcessPendingEvents, SetEvtHandlerEnabled, SetNextHandler, SetPreviousHandler, Unbind

Inherited from wx._core.EvtHandler (private): _setOORInfo

Inherited from wx._core.Object: GetClassName

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __str__


Static Methods [hide private]

Inherited from wx._windows.Dialog: GetClassDefaultAttributes

Inherited from wx._core.Window: FindFocus, GetCapture, NewControlId, NextControlId, PrevControlId


Class Variables [hide private]

Inherited from wx._windows.Dialog: ButtonSizerFlags


Properties [hide private]

Inherited from wx._windows.Dialog: AffirmativeId, EscapeId, ReturnCode, thisown

Inherited from wx._windows.TopLevelWindow: DefaultItem, Icon, Title, TmpDefaultItem

Inherited from wx._core.Window: AcceleratorTable, AdjustedBestSize, AutoLayout, BackgroundColour, BackgroundStyle, BestFittingSize, BestSize, BestVirtualSize, Border, Caret, CharHeight, CharWidth, Children, ClientAreaOrigin, ClientRect, ClientSize, Constraints, ContainingSizer, Cursor, DefaultAttributes, DropTarget, Enabled, EventHandler, ExtraStyle, Font, ForegroundColour, GrandParent, Handle, HelpText, Id, Label, LayoutDirection, MaxHeight, MaxSize, MaxWidth, MinHeight, MinSize, MinWidth, Name, Parent, Position, Rect, ScreenPosition, ScreenRect, Shown, Size, Sizer, ThemeEnabled, ToolTip, TopLevel, UpdateClientRect, UpdateRegion, Validator, VirtualSize, WindowStyle, WindowStyleFlag, WindowVariant

Inherited from wx._core.EvtHandler: EvtHandlerEnabled, NextHandler, PreviousHandler

Inherited from wx._core.Object: ClassName

Inherited from object: __class__


Method Details [hide private]

__init__(self, parent=None, id=-1, title="", message="", style=wx.PD_APP_MODAL | wx.PD_AUTO_HIDE)
(Constructor)

source code 
Default class constructor.
Overrides: wx._windows.Dialog.__init__

CreateLabel(self, text, sizer)

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

UpdatePulse(self, newmsg="")

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

GetFirstGradientColour(self)

source code 
Returns the gauge first gradient colour.

SetFirstGradientColour(self, colour)

source code 
Sets the gauge first gradient colour.

GetSecondGradientColour(self)

source code 
Returns the gauge second gradient colour.

SetSecondGradientColour(self, colour)

source code 
Sets the gauge second gradient colour.

GetGaugeBackground(self)

source code 
Returns the gauge background colour.

SetGaugeBackground(self, colour)

source code 
Sets the gauge background colour.

SetGaugeSteps(self, steps)

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

GetGaugeSteps(self)

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

GetGaugeProportion(self)

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

SetGaugeProportion(self, proportion)

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

ShowDialog(self, show=True)

source code 
Show the dialog.

OnCancel(self, event)

source code 
Handles the wx.EVT_BUTTON event for the Cancel button.

OnDestroy(self, event)

source code 
Handles the wx.EVT_WINDOW_DESTROY event for PyProgress.

OnClose(self, event)

source code 
Handles the wx.EVT_CLOSE event for PyProgress.

ReenableOtherWindows(self)

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

SetTimeLabel(self, val, label=None)

source code 
Sets the elapsed time label.

EnableAbort(self, enable=True)

source code 
Enables or disables the Cancel button.

EnableClose(self, enable=True)

source code 
Enables or disables the Close button.

DisableAbort(self)

source code 
Disables the Cancel button.