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= "CheckButton"  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 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										[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.
							 
						 
					
						
							
								
									
										
										
										
											2020-09-23 23:34:28 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										See also [BaseButton] which contains common properties and methods associated with this node.
							 
						 
					
						
							
								
									
										
										
										
											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 toggle icons (in pixels).
							 
						 
					
						
							
								
									
										
										
										
											2018-10-07 21:52:07 +08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2022-09-06 20:09:32 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "checked"  data_type= "icon"  type= "Texture2D" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-08-12 14:49:10 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The icon to display when the [CheckButton] is checked (for left-to-right layouts).
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2022-09-06 20:09:32 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "checked_disabled"  data_type= "icon"  type= "Texture2D" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-08-12 14:49:10 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The icon to display when the [CheckButton] is checked and disabled (for left-to-right layouts).
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2022-09-06 20:09:32 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "checked_disabled_mirrored"  data_type= "icon"  type= "Texture2D" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-08-12 14:49:10 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The icon to display when the [CheckButton] is checked and disabled (for right-to-left layouts).
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2022-09-06 20:09:32 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "checked_mirrored"  data_type= "icon"  type= "Texture2D" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-08-12 14:49:10 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The icon to display when the [CheckButton] is checked (for right-to-left layouts).
							 
						 
					
						
							
								
									
										
										
										
											2019-05-15 12:51:58 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2022-09-06 20:09:32 +03: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> 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
									</theme_items> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								</class>