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
1d0bd2f212
godot/doc/classes/CheckButton.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

98 lines
6.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" ?>
Bump version to 4.1-dev Can't stop, won't stop, they said, huh?
2023-03-01 08:44:37 +08:00
<class name="CheckButton" inherits="Button" version="4.1" 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-13 04:42:36 +08:00
<brief_description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 22:26:09 +08:00
A button that represents a binary choice.
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>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 22:26:09 +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 example, it can be used when pressing it shows or hides advanced settings, without asking the user to confirm this action.
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>
align to horizontal_alignment, valign to vertical_alignment, related
2021-11-25 10:58:47 +08:00
<member name="alignment" type="int" setter="set_text_alignment" getter="get_text_alignment" overrides="Button" enum="HorizontalAlignment" default="0" />
Make overridden properties link to parent definition Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-03 03:38:49 +08:00
<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 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>
Improve the default project theme The new default project theme uses StyleBoxFlat extensively for a more modern design and better scalability to multiple resolutions. SVG icons are now used in place of PNG icons. While this does not allow for true vector-based icon drawing (icons are still rasterized at load-time), this makes the design work easier for contributors and opens the door to vector drawing in the future (e.g. with polygons or SDFs). Like for editor icons, the SVG header file is now built automatically when a SVG file is changed. This removing the need for running `make_header.py` manually (TODO). The "Use Hidpi" project setting has been removed in favor of a "Default Theme Scale" project setting, which allows creating the default theme at a higher/lower scale than the default. This can be used when designing GUIs with a high base resolution to ensure crisp visuals. Co-authored-by: Yuri Sizov <yuris@humnom.net>
2021-12-31 00:22:06 +08:00
<theme_item name="font_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 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>
Improve the default project theme The new default project theme uses StyleBoxFlat extensively for a more modern design and better scalability to multiple resolutions. SVG icons are now used in place of PNG icons. While this does not allow for true vector-based icon drawing (icons are still rasterized at load-time), this makes the design work easier for contributors and opens the door to vector drawing in the future (e.g. with polygons or SDFs). Like for editor icons, the SVG header file is now built automatically when a SVG file is changed. This removing the need for running `make_header.py` manually (TODO). The "Use Hidpi" project setting has been removed in favor of a "Default Theme Scale" project setting, which allows creating the default theme at a higher/lower scale than the default. This can be used when designing GUIs with a high base resolution to ensure crisp visuals. Co-authored-by: Yuri Sizov <yuris@humnom.net>
2021-12-31 00:22:06 +08:00
<theme_item name="font_disabled_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 0.5)">
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>
Improve the default project theme The new default project theme uses StyleBoxFlat extensively for a more modern design and better scalability to multiple resolutions. SVG icons are now used in place of PNG icons. While this does not allow for true vector-based icon drawing (icons are still rasterized at load-time), this makes the design work easier for contributors and opens the door to vector drawing in the future (e.g. with polygons or SDFs). Like for editor icons, the SVG header file is now built automatically when a SVG file is changed. This removing the need for running `make_header.py` manually (TODO). The "Use Hidpi" project setting has been removed in favor of a "Default Theme Scale" project setting, which allows creating the default theme at a higher/lower scale than the default. This can be used when designing GUIs with a high base resolution to ensure crisp visuals. Co-authored-by: Yuri Sizov <yuris@humnom.net>
2021-12-31 00:22:06 +08:00
<theme_item name="font_focus_color" data_type="color" type="Color" default="Color(0.95, 0.95, 0.95, 1)">
Add focus font color to Button and derivatives
2021-10-26 22:28:12 +08:00
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>
Improve the default project theme The new default project theme uses StyleBoxFlat extensively for a more modern design and better scalability to multiple resolutions. SVG icons are now used in place of PNG icons. While this does not allow for true vector-based icon drawing (icons are still rasterized at load-time), this makes the design work easier for contributors and opens the door to vector drawing in the future (e.g. with polygons or SDFs). Like for editor icons, the SVG header file is now built automatically when a SVG file is changed. This removing the need for running `make_header.py` manually (TODO). The "Use Hidpi" project setting has been removed in favor of a "Default Theme Scale" project setting, which allows creating the default theme at a higher/lower scale than the default. This can be used when designing GUIs with a high base resolution to ensure crisp visuals. Co-authored-by: Yuri Sizov <yuris@humnom.net>
2021-12-31 00:22:06 +08:00
<theme_item name="font_hover_color" data_type="color" type="Color" default="Color(0.95, 0.95, 0.95, 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>
Improve naming of theme properties throughout GUI code Rename ItemList's bg -> panel Rename ItemList's bg_focus -> focus Rename ProgressBar's bg -> background Rename ProgressBar's fg -> fill Rename Tree's bg -> panel Rename Tree's bg_focus -> focus Rename ScrollContainer's bg -> panel Rename FileDialog's *_icon_modulate -> *_icon_color Rename FileDialog's files_disabled -> file_disabled_color Rename CheckButton's on/off -> checked/unchecked Rename check_v_adjust -> check_v_offset
2022-09-07 01:09:32 +08:00
<theme_item name="check_v_offset" data_type="constant" type="int" default="0">
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-02 02:02:20 +08:00
The vertical offset used when rendering the toggle icons (in pixels).
Update class documentation xml
2018-10-07 21:52:07 +08:00
</theme_item>
Rename theme properties to include underscores - check_vadjust -> check_v_adjust - close_h_ofs -> close_h_offset - close_v_ofs -> close_v_offset - commentfocus -> comment_focus - hseparation -> h_separation - ofs -> offset - selectedframe -> selected_frame - state_machine_selectedframe -> state_machine_selected_frame - table_hseparation -> table_h_separation - table_vseparation -> table_v_separation - vseparation -> v_separation
2022-04-15 05:20:28 +08:00
<theme_item name="h_separation" data_type="constant" type="int" default="4">
Fix case where `h_separation` might not work in `Button` This patch mainly solves two things: 1. The typo of `h_separation`; 2. Negative values of `h_separation` will be treated as `0` when used, to prevent the button's minimum `width` from being reduced by `h_separation`.
2022-08-12 19:39:22 +08:00
The separation between the toggle icon and the text (in pixels). Negative values will be treated as [code]0[/code] when used.
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>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-02 02:02:20 +08:00
<theme_item name="outline_size" data_type="constant" type="int" default="0">
The size of the text outline.
Document MDSF font outlines may require `msdf_pixel_range` adjustments
2022-12-20 00:15:44 +08:00
[b]Note:[/b] If using a font with [member FontFile.multichannel_signed_distance_field] enabled, its [member FontFile.msdf_pixel_range] must be set to at least [i]twice[/i] the value of [theme_item outline_size] for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-02 02:02:20 +08:00
</theme_item>
<theme_item name="font" data_type="font" type="Font">
The [Font] to use for the [CheckButton] text.
</theme_item>
<theme_item name="font_size" data_type="font_size" type="int">
Font size of the [CheckButton]'s 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>
Improve naming of theme properties throughout GUI code Rename ItemList's bg -> panel Rename ItemList's bg_focus -> focus Rename ProgressBar's bg -> background Rename ProgressBar's fg -> fill Rename Tree's bg -> panel Rename Tree's bg_focus -> focus Rename ScrollContainer's bg -> panel Rename FileDialog's *_icon_modulate -> *_icon_color Rename FileDialog's files_disabled -> file_disabled_color Rename CheckButton's on/off -> checked/unchecked Rename check_v_adjust -> check_v_offset
2022-09-07 01:09:32 +08:00
<theme_item name="checked" 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>
Improve naming of theme properties throughout GUI code Rename ItemList's bg -> panel Rename ItemList's bg_focus -> focus Rename ProgressBar's bg -> background Rename ProgressBar's fg -> fill Rename Tree's bg -> panel Rename Tree's bg_focus -> focus Rename ScrollContainer's bg -> panel Rename FileDialog's *_icon_modulate -> *_icon_color Rename FileDialog's files_disabled -> file_disabled_color Rename CheckButton's on/off -> checked/unchecked Rename check_v_adjust -> check_v_offset
2022-09-07 01:09:32 +08:00
<theme_item name="checked_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>
Improve naming of theme properties throughout GUI code Rename ItemList's bg -> panel Rename ItemList's bg_focus -> focus Rename ProgressBar's bg -> background Rename ProgressBar's fg -> fill Rename Tree's bg -> panel Rename Tree's bg_focus -> focus Rename ScrollContainer's bg -> panel Rename FileDialog's *_icon_modulate -> *_icon_color Rename FileDialog's files_disabled -> file_disabled_color Rename CheckButton's on/off -> checked/unchecked Rename check_v_adjust -> check_v_offset
2022-09-07 01:09:32 +08:00
<theme_item name="checked_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>
Improve naming of theme properties throughout GUI code Rename ItemList's bg -> panel Rename ItemList's bg_focus -> focus Rename ProgressBar's bg -> background Rename ProgressBar's fg -> fill Rename Tree's bg -> panel Rename Tree's bg_focus -> focus Rename ScrollContainer's bg -> panel Rename FileDialog's *_icon_modulate -> *_icon_color Rename FileDialog's files_disabled -> file_disabled_color Rename CheckButton's on/off -> checked/unchecked Rename check_v_adjust -> check_v_offset
2022-09-07 01:09:32 +08:00
<theme_item name="checked_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>
Improve naming of theme properties throughout GUI code Rename ItemList's bg -> panel Rename ItemList's bg_focus -> focus Rename ProgressBar's bg -> background Rename ProgressBar's fg -> fill Rename Tree's bg -> panel Rename Tree's bg_focus -> focus Rename ScrollContainer's bg -> panel Rename FileDialog's *_icon_modulate -> *_icon_color Rename FileDialog's files_disabled -> file_disabled_color Rename CheckButton's on/off -> checked/unchecked Rename check_v_adjust -> check_v_offset
2022-09-07 01:09:32 +08:00
<theme_item name="unchecked" data_type="icon" type="Texture2D">
The icon to display when the [CheckButton] is unchecked (for left-to-right layouts).
</theme_item>
<theme_item name="unchecked_disabled" data_type="icon" type="Texture2D">
The icon to display when the [CheckButton] is unchecked and disabled (for left-to-right layouts).
</theme_item>
<theme_item name="unchecked_disabled_mirrored" data_type="icon" type="Texture2D">
The icon to display when the [CheckButton] is unchecked and disabled (for right-to-left layouts).
</theme_item>
<theme_item name="unchecked_mirrored" data_type="icon" type="Texture2D">
The icon to display when the [CheckButton] is unchecked (for right-to-left layouts).
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-02 02:02:20 +08: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">
Document that transparent StyleBoxes/textures should be used for UI focus
2021-11-21 00:43:34 +08:00
The [StyleBox] to display as a background when the [CheckButton] is focused. The [code]focus[/code] [StyleBox] is displayed [i]over[/i] the base [StyleBox], so a partially transparent [StyleBox] should be used to ensure the base [StyleBox] remains visible. A [StyleBox] that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a [StyleBoxEmpty] resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-02 02:02:20 +08:00
</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.
[CTL] Add missing font outline drawing routines and theme constants.
2020-12-26 05:45:28 +08:00
</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