p.g.l.LMRButton(LMRWidget, planes.gui.Button) : class documentation

Part of planes.gui.lmr View In Hierarchy

A planes.gui.Button with LMR background.
    
Method __init__ Initialise the Button.
Method redraw Conditionally redraw the Button.

Inherited from Button:

Method update Change color if clicked, then call the base class method.
Method clicked Plane standard method, called when there is a MOUSEDOWN event on this plane. Changes the Button color for some frames and calls the base class implementation.

Inherited from Plane (via Button, Label):

Method sub Remove the Plane given from its current parent and add it as a subplane of this Plane.
Method remove Remove subplane by name or Plane instance.
Method remove_all Convenience method to call Plane.remove() for all subplanes.
Method __getattr__ Access subplanes as attributes.
Method render Draw a composite surface of this plane and all subplanes, in order of their addition.
Method get_plane_at Return the (sub)plane and the succeeding parent coordinates at the given coordinates. Subplanes are tested in reverse order of their addition (i.e. latest first).
Method dropped_upon If a plane is dropped on top of this one, call dropped_upon_callback() and conditionally grab it.
Method destroy Remove this Plane from the parent plane, remove all subplanes and delete all pygame Surfaces.
Method sync Save the Plane given as master Plane and the position offset to that Plane for position synchronisation in Plane.update().
Method unsync Remove the position synchronisation to the sync master Plane.
Method mouseover_callback Callback function when the mouse cursor moves over this plane. The default implementation sets Plan.mouseover to True when Plane.highlight is set.
Method mouseout_callback Callback function when the mouse cursor has left this plane. The default implementation sets Plan.mouseover to False.
Method __repr__ Readable string representation.
def __init__(self, label, width, callback, style=GREY_BUTTON_STYLE):
Initialise the Button.

label is the Text to be written on the button.

callback is the function to be called with callback(Button) when the
Button is clicked with the left mouse button.

style is an instance of LMRStyle. If omitted, GREY_BUTTON_STYLE will be
used.
def redraw(self):
Conditionally redraw the Button.
        
API Documentation for planes, generated by pydoctor at 2013-03-05 14:16:20.