mirror of
https://github.com/godotengine/godot.git
synced 2024-12-15 10:12:40 +08:00
b68dd2e189
This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
97 lines
6.0 KiB
XML
97 lines
6.0 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="CheckButton" inherits="Button" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<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>
|
|
<members>
|
|
<member name="alignment" type="int" setter="set_text_alignment" getter="get_text_alignment" overrides="Button" enum="HorizontalAlignment" default="0" />
|
|
<member name="toggle_mode" type="bool" setter="set_toggle_mode" getter="is_toggle_mode" overrides="BaseButton" default="true" />
|
|
</members>
|
|
<theme_items>
|
|
<theme_item name="font_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 1)">
|
|
The [CheckButton] text's font color.
|
|
</theme_item>
|
|
<theme_item name="font_disabled_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 0.5)">
|
|
The [CheckButton] text's font color when it's disabled.
|
|
</theme_item>
|
|
<theme_item name="font_focus_color" data_type="color" type="Color" default="Color(0.95, 0.95, 0.95, 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_hover_color" data_type="color" type="Color" default="Color(0.95, 0.95, 0.95, 1)">
|
|
The [CheckButton] text's font color when it's hovered.
|
|
</theme_item>
|
|
<theme_item name="font_hover_pressed_color" 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_outline_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
|
|
The tint of text outline of the [CheckButton].
|
|
</theme_item>
|
|
<theme_item name="font_pressed_color" 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="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.
|
|
</theme_item>
|
|
<theme_item name="off" data_type="icon" type="Texture2D">
|
|
The icon to display when the [CheckButton] is unchecked (for left-to-right layouts).
|
|
</theme_item>
|
|
<theme_item name="off_disabled" data_type="icon" type="Texture2D">
|
|
The icon to display when the [CheckButton] is unchecked and disabled (for left-to-right layouts).
|
|
</theme_item>
|
|
<theme_item name="off_disabled_mirrored" data_type="icon" type="Texture2D">
|
|
The icon to display when the [CheckButton] is unchecked and disabled (for right-to-left layouts).
|
|
</theme_item>
|
|
<theme_item name="off_mirrored" data_type="icon" type="Texture2D">
|
|
The icon to display when the [CheckButton] is unchecked (for right-to-left layouts).
|
|
</theme_item>
|
|
<theme_item name="on" data_type="icon" type="Texture2D">
|
|
The icon to display when the [CheckButton] is checked (for left-to-right layouts).
|
|
</theme_item>
|
|
<theme_item name="on_disabled" data_type="icon" type="Texture2D">
|
|
The icon to display when the [CheckButton] is checked and disabled (for left-to-right layouts).
|
|
</theme_item>
|
|
<theme_item name="on_disabled_mirrored" data_type="icon" type="Texture2D">
|
|
The icon to display when the [CheckButton] is checked and disabled (for right-to-left layouts).
|
|
</theme_item>
|
|
<theme_item name="on_mirrored" data_type="icon" type="Texture2D">
|
|
The icon to display when the [CheckButton] is checked (for right-to-left layouts).
|
|
</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. The [code]focus[/code] [StyleBox] is displayed [i]over[/i] 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.
|
|
</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>
|