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

Class KEYDOWN_Event

object --+            
         |            
    Sprite --+        
             |        
         Event --+    
                 |    
         KEY_Event --+
                     |
                    KEYDOWN_Event


Method Summary
  __init__(self, key, callback, **kwargs)
Initialize a KEYDOWN event.
    Inherited from KEY_Event
  call(self, pygame_event, **kwargs)
Perform the callback, if the event is enabled, and the key pressed is the right key.
  check_holding(self, ev, **kwargs)
  press(self, ev, **kwargs)
  release(self, ev, **kwargs)
    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, key=None, callback=None, **kwargs)
(Constructor)

Initialize a KEYDOWN event.

The KEYDOWN is generated when the key is first pressed. Any key can generate a KEYDOWN event, it has nothing in particular to do with the up and down arrows on the keyboard.
Parameters:
key - The keyboard key which will trigger this event, or a sequence of keys. (ie: Pressing any one of these keys will trigger the event) If key is None then any keypress will fire the callback.
callback - Function or method to call when the event occurs.
kwargs - Additional parameters that should be passed on to the callback.
Overrides:
pygsear.Event.KEY_Event.__init__

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