Package pygsear :: Module Event :: Class MOUSEBUTTON_Event
[show private | hide private]
[frames | no frames]

Class MOUSEBUTTON_Event

object --+        
         |        
    Sprite --+    
             |    
         Event --+
                 |
                MOUSEBUTTON_Event

Known Subclasses:
MOUSEBUTTONDOWN_Event, MOUSEBUTTONUP_Event

Mouse button events.
Method Summary
  __init__(self, type, button, callback, **kwargs)
Initialize a mouse Event
  call(self, pygame_event, **kwargs)
Perform the callback, if the event is enabled, and the mouse button pressed is the correct button.
    Inherited from Event
  add(self, group)
Add this Event to an EventGroup.
  disable(self)
Do not allow callbacks to go through.
  enable(self)
Allow callbacks to go through.
  nop(self, ev, **kwargs)
Do nothing.
    Inherited from Sprite
  __repr__(self)
  add_internal(self, group)
  alive(self)
alive() -> bool check to see if the sprite is in any groups
  groups(self)
groups() -> list of groups list used sprite containers
  kill(self)
kill() remove this sprite from all groups
  remove(self, *groups)
remove(group or list of groups, ...) remove a sprite from container
  remove_internal(self, group)
  update(self, *args)
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)
    Inherited from type
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T

Method Details

__init__(self, type, button, callback=None, **kwargs)
(Constructor)

Initialize a mouse Event
Parameters:
type - pygame.event type. Should be MOUSEBUTTONDOWN or MOUSEBUTTONUP
button - The mouse button which will trigger this event, or a sequence of buttons. (ie: Pressing any one of these buttons will trigger the event)
callback - Function or method to call when the event occurs.
kwargs - Additional parameters that should be passed on to the callback.
Overrides:
pygsear.Event.Event.__init__

call(self, pygame_event, **kwargs)

Perform the callback, if the event is enabled, and the mouse button pressed is the correct button.
Parameters:
pygame_event - The actual pygame.event.Event that triggered this Event.
kwargs - Additional parameters that should be passed on to the callback. Note that keyword args included here will overwrite those added at the creation of the event.
Overrides:
pygsear.Event.Event.call

Generated by Epydoc 2.0 on Sat Dec 9 14:11:18 2006 http://epydoc.sf.net