virtualx-engine/doc/classes/CheckBox.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CheckBox" inherits="Button" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A button that represents a binary choice.
	</brief_description>
	<description>
		[CheckBox] allows the user to choose one of only 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 example, it could be used when toggling it will only do something once a confirmation button is pressed.
		See also [BaseButton] which contains common properties and methods associated with this node.
		When [member BaseButton.button_group] specifies a [ButtonGroup], [CheckBox] changes its appearance to that of a radio button and uses the various [code]radio_*[/code] theme properties.
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="alignment" type="int" setter="set_text_alignment" getter="get_text_alignment" overrides="Button" enum="HorizontalAlignment" default="0" />
		<member name="toggle_mode" type="bool" setter="set_toggle_mode" getter="is_toggle_mode" overrides="BaseButton" default="true" />
	</members>
	<theme_items>
		<theme_item name="check_v_offset" data_type="constant" type="int" default="0">
			The vertical offset used when rendering the check icons (in pixels).
		</theme_item>
		<theme_item name="checked" data_type="icon" type="Texture2D">
			The check icon to display when the [CheckBox] is checked.
		</theme_item>
		<theme_item name="checked_disabled" data_type="icon" type="Texture2D">
			The check icon to display when the [CheckBox] is checked and is disabled.
		</theme_item>
		<theme_item name="radio_checked" data_type="icon" type="Texture2D">
			The check icon to display when the [CheckBox] is configured as a radio button and is checked.
		</theme_item>
		<theme_item name="radio_checked_disabled" data_type="icon" type="Texture2D">
			The check icon to display when the [CheckBox] is configured as a radio button, is disabled, and is unchecked.
		</theme_item>
		<theme_item name="radio_unchecked" data_type="icon" type="Texture2D">
			The check icon to display when the [CheckBox] is configured as a radio button and is unchecked.
		</theme_item>
		<theme_item name="radio_unchecked_disabled" data_type="icon" type="Texture2D">
			The check icon to display when the [CheckBox] is configured as a radio button, is disabled, and is unchecked.
		</theme_item>
		<theme_item name="unchecked" data_type="icon" type="Texture2D">
			The check icon to display when the [CheckBox] is unchecked.
		</theme_item>
		<theme_item name="unchecked_disabled" data_type="icon" type="Texture2D">
			The check icon to display when the [CheckBox] is unchecked and is disabled.
		</theme_item>
	</theme_items>
</class>
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" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 10:08:05 +02:00			`<class name="CheckBox" inherits="Button" 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>`
Overhaul the top sections of the class reference (GUI classes) 2023-04-30 16:26:09 +02: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-12 22:42:36 +02:00			`</brief_description>`
			`<description>`
Overhaul the top sections of the class reference (GUI classes) 2023-04-30 16:26:09 +02:00			`[CheckBox] allows the user to choose one of only 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 example, it could 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-23 23:34:28 +02:00			`See also [BaseButton] which contains common properties and methods associated with this node.`
Overhaul the top sections of the class reference (GUI classes) 2023-04-30 16:26:09 +02:00			`When [member BaseButton.button_group] specifies a [ButtonGroup], [CheckBox] changes its appearance to that of a radio button and uses the various [code]radio_*[/code] theme properties.`
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>`
Run doctool after overridden properties changes 2019-09-03 12:44:58 +02:00			`<members>`
align to horizontal_alignment, valign to vertical_alignment, related 2021-11-25 03:58:47 +01: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-02 20:38:49 +01: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 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			`<theme_items>`
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-06 19:09:32 +02: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-01 19:02:20 +01:00			`The vertical offset used when rendering the check icons (in pixels).`
Update class documentation xml 2018-10-07 15:52:07 +02:00			`</theme_item>`
Sort and group theme properties in docs, improve formatting for theme and enums 2021-12-01 19:02:20 +01:00			`<theme_item name="checked" data_type="icon" type="Texture2D">`
			`The check icon to display when the [CheckBox] is checked.`
			`</theme_item>`
			`<theme_item name="checked_disabled" data_type="icon" type="Texture2D">`
Add documentation to CheckBox 2022-03-26 03:12:13 +01:00			`The check icon to display when the [CheckBox] is checked and 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>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="radio_checked" data_type="icon" type="Texture2D">`
Add documentation to CheckBox 2022-03-26 03:12:13 +01:00			`The check icon to display when the [CheckBox] is configured as a radio button and 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-04 18:54:41 +02:00			`<theme_item name="radio_checked_disabled" data_type="icon" type="Texture2D">`
Add documentation to CheckBox 2022-03-26 03:12:13 +01:00			`The check icon to display when the [CheckBox] is configured as a radio button, is disabled, and is unchecked.`
doc: Sync classref with current source 2021-03-25 12:19:51 +01:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="radio_unchecked" data_type="icon" type="Texture2D">`
Add documentation to CheckBox 2022-03-26 03:12:13 +01:00			`The check icon to display when the [CheckBox] is configured as a radio button and 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-04 18:54:41 +02:00			`<theme_item name="radio_unchecked_disabled" data_type="icon" type="Texture2D">`
Add documentation to CheckBox 2022-03-26 03:12:13 +01:00			`The check icon to display when the [CheckBox] is configured as a radio button, is disabled, and is unchecked.`
doc: Sync classref with current source 2021-03-25 12:19:51 +01:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="unchecked" data_type="icon" type="Texture2D">`
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. 2020-01-30 20:02:27 +01: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-12 22:42:36 +02:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02:00			`<theme_item name="unchecked_disabled" data_type="icon" type="Texture2D">`
Add documentation to CheckBox 2022-03-26 03:12:13 +01:00			`The check icon to display when the [CheckBox] is unchecked and is disabled.`
doc: Sync classref with current source 2021-03-25 12:19:51 +01: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_items>`
			`</class>`