2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2021-03-23 13:40:34 +01:00
<class name= "CheckBox" inherits= "Button" version= "3.3" >
2017-09-12 22:42:36 +02:00
<brief_description >
2020-01-30 20:02:27 +01:00
Binary choice user interface widget. See also [CheckButton].
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2020-09-18 14:09:51 +02:00
A checkbox allows the user to make a binary choice (choosing only one of 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 [b]no[/b] immediate effect on something. For instance, it should be used when toggling it will only do something once a confirmation button is pressed.
2020-09-23 23:34:28 +02:00
See also [BaseButton] which contains common properties and methods associated with this node.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
</tutorials>
<methods >
</methods>
2019-09-03 12:44:58 +02:00
<members >
2019-09-24 13:34:03 +02:00
<member name= "align" type= "int" setter= "set_text_align" getter= "get_text_align" override= "true" enum= "Button.TextAlign" default= "0" />
<member name= "toggle_mode" type= "bool" setter= "set_toggle_mode" getter= "is_toggle_mode" override= "true" default= "true" />
2019-09-03 12:44:58 +02:00
</members>
2017-09-12 22:42:36 +02:00
<constants >
</constants>
<theme_items >
2019-06-29 12:38:01 +02:00
<theme_item name= "check_vadjust" type= "int" default= "0" >
2020-01-30 20:02:27 +01:00
The vertical offset used when rendering the check icons (in pixels).
2017-09-12 22:42:36 +02:00
</theme_item>
<theme_item name= "checked" type= "Texture" >
2020-01-30 20:02:27 +01:00
The check icon to display when the [CheckBox] is checked.
2017-09-12 22:42:36 +02:00
</theme_item>
2020-04-10 13:40:52 +02:00
<theme_item name= "checked_disabled" type= "Texture" >
</theme_item>
2017-09-12 22:42:36 +02:00
<theme_item name= "disabled" type= "StyleBox" >
2020-01-30 20:02:27 +01:00
The [StyleBox] to display as a background when the [CheckBox] is disabled.
2017-09-12 22:42:36 +02:00
</theme_item>
<theme_item name= "focus" type= "StyleBox" >
2020-01-30 20:02:27 +01:00
The [StyleBox] to display as a background when the [CheckBox] is focused.
2017-09-12 22:42:36 +02:00
</theme_item>
<theme_item name= "font" type= "Font" >
2020-01-30 20:02:27 +01:00
The [Font] to use for the [CheckBox] text.
2017-09-12 22:42:36 +02:00
</theme_item>
2019-07-09 09:13:00 +02:00
<theme_item name= "font_color" type= "Color" default= "Color( 0.88, 0.88, 0.88, 1 )" >
2020-01-30 20:02:27 +01:00
The [CheckBox] text's font color.
2017-09-12 22:42:36 +02:00
</theme_item>
2019-06-29 12:38:01 +02:00
<theme_item name= "font_color_disabled" type= "Color" default= "Color( 0.9, 0.9, 0.9, 0.2 )" >
2020-01-30 20:02:27 +01:00
The [CheckBox] text's font color when it's disabled.
2017-09-12 22:42:36 +02:00
</theme_item>
2019-07-09 09:13:00 +02:00
<theme_item name= "font_color_hover" type= "Color" default= "Color( 0.94, 0.94, 0.94, 1 )" >
2020-01-30 20:02:27 +01:00
The [CheckBox] text's font color when it's hovered.
2017-09-12 22:42:36 +02:00
</theme_item>
2019-06-29 12:38:01 +02:00
<theme_item name= "font_color_hover_pressed" type= "Color" default= "Color( 1, 1, 1, 1 )" >
2020-01-30 20:02:27 +01:00
The [CheckBox] text's font color when it's hovered and pressed.
2018-10-07 15:52:07 +02:00
</theme_item>
2019-06-29 12:38:01 +02:00
<theme_item name= "font_color_pressed" type= "Color" default= "Color( 1, 1, 1, 1 )" >
2020-01-30 20:02:27 +01:00
The [CheckBox] text's font color when it's pressed.
2017-09-12 22:42:36 +02:00
</theme_item>
<theme_item name= "hover" type= "StyleBox" >
2020-01-30 20:02:27 +01:00
The [StyleBox] to display as a background when the [CheckBox] is hovered.
2017-09-12 22:42:36 +02:00
</theme_item>
2018-10-07 15:52:07 +02:00
<theme_item name= "hover_pressed" type= "StyleBox" >
2020-01-30 20:02:27 +01:00
The [StyleBox] to display as a background when the [CheckBox] is hovered and pressed.
2018-10-07 15:52:07 +02:00
</theme_item>
2019-06-29 12:38:01 +02:00
<theme_item name= "hseparation" type= "int" default= "4" >
2020-01-30 20:02:27 +01:00
The separation between the check icon and the text (in pixels).
2017-09-12 22:42:36 +02:00
</theme_item>
<theme_item name= "normal" type= "StyleBox" >
2020-01-30 20:02:27 +01:00
The [StyleBox] to display as a background.
2017-09-12 22:42:36 +02:00
</theme_item>
<theme_item name= "pressed" type= "StyleBox" >
2020-01-30 20:02:27 +01:00
The [StyleBox] to display as a background when the [CheckBox] is pressed.
2017-09-12 22:42:36 +02:00
</theme_item>
<theme_item name= "radio_checked" type= "Texture" >
2020-01-30 20:02:27 +01:00
If the [CheckBox] is configured as a radio button, the icon to display when the [CheckBox] is checked.
2017-09-12 22:42:36 +02:00
</theme_item>
2020-04-10 13:40:52 +02:00
<theme_item name= "radio_checked_disabled" type= "Texture" >
</theme_item>
2017-09-12 22:42:36 +02:00
<theme_item name= "radio_unchecked" type= "Texture" >
2020-01-30 20:02:27 +01:00
If the [CheckBox] is configured as a radio button, the icon to display when the [CheckBox] is unchecked.
2017-09-12 22:42:36 +02:00
</theme_item>
2020-04-10 13:40:52 +02:00
<theme_item name= "radio_unchecked_disabled" type= "Texture" >
</theme_item>
2017-09-12 22:42:36 +02:00
<theme_item name= "unchecked" type= "Texture" >
2020-01-30 20:02:27 +01:00
The check icon to display when the [CheckBox] is unchecked.
2017-09-12 22:42:36 +02:00
</theme_item>
2020-04-10 13:40:52 +02:00
<theme_item name= "unchecked_disabled" type= "Texture" >
</theme_item>
2017-09-12 22:42:36 +02:00
</theme_items>
</class>