Pygame Button Widget
A button widget for pygame display surfaces. Sends a message when clicked.
Uses the Pygame Display service.
Three buttons that output messages to the console:
button1 = Button(caption="Press SPACE or click",key=K_SPACE).activate() button2 = Button(caption="Reverse colours",fgcolour=(255,255,255),bgcolour=(0,0,0)).activate() button3 = Button(caption="Mary...",msg="Mary had a little lamb", position=(200,100)).activate() ce = ConsoleEchoer().activate() button1.link( (button1,"outbox"), (ce,"inbox") ) button2.link( (button2,"outbox"), (ce,"inbox") ) button3.link( (button3,"outbox"), (ce,"inbox") )
The component requests a display surface from the Pygame Display service component. This is used as the surface of the button. It also binds event listeners to the service, as appropriate.
Arguments to the constructor configure the appearance and behaviour of the button component:
If a producerFinished or shutdownMicroprocess message is received on its "control" inbox. It is passed on out of its "signal" outbox and the component terminates.
Upon termination, this component does not unbind itself from the Pygame Display service. It does not deregister event handlers and does not relinquish the display surface it requested.
Button(...) -> new Button component.
Create a button widget in pygame, using the Pygame Display service. Sends a message out of its outbox when clicked.
Keyword arguments (all optional):
Methods defined here
__init__(self[, caption][, position][, margin][, bgcolour][, fgcolour][, msg][, key][, transparent][, size])
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Clears the background and renders the text label onto the button surface.
Pre-render the text to go on the button label.
Generator. yields 1 until data ready on the named inbox.
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
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.