godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/CheckBox.xml

90 lines
4.8 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Update classref headers with 3.4 version
2021-04-26 11:14:51 +00:00
<class name="CheckBox" inherits="Button" version="3.4">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. (cherry picked from commit c9946bc87e269a2733fa28885ed305b381a5f909)
2020-01-30 19:02:27 +00:00
Binary choice user interface widget. See also [CheckButton].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
Fix typos with codespell Using codespell 1.17.1. Method: ``` $ cat > ../godot-word-whitelist.txt << EOF ang curvelinear dof doubleclick fave findn leapyear lod merchantibility nd numer ois ony que seeked synching te uint unselect webp EOF $ codespell -w -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po" $ git diff // undo unwanted changes ```
2020-09-18 12:09:51 +00:00
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.
Reference the BaseButton class explicitly in button class documentations 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 038baede5a7c882e36cafbe3ad75611849e68c47)
2020-09-23 21:34:28 +00:00
See also [BaseButton] which contains common properties and methods associated with this node.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<methods>
</methods>
Run doctool after overridden properties changes
2019-09-03 10:44:58 +00:00
<members>
doc: Fix parsing of self-closing XML tags Follow-up to #31925, `<member />` tags just before `</members>` would cause a parsing issue, and we'd never notice that we're no longer parsing members. Also added space before closing `/>`.
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" />
Run doctool after overridden properties changes
2019-09-03 10:44:58 +00:00
</members>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<constants>
</constants>
<theme_items>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="check_vadjust" data_type="constant" type="int" default="0">
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. (cherry picked from commit c9946bc87e269a2733fa28885ed305b381a5f909)
2020-01-30 19:02:27 +00:00
The vertical offset used when rendering the check icons (in pixels).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="checked" data_type="icon" type="Texture">
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. (cherry picked from commit c9946bc87e269a2733fa28885ed305b381a5f909)
2020-01-30 19:02:27 +00:00
The check icon to display when the [CheckBox] is checked.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="checked_disabled" data_type="icon" type="Texture">
Add focus font color to Button and derivatives
2021-10-26 13:32:15 +00:00
The check icon to display when the [CheckBox] is checked and disabled.
Add disabled theme icons for CheckBox (cherry picked from commit 3a40c268a60bff45bb123625b261345c28259441)
2020-04-10 11:40:52 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="disabled" data_type="style" type="StyleBox">
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. (cherry picked from commit c9946bc87e269a2733fa28885ed305b381a5f909)
2020-01-30 19:02:27 +00:00
The [StyleBox] to display as a background when the [CheckBox] is disabled.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="focus" data_type="style" type="StyleBox">
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. (cherry picked from commit c9946bc87e269a2733fa28885ed305b381a5f909)
2020-01-30 19:02:27 +00:00
The [StyleBox] to display as a background when the [CheckBox] is focused.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="font" data_type="font" type="Font">
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. (cherry picked from commit c9946bc87e269a2733fa28885ed305b381a5f909)
2020-01-30 19:02:27 +00:00
The [Font] to use for the [CheckBox] text.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="font_color" data_type="color" type="Color" default="Color( 0.88, 0.88, 0.88, 1 )">
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. (cherry picked from commit c9946bc87e269a2733fa28885ed305b381a5f909)
2020-01-30 19:02:27 +00:00
The [CheckBox] text's font color.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="font_color_disabled" data_type="color" type="Color" default="Color( 0.9, 0.9, 0.9, 0.2 )">
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. (cherry picked from commit c9946bc87e269a2733fa28885ed305b381a5f909)
2020-01-30 19:02:27 +00:00
The [CheckBox] text's font color when it's disabled.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add focus font color to Button and derivatives
2021-10-26 13:32:15 +00:00
<theme_item name="font_color_focus" data_type="color" type="Color" default="Color( 0.94, 0.94, 0.94, 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>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="font_color_hover" data_type="color" type="Color" default="Color( 0.94, 0.94, 0.94, 1 )">
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. (cherry picked from commit c9946bc87e269a2733fa28885ed305b381a5f909)
2020-01-30 19:02:27 +00:00
The [CheckBox] text's font color when it's hovered.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="font_color_hover_pressed" data_type="color" type="Color" default="Color( 1, 1, 1, 1 )">
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. (cherry picked from commit c9946bc87e269a2733fa28885ed305b381a5f909)
2020-01-30 19:02:27 +00:00
The [CheckBox] text's font color when it's hovered and pressed.
Update class documentation xml
2018-10-07 13:52:07 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="font_color_pressed" data_type="color" type="Color" default="Color( 1, 1, 1, 1 )">
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. (cherry picked from commit c9946bc87e269a2733fa28885ed305b381a5f909)
2020-01-30 19:02:27 +00:00
The [CheckBox] text's font color when it's pressed.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="hover" data_type="style" type="StyleBox">
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. (cherry picked from commit c9946bc87e269a2733fa28885ed305b381a5f909)
2020-01-30 19:02:27 +00:00
The [StyleBox] to display as a background when the [CheckBox] is hovered.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="hover_pressed" data_type="style" type="StyleBox">
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. (cherry picked from commit c9946bc87e269a2733fa28885ed305b381a5f909)
2020-01-30 19:02:27 +00:00
The [StyleBox] to display as a background when the [CheckBox] is hovered and pressed.
Update class documentation xml
2018-10-07 13:52:07 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="hseparation" data_type="constant" type="int" default="4">
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. (cherry picked from commit c9946bc87e269a2733fa28885ed305b381a5f909)
2020-01-30 19:02:27 +00:00
The separation between the check icon and the text (in pixels).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="normal" data_type="style" type="StyleBox">
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. (cherry picked from commit c9946bc87e269a2733fa28885ed305b381a5f909)
2020-01-30 19:02:27 +00:00
The [StyleBox] to display as a background.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="pressed" data_type="style" type="StyleBox">
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. (cherry picked from commit c9946bc87e269a2733fa28885ed305b381a5f909)
2020-01-30 19:02:27 +00:00
The [StyleBox] to display as a background when the [CheckBox] is pressed.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="radio_checked" data_type="icon" type="Texture">
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. (cherry picked from commit c9946bc87e269a2733fa28885ed305b381a5f909)
2020-01-30 19:02:27 +00:00
If the [CheckBox] is configured as a radio button, the icon to display when the [CheckBox] is checked.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="radio_checked_disabled" data_type="icon" type="Texture">
Add disabled theme icons for CheckBox (cherry picked from commit 3a40c268a60bff45bb123625b261345c28259441)
2020-04-10 11:40:52 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="radio_unchecked" data_type="icon" type="Texture">
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. (cherry picked from commit c9946bc87e269a2733fa28885ed305b381a5f909)
2020-01-30 19:02:27 +00:00
If the [CheckBox] is configured as a radio button, the icon to display when the [CheckBox] is unchecked.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="radio_unchecked_disabled" data_type="icon" type="Texture">
Add disabled theme icons for CheckBox (cherry picked from commit 3a40c268a60bff45bb123625b261345c28259441)
2020-04-10 11:40:52 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="unchecked" data_type="icon" type="Texture">
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. (cherry picked from commit c9946bc87e269a2733fa28885ed305b381a5f909)
2020-01-30 19:02:27 +00:00
The check icon to display when the [CheckBox] is unchecked.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="unchecked_disabled" data_type="icon" type="Texture">
Add focus font color to Button and derivatives
2021-10-26 13:32:15 +00:00
The check icon to display when the [CheckBox] is unchecked and disabled.
Add disabled theme icons for CheckBox (cherry picked from commit 3a40c268a60bff45bb123625b261345c28259441)
2020-04-10 11:40:52 +00:00
</theme_item>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_items>
</class>