Background

CactusGUI element for painting the background for a state. Usually has the lowest z-order.

Example Code:


gui.makeBackground('myBackground')
gui['myBackground'].style(owner='main', color=(255,255,255), z_order=-200)

Attributes:

Background - Specific Type Attributes:
Attribute Datatype Comments
color color Color to paint the background with. (R,G,B) Might be renamed to "background-color" instead later to avoid name confusion.
GUI Primary Attributes:
Attribute Datatype Comments
name string Identifies the element inside the GUI
owner string Name of the element that "owns" the current element
type string The specific kind of element - ex: Textbox, Button, Image, State, etc.
z_order int Determines the layering order of the element when GUI elements with the same owner are rendered. The element with the highest z-order is layered on top. Can use both positive and negative numbers.
visible bool If visible is True then the element is displayed, if False then the element will not display. Child-elements that the element owns will still be rendered. Defaults to True.
show bool If False then the element's child-elements will not be rendered to the screen. Defaults to True.
use_hover bool Defaults to True for some elements. Tells the GUI's listener object to listen for events from the current element:
onHover, onUnhover
use_click bool Defaults to True for some elements. Tells the GUI's listener object to listen for events from the current element:
onMousedown, onRightMousedown, onAnyMousedown, onMouseup, onRightMouseup, onAnyMouseup, onClick, onRightClick, onAnyClick, onBlur, onDeactivate

onActivate requires both use_click and use_active
onFocus requires both use_click and use_focus
use_scroll bool Defaults to True for some elements. Tells the GUI's listener object to listen for events from the current element:
onCenterMousedown, onCenterMouseup, onScrollUp, onScrollDown
use_active bool Defaults to True for some elements.
onActivate requires both use_click and use_active
use_focus bool Defaults to True for some elements.
onFocus requires both use_click and use_focus