wx.lib.throbber.Throbber

Package wx :: Package lib :: Module throbber :: Class Throbber

Type Throbber

object --+                    
         |                    
    Object --+                
             |                
    EvtHandler --+            
                 |            
            Window --+        
                     |        
                 Panel --+    
                         |    
                   PyPanel --+
                             |
                            Throbber

The first argument is either the name of a file that will be split into frames (a composite image) or a list of strings of image names that will be treated as individual frames. If a single (composite) image is given, then additional information must be provided: the number of frames in the image and the width of each frame. The first frame is treated as the "at rest" frame (it is not shown during animation, but only when Throbber.Rest() is called. A second, single image may be optionally specified to overlay on top of the animation. A label may also be specified to show on top of the animation.

Method Summary
	`__init__(self, parent, id, bitmap, pos, size, frameDelay, frames, frameWidth, label, overlay, reverse, style, name)`
	`DoGetBestSize(self)`
	`Draw(self, dc)`
	`OnDestroyWindow(self, event)`
	`OnPaint(self, event)`
	`OnTimer(self, event)`
	`Rest(self)` Stop the animation and return to frame 0
	`Reverse(self)` Change the direction of the animation
	`Rotate(self, event)`
	`Running(self)` Returns True if the animation is running
	`SetFont(self, font)` Set the font for the label
	`SetFrameDelay(self, frameDelay)` Delay between each frame
	`SetLabel(self, label)` Change the text of the label
	`Start(self)` Start the animation
	`Stop(self)` Stop the animation
	`ToggleLabel(self, state)` Toggle the label
	`ToggleOverlay(self, state)` Toggle the overlay image

Instance Method Details

Rest(self)

Stop the animation and return to frame 0

Reverse(self)

Change the direction of the animation

Running(self)

Returns True if the animation is running

SetFont(self, font)

Set the font for the label

Overrides:: wx.Window.SetFont

SetFrameDelay(self, frameDelay=0.050000000000000003)

Delay between each frame

SetLabel(self, label)

Change the text of the label

Overrides:: wx.Window.SetLabel

Start(self)

Start the animation

Stop(self)

Stop the animation

ToggleLabel(self, state=None)

Toggle the label

ToggleOverlay(self, state=None)

Toggle the overlay image

Generated by Epydoc 2.1.20040428.rpd on Tue Nov 9 17:04:41 2004

http://epydoc.sf.net