Kamaelia docs : Kamaelia.UI.Pygame.Multiclick.Multiclick
For examples and more explanations, see the module level docs.
Multiclick(...) -> new Multiclick 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):
- 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)) of msgs is not specified
- msgs -- list of messages. msgs[x] is sent when button X is clicked (default=None)
- transparent -- draw background transparent if True (default=False)
- size -- (width,height) pixels size of the button (default=scaled to fit caption)
- control : Shutdown messages: shutdownMicroprocess or producerFinished
- callback : Receive callbacks from Pygame Display
- inbox : Receive events from Pygame Display
- outbox : button click events emitted here
- signal : Shutdown signalling: shutdownMicroprocess or producerFinished
- display_signal : For sending signals to the Pygame Display
Methods defined here
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.
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: