GUILayout.Toggle Manual     Reference     Scripting  
Scripting > Runtime Classes > GUILayout
GUILayout.Toggle

static function Toggle (value : bool, image : Texture, params options : GUILayoutOption[]) : bool

static function Toggle (value : bool, text : string, params options : GUILayoutOption[]) : bool

static function Toggle (value : bool, content : GUIContent, params options : GUILayoutOption[]) : bool

static function Toggle (value : bool, image : Texture, style : GUIStyle, params options : GUILayoutOption[]) : bool

static function Toggle (value : bool, text : string, style : GUIStyle, params options : GUILayoutOption[]) : bool

static function Toggle (value : bool, content : GUIContent, style : GUIStyle, params options : GUILayoutOption[]) : bool

Parameters

NameDescription
value Is the button on or off?
text Text to display on the button.
image Texture to display on the button.
content Text, image and tooltip for this button.
style The style to use. If left out, the button style from the current GUISkin is used.
options An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.
See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight

Returns

bool - The new value of the button.

Description

Make an on/off toggle button.