pandemonium_engine/doc/classes/CheckBox.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CheckBox" inherits="Button" version="3.7">
	<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>
	<methods>
	</methods>
	<members>
		<member name="align" type="int" setter="set_text_align" getter="get_text_align" overrides="Button" enum="Button.TextAlign" default="0" />
		<member name="toggle_mode" type="bool" setter="set_toggle_mode" getter="is_toggle_mode" overrides="BaseButton" default="true" />
	</members>
	<constants>
	</constants>
	<theme_items>
		<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_color_disabled" 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_color_focus" 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_color_hover" 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_color_hover_pressed" 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_color_pressed" 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="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="hseparation" data_type="constant" type="int" default="4">
			The separation between the check icon and the text (in pixels).
		</theme_item>
		<theme_item name="font" data_type="font" type="Font">
			The [Font] to use for the [CheckBox] text.
		</theme_item>
		<theme_item name="checked" data_type="icon" type="Texture">
			The check icon to display when the [CheckBox] is checked.
		</theme_item>
		<theme_item name="checked_disabled" data_type="icon" type="Texture">
			The check icon to display when the [CheckBox] is checked and disabled.
		</theme_item>
		<theme_item name="radio_checked" data_type="icon" type="Texture">
			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="Texture">
		</theme_item>
		<theme_item name="radio_unchecked" data_type="icon" type="Texture">
			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="Texture">
		</theme_item>
		<theme_item name="unchecked" data_type="icon" type="Texture">
			The check icon to display when the [CheckBox] is unchecked.
		</theme_item>
		<theme_item name="unchecked_disabled" data_type="icon" type="Texture">
			The check icon to display when the [CheckBox] is unchecked 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="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="normal" data_type="style" type="StyleBox">
			The [StyleBox] to display as a background.
		</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_items>
</class>