Package pygsear :: Module Widget :: Class SpriteButton
[show private | hide private]
[frames | no frames]

Class SpriteButton

    Widget --+    
             |    
        Button --+
                 |
object --+       |
         |       |
    Sprite --+   |
             |   |
      Drawable --+
                 |
                SpriteButton

Known Subclasses:
StationaryButton, ImageButton, SpriteTextButton

Clickable button which is also a sprite.
Method Summary
  __init__(self, sprite, callback, group)
Initialize the button.
a new object with type S, a subtype of T __new__(S, ...)
  __repr__(self)
(inherited from Sprite)
  activate(self)
(inherited from Widget)
  add(self, group)
add(group) add a sprite to container (inherited from Sprite)
  add_internal(self, group)
(inherited from Sprite)
  alive(self)
alive() -> bool ask the life of a sprite (inherited from Sprite)
  arm(self)
(inherited from Button)
bool can_see(self, target, blocking_rects_list)
Performs a los (line of sight) check from the center of the source to the center of the target. (inherited from Drawable)
  center(self, x, y, dx, dy)
Align the Drawable in its layer (inherited from Drawable)
  clear(self, surface)
Erase sprite to background (inherited from Drawable)
  clicked(self, pygameEvent)
(inherited from Button)
bool collide(self, other)
return True if this sprite and other sprite overlap. (inherited from Drawable)
Drawable or False collidelist(self, lothers)
return True if this sprite and any in list of others collide. (inherited from Drawable)
List collidelistall(self, lothers)
return True if this sprite and any in list of others collide. (inherited from Drawable)
  deactivate(self)
(inherited from Widget)
  direction(self, point)
return the direction from the sprite to a point (inherited from Drawable)
  distance(self, point)
return the distance from the sprite to a point (inherited from Drawable)
  draw(self, surface)
Blit image to layer (inherited from Drawable)
  fire(self, pygameEvent)
(inherited from Button)
  get_position(self)
return a copy of the sprite's position (inherited from Drawable)
  get_size(self)
return size of sprite's rect. (inherited from Drawable)
  groups(self)
groups() -> list list used sprite containers (inherited from Sprite)
  kill(self)
kill() end life of sprite, remove from all groups (inherited from Sprite)
  modal(self)
  move(self)
set position to next position on path (inherited from Drawable)
  nop(self, arg)
(inherited from Widget)
  nudge(self, dx, dy)
Move sprite. (inherited from Drawable)
  onscreen(self, slack, **kw)
return True if image is on the screen or layer. (inherited from Drawable)
  pause(self)
stop moving along Path (inherited from Drawable)
  released(self, pygameEvent)
(inherited from Button)
  remove(self, group)
remove(group) remove a sprite from container (inherited from Sprite)
  remove_internal(self, group)
(inherited from Sprite)
  runPath(self, frames)
call move() continuously (inherited from Drawable)
  set_callback(self, callback)
(inherited from Widget)
  set_crect(self, crect)
set the collision pygame.Rectused for collision checking. (inherited from Drawable)
  set_path(self, path)
set which path to follow (inherited from Drawable)
  set_position(self, location, *args)
Move sprite to location. (inherited from Drawable)
  set_positionRandom(self, slack)
Move sprite to a random location on screen (inherited from Drawable)
  set_size(self, size)
Set size of sprite's rect. (inherited from Drawable)
  solid(self, other, move_both)
move sprite so that it does not overlap with other sprite (inherited from Drawable)
  stretch(self, dx, dy, size, keepAspectRatio)
Change the size of sprite's image, and rect. (inherited from Drawable)
  uclear(self, surface)
clear sprite and update display (inherited from Drawable)
  udraw(self, surface)
Draw image and update display. (inherited from Drawable)
  unpause(self)
start moving along Path (inherited from Drawable)
  update(self, *args)
(inherited from Sprite)

Method Details

__init__(self, sprite, callback=None, group=None)
(Constructor)

Initialize the button.
Parameters:
sprite - Clickable sprite.
callback - Function to call when sprite is clicked.
group - Other EventGroup to put this widget's events in to also.

__new__(S, ...)

Returns:
a new object with type S, a subtype of T

Generated by Epydoc 1.1 on Sun Jan 25 19:10:10 2004 http://epydoc.sf.net