Class DebugUI.Foldout
Unity-like foldout that can be collapsed.
Inherited Members
Namespace: UnityEngine.Rendering
Syntax
public class Foldout : DebugUI.Container, DebugUI.IContainer, DebugUI.IValueField
Constructors
Foldout()
Constructor.
Declaration
public Foldout()
Foldout(String, ObservableList<DebugUI.Widget>, String[], String[])
Constructor.
Declaration
public Foldout(string displayName, ObservableList<DebugUI.Widget> children, string[] columnLabels = null, string[] columnTooltips = null)
Parameters
Type | Name | Description |
---|---|---|
String | displayName | Display name of the foldout. |
ObservableList<DebugUI.Widget> | children | List of attached children. |
String[] | columnLabels | Optional list of column names. |
String[] | columnTooltips | Optional list of tooltips for column name labels. |
Fields
contextMenuItems
Optional list of context menu items. If the list is not provided, no context menu button will be displayed.
Declaration
public List<DebugUI.Foldout.ContextMenuItem> contextMenuItems
Field Value
Type | Description |
---|---|
List<DebugUI.Foldout.ContextMenuItem> |
isHeader
Draw the foldout in full width using a header style.
Declaration
public bool isHeader
Field Value
Type | Description |
---|---|
Boolean |
opened
Opened state of the foldout.
Declaration
public bool opened
Field Value
Type | Description |
---|---|
Boolean |
Properties
columnLabels
List of columns labels.
Declaration
public string[] columnLabels { get; set; }
Property Value
Type | Description |
---|---|
String[] |
columnTooltips
List of columns label tooltips.
Declaration
public string[] columnTooltips { get; set; }
Property Value
Type | Description |
---|---|
String[] |
isReadOnly
Always false.
Declaration
public bool isReadOnly { get; }
Property Value
Type | Description |
---|---|
Boolean |
Methods
GetValue()
Get the opened state of the foldout.
Declaration
public bool GetValue()
Returns
Type | Description |
---|---|
Boolean | True if the foldout is opened. |
SetValue(Boolean)
Set the value of the widget.
Declaration
public void SetValue(bool value)
Parameters
Type | Name | Description |
---|---|---|
Boolean | value | Input value. |
SetValue(Object)
Set the opened state of the foldout.
Declaration
public void SetValue(object value)
Parameters
Type | Name | Description |
---|---|---|
Object | value | True to open the foldout, false to close it. |
Implements
ValidateValue(Object)
Validates the value of the widget before setting it.
Declaration
public object ValidateValue(object value)
Parameters
Type | Name | Description |
---|---|---|
Object | value | Input value. |
Returns
Type | Description |
---|---|
Object | The validated value. |
Implements
Explicit Interface Implementations
DebugUI.IValueField.GetValue()
Get the opened state of the foldout.
Declaration
object DebugUI.IValueField.GetValue()
Returns
Type | Description |
---|---|
Object | True if the foldout is opened. |