p.g.l.LMROptionList(planes.gui.OptionList) : class documentation

Part of planes.gui.lmr View In Hierarchy

A planes.gui.OptionList with LMROption elements.

Options are LMROption subplanes of OptionList, named option0, option1,
..., optionN

Please note that it is not possible to confirm a selection here. Use a
wrapper like OptionSelector to accomplish that.

Additional attributes:

LMROptionList.highlighted_background
    A Pygame Surface, holding the background for the highlighted
    LMROption subplane.

LMROptionList.selected
    The selected Option
Method __init__ Initialise the OptionList.

Inherited from Container (via OptionList):

Method redraw Redraw Container.image from the dimensions in Containter.rect. This also creates a new Container.rendersurface.
Method sub Resize the container, update the position of plane and add it as a subplane.
Method remove Remove the subplane, then reposition remaining subplanes and resize the container.
Method remove_all Remove all subplanes and shrink accordingly.

Inherited from Plane (via OptionList, Container):

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 update No summary
Method clicked Called when there is a MOUSEDOWN event on this plane. If click callbacks are set, the appropriate one is called with this Plane as argument.
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, name, option_list, width, option_style=GREY_OPTION_STYLE, highlight_style=ORANGE_OPTION_STYLE):
Initialise the OptionList.

option_list is a list of strings to be displayed as options.

width is the total widget width in pixels.

option_style is an optional instance of LMRStyle to be used for the
LMROption subplanes. If it is omitted, GREY_OPTION_STYLE will be
used.

highlight_style is an optional instance of LMRStyle to be used for
the highlighted LMROption subplane. If it is omitted,
ORANGE_OPTION_STYLE will be used.
API Documentation for planes, generated by pydoctor at 2013-03-05 14:16:20.