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

Class MOUSEBUTTONDOWN_Event

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


Method Summary
  __init__(self, button, callback, **kwargs)
Initialize a MOUSEBUTTONDOWN event.
a new object with type S, a subtype of T __new__(S, ...)
  __repr__(self)
(inherited from Sprite)
  add(self, group)
Add this Event to an EventGroup. (inherited from Event)
  add_internal(self, group)
(inherited from Sprite)
  alive(self)
alive() -> bool ask the life of a sprite (inherited from Sprite)
  call(self, pygame_event, **kwargs)
Perform the callback, if the event is enabled, and the mouse button pressed is the correct button. (inherited from MOUSEBUTTON_Event)
  disable(self)
Do not allow callbacks to go through. (inherited from Event)
  enable(self)
Allow callbacks to go through. (inherited from Event)
  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)
  nop(self, ev, **kwargs)
Do nothing. (inherited from Event)
  remove(self, group)
remove(group) remove a sprite from container (inherited from Sprite)
  remove_internal(self, group)
(inherited from Sprite)
  update(self, *args)
(inherited from Sprite)

Method Details

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

Initialize a MOUSEBUTTONDOWN event.

The MOUSEBUTTONDOWN event is generated when the mouse button is first pressed.
Parameters:
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) If button is None it is assumed that the left mouse button (button 1) is the intended button.
callback - Function or method to call when the event occurs.
kwargs - Additional parameters that should be passed on to the callback.

__new__(S, ...)

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

Generated by Epydoc 1.1 on Sun Nov 30 19:33:11 2003 http://epydoc.sf.net