p.g.OutlinedText(Label) : class documentation

Part of planes.gui View In Hierarchy

A Label with outlined text and a transparent background.

Additional attributes:

OutlinedText.text_color
   A tuple (R, G, B) holding the color of the text.

Method	__init__	`Initialise the OutlinedText. text is the text to be written on the Label. If text is None, it is replaced by an empty string.`
Method	redraw	`Redraw the Label if necessary. The new Label will have the same rect center as the old Label.`

Inherited from Label:

Method update Renew the text on the label, then call the base class method.

Inherited from Plane (via 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	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, text, text_color=(255, 255, 255), font=None):

overrides planes.gui.Label.__init__

Initialise the OutlinedText.
text is the text to be written on the Label. If text is None, it is
replaced by an empty string.

def redraw(self):

overrides planes.gui.Label.redraw

Redraw the Label if necessary.
The new Label will have the same rect center as the old Label.

API Documentation for planes, generated by pydoctor at 2013-03-05 14:16:20.