Kamaelia docs : Kamaelia.UI.Pygame.KeyEvent.KeyEvent

Kamaelia.UI.Pygame.KeyEvent.KeyEvent

For examples and more explanations, see the module level docs.


class KeyEvent(Axon.Component.component)

KeyEvent([allkeys][,key_events][,outboxes]) -> new KeyEvent component.

Component that sends out messages in response to pygame keypress events.

Keyword arguments:

  • allkeys -- if True, all keystrokes send messages out of "allkeys" outbox (default=False)
  • key_events -- dict mapping pygame keycodes to (msg,"outboxname") pairs (default=None)
  • outboxes -- dict of "outboxname":"description" key:value pairs (default={})

Inboxes

  • control : Shutdown messages: shutdownMicroprocess or producerFinished
  • callback : Receive callbacks from Pygame Display
  • inbox : Receive events from Pygame Display

Outboxes

  • outbox : NOT USED
  • signal : Shutdown signalling: shutdownMicroprocess or producerFinished
  • allkeys : Outbox that receives *every* keystroke if enabled
  • display_signal : Outbox used for communicating to the display surface

Methods defined here

__init__(self[, allkeys][, key_events][, key_up_events][, outboxes])

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

main(self)

Main loop.

waitBox(self, boxname)

Generator. yields 1 until data is ready on the named inbox.

Feedback

Got a problem with the documentation? Something unclear that could be clearer? Want to help improve it? Constructive criticism is very welcome - especially if you can suggest a better rewording!

Please leave you feedback here in reply to the documentation thread in the Kamaelia blog.

-- Automatic documentation generator, 19 Oct 2008 at 14:29:09 UTC/GMT

This is a page from the Kamaelia website. You can find the original here: