asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/CheckButton.xml

80 lines
4.3 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 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation 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.
2022-03-16 23:01:02 +01:00
<class name="CheckButton" inherits="Button" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
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 22:42:36 +02: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 20:02:27 +01:00
Checkable button. See also [CheckBox].
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 22:42:36 +02: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 14:09:51 +02:00
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.
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 23:34:28 +02: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 22:42:36 +02:00
</description>
<tutorials>
</tutorials>
<methods>
</methods>
Run doctool after overridden properties changes
2019-09-03 12:44:58 +02:00
<members>
Make overridden properties link to parent definition Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-02 21:15:17 +01:00
<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" />
Run doctool after overridden properties changes
2019-09-03 12:44:58 +02: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 22:42:36 +02:00
<constants>
</constants>
<theme_items>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02: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 20:02:27 +01:00
The [CheckButton] 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 22:42:36 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02: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 20:02:27 +01:00
The [CheckButton] 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 22:42:36 +02:00
</theme_item>
Add focus font color to Button and derivatives
2021-10-26 15:32:15 +02:00
<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>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02: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 20:02:27 +01:00
The [CheckButton] 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 22:42:36 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02: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 20:02:27 +01:00
The [CheckButton] text's font color when it's hovered and pressed.
Update class documentation xml
2018-10-07 15:52:07 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02: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 20:02:27 +01:00
The [CheckButton] 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 22:42:36 +02:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 20:45:12 +01:00
<theme_item name="check_vadjust" data_type="constant" type="int" default="0">
The vertical offset used when rendering the toggle icons (in pixels).
Update class documentation xml
2018-10-07 15:52:07 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02: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 20:02:27 +01:00
The separation between the toggle 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 22:42:36 +02:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 20:45:12 +01:00
<theme_item name="font" data_type="font" type="Font">
The [Font] to use for the [CheckButton] 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 22:42:36 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02:00
<theme_item name="off" 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 20:02:27 +01:00
The icon to display when the [CheckButton] 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 22:42:36 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02:00
<theme_item name="off_disabled" 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 20:02:27 +01:00
The icon to display when the [CheckButton] is unchecked and disabled.
doc: Sync classref with current source
2019-05-15 12:51:58 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02:00
<theme_item name="on" 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 20:02:27 +01:00
The icon to display when the [CheckButton] 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 22:42:36 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02:00
<theme_item name="on_disabled" 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 20:02:27 +01:00
The icon to display when the [CheckButton] is checked and disabled.
doc: Sync classref with current source
2019-05-15 12:51:58 +02:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 20:45:12 +01:00
<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>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02: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 20:02:27 +01:00
The [StyleBox] to display as a background when the [CheckButton] 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 22:42:36 +02:00
</theme_item>
</theme_items>
</class>
Reference in a new issue Copy permalink