c33373b80a
Users are sometimes confused as to the `pressed` property not being
visible in the Button class documentation. This is because `pressed`
is defined in BaseButton.
(cherry picked from commit 038baede5a)
76 lines
3.6 KiB
XML
76 lines
3.6 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="CheckButton" inherits="Button" version="3.2">
|
|
<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" 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" />
|
|
</members>
|
|
<constants>
|
|
</constants>
|
|
<theme_items>
|
|
<theme_item name="check_vadjust" type="int" default="0">
|
|
The vertical offset used when rendering the toggle icons (in pixels).
|
|
</theme_item>
|
|
<theme_item name="disabled" type="StyleBox">
|
|
The [StyleBox] to display as a background when the [CheckButton] is disabled.
|
|
</theme_item>
|
|
<theme_item name="focus" type="StyleBox">
|
|
The [StyleBox] to display as a background when the [CheckButton] is focused.
|
|
</theme_item>
|
|
<theme_item name="font" type="Font">
|
|
The [Font] to use for the [CheckButton] text.
|
|
</theme_item>
|
|
<theme_item name="font_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" 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_hover" 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" 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" type="Color" default="Color( 1, 1, 1, 1 )">
|
|
The [CheckButton] text's font color when it's pressed.
|
|
</theme_item>
|
|
<theme_item name="hover" type="StyleBox">
|
|
The [StyleBox] to display as a background when the [CheckButton] is hovered.
|
|
</theme_item>
|
|
<theme_item name="hover_pressed" type="StyleBox">
|
|
The [StyleBox] to display as a background when the [CheckButton] is hovered and pressed.
|
|
</theme_item>
|
|
<theme_item name="hseparation" type="int" default="4">
|
|
The separation between the toggle icon and the text (in pixels).
|
|
</theme_item>
|
|
<theme_item name="normal" type="StyleBox">
|
|
The [StyleBox] to display as a background.
|
|
</theme_item>
|
|
<theme_item name="off" type="Texture">
|
|
The icon to display when the [CheckButton] is unchecked.
|
|
</theme_item>
|
|
<theme_item name="off_disabled" type="Texture">
|
|
The icon to display when the [CheckButton] is unchecked and disabled.
|
|
</theme_item>
|
|
<theme_item name="on" type="Texture">
|
|
The icon to display when the [CheckButton] is checked.
|
|
</theme_item>
|
|
<theme_item name="on_disabled" type="Texture">
|
|
The icon to display when the [CheckButton] is checked and disabled.
|
|
</theme_item>
|
|
<theme_item name="pressed" type="StyleBox">
|
|
The [StyleBox] to display as a background when the [CheckButton] is pressed.
|
|
</theme_item>
|
|
</theme_items>
|
|
</class>
|