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

Warning!

You should be using the inbox/outbox interface, not these methods (except construction). This documentation is designed as a roadmap as to their functionalilty for maintainers and new component developers.

__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, 05 Jun 2009 at 03:01:38 UTC/GMT


Kamaelia is an open source project originated from and guided by BBC Research. For more information browse the site or get in contact.

This is an ongoing community based development site. As a result the contents of this page is the opinions of the contributors of the pages involved not the organisations involved. Specificially, this page may contain personal views which are not the views of the BBC. (the site is powered by a wiki engine)

(C) Copyright 2008 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved.

This web site is powered by the same code created for the bicker manor project. For more details, contact Michael Sparks at BBC Research directly (cf contact)