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.

Inheritance Diagram

Inheritance diagram for class Throbber

Known Superclasses

PyPanel

Methods Summary

__init__
Decrement	Display previous image in sequence
DoGetBestSize
Draw
Increment	Display next image in sequence
Next	Display next image in sequence according to direction
OnDestroyWindow
OnPaint
OnTimer
Previous	Display previous image in sequence according to direction
Rest	Stop the animation and return to frame 0
Reverse	Change the direction of the animation
Running	Returns True if the animation is running
SetCurrent	Set current image
SetFont	Set the font for the label
SetFrameDelay	Delay between each frame
SetLabel	Change the text of the label
SetRest	Set rest image
SetSequence	Order to display images
Start	Start the animation
Stop	Stop the animation
ToggleLabel	Toggle the label
ToggleOverlay	Toggle the overlay image
Update
Wrap

Class API

---

class Throbber(PyPanel)

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.

Methods

---

__init__(self, parent, id, bitmap, pos = DefaultPosition, size = DefaultSize, frameDelay = 0.1, frames = 0, frameWidth = 0, label = None, overlay = None, reverse = 0, style = 0, name = "throbber", rest = 0, current = 0, direction = 1, sequence = None)

---

Decrement(self)

Display previous image in sequence

---

DoGetBestSize(self)

---

Draw(self, dc)

---

Increment(self)

Display next image in sequence

---

Next(self)

Display next image in sequence according to direction

---

OnDestroyWindow(self, event)

---

OnPaint(self, event)

---

OnTimer(self, event)

---

Previous(self)

Display previous image in sequence according to direction

---

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

---

SetCurrent(self, current)

Set current image

---

SetFont(self, font)

Set the font for the label

---

SetFrameDelay(self, frameDelay = 0.05)

Delay between each frame

---

SetLabel(self, label)

Change the text of the label

---

SetRest(self, rest)

Set rest image

---

SetSequence(self, sequence = None)

Order to display images

---

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

---

Update(self, event)

---

Wrap(self)