p.g.t.TMBContainer(planes.gui.Container) : class documentation

Part of planes.gui.tmb View In Hierarchy

Known subclasses: planes.gui.tmb.TMBFadingContainer, planes.gui.tmb.TMBGetStringDialog, planes.gui.tmb.TMBOkBox, planes.gui.tmb.TMBOptionSelector

A planes.gui.Container with fixed width and TMB background.

Additional attributes:

TMBContainer.style
    An instance of TMBStyle.

TMBContainer.background
    A Pygame Surface, holding the rendered background.
    Initially None, repainted in TMBContainer.sub().
Method __init__ Initialise.
Method sub Resize the container, update the position of plane and add it as a subplane. This will also repaint TMBContainer.background.
Method redraw Redraw TMBContainer.image using TMBContainer.background. This also creates a new TMBContainer.rendersurface.
Method remove Remove the subplane, then reposition remaining subplanes and resize the container.

Inherited from Container:

Method remove_all Remove all subplanes and shrink accordingly.

Inherited from Plane (via 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, style, padding=0):
Initialise.

style is an instance of TMBStyle.
def sub(self, plane):
Resize the container, update the position of plane and add it as a subplane.
This will also repaint TMBContainer.background.
def redraw(self):
Redraw TMBContainer.image using TMBContainer.background.
This also creates a new TMBContainer.rendersurface.
def remove(self, plane_identifier):
Remove the subplane, then reposition remaining subplanes and resize the container.
        
API Documentation for planes, generated by pydoctor at 2013-03-05 14:16:20.