2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 01:03:48 +00:00
<class name= "CheckButton" inherits= "Button" version= "4.0" >
2017-09-12 20:42:36 +00:00
<brief_description >
2020-01-30 19:02:27 +00:00
Checkable button. See also [CheckBox].
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2020-03-11 17:59:18 +00:00
CheckButton is a toggle button displayed as a check field. It's similar to [CheckBox] in functionality, but it has a different appearance. To follow established UX patterns, it's recommended to use CheckButton when toggling it has an [b]immediate[/b] effect on something. For instance, it should be used if toggling it enables/disables a setting without requiring the user to press a confirmation button.
2020-09-23 21:34:28 +00:00
See also [BaseButton] which contains common properties and methods associated with this node.
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
</tutorials>
2019-09-03 10:44:58 +00:00
<members >
2019-09-24 11:34:03 +00: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 10:44:58 +00:00
</members>
2017-09-12 20:42:36 +00:00
<theme_items >
2021-08-04 16:54:41 +00:00
<theme_item name= "font_color" data_type= "color" type= "Color" default= "Color(0.88, 0.88, 0.88, 1)" >
2020-01-30 19:02:27 +00:00
The [CheckButton] text's font color.
2017-09-12 20:42:36 +00:00
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "font_disabled_color" data_type= "color" type= "Color" default= "Color(0.9, 0.9, 0.9, 0.2)" >
2020-01-30 19:02:27 +00:00
The [CheckButton] text's font color when it's disabled.
2017-09-12 20:42:36 +00:00
</theme_item>
2021-10-26 14:28:12 +00:00
<theme_item name= "font_focus_color" data_type= "color" type= "Color" default= "Color(0.94, 0.94, 0.94, 1)" >
The [CheckButton] text's font color when it's focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color.
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "font_hover_color" data_type= "color" type= "Color" default= "Color(0.94, 0.94, 0.94, 1)" >
2020-01-30 19:02:27 +00:00
The [CheckButton] text's font color when it's hovered.
2017-09-12 20:42:36 +00:00
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "font_hover_pressed_color" data_type= "color" type= "Color" default= "Color(1, 1, 1, 1)" >
2020-01-30 19:02:27 +00:00
The [CheckButton] text's font color when it's hovered and pressed.
2018-10-07 13:52:07 +00:00
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "font_outline_color" data_type= "color" type= "Color" default= "Color(1, 1, 1, 1)" >
2020-12-25 21:45:28 +00:00
The tint of text outline of the [CheckButton].
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "font_pressed_color" data_type= "color" type= "Color" default= "Color(1, 1, 1, 1)" >
2020-01-30 19:02:27 +00:00
The [CheckButton] text's font color when it's pressed.
2017-09-12 20:42:36 +00:00
</theme_item>
2021-12-01 18:02:20 +00:00
<theme_item name= "check_vadjust" data_type= "constant" type= "int" default= "0" >
The vertical offset used when rendering the toggle icons (in pixels).
2018-10-07 13:52:07 +00:00
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "hseparation" data_type= "constant" type= "int" default= "4" >
2020-01-30 19:02:27 +00:00
The separation between the toggle icon and the text (in pixels).
2017-09-12 20:42:36 +00:00
</theme_item>
2021-12-01 18:02:20 +00:00
<theme_item name= "outline_size" data_type= "constant" type= "int" default= "0" >
The size of the text outline.
</theme_item>
<theme_item name= "font" data_type= "font" type= "Font" >
The [Font] to use for the [CheckButton] text.
</theme_item>
<theme_item name= "font_size" data_type= "font_size" type= "int" >
Font size of the [CheckButton]'s text.
2017-09-12 20:42:36 +00:00
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "off" data_type= "icon" type= "Texture2D" >
2020-08-12 11:49:10 +00:00
The icon to display when the [CheckButton] is unchecked (for left-to-right layouts).
2017-09-12 20:42:36 +00:00
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "off_disabled" data_type= "icon" type= "Texture2D" >
2020-08-12 11:49:10 +00:00
The icon to display when the [CheckButton] is unchecked and disabled (for left-to-right layouts).
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "off_disabled_mirrored" data_type= "icon" type= "Texture2D" >
2020-08-12 11:49:10 +00:00
The icon to display when the [CheckButton] is unchecked and disabled (for right-to-left layouts).
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "off_mirrored" data_type= "icon" type= "Texture2D" >
2020-08-12 11:49:10 +00:00
The icon to display when the [CheckButton] is unchecked (for right-to-left layouts).
2019-05-15 10:51:58 +00:00
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "on" data_type= "icon" type= "Texture2D" >
2020-08-12 11:49:10 +00:00
The icon to display when the [CheckButton] is checked (for left-to-right layouts).
2017-09-12 20:42:36 +00:00
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "on_disabled" data_type= "icon" type= "Texture2D" >
2020-08-12 11:49:10 +00:00
The icon to display when the [CheckButton] is checked and disabled (for left-to-right layouts).
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "on_disabled_mirrored" data_type= "icon" type= "Texture2D" >
2020-08-12 11:49:10 +00:00
The icon to display when the [CheckButton] is checked and disabled (for right-to-left layouts).
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "on_mirrored" data_type= "icon" type= "Texture2D" >
2020-08-12 11:49:10 +00:00
The icon to display when the [CheckButton] is checked (for right-to-left layouts).
2019-05-15 10:51:58 +00:00
</theme_item>
2021-12-01 18:02:20 +00:00
<theme_item name= "disabled" data_type= "style" type= "StyleBox" >
The [StyleBox] to display as a background when the [CheckButton] is disabled.
</theme_item>
<theme_item name= "focus" data_type= "style" type= "StyleBox" >
The [StyleBox] to display as a background when the [CheckButton] is focused.
</theme_item>
<theme_item name= "hover" data_type= "style" type= "StyleBox" >
The [StyleBox] to display as a background when the [CheckButton] is hovered.
</theme_item>
<theme_item name= "hover_pressed" data_type= "style" type= "StyleBox" >
The [StyleBox] to display as a background when the [CheckButton] is hovered and pressed.
</theme_item>
<theme_item name= "normal" data_type= "style" type= "StyleBox" >
The [StyleBox] to display as a background.
2020-12-25 21:45:28 +00:00
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "pressed" data_type= "style" type= "StyleBox" >
2020-01-30 19:02:27 +00:00
The [StyleBox] to display as a background when the [CheckButton] is pressed.
2017-09-12 20:42:36 +00:00
</theme_item>
</theme_items>
</class>