Class reference
CheckBox
Inherits Button
A button that represents a binary choice.
Description
CheckBox allows the user to choose one of only two possible options. It's similar to CheckButton in functionality, but it has a different appearance. To follow established UX patterns, it's recommended to use CheckBox when toggling it has no immediate effect on something. For example, it could be used when toggling it will only do something once a confirmation button is pressed. See also BaseButton which contains common properties and methods associated with this node. When BaseButton.button_group specifies a ButtonGroup, CheckBox changes its appearance to that of a radio button and uses the various radio_* theme properties.
Properties
Theme properties
Color checkbox_checked_color = Color(1, 1, 1, 1)
Color checkbox_checked_color = Color(1, 1, 1, 1)The color of the checked icon when the checkbox is pressed.
Color checkbox_unchecked_color = Color(1, 1, 1, 1)
Color checkbox_unchecked_color = Color(1, 1, 1, 1)The color of the unchecked icon when the checkbox is not pressed.
int check_v_offset = 0
int check_v_offset = 0The vertical offset used when rendering the check icons (in pixels).
Texture2D checked
Texture2D checkedThe check icon to display when the CheckBox is checked.
Texture2D checked_disabled
Texture2D checked_disabledThe check icon to display when the CheckBox is checked and is disabled.
Texture2D radio_checked
Texture2D radio_checkedThe check icon to display when the CheckBox is configured as a radio button and is checked.
Texture2D radio_checked_disabled
Texture2D radio_checked_disabledThe check icon to display when the CheckBox is configured as a radio button, is disabled, and is unchecked.
Texture2D radio_unchecked
Texture2D radio_uncheckedThe check icon to display when the CheckBox is configured as a radio button and is unchecked.
Texture2D radio_unchecked_disabled
Texture2D radio_unchecked_disabledThe check icon to display when the CheckBox is configured as a radio button, is disabled, and is unchecked.
Texture2D unchecked
Texture2D uncheckedThe check icon to display when the CheckBox is unchecked.
Texture2D unchecked_disabled
Texture2D unchecked_disabledThe check icon to display when the CheckBox is unchecked and is disabled.