virtualx-engine/doc/classes/CheckBox.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CheckBox" inherits="Button" version="4.0">
	<brief_description>
		Binary choice user interface widget. See also [CheckButton].
	</brief_description>
	<description>
		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.
		See also [BaseButton] which contains common properties and methods associated with this node.
	</description>
	<tutorials>
	</tutorials>
	<members>
		<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" />
	</members>
	<theme_items>
		<theme_item name="check_vadjust" 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 disabled.
		</theme_item>
		<theme_item name="disabled" data_type="style" type="StyleBox">
			The [StyleBox] to display as a background when the [CheckBox] is disabled.
		</theme_item>
		<theme_item name="focus" data_type="style" type="StyleBox">
			The [StyleBox] to display as a background when the [CheckBox] is focused.
		</theme_item>
		<theme_item name="font" data_type="font" type="Font">
			The [Font] to use for the [CheckBox] text.
		</theme_item>
		<theme_item name="font_color" data_type="color" type="Color" default="Color(0.88, 0.88, 0.88, 1)">
			The [CheckBox] text's font color.
		</theme_item>
		<theme_item name="font_disabled_color" data_type="color" type="Color" default="Color(0.9, 0.9, 0.9, 0.2)">
			The [CheckBox] text's font color when it's disabled.
		</theme_item>
		<theme_item name="font_focus_color" data_type="color" type="Color" default="Color(0.94, 0.94, 0.94, 1)">
			The [CheckBox] text's font color when it's focused. Only replaces the normal text color of the checkbox. Disabled, hovered, and pressed states take precedence over this color.
		</theme_item>
		<theme_item name="font_hover_color" data_type="color" type="Color" default="Color(0.94, 0.94, 0.94, 1)">
			The [CheckBox] text's font color when it's hovered.
		</theme_item>
		<theme_item name="font_hover_pressed_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
			The [CheckBox] text's font color when it's hovered and pressed.
		</theme_item>
		<theme_item name="font_outline_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
			The tint of text outline of the [CheckBox].
		</theme_item>
		<theme_item name="font_pressed_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
			The [CheckBox] text's font color when it's pressed.
		</theme_item>
		<theme_item name="font_size" data_type="font_size" type="int">
			Font size of the [CheckBox]'s text.
		</theme_item>
		<theme_item name="hover" data_type="style" type="StyleBox">
			The [StyleBox] to display as a background when the [CheckBox] is hovered.
		</theme_item>
		<theme_item name="hover_pressed" data_type="style" type="StyleBox">
			The [StyleBox] to display as a background when the [CheckBox] is hovered and pressed.
		</theme_item>
		<theme_item name="hseparation" data_type="constant" type="int" default="4">
			The separation between the check icon and the text (in pixels).
		</theme_item>
		<theme_item name="normal" data_type="style" type="StyleBox">
			The [StyleBox] to display as a background.
		</theme_item>
		<theme_item name="outline_size" data_type="constant" type="int" default="0">
			The size of the text outline.
		</theme_item>
		<theme_item name="pressed" data_type="style" type="StyleBox">
			The [StyleBox] to display as a background when the [CheckBox] is pressed.
		</theme_item>
		<theme_item name="radio_checked" data_type="icon" type="Texture2D">
			If the [CheckBox] is configured as a radio button, the icon to display when the [CheckBox] is checked.
		</theme_item>
		<theme_item name="radio_checked_disabled" data_type="icon" type="Texture2D">
		</theme_item>
		<theme_item name="radio_unchecked" data_type="icon" type="Texture2D">
			If the [CheckBox] is configured as a radio button, the icon to display when the [CheckBox] is unchecked.
		</theme_item>
		<theme_item name="radio_unchecked_disabled" data_type="icon" type="Texture2D">
		</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 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" ?>`
Update docs to version 4.0 2020-02-01 02:03:48 +01: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-12 22:42:36 +02:00			`<brief_description>`
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. 2020-01-30 20:02:27 +01: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-12 22:42:36 +02:00			`</brief_description>`
			`<description>`
Fix various typos Found via `codespell` 2020-03-11 18:59:18 +01: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-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>`
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 13:34:03 +02: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 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>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02: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-30 20:02:27 +01: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-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="checked" 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 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="checked_disabled" data_type="icon" type="Texture2D">`
Add focus font color to Button and derivatives 2021-10-26 16:28:12 +02:00			`The check icon to display when the [CheckBox] is checked and disabled.`
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="disabled" data_type="style" type="StyleBox">`
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 [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-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="focus" data_type="style" type="StyleBox">`
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 [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-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="font" data_type="font" type="Font">`
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 [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-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="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-30 20:02:27 +01: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-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="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-30 20:02:27 +01: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-12 22:42:36 +02:00			`</theme_item>`
Add focus font color to Button and derivatives 2021-10-26 16:28:12 +02:00			`<theme_item name="font_focus_color" data_type="color" type="Color" default="Color(0.94, 0.94, 0.94, 1)">`
			`The [CheckBox] text's font color when it's focused. Only replaces the normal text color of the checkbox. Disabled, hovered, and pressed states take precedence over this color.`
			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02: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-30 20:02:27 +01: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-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="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-30 20:02:27 +01:00			`The [CheckBox] text's font color when it's hovered and pressed.`
Update class documentation xml 2018-10-07 15:52:07 +02:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02: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-25 22:45:28 +01:00			`The tint of text outline of the [CheckBox].`
			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02: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-30 20:02:27 +01: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-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="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 13:49:10 +02:00			`Font size of the [CheckBox]'s text.`
			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02: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-30 20:02:27 +01: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-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="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-30 20:02:27 +01:00			`The [StyleBox] to display as a background when the [CheckBox] is hovered and pressed.`
Update class documentation xml 2018-10-07 15:52:07 +02:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02: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-30 20:02:27 +01: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-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="normal" data_type="style" type="StyleBox">`
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 [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-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="outline_size" data_type="constant" type="int" default="0">`
[CTL] Add missing font outline drawing routines and theme constants. 2020-12-25 22:45:28 +01:00			`The size of the text outline.`
			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-04 18:54:41 +02: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-30 20:02:27 +01: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-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">`
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. 2020-01-30 20:02:27 +01: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-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">`
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">`
Improve the CheckBox and CheckButton class documentations This makes the CheckBox and CheckButton classes 100% documented. 2020-01-30 20:02:27 +01: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-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">`
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 focus font color to Button and derivatives 2021-10-26 16:28:12 +02:00			`The check icon to display when the [CheckBox] is unchecked and 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>`