Web Analytics Made Easy - Statcounter
Skip to content


Checkbox Element - Displays a checkbox and text next to it

    default = False,
    size = (None, None),
    auto_size_text = None,
    font = None,
    background_color = None,
    text_color = None,
    change_submits = False,
    enable_events = False,
    disabled = False,
    key = None,
    pad = None,
    tooltip = None,
    visible = True,
    size_px = (None, None)

Parameter Descriptions

Name Type Default Description
auto_size_text bool None if True will size the element to match the length of the text
background_color str None color of background. Can be in #RRGGBB format or a color name "black"
change_submits bool False DO NOT USE. Only listed for backwards compat - Use enable_events instead
default bool False Set to True if you want this checkbox initially checked
disabled bool False set disable state
enable_events bool False Turns on the element specific events. Checkbox events happen when an item changes
font (str or (str, int[, str]) or None) None specifies the font family, size, etc. Tuple or Single string format 'name size styles'. Styles: italic * roman bold normal underline overstrike
key str or int or tuple or object None Used with window.find_element and with return values to uniquely identify this element
pad (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) or int None Amount of padding to put around element in pixels (left/right, top/bottom) or ((left, right), (top, bottom)) or an int. If an int, then it's converted into a tuple (int, int)
size (int, int) or (None, None) (None, None) (w, h) w=characters-wide, h=rows-high
size_px (int, int) or (None, None) (None, None) w=pixels-wide, h=pixels-high
text str Text to display next to checkbox
text_color str None element's text color. Can be in #RRGGBB format or a color name "black"
tooltip str None text, that will appear when mouse hovers over the element
visible bool True set visibility state of the element

Class Properties

This class has no public properties

Class Methods

 def get
 def update


Return the current state of this checkbox


Parameter Descriptions

Name Type Default Description
RETURN bool Current state of checkbox


Changes some of the settings for the Checkbox Element. Must call Window.Read or Window.Finalize prior.

Changes will not be visible in your window until you call window.read or window.refresh.

    value = None,
    disabled = None

Parameter Descriptions

Name Type Default Description
disabled bool None disable or enable element
value bool None if True checks the checkbox, False clears it