2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								<?xml version="1.0" encoding="UTF-8" ?>  
						 
					
						
							
								
									
										
										
										
											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" >  
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
									<brief_description > 
							 
						 
					
						
							
								
									
										
										
										
											2023-04-30 16:26:09 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										A button that represents a binary choice.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
									</brief_description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									<description > 
							 
						 
					
						
							
								
									
										
										
										
											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.
							 
						 
					
						
							
								
									
										
										
										
											2020-09-23 23:34:28 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										See also [BaseButton] which contains common properties and methods associated with this node.
							 
						 
					
						
							
								
									
										
										
										
											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.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
									</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									<tutorials > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									</tutorials> 
							 
						 
					
						
							
								
									
										
										
										
											2019-09-03 13:44:58 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
									<members > 
							 
						 
					
						
							
								
									
										
										
										
											2021-11-24 20:58:47 -06:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "alignment"  type= "int"  setter= "set_text_alignment"  getter= "get_text_alignment"  overrides= "Button"  enum= "HorizontalAlignment"  default= "0"  /> 
							 
						 
					
						
							
								
									
										
										
										
											2021-12-02 22:38:49 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "toggle_mode"  type= "bool"  setter= "set_toggle_mode"  getter= "is_toggle_mode"  overrides= "BaseButton"  default= "true"  /> 
							 
						 
					
						
							
								
									
										
										
										
											2019-09-03 13:44:58 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
									</members> 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
									<theme_items > 
							 
						 
					
						
							
								
									
										
										
										
											2022-09-06 20:09:32 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "check_v_offset"  data_type= "constant"  type= "int"  default= "0" > 
							 
						 
					
						
							
								
									
										
										
										
											2021-12-01 21:02:20 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The vertical offset used when rendering the check icons (in pixels).
							 
						 
					
						
							
								
									
										
										
										
											2018-10-07 21:52:07 +08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2021-12-01 21:02:20 +03: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" > 
							 
						 
					
						
							
								
									
										
										
										
											2022-03-25 19:12:13 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The check icon to display when the [CheckBox] is checked and is disabled.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2021-08-04 19:54:41 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "radio_checked"  data_type= "icon"  type= "Texture2D" > 
							 
						 
					
						
							
								
									
										
										
										
											2022-03-25 19:12:13 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The check icon to display when the [CheckBox] is configured as a radio button and is checked.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2021-08-04 19:54:41 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "radio_checked_disabled"  data_type= "icon"  type= "Texture2D" > 
							 
						 
					
						
							
								
									
										
										
										
											2022-03-25 19:12:13 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The check icon to display when the [CheckBox] is configured as a radio button, is disabled, and is unchecked.
							 
						 
					
						
							
								
									
										
										
										
											2021-03-25 12:19:51 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2021-08-04 19:54:41 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "radio_unchecked"  data_type= "icon"  type= "Texture2D" > 
							 
						 
					
						
							
								
									
										
										
										
											2022-03-25 19:12:13 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The check icon to display when the [CheckBox] is configured as a radio button and is unchecked.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2021-08-04 19:54:41 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "radio_unchecked_disabled"  data_type= "icon"  type= "Texture2D" > 
							 
						 
					
						
							
								
									
										
										
										
											2022-03-25 19:12:13 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The check icon to display when the [CheckBox] is configured as a radio button, is disabled, and is unchecked.
							 
						 
					
						
							
								
									
										
										
										
											2021-03-25 12:19:51 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2021-08-04 19:54:41 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "unchecked"  data_type= "icon"  type= "Texture2D" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-30 20:02:27 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The check icon to display when the [CheckBox] is unchecked.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2021-08-04 19:54:41 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "unchecked_disabled"  data_type= "icon"  type= "Texture2D" > 
							 
						 
					
						
							
								
									
										
										
										
											2022-03-25 19:12:13 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The check icon to display when the [CheckBox] is unchecked and is disabled.
							 
						 
					
						
							
								
									
										
										
										
											2021-03-25 12:19:51 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
									</theme_items> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								</class>