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

77 lines
3.6 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" ?>
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
<class name="CheckButton" inherits="Button" version="3.3">
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>
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 13:34:03 +02: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 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>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<theme_item name="check_vadjust" 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 20:02:27 +01:00
The vertical offset used when rendering the toggle 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 22:42:36 +02:00
</theme_item>
<theme_item name="disabled" 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 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>
<theme_item name="focus" 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 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 22:42:36 +02:00
</theme_item>
<theme_item name="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 20:02:27 +01:00
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>
TreeItem: Rename new button disable method to set_button_disabled Follow-up to #30408. Also sync classref with current source.
2019-07-09 09:13:00 +02:00
<theme_item name="font_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>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<theme_item name="font_color_disabled" 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>
TreeItem: Rename new button disable method to set_button_disabled Follow-up to #30408. Also sync classref with current source.
2019-07-09 09:13:00 +02:00
<theme_item name="font_color_hover" 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>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<theme_item name="font_color_hover_pressed" 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>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<theme_item name="font_color_pressed" 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>
<theme_item name="hover" 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 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>
Update class documentation xml
2018-10-07 15:52:07 +02:00
<theme_item name="hover_pressed" 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 hovered and pressed.
Update class documentation xml
2018-10-07 15:52:07 +02:00
</theme_item>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<theme_item name="hseparation" 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>
<theme_item name="normal" 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.
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_item name="off" 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>
doc: Sync classref with current source
2019-05-15 12:51:58 +02:00
<theme_item name="off_disabled" 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>
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 name="on" 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>
doc: Sync classref with current source
2019-05-15 12:51:58 +02:00
<theme_item name="on_disabled" 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>
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 name="pressed" 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