CheckBox¶
Inherits: Button < BaseButton < Control < CanvasItem < Node < Object
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¶
alignment |
|
|
toggle_mode |
|
Theme Properties¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Theme Property Descriptions¶
Color font_color = Color(0.875, 0.875, 0.875, 1)
The CheckBox text's font color.
Color font_disabled_color = Color(0.875, 0.875, 0.875, 0.5)
The CheckBox text's font color when it's disabled.
Color font_focus_color = Color(0.95, 0.95, 0.95, 1)
The CheckBox text's font color when it's focused. Only replaces the normal text color of the checkbox. Disabled, hovered, and pressed states take precedence over this color.
Color font_hover_color = Color(0.95, 0.95, 0.95, 1)
The CheckBox text's font color when it's hovered.
Color font_hover_pressed_color = Color(1, 1, 1, 1)
The CheckBox text's font color when it's hovered and pressed.
Color font_outline_color = Color(1, 1, 1, 1)
The tint of text outline of the CheckBox.
Color font_pressed_color = Color(1, 1, 1, 1)
The CheckBox text's font color when it's pressed.
int check_v_offset = 0
The vertical offset used when rendering the check icons (in pixels).
int h_separation = 4
The separation between the check icon and the text (in pixels). Negative values will be treated as 0 when used.
int outline_size = 0
The size of the text outline.
Note: If using a font with FontFile.multichannel_signed_distance_field enabled, its FontFile.msdf_pixel_range must be set to at least twice the value of outline_size for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.
Font font
The Font to use for the CheckBox text.
int font_size
Font size of the CheckBox's text.
Texture2D checked
The check icon to display when the CheckBox is checked.
Texture2D checked_disabled
The check icon to display when the CheckBox is checked and is disabled.
Texture2D radio_checked
The check icon to display when the CheckBox is configured as a radio button and is checked.
Texture2D radio_checked_disabled
The check icon to display when the CheckBox is configured as a radio button, is disabled, and is unchecked.
Texture2D radio_unchecked
The check icon to display when the CheckBox is configured as a radio button and is unchecked.
Texture2D radio_unchecked_disabled
The check icon to display when the CheckBox is configured as a radio button, is disabled, and is unchecked.
Texture2D unchecked
The check icon to display when the CheckBox is unchecked.
Texture2D unchecked_disabled
The check icon to display when the CheckBox is unchecked and is disabled.
StyleBox disabled
The StyleBox to display as a background when the CheckBox is disabled.
StyleBox focus
The StyleBox to display as a background when the CheckBox is focused. The focus StyleBox is displayed over the base StyleBox, so a partially transparent StyleBox should be used to ensure the base StyleBox remains visible. A StyleBox that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a StyleBoxEmpty resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.
StyleBox hover
The StyleBox to display as a background when the CheckBox is hovered.
StyleBox hover_pressed
The StyleBox to display as a background when the CheckBox is hovered and pressed.
StyleBox normal
The StyleBox to display as a background.
StyleBox pressed
The StyleBox to display as a background when the CheckBox is pressed.