Kamaelia docs : Kamaelia.UI.OpenGL.Button.Button

Kamaelia.UI.OpenGL.Button.Button

For examples and more explanations, see the module level docs.


class Button(Kamaelia.UI.OpenGL.OpenGLComponent.OpenGLComponent)

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

A button widget for the OpenGL display service. Sends a message when clicked or an assigned key is pressed.

Keyword arguments:

  • caption -- Button caption (default="Button")
  • bgcolour -- Colour of surfaces behind caption (default=(244,244,244))
  • fgcolour -- Colour of the caption text (default=(0,0,0)
  • sidecolour -- Colour of side planes (default=(200,200,244))
  • margin -- Margin size in pixels (default=8)
  • key -- Key to activate button (default=None)
  • fontsize -- Font size for caption text (default=50)
  • pixelscaling -- Factor to convert pixels to units in 3d, ignored if size is specified (default=100)
  • thickness -- Thickness of button widget, ignored if size is specified (default=0.3)
  • msg -- Message which gets sent when button is activated (default="CLICK")

Methods defined here

__init__(self, **argd)

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

activationMovement(self)

Rotate button stepwise by 360 degrees when it has been activated.

buildCaption(self)

Pre-render the text to go on the label.

draw(self)

Draw button cuboid.

frame(self)

Rotate button if it has been activated.

handleEvents(self)

Handle events.

setup(self)

Build caption and request reception of events.

Methods inherited from Kamaelia.UI.OpenGL.OpenGLComponent.OpenGLComponent :

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: