d9c9481f26
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_2_4_BRANCH@18377 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
259 lines
8.5 KiB
Python
259 lines
8.5 KiB
Python
"""
|
|
A throbber displays an animated image that can be
|
|
started, stopped, reversed, etc. Useful for showing
|
|
an ongoing process (like most web browsers use) or
|
|
simply for adding eye-candy to an application.
|
|
|
|
Throbbers run in a separate thread so normal application
|
|
processing can continue unencumbered.
|
|
"""
|
|
|
|
#
|
|
# throbber.py - Cliff Wells <clifford.wells@attbi.com>
|
|
#
|
|
# Thanks to Harald Massa <harald.massa@suedvers.de> for
|
|
# suggestions and sample code.
|
|
#
|
|
# $Id$
|
|
#
|
|
|
|
import threading, os
|
|
##os.putenv('LANG', 'C') # for running on GTK2
|
|
from wxPython.wx import *
|
|
|
|
# ------------------------------------------------------------------------------
|
|
|
|
wxEVT_UPDATE_THROBBER = wxNewEventType()
|
|
def EVT_UPDATE_THROBBER(win, func):
|
|
win.Connect(-1, -1, wxEVT_UPDATE_THROBBER, func)
|
|
|
|
class UpdateThrobberEvent(wxPyEvent):
|
|
def __init__(self):
|
|
wxPyEvent.__init__(self)
|
|
self.SetEventType(wxEVT_UPDATE_THROBBER)
|
|
|
|
# ------------------------------------------------------------------------------
|
|
|
|
class Throbber(wxPanel):
|
|
"""
|
|
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.
|
|
"""
|
|
def __init__(self, parent, id,
|
|
bitmap, # single (composite) bitmap or list of bitmaps
|
|
pos = wxDefaultPosition,
|
|
size = wxDefaultSize,
|
|
frameDelay = 0.1,# time between frames
|
|
frames = 0, # number of frames (only necessary for composite image)
|
|
frameWidth = 0, # width of each frame (only necessary for composite image)
|
|
label = None, # optional text to be displayed
|
|
overlay = None, # optional image to overlay on animation
|
|
reverse = 0, # reverse direction at end of animation
|
|
style = 0, # window style
|
|
name = "throbber"):
|
|
wxPanel.__init__(self, parent, id, pos, size, style, name)
|
|
self.name = name
|
|
self.label = label
|
|
_seqTypes = (type([]), type(()))
|
|
|
|
# set size, guessing if necessary
|
|
width, height = size
|
|
if width == -1:
|
|
if type(bitmap) in _seqTypes:
|
|
width = bitmap[0].GetWidth()
|
|
else:
|
|
if frameWidth:
|
|
width = frameWidth
|
|
if height == -1:
|
|
if type(bitmap) in _seqTypes:
|
|
height = bitmap[0].GetHeight()
|
|
else:
|
|
height = bitmap.GetHeight()
|
|
self.width, self.height = width, height
|
|
|
|
# double check it
|
|
assert width != -1 and height != -1, "Unable to guess size"
|
|
|
|
if label:
|
|
extentX, extentY = self.GetTextExtent(label)
|
|
self.labelX = (width - extentX)/2
|
|
self.labelY = (height - extentY)/2
|
|
self.frameDelay = frameDelay
|
|
self.current = 0
|
|
self.direction = 1
|
|
self.autoReverse = reverse
|
|
self.overlay = overlay
|
|
if overlay is not None:
|
|
self.overlay = overlay
|
|
self.overlayX = (width - self.overlay.GetWidth()) / 2
|
|
self.overlayY = (height - self.overlay.GetHeight()) / 2
|
|
self.showOverlay = overlay is not None
|
|
self.showLabel = label is not None
|
|
|
|
# do we have a sequence of images?
|
|
if type(bitmap) in _seqTypes:
|
|
self.submaps = bitmap
|
|
self.frames = len(self.submaps)
|
|
# or a composite image that needs to be split?
|
|
else:
|
|
self.frames = frames
|
|
self.submaps = []
|
|
for chunk in range(frames):
|
|
rect = (chunk * frameWidth, 0, width, height)
|
|
self.submaps.append(bitmap.GetSubBitmap(rect))
|
|
|
|
# self.sequence can be changed, but it's not recommended doing it
|
|
# while the throbber is running. self.sequence[0] should always
|
|
# refer to whatever frame is to be shown when 'resting' and be sure
|
|
# that no item in self.sequence >= self.frames or < 0!!!
|
|
self.sequence = range(self.frames)
|
|
|
|
self.SetClientSize((width, height))
|
|
|
|
EVT_PAINT(self, self.OnPaint)
|
|
EVT_UPDATE_THROBBER(self, self.Rotate)
|
|
EVT_WINDOW_DESTROY(self, self.OnDestroyWindow)
|
|
|
|
self.event = threading.Event()
|
|
self.event.set() # we start out in the "resting" state
|
|
|
|
|
|
def __del__(self):
|
|
# make sure it's stopped, since EVT_WINDOW_DESTROY may not be sent
|
|
# on all platforms
|
|
self.Stop()
|
|
|
|
|
|
def OnDestroyWindow(self, event):
|
|
# this is currently broken due to a bug in wxWindows... hopefully
|
|
# it'll be fixed soon. Meanwhile be sure to explicitly call Stop()
|
|
# before the throbber is destroyed.
|
|
self.Stop()
|
|
event.Skip()
|
|
|
|
|
|
def Draw(self, dc):
|
|
dc.DrawBitmap(self.submaps[self.sequence[self.current]], 0, 0, true)
|
|
if self.overlay and self.showOverlay:
|
|
dc.DrawBitmap(self.overlay, self.overlayX, self.overlayY, true)
|
|
if self.label and self.showLabel:
|
|
dc.DrawText(self.label, self.labelX, self.labelY)
|
|
dc.SetTextForeground(wxWHITE)
|
|
dc.DrawText(self.label, self.labelX-1, self.labelY-1)
|
|
|
|
|
|
def OnPaint(self, event):
|
|
self.Draw(wxPaintDC(self))
|
|
event.Skip()
|
|
|
|
|
|
def UpdateThread(self):
|
|
try:
|
|
while hasattr(self, 'event') and not self.event.isSet():
|
|
wxPostEvent(self, UpdateThrobberEvent())
|
|
self.event.wait(self.frameDelay)
|
|
except wxPyDeadObjectError: # BUG: we were destroyed
|
|
return
|
|
|
|
|
|
def Rotate(self, event):
|
|
if self.event.isSet():
|
|
return
|
|
self.current += self.direction
|
|
if self.current >= len(self.sequence):
|
|
if self.autoReverse:
|
|
self.Reverse()
|
|
self.current = len(self.sequence) - 1
|
|
else:
|
|
self.current = 1
|
|
if self.current < 1:
|
|
if self.autoReverse:
|
|
self.Reverse()
|
|
self.current = 1
|
|
else:
|
|
self.current = len(self.sequence) - 1
|
|
self.Draw(wxClientDC(self))
|
|
|
|
|
|
# --------- public methods ---------
|
|
def SetFont(self, font):
|
|
"""Set the font for the label"""
|
|
wxPanel.SetFont(self, font)
|
|
self.SetLabel(self.label)
|
|
self.Draw(wxClientDC(self))
|
|
|
|
|
|
def Rest(self):
|
|
"""Stop the animation and return to frame 0"""
|
|
self.Stop()
|
|
self.current = 0
|
|
self.Draw(wxClientDC(self))
|
|
|
|
|
|
def Reverse(self):
|
|
"""Change the direction of the animation"""
|
|
self.direction = -self.direction
|
|
|
|
|
|
def Running(self):
|
|
"""Returns true if the animation is running"""
|
|
return not self.event.isSet()
|
|
|
|
|
|
def Start(self):
|
|
"""Start the animation"""
|
|
if not self.Running():
|
|
self.event.clear()
|
|
thread = threading.Thread(target = self.UpdateThread,
|
|
name = "%s-thread" % self.name)
|
|
thread.start()
|
|
|
|
|
|
def Stop(self):
|
|
"""Stop the animation"""
|
|
self.event.set()
|
|
|
|
|
|
def SetFrameDelay(self, frameDelay = 0.05):
|
|
"""Delay between each frame"""
|
|
self.frameDelay = frameDelay
|
|
|
|
|
|
def ToggleOverlay(self, state = None):
|
|
"""Toggle the overlay image"""
|
|
if state is None:
|
|
self.showOverlay = not self.showOverlay
|
|
else:
|
|
self.showOverlay = state
|
|
self.Draw(wxClientDC(self))
|
|
|
|
|
|
def ToggleLabel(self, state = None):
|
|
"""Toggle the label"""
|
|
if state is None:
|
|
self.showLabel = not self.showLabel
|
|
else:
|
|
self.showLabel = state
|
|
self.Draw(wxClientDC(self))
|
|
|
|
|
|
def SetLabel(self, label):
|
|
"""Change the text of the label"""
|
|
self.label = label
|
|
if label:
|
|
extentX, extentY = self.GetTextExtent(label)
|
|
self.labelX = (self.width - extentX)/2
|
|
self.labelY = (self.height - extentY)/2
|
|
self.Draw(wxClientDC(self))
|
|
|
|
|
|
|
|
# ------------------------------------------------------------------------------
|
|
|