Kamaelia.UI.Pygame.Button.Button

class Button(Axon.Component.component)

Button(...) -> new Button component.

Create a button widget in pygame, using the PygameDisplay service. Sends a message out of its outbox when clicked.

Keyword arguments (all optional): - caption -- text (default="Button <component id>") - position -- (x,y) position of top left corner in pixels - margin -- pixels margin between caption and button edge (default=8) - bgcolour -- (r,g,b) fill colour (default=(224,224,224)) - fgcolour -- (r,g,b) text colour (default=(0,0,0)) - msg -- sent when clicked (default=("CLICK",self.id)) - key -- if not None, pygame keycode to trigger click (default=None) - transparent -- draw background transparent if True (default=False)

Inboxes

control : For shutdown messages
callback : Receive callbacks from PygameDisplay
inbox : Receive events from PygameDisplay

Outboxes

outbox : button click events emitted here
signal : For shutdown messages
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, caption, position, margin, bgcolour, fgcolour, msg, key, transparent)

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

blitToSurface(self)

Clears the background and renders the text label onto the button surface.

buildCaption(self, text)

Pre-render the text to go on the button label.

main(self)

Main loop.

waitBox(self, boxname)

Generator. yields 1 until data 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.