2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								<?xml version="1.0" encoding="UTF-8" ?>  
						 
					
						
							
								
									
										
										
										
											2020-01-26 16:01:49 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								<class  name= "CheckButton"  inherits= "Button"  version= "3.2" >  
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
									<brief_description > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-30 20:02:27 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										Checkable button. See also [CheckBox].
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
									</brief_description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									<description > 
							 
						 
					
						
							
								
									
										
										
										
											2020-09-18 14:09:51 +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 instance, it should be used if toggling it enables/disables a setting without requiring the user to press a confirmation button.
							 
						 
					
						
							
								
									
										
										
										
											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> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									<methods > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									</methods> 
							 
						 
					
						
							
								
									
										
										
										
											2019-09-03 13:44:58 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
									<members > 
							 
						 
					
						
							
								
									
										
										
										
											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"  /> 
							 
						 
					
						
							
								
									
										
										
										
											2019-09-03 13:44:58 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
									</members> 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
									<constants > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									</constants> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									<theme_items > 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 12:38:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "check_vadjust"  type= "int"  default= "0" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-30 20:02:27 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The vertical offset used when rendering the toggle icons (in pixels).
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<theme_item  name= "disabled"  type= "StyleBox" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-30 20:02:27 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The [StyleBox] to display as a background when the [CheckButton] is disabled.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<theme_item  name= "focus"  type= "StyleBox" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-30 20:02:27 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The [StyleBox] to display as a background when the [CheckButton] is focused.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<theme_item  name= "font"  type= "Font" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-30 20:02:27 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The [Font] to use for the [CheckButton] text.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2019-07-09 09:13:00 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "font_color"  type= "Color"  default= "Color( 0.88, 0.88, 0.88, 1 )" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-30 20:02:27 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The [CheckButton] text's font color.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 12:38:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "font_color_disabled"  type= "Color"  default= "Color( 0.9, 0.9, 0.9, 0.2 )" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-30 20:02:27 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The [CheckButton] text's font color when it's disabled.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2019-07-09 09:13:00 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "font_color_hover"  type= "Color"  default= "Color( 0.94, 0.94, 0.94, 1 )" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-30 20:02:27 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The [CheckButton] text's font color when it's hovered.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 12:38:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "font_color_hover_pressed"  type= "Color"  default= "Color( 1, 1, 1, 1 )" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-30 20:02:27 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The [CheckButton] text's font color when it's hovered and pressed.
							 
						 
					
						
							
								
									
										
										
										
											2018-10-07 21:52:07 +08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 12:38:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "font_color_pressed"  type= "Color"  default= "Color( 1, 1, 1, 1 )" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-30 20:02:27 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The [CheckButton] text's font color when it's pressed.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<theme_item  name= "hover"  type= "StyleBox" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-30 20:02:27 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The [StyleBox] to display as a background when the [CheckButton] is hovered.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2018-10-07 21:52:07 +08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "hover_pressed"  type= "StyleBox" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-30 20:02:27 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The [StyleBox] to display as a background when the [CheckButton] is hovered and pressed.
							 
						 
					
						
							
								
									
										
										
										
											2018-10-07 21:52:07 +08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 12:38:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "hseparation"  type= "int"  default= "4" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-30 20:02:27 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The separation between the toggle icon and the text (in pixels).
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<theme_item  name= "normal"  type= "StyleBox" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-30 20:02:27 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The [StyleBox] to display as a background.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<theme_item  name= "off"  type= "Texture" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-30 20:02:27 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The icon to display when the [CheckButton] is unchecked.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2019-05-15 12:51:58 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "off_disabled"  type= "Texture" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-30 20:02:27 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The icon to display when the [CheckButton] is unchecked and disabled.
							 
						 
					
						
							
								
									
										
										
										
											2019-05-15 12:51:58 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										<theme_item  name= "on"  type= "Texture" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-30 20:02:27 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The icon to display when the [CheckButton] is checked.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2019-05-15 12:51:58 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "on_disabled"  type= "Texture" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-30 20:02:27 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The icon to display when the [CheckButton] is checked and disabled.
							 
						 
					
						
							
								
									
										
										
										
											2019-05-15 12:51:58 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										<theme_item  name= "pressed"  type= "StyleBox" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-30 20:02:27 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The [StyleBox] to display as a background when the [CheckButton] is pressed.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									</theme_items> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								</class>