2022-03-15 13:29:32 +01:00
<?xml version="1.0" encoding="UTF-8" ?>
2024-09-20 10:03:06 +02:00
<class name= "CheckButton" inherits= "Button" >
2022-03-15 13:29:32 +01:00
<brief_description >
Checkable button. See also [CheckBox].
</brief_description>
<description >
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.
See also [BaseButton] which contains common properties and methods associated with this node.
</description>
<tutorials >
</tutorials>
<methods >
</methods>
<members >
<member name= "align" type= "int" setter= "set_text_align" getter= "get_text_align" overrides= "Button" enum= "Button.TextAlign" default= "0" />
<member name= "toggle_mode" type= "bool" setter= "set_toggle_mode" getter= "is_toggle_mode" overrides= "BaseButton" default= "true" />
</members>
<constants >
</constants>
<theme_items >
<theme_item name= "font_color" data_type= "color" type= "Color" default= "Color( 0.88, 0.88, 0.88, 1 )" >
The [CheckButton] text's font color.
</theme_item>
<theme_item name= "font_color_disabled" data_type= "color" type= "Color" default= "Color( 0.9, 0.9, 0.9, 0.2 )" >
The [CheckButton] text's font color when it's disabled.
</theme_item>
<theme_item name= "font_color_focus" 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>
<theme_item name= "font_color_hover" data_type= "color" type= "Color" default= "Color( 0.94, 0.94, 0.94, 1 )" >
The [CheckButton] text's font color when it's hovered.
</theme_item>
<theme_item name= "font_color_hover_pressed" data_type= "color" type= "Color" default= "Color( 1, 1, 1, 1 )" >
The [CheckButton] text's font color when it's hovered and pressed.
</theme_item>
<theme_item name= "font_color_pressed" data_type= "color" type= "Color" default= "Color( 1, 1, 1, 1 )" >
The [CheckButton] text's font color when it's pressed.
</theme_item>
<theme_item name= "check_vadjust" data_type= "constant" type= "int" default= "0" >
The vertical offset used when rendering the toggle icons (in pixels).
</theme_item>
<theme_item name= "hseparation" data_type= "constant" type= "int" default= "4" >
The separation between the toggle icon and the text (in pixels).
</theme_item>
<theme_item name= "font" data_type= "font" type= "Font" >
The [Font] to use for the [CheckButton] text.
</theme_item>
<theme_item name= "off" data_type= "icon" type= "Texture" >
The icon to display when the [CheckButton] is unchecked.
</theme_item>
<theme_item name= "off_disabled" data_type= "icon" type= "Texture" >
The icon to display when the [CheckButton] is unchecked and disabled.
</theme_item>
<theme_item name= "on" data_type= "icon" type= "Texture" >
The icon to display when the [CheckButton] is checked.
</theme_item>
<theme_item name= "on_disabled" data_type= "icon" type= "Texture" >
The icon to display when the [CheckButton] is checked and disabled.
</theme_item>
<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.
</theme_item>
<theme_item name= "pressed" data_type= "style" type= "StyleBox" >
The [StyleBox] to display as a background when the [CheckButton] is pressed.
</theme_item>
</theme_items>
</class>
