mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-27 11:24:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
e223a9c129
godot/doc/classes/CheckButton.xml

97 lines
5.4 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-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
Update docs to version 4.0
2020-02-01 09:03:48 +08:00
<class name="CheckButton" inherits="Button" version="4.0">
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-13 04:42:36 +08:00
<brief_description>
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented.
2020-01-31 03:02:27 +08: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-13 04:42:36 +08:00
</brief_description>
<description>
Fix various typos Found via `codespell`
2020-03-12 01:59:18 +08: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.
2020-09-24 05:34:28 +08: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-13 04:42:36 +08:00
</description>
<tutorials>
</tutorials>
Run doctool after overridden properties changes
2019-09-03 18:44:58 +08: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 19:34:03 +08: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 18:44:58 +08: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-13 04:42:36 +08:00
<theme_items>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08: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.
2020-01-31 03:02:27 +08: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-13 04:42:36 +08:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08: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.
2020-01-31 03:02:27 +08: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-13 04:42:36 +08:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08: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.
2020-01-31 03:02:27 +08: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-13 04:42:36 +08:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08: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.
2020-01-31 03:02:27 +08: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-13 04:42:36 +08:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08: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.
2020-01-31 03:02:27 +08: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-13 04:42:36 +08:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08:00
<theme_item name="font_disabled_color" 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.
2020-01-31 03:02:27 +08: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-13 04:42:36 +08:00
</theme_item>
Add focus font color to Button and derivatives
2021-10-26 22:28:12 +08:00
<theme_item name="font_focus_color" 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-05 00:54:41 +08:00
<theme_item name="font_hover_color" 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.
2020-01-31 03:02:27 +08: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-13 04:42:36 +08:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08:00
<theme_item name="font_hover_pressed_color" 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.
2020-01-31 03:02:27 +08:00
The [CheckButton] text's font color when it's hovered and pressed.
Update class documentation xml
2018-10-07 21:52:07 +08:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08:00
<theme_item name="font_outline_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
[CTL] Add missing font outline drawing routines and theme constants.
2020-12-26 05:45:28 +08:00
The tint of text outline of the [CheckButton].
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08:00
<theme_item name="font_pressed_color" 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.
2020-01-31 03:02:27 +08: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-13 04:42:36 +08:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08:00
<theme_item name="font_size" data_type="font_size" type="int">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
Font size of the [CheckButton]'s text.
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08: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.
2020-01-31 03:02:27 +08: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-13 04:42:36 +08:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08: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.
2020-01-31 03:02:27 +08:00
The [StyleBox] to display as a background when the [CheckButton] is hovered and pressed.
Update class documentation xml
2018-10-07 21:52:07 +08:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08: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.
2020-01-31 03:02:27 +08: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-13 04:42:36 +08:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08: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.
2020-01-31 03:02:27 +08: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-13 04:42:36 +08:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08:00
<theme_item name="off" data_type="icon" type="Texture2D">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
The icon to display when the [CheckButton] is unchecked (for left-to-right layouts).
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-13 04:42:36 +08:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08:00
<theme_item name="off_disabled" data_type="icon" type="Texture2D">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
The icon to display when the [CheckButton] is unchecked and disabled (for left-to-right layouts).
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08:00
<theme_item name="off_disabled_mirrored" data_type="icon" type="Texture2D">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
The icon to display when the [CheckButton] is unchecked and disabled (for right-to-left layouts).
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08:00
<theme_item name="off_mirrored" data_type="icon" type="Texture2D">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
The icon to display when the [CheckButton] is unchecked (for right-to-left layouts).
doc: Sync classref with current source
2019-05-15 18:51:58 +08:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08:00
<theme_item name="on" data_type="icon" type="Texture2D">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
The icon to display when the [CheckButton] is checked (for left-to-right layouts).
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-13 04:42:36 +08:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08:00
<theme_item name="on_disabled" data_type="icon" type="Texture2D">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
The icon to display when the [CheckButton] is checked and disabled (for left-to-right layouts).
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08:00
<theme_item name="on_disabled_mirrored" data_type="icon" type="Texture2D">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
The icon to display when the [CheckButton] is checked and disabled (for right-to-left layouts).
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08:00
<theme_item name="on_mirrored" data_type="icon" type="Texture2D">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
The icon to display when the [CheckButton] is checked (for right-to-left layouts).
doc: Sync classref with current source
2019-05-15 18:51:58 +08:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08:00
<theme_item name="outline_size" data_type="constant" type="int" default="0">
[CTL] Add missing font outline drawing routines and theme constants.
2020-12-26 05:45:28 +08:00
The size of the text outline.
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08: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.
2020-01-31 03:02:27 +08: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-13 04:42:36 +08:00
</theme_item>
</theme_items>
</class>
Reference in New Issue Copy Permalink