p.gui : package documentation

Part of planes

planes Graphical User Interface Module

Copyright 2010-2013 by Florian Berger <fberger@florian-berger.de>

Global variables:

BACKGROUND_COLOR
    Defaults to (150, 150, 150).

HIGHLIGHT_COLOR
    Defaults to (191, 95, 0).

FONTS
    An instance of Fonts, a font manager.
Module lmr lmr - planes.gui widgets with left-mid-right backgrounds.
Module tmb tmb - planes.gui widgets with top-mid-bottom backgrounds.

From the __init__.py module:

Class Button A planes plane which displays a text and reacts on mouse clicks.
Class Container A Container for Planes. If a subplane is added via sub(), the container places it below any existing subplanes and resizes itself to fit the width and height of the subplanes.
Class FadingContainer A Container that, once visible, will fade out and destroy itself.
Class Fonts A font manager.
Class GetStringDialog A combination of Container, Label, TextBox and Button that asks the user for a string.
Class Label A planes.Plane which displays a text.
Class OkBox A box which displays a message and an OK button. It is destroyed when OK is clicked. The message will be wrapped at newline characters.
Class Option A subclass of Label which handles mouseclicks, to be used in an OptionList.
Class OptionList A list of options to select from.
Class OptionSelector An OptionSelector wraps an OptionList and an OK button, calling a callback when a selection is confirmed.
Class OutlinedText A Label with outlined text and a transparent background.
Class PlusMinusBox This class implements a TextBox with plus and minus buttons attached, to change a numerical value. The value is accessible as PlusMinusBox.textbox.text
Class ProgressBar A horizontal progress bar, filling from left to right. Additional attributes:
Class ScrollingPlane This class implements a fixed-dimension plane with a scroll bar to scroll its content plane. Subplane structure:
Class TextBox A box where the user can type text.
Function draw_border Draw a border around plane.
def draw_border(plane, color):
Draw a border around plane.
    
API Documentation for planes, generated by pydoctor at 2013-03-05 14:16:20.