mirror of
https://github.com/godotengine/godot.git
synced 2024-12-09 10:09:20 +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.
95 lines
5.7 KiB
XML
95 lines
5.7 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="CheckBox" inherits="Button" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
Binary choice user interface widget. See also [CheckButton].
|
|
</brief_description>
|
|
<description>
|
|
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.
|
|
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 [CheckBox] 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 [CheckBox] 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 [CheckBox] text's font color when it's focused. Only replaces the normal text color of the checkbox. 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 [CheckBox] 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 [CheckBox] 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 [CheckBox].
|
|
</theme_item>
|
|
<theme_item name="font_pressed_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
|
|
The [CheckBox] 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 check icons (in pixels).
|
|
</theme_item>
|
|
<theme_item name="hseparation" data_type="constant" type="int" default="4">
|
|
The separation between the check 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 [CheckBox] text.
|
|
</theme_item>
|
|
<theme_item name="font_size" data_type="font_size" type="int">
|
|
Font size of the [CheckBox]'s text.
|
|
</theme_item>
|
|
<theme_item name="checked" data_type="icon" type="Texture2D">
|
|
The check icon to display when the [CheckBox] is checked.
|
|
</theme_item>
|
|
<theme_item name="checked_disabled" data_type="icon" type="Texture2D">
|
|
The check icon to display when the [CheckBox] is checked and disabled.
|
|
</theme_item>
|
|
<theme_item name="radio_checked" data_type="icon" type="Texture2D">
|
|
If the [CheckBox] is configured as a radio button, the icon to display when the [CheckBox] is checked.
|
|
</theme_item>
|
|
<theme_item name="radio_checked_disabled" data_type="icon" type="Texture2D">
|
|
</theme_item>
|
|
<theme_item name="radio_unchecked" data_type="icon" type="Texture2D">
|
|
If the [CheckBox] is configured as a radio button, the icon to display when the [CheckBox] is unchecked.
|
|
</theme_item>
|
|
<theme_item name="radio_unchecked_disabled" data_type="icon" type="Texture2D">
|
|
</theme_item>
|
|
<theme_item name="unchecked" data_type="icon" type="Texture2D">
|
|
The check icon to display when the [CheckBox] is unchecked.
|
|
</theme_item>
|
|
<theme_item name="unchecked_disabled" data_type="icon" type="Texture2D">
|
|
The check icon to display when the [CheckBox] is unchecked and disabled.
|
|
</theme_item>
|
|
<theme_item name="disabled" data_type="style" type="StyleBox">
|
|
The [StyleBox] to display as a background when the [CheckBox] is disabled.
|
|
</theme_item>
|
|
<theme_item name="focus" data_type="style" type="StyleBox">
|
|
The [StyleBox] to display as a background when the [CheckBox] 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 [CheckBox] is hovered.
|
|
</theme_item>
|
|
<theme_item name="hover_pressed" data_type="style" type="StyleBox">
|
|
The [StyleBox] to display as a background when the [CheckBox] 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 [CheckBox] is pressed.
|
|
</theme_item>
|
|
</theme_items>
|
|
</class>
|