Unity - Scripting API: EditorGUI.Toggle

static function Toggle(position: Rect, value: bool): bool;

static bool Toggle(Rect position, bool value);

static def Toggle(position as Rect, value as bool) as bool

static function Toggle(position: Rect, label: string, value: bool): bool;

static bool Toggle(Rect position, string label, bool value);

static def Toggle(position as Rect, label as string, value as bool) as bool

static function Toggle(position: Rect, value: bool, style: GUIStyle): bool;

static bool Toggle(Rect position, bool value, GUIStyle style);

static def Toggle(position as Rect, value as bool, style as GUIStyle) as bool

static function Toggle(position: Rect, label: string, value: bool, style: GUIStyle): bool;

static bool Toggle(Rect position, string label, bool value, GUIStyle style);

static def Toggle(position as Rect, label as string, value as bool, style as GUIStyle) as bool

static function Toggle(position: Rect, label: GUIContent, value: bool): bool;

static bool Toggle(Rect position, GUIContent label, bool value);

static def Toggle(position as Rect, label as GUIContent, value as bool) as bool

static function Toggle(position: Rect, label: GUIContent, value: bool, style: GUIStyle): bool;

static bool Toggle(Rect position, GUIContent label, bool value, GUIStyle style);

static def Toggle(position as Rect, label as GUIContent, value as bool, style as GUIStyle) as bool

Parameters

position	Rectangle on the screen to use for the toggle.
label	Optional label in front of the toggle.
value	The shown state of the toggle.
style	Optional GUIStyle.

Returns

bool The selected state of the toggle.

Description

Make a toggle.

Toggle control in an Editor Window.

	// Use a toggle button to show/hide a button that can close the window.
	
	class EditorGUIToggle extends EditorWindow {
	
		var showClose : boolean = true;
	
		@MenuItem("Examples/EditorGUI Toggle usage")
		static function Init() {
			var window = GetWindow(EditorGUIToggle);
			window.Show();
		}
		
		function OnGUI() {
			showClose = EditorGUI.Toggle(Rect(0,5,position.width,20),
						"Show Close Button",
						showClose);
			if(showClose)
				if(GUI.Button(Rect(0, 25, position.width, 100),"Close Window!"))
					this.Close();
		}
	}

Script language:

Script language

Scripting API

EditorGUI.Toggle

Parameters

Returns

Description