virtualx-engine/doc/classes/CheckButton.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CheckButton" 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>
		[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.
		See also [BaseButton] which contains common properties and methods associated with this node.
	</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 toggle icons (in pixels).
		</theme_item>
		<theme_item name="checked" data_type="icon" type="Texture2D">
			The icon to display when the [CheckButton] is checked (for left-to-right layouts).
		</theme_item>
		<theme_item name="checked_disabled" data_type="icon" type="Texture2D">
			The icon to display when the [CheckButton] is checked and disabled (for left-to-right layouts).
		</theme_item>
		<theme_item name="checked_disabled_mirrored" data_type="icon" type="Texture2D">
			The icon to display when the [CheckButton] is checked and disabled (for right-to-left layouts).
		</theme_item>
		<theme_item name="checked_mirrored" data_type="icon" type="Texture2D">
			The icon to display when the [CheckButton] is checked (for right-to-left layouts).
		</theme_item>
		<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>
	</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="CheckButton" 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			`[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-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>`
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 toggle icons (in pixels).`
Update class documentation xml 2018-10-07 15:52:07 +02: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-06 19:09:32 +02: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 13:49:10 +02: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-12 22:42:36 +02: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-06 19:09:32 +02: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 13:49:10 +02: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-06 19:09:32 +02: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 13:49:10 +02: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-06 19:09:32 +02: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 13:49:10 +02:00			`The icon to display when the [CheckButton] is checked (for right-to-left layouts).`
doc: Sync classref with current source 2019-05-15 12:51:58 +02: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-06 19:09:32 +02: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>`
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>`