Quick search

Table Of Contents

CheckBox

New in version 1.4.0.

_images/checkbox.png

CheckBox is a specific two-state button that can be either checked or unchecked. If the CheckBox is in a Group, it becomes a Radio button. As with the ToggleButton, only one Radio button at a time can be selected when the CheckBox.group is set.

An example usage:

from kivy.uix.checkbox import CheckBox

# ...

def on_checkbox_active(checkbox, value):
    if value:
        print 'The checkbox', checkbox, 'is active'
    else:
        print 'The checkbox', checkbox, 'is inactive'

checkbox = CheckBox()
checkbox.bind(active=on_checkbox_active)
class kivy.uix.checkbox.CheckBox(**kwargs)

Bases: kivy.uix.widget.Widget

CheckXox class, see module documentation for more information.

active

Indicates if the switch is active or inactive.

active is a BooleanProperty, default to False.

group

Group of the checkbox. If None, no group will be used (the checkbox is independent). If specified, group must be a hashable object, like a string. Only one checkbox in a group can be active.

group is a ObjectProperty