mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-15 10:12:40 +08:00
Code Issues Packages Projects Releases Wiki Activity
4ebf248e1b
godot/doc/classes/CheckBox.xml

94 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-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="CheckBox" 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
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-13 04:42:36 +08:00
</brief_description>
<description>
Fix various typos Found via `codespell`
2020-03-12 01:59:18 +08: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.
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>
<methods>
</methods>
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
<constants>
</constants>
<theme_items>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08: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.
2020-01-31 03:02:27 +08: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-13 04:42:36 +08:00
</theme_item>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 16:59:06 +08:00
<theme_item name="checked" type="Texture2D">
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 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-13 04:42:36 +08:00
</theme_item>
doc: Sync classref with current source
2021-03-25 19:19:51 +08:00
<theme_item name="checked_disabled" type="Texture2D">
</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-13 04:42:36 +08:00
<theme_item name="disabled" 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 [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-13 04:42:36 +08: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.
2020-01-31 03:02:27 +08: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-13 04:42:36 +08: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.
2020-01-31 03:02:27 +08: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-13 04:42:36 +08: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 15:13:00 +08: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.
2020-01-31 03:02:27 +08: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-13 04:42:36 +08:00
</theme_item>
Change themes *_color_* to *_*_color Changed: font_color_accel -> font_accelerator_color font_color_bg -> font_unselected_color font_color_disabled -> font_disabled_color font_color_fg -> font_selected_color font_color_hover -> font_hover_color font_color_hover_pressed -> font_hover_pressed_color font_color_pressed -> font_pressed_color font_color_readonly -> font_readonly_color font_color_selected -> font_selected_color font_color_shadow -> font_shadow_color font_color_uneditable -> font_uneditable_color icon_color_disabled -> icon_disabled_color icon_color_hover -> icon_hover_color icon_color_hover_pressed -> icon_hover_pressed_color icon_color_normal -> icon_normal_color icon_color_pressed -> icon_pressed_color Also includes: font_outline_modulate -> font_outline_color tab_fg -> tab_selected tab_bg -> tab_unselected
2020-12-08 21:11:45 +08:00
<theme_item name="font_disabled_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 [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-13 04:42:36 +08:00
</theme_item>
Change themes *_color_* to *_*_color Changed: font_color_accel -> font_accelerator_color font_color_bg -> font_unselected_color font_color_disabled -> font_disabled_color font_color_fg -> font_selected_color font_color_hover -> font_hover_color font_color_hover_pressed -> font_hover_pressed_color font_color_pressed -> font_pressed_color font_color_readonly -> font_readonly_color font_color_selected -> font_selected_color font_color_shadow -> font_shadow_color font_color_uneditable -> font_uneditable_color icon_color_disabled -> icon_disabled_color icon_color_hover -> icon_hover_color icon_color_hover_pressed -> icon_hover_pressed_color icon_color_normal -> icon_normal_color icon_color_pressed -> icon_pressed_color Also includes: font_outline_modulate -> font_outline_color tab_fg -> tab_selected tab_bg -> tab_unselected
2020-12-08 21:11:45 +08:00
<theme_item name="font_hover_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 [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-13 04:42:36 +08:00
</theme_item>
Change themes *_color_* to *_*_color Changed: font_color_accel -> font_accelerator_color font_color_bg -> font_unselected_color font_color_disabled -> font_disabled_color font_color_fg -> font_selected_color font_color_hover -> font_hover_color font_color_hover_pressed -> font_hover_pressed_color font_color_pressed -> font_pressed_color font_color_readonly -> font_readonly_color font_color_selected -> font_selected_color font_color_shadow -> font_shadow_color font_color_uneditable -> font_uneditable_color icon_color_disabled -> icon_disabled_color icon_color_hover -> icon_hover_color icon_color_hover_pressed -> icon_hover_pressed_color icon_color_normal -> icon_normal_color icon_color_pressed -> icon_pressed_color Also includes: font_outline_modulate -> font_outline_color tab_fg -> tab_selected tab_bg -> tab_unselected
2020-12-08 21:11:45 +08:00
<theme_item name="font_hover_pressed_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 [CheckBox] text's font color when it's hovered and pressed.
Update class documentation xml
2018-10-07 21:52:07 +08:00
</theme_item>
[CTL] Add missing font outline drawing routines and theme constants.
2020-12-26 05:45:28 +08:00
<theme_item name="font_outline_color" type="Color" default="Color( 1, 1, 1, 1 )">
The tint of text outline of the [CheckBox].
</theme_item>
Change themes *_color_* to *_*_color Changed: font_color_accel -> font_accelerator_color font_color_bg -> font_unselected_color font_color_disabled -> font_disabled_color font_color_fg -> font_selected_color font_color_hover -> font_hover_color font_color_hover_pressed -> font_hover_pressed_color font_color_pressed -> font_pressed_color font_color_readonly -> font_readonly_color font_color_selected -> font_selected_color font_color_shadow -> font_shadow_color font_color_uneditable -> font_uneditable_color icon_color_disabled -> icon_disabled_color icon_color_hover -> icon_hover_color icon_color_hover_pressed -> icon_hover_pressed_color icon_color_normal -> icon_normal_color icon_color_pressed -> icon_pressed_color Also includes: font_outline_modulate -> font_outline_color tab_fg -> tab_selected tab_bg -> tab_unselected
2020-12-08 21:11:45 +08:00
<theme_item name="font_pressed_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 [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-13 04:42:36 +08:00
</theme_item>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<theme_item name="font_size" type="int">
Font size of the [CheckBox]'s text.
</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-13 04:42:36 +08:00
<theme_item name="hover" 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 [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-13 04:42:36 +08:00
</theme_item>
Update class documentation xml
2018-10-07 21:52:07 +08:00
<theme_item name="hover_pressed" 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 [CheckBox] is hovered and pressed.
Update class documentation xml
2018-10-07 21:52:07 +08:00
</theme_item>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08: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.
2020-01-31 03:02:27 +08: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-13 04:42:36 +08: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.
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>
[CTL] Add missing font outline drawing routines and theme constants.
2020-12-26 05:45:28 +08:00
<theme_item name="outline_size" type="int" default="0">
The size of the text outline.
</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-13 04:42:36 +08:00
<theme_item name="pressed" 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 [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-13 04:42:36 +08:00
</theme_item>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 16:59:06 +08:00
<theme_item name="radio_checked" type="Texture2D">
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented.
2020-01-31 03:02:27 +08: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-13 04:42:36 +08:00
</theme_item>
doc: Sync classref with current source
2021-03-25 19:19:51 +08:00
<theme_item name="radio_checked_disabled" type="Texture2D">
</theme_item>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 16:59:06 +08:00
<theme_item name="radio_unchecked" type="Texture2D">
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented.
2020-01-31 03:02:27 +08: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-13 04:42:36 +08:00
</theme_item>
doc: Sync classref with current source
2021-03-25 19:19:51 +08:00
<theme_item name="radio_unchecked_disabled" type="Texture2D">
</theme_item>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 16:59:06 +08:00
<theme_item name="unchecked" type="Texture2D">
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 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-13 04:42:36 +08:00
</theme_item>
doc: Sync classref with current source
2021-03-25 19:19:51 +08:00
<theme_item name="unchecked_disabled" type="Texture2D">
</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-13 04:42:36 +08:00
</theme_items>
</class>
Reference in New Issue Copy Permalink