Kamaelia.UI.Pygame.KeyEvent.KeyEvent

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 PygameDisplay
inbox : Receive events from PygameDisplay

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, 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, could be clearer? Want to help with improving? Constructive criticism, preferably in the form of suggested rewording is very welcome.

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

(C) 2006 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved, 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.