Class ReorderableListGUI

Utility class for drawing reorderable lists.

Inheritance

Object

ReorderableListGUI

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Unity.VisualScripting.ReorderableList

Syntax

public static class ReorderableListGUI

Fields

DefaultItemHeight

Default list item height is 18 pixels.

Declaration

public const float DefaultItemHeight = 18F

Field Value

Type	Description
Single

Properties

CurrentItemIndex

Gets the zero-based index of the list item that is currently being drawn; or a value of -1 if no item is currently being drawn.

Declaration

public static int CurrentItemIndex { get; }

Property Value

Type	Description
Int32

CurrentItemTotalPosition

Gets the total position of the list item that is currently being drawn.

Declaration

public static Rect CurrentItemTotalPosition { get; }

Property Value

Type	Description
Rect

Remarks

The value of this property should be ignored for Layout type events when using reorderable list controls with automatic layout.

CurrentListControlID

Gets the control ID of the list that is currently being drawn.

Declaration

public static int CurrentListControlID { get; }

Property Value

Type	Description
Int32

CurrentListPosition

Gets the position of the list control that is currently being drawn.

Declaration

public static Rect CurrentListPosition { get; }

Property Value

Type	Description
Rect

Remarks

The value of this property should be ignored for Layout type events when using reorderable list controls with automatic layout.

IndexOfChangedItem

Gets or sets the zero-based index of the last item that was changed. A value of -1 indicates that no item was changed by list.

Declaration

public static int IndexOfChangedItem { get; }

Property Value

Type	Description
Int32

Remarks

This property should not be set when items are added or removed.

Methods

CalculateListFieldHeight(Int32)

Calculate height of list field for absolute positioning.

Declaration

public static float CalculateListFieldHeight(int itemCount)

Parameters

Type	Name	Description
Int32	itemCount

Returns

Type	Description
Single	Required list height in pixels.

CalculateListFieldHeight(Int32, Single)

Calculate height of list field for absolute positioning.

Declaration

public static float CalculateListFieldHeight(int itemCount, float itemHeight)

Parameters

Type	Name	Description
Int32	itemCount
Single	itemHeight

Returns

Type	Description
Single	Required list height in pixels.

CalculateListFieldHeight(Int32, Single, ReorderableListFlags)

Calculate height of list field for absolute positioning.

Declaration

public static float CalculateListFieldHeight(int itemCount, float itemHeight, ReorderableListFlags flags)

Parameters

Type	Name	Description
Int32	itemCount	Count of items in list.
Single	itemHeight	Fixed height of list item.
ReorderableListFlags	flags	Optional flags to pass into list field.

Returns

Type	Description
Single	Required list height in pixels.

CalculateListFieldHeight(Int32, ReorderableListFlags)

Calculate height of list field for absolute positioning.

Declaration

public static float CalculateListFieldHeight(int itemCount, ReorderableListFlags flags)

Parameters

Type	Name	Description
Int32	itemCount
ReorderableListFlags	flags

Returns

Type	Description
Single	Required list height in pixels.

CalculateListFieldHeight(IReorderableListAdaptor)

Calculate height of list field for adapted collection.

Declaration

public static float CalculateListFieldHeight(IReorderableListAdaptor adaptor)

Parameters

Type	Name	Description
IReorderableListAdaptor	adaptor

Returns

Type	Description
Single	Required list height in pixels.

CalculateListFieldHeight(IReorderableListAdaptor, ReorderableListFlags)

Calculate height of list field for adapted collection.

Declaration

public static float CalculateListFieldHeight(IReorderableListAdaptor adaptor, ReorderableListFlags flags)

Parameters

Type	Name	Description
IReorderableListAdaptor	adaptor	Reorderable list adaptor.
ReorderableListFlags	flags	Optional flags to pass into list field.

Returns

Type	Description
Single	Required list height in pixels.

CalculateListFieldHeight(SerializedProperty)

Calculate height of list field for absolute positioning.

Declaration

public static float CalculateListFieldHeight(SerializedProperty arrayProperty)

Parameters

Type	Name	Description
SerializedProperty	arrayProperty

Returns

Type	Description
Single	Required list height in pixels.

CalculateListFieldHeight(SerializedProperty, ReorderableListFlags)

Calculate height of list field for absolute positioning.

Declaration

public static float CalculateListFieldHeight(SerializedProperty arrayProperty, ReorderableListFlags flags)

Parameters

Type	Name	Description
SerializedProperty	arrayProperty	Serializable property.
ReorderableListFlags	flags	Optional flags to pass into list field.

Returns

Type	Description
Single	Required list height in pixels.

DefaultItemDrawer<T>(Rect, T)

Default list item drawer implementation.

Declaration

public static T DefaultItemDrawer<T>(Rect position, T item)

Parameters

Type	Name	Description
Rect	position	Position to draw list item control(s).
T	item	Value of list item.

Returns

Type	Description
T	Unmodified value of list item.

Type Parameters

Name	Description
T	Type of list item.

Remarks

Always presents the label "Item drawer not implemented.".

ListField(IReorderableListAdaptor)

Declaration

public static void ListField(IReorderableListAdaptor adaptor)

Parameters

Type	Name	Description
IReorderableListAdaptor	adaptor

ListField(IReorderableListAdaptor, ReorderableListControl.DrawEmpty)

Declaration

public static void ListField(IReorderableListAdaptor adaptor, ReorderableListControl.DrawEmpty drawEmpty)

Parameters

Type	Name	Description
IReorderableListAdaptor	adaptor
ReorderableListControl.DrawEmpty	drawEmpty

ListField(IReorderableListAdaptor, ReorderableListControl.DrawEmpty, ReorderableListFlags)

Declaration

public static void ListField(IReorderableListAdaptor adaptor, ReorderableListControl.DrawEmpty drawEmpty, ReorderableListFlags flags)

Parameters

Type	Name	Description
IReorderableListAdaptor	adaptor
ReorderableListControl.DrawEmpty	drawEmpty
ReorderableListFlags	flags

ListField(IReorderableListAdaptor, ReorderableListFlags)

Declaration

public static void ListField(IReorderableListAdaptor adaptor, ReorderableListFlags flags)

Parameters

Type	Name	Description
IReorderableListAdaptor	adaptor
ReorderableListFlags	flags

ListField(SerializedProperty)

Declaration

public static void ListField(SerializedProperty arrayProperty)

Parameters

Type	Name	Description
SerializedProperty	arrayProperty

ListField(SerializedProperty, Single)

Declaration

public static void ListField(SerializedProperty arrayProperty, float fixedItemHeight)

Parameters

Type	Name	Description
SerializedProperty	arrayProperty
Single	fixedItemHeight

ListField(SerializedProperty, Single, ReorderableListControl.DrawEmpty)

Declaration

public static void ListField(SerializedProperty arrayProperty, float fixedItemHeight, ReorderableListControl.DrawEmpty drawEmpty)

Parameters

Type	Name	Description
SerializedProperty	arrayProperty
Single	fixedItemHeight
ReorderableListControl.DrawEmpty	drawEmpty

ListField(SerializedProperty, Single, ReorderableListControl.DrawEmpty, ReorderableListFlags)

Declaration

public static void ListField(SerializedProperty arrayProperty, float fixedItemHeight, ReorderableListControl.DrawEmpty drawEmpty, ReorderableListFlags flags)

Parameters

Type	Name	Description
SerializedProperty	arrayProperty
Single	fixedItemHeight
ReorderableListControl.DrawEmpty	drawEmpty
ReorderableListFlags	flags

ListField(SerializedProperty, Single, ReorderableListFlags)

Declaration

public static void ListField(SerializedProperty arrayProperty, float fixedItemHeight, ReorderableListFlags flags)

Parameters

Type	Name	Description
SerializedProperty	arrayProperty
Single	fixedItemHeight
ReorderableListFlags	flags

ListField(SerializedProperty, ReorderableListControl.DrawEmpty)

Declaration

public static void ListField(SerializedProperty arrayProperty, ReorderableListControl.DrawEmpty drawEmpty)

Parameters

Type	Name	Description
SerializedProperty	arrayProperty
ReorderableListControl.DrawEmpty	drawEmpty

ListField(SerializedProperty, ReorderableListControl.DrawEmpty, ReorderableListFlags)

Declaration

public static void ListField(SerializedProperty arrayProperty, ReorderableListControl.DrawEmpty drawEmpty, ReorderableListFlags flags)

Parameters

Type	Name	Description
SerializedProperty	arrayProperty
ReorderableListControl.DrawEmpty	drawEmpty
ReorderableListFlags	flags

ListField(SerializedProperty, ReorderableListFlags)

Declaration

public static void ListField(SerializedProperty arrayProperty, ReorderableListFlags flags)

Parameters

Type	Name	Description
SerializedProperty	arrayProperty
ReorderableListFlags	flags

ListField<T>(IList<T>, ReorderableListControl.ItemDrawer<T>)

Declaration

public static void ListField<T>(IList<T> list, ReorderableListControl.ItemDrawer<T> drawItem)

Parameters

Type	Name	Description
IList<T>	list
ReorderableListControl.ItemDrawer<T>	drawItem

Type Parameters

Name	Description
T

ListField<T>(IList<T>, ReorderableListControl.ItemDrawer<T>, Single)

Declaration

public static void ListField<T>(IList<T> list, ReorderableListControl.ItemDrawer<T> drawItem, float itemHeight)

Parameters

Type	Name	Description
IList<T>	list
ReorderableListControl.ItemDrawer<T>	drawItem
Single	itemHeight

Type Parameters

Name	Description
T

ListField<T>(IList<T>, ReorderableListControl.ItemDrawer<T>, Single, ReorderableListFlags)

Declaration

public static void ListField<T>(IList<T> list, ReorderableListControl.ItemDrawer<T> drawItem, float itemHeight, ReorderableListFlags flags)

Parameters

Type	Name	Description
IList<T>	list
ReorderableListControl.ItemDrawer<T>	drawItem
Single	itemHeight
ReorderableListFlags	flags

Type Parameters

Name	Description
T

ListField<T>(IList<T>, ReorderableListControl.ItemDrawer<T>, ReorderableListControl.DrawEmpty)

Declaration

public static void ListField<T>(IList<T> list, ReorderableListControl.ItemDrawer<T> drawItem, ReorderableListControl.DrawEmpty drawEmpty)

Parameters

Type	Name	Description
IList<T>	list
ReorderableListControl.ItemDrawer<T>	drawItem
ReorderableListControl.DrawEmpty	drawEmpty

Type Parameters

Name	Description
T

ListField<T>(IList<T>, ReorderableListControl.ItemDrawer<T>, ReorderableListControl.DrawEmpty, Single)

Declaration

public static void ListField<T>(IList<T> list, ReorderableListControl.ItemDrawer<T> drawItem, ReorderableListControl.DrawEmpty drawEmpty, float itemHeight)

Parameters

Type	Name	Description
IList<T>	list
ReorderableListControl.ItemDrawer<T>	drawItem
ReorderableListControl.DrawEmpty	drawEmpty
Single	itemHeight

Type Parameters

Name	Description
T

ListField<T>(IList<T>, ReorderableListControl.ItemDrawer<T>, ReorderableListControl.DrawEmpty, Single, ReorderableListFlags)

Declaration

public static void ListField<T>(IList<T> list, ReorderableListControl.ItemDrawer<T> drawItem, ReorderableListControl.DrawEmpty drawEmpty, float itemHeight, ReorderableListFlags flags)

Parameters

Type	Name	Description
IList<T>	list
ReorderableListControl.ItemDrawer<T>	drawItem
ReorderableListControl.DrawEmpty	drawEmpty
Single	itemHeight
ReorderableListFlags	flags

Type Parameters

Name	Description
T

ListField<T>(IList<T>, ReorderableListControl.ItemDrawer<T>, ReorderableListControl.DrawEmpty, ReorderableListFlags)

Declaration

public static void ListField<T>(IList<T> list, ReorderableListControl.ItemDrawer<T> drawItem, ReorderableListControl.DrawEmpty drawEmpty, ReorderableListFlags flags)

Parameters

Type	Name	Description
IList<T>	list
ReorderableListControl.ItemDrawer<T>	drawItem
ReorderableListControl.DrawEmpty	drawEmpty
ReorderableListFlags	flags

Type Parameters

Name	Description
T

ListField<T>(IList<T>, ReorderableListControl.ItemDrawer<T>, ReorderableListFlags)

Declaration

public static void ListField<T>(IList<T> list, ReorderableListControl.ItemDrawer<T> drawItem, ReorderableListFlags flags)

Parameters

Type	Name	Description
IList<T>	list
ReorderableListControl.ItemDrawer<T>	drawItem
ReorderableListFlags	flags

Type Parameters

Name	Description
T

ListFieldAbsolute(Rect, IReorderableListAdaptor)

Declaration

public static void ListFieldAbsolute(Rect position, IReorderableListAdaptor adaptor)

Parameters

Type	Name	Description
Rect	position
IReorderableListAdaptor	adaptor

ListFieldAbsolute(Rect, IReorderableListAdaptor, ReorderableListControl.DrawEmptyAbsolute)

Declaration

public static void ListFieldAbsolute(Rect position, IReorderableListAdaptor adaptor, ReorderableListControl.DrawEmptyAbsolute drawEmpty)

Parameters

Type	Name	Description
Rect	position
IReorderableListAdaptor	adaptor
ReorderableListControl.DrawEmptyAbsolute	drawEmpty

ListFieldAbsolute(Rect, IReorderableListAdaptor, ReorderableListControl.DrawEmptyAbsolute, ReorderableListFlags)

Declaration

public static void ListFieldAbsolute(Rect position, IReorderableListAdaptor adaptor, ReorderableListControl.DrawEmptyAbsolute drawEmpty, ReorderableListFlags flags)

Parameters

Type	Name	Description
Rect	position
IReorderableListAdaptor	adaptor
ReorderableListControl.DrawEmptyAbsolute	drawEmpty
ReorderableListFlags	flags

ListFieldAbsolute(Rect, IReorderableListAdaptor, ReorderableListFlags)

Declaration

public static void ListFieldAbsolute(Rect position, IReorderableListAdaptor adaptor, ReorderableListFlags flags)

Parameters

Type	Name	Description
Rect	position
IReorderableListAdaptor	adaptor
ReorderableListFlags	flags

ListFieldAbsolute(Rect, SerializedProperty)

Declaration

public static void ListFieldAbsolute(Rect position, SerializedProperty arrayProperty)

Parameters

Type	Name	Description
Rect	position
SerializedProperty	arrayProperty

ListFieldAbsolute(Rect, SerializedProperty, Single)

Declaration

public static void ListFieldAbsolute(Rect position, SerializedProperty arrayProperty, float fixedItemHeight)

Parameters

Type	Name	Description
Rect	position
SerializedProperty	arrayProperty
Single	fixedItemHeight

ListFieldAbsolute(Rect, SerializedProperty, Single, ReorderableListControl.DrawEmptyAbsolute)

Declaration

public static void ListFieldAbsolute(Rect position, SerializedProperty arrayProperty, float fixedItemHeight, ReorderableListControl.DrawEmptyAbsolute drawEmpty)

Parameters

Type	Name	Description
Rect	position
SerializedProperty	arrayProperty
Single	fixedItemHeight
ReorderableListControl.DrawEmptyAbsolute	drawEmpty

ListFieldAbsolute(Rect, SerializedProperty, Single, ReorderableListControl.DrawEmptyAbsolute, ReorderableListFlags)

Declaration

public static void ListFieldAbsolute(Rect position, SerializedProperty arrayProperty, float fixedItemHeight, ReorderableListControl.DrawEmptyAbsolute drawEmpty, ReorderableListFlags flags)

Parameters

Type	Name	Description
Rect	position
SerializedProperty	arrayProperty
Single	fixedItemHeight
ReorderableListControl.DrawEmptyAbsolute	drawEmpty
ReorderableListFlags	flags

ListFieldAbsolute(Rect, SerializedProperty, Single, ReorderableListFlags)

Declaration

public static void ListFieldAbsolute(Rect position, SerializedProperty arrayProperty, float fixedItemHeight, ReorderableListFlags flags)

Parameters

Type	Name	Description
Rect	position
SerializedProperty	arrayProperty
Single	fixedItemHeight
ReorderableListFlags	flags

ListFieldAbsolute(Rect, SerializedProperty, ReorderableListControl.DrawEmptyAbsolute)

Declaration

public static void ListFieldAbsolute(Rect position, SerializedProperty arrayProperty, ReorderableListControl.DrawEmptyAbsolute drawEmpty)

Parameters

Type	Name	Description
Rect	position
SerializedProperty	arrayProperty
ReorderableListControl.DrawEmptyAbsolute	drawEmpty

ListFieldAbsolute(Rect, SerializedProperty, ReorderableListControl.DrawEmptyAbsolute, ReorderableListFlags)

Declaration

public static void ListFieldAbsolute(Rect position, SerializedProperty arrayProperty, ReorderableListControl.DrawEmptyAbsolute drawEmpty, ReorderableListFlags flags)

Parameters

Type	Name	Description
Rect	position
SerializedProperty	arrayProperty
ReorderableListControl.DrawEmptyAbsolute	drawEmpty
ReorderableListFlags	flags

ListFieldAbsolute(Rect, SerializedProperty, ReorderableListFlags)

Declaration

public static void ListFieldAbsolute(Rect position, SerializedProperty arrayProperty, ReorderableListFlags flags)

Parameters

Type	Name	Description
Rect	position
SerializedProperty	arrayProperty
ReorderableListFlags	flags

ListFieldAbsolute<T>(Rect, IList<T>, ReorderableListControl.ItemDrawer<T>)

Declaration

public static void ListFieldAbsolute<T>(Rect position, IList<T> list, ReorderableListControl.ItemDrawer<T> drawItem)

Parameters

Type	Name	Description
Rect	position
IList<T>	list
ReorderableListControl.ItemDrawer<T>	drawItem

Type Parameters

Name	Description
T

ListFieldAbsolute<T>(Rect, IList<T>, ReorderableListControl.ItemDrawer<T>, Single)

Declaration

public static void ListFieldAbsolute<T>(Rect position, IList<T> list, ReorderableListControl.ItemDrawer<T> drawItem, float itemHeight)

Parameters

Type	Name	Description
Rect	position
IList<T>	list
ReorderableListControl.ItemDrawer<T>	drawItem
Single	itemHeight

Type Parameters

Name	Description
T

ListFieldAbsolute<T>(Rect, IList<T>, ReorderableListControl.ItemDrawer<T>, Single, ReorderableListFlags)

Declaration

public static void ListFieldAbsolute<T>(Rect position, IList<T> list, ReorderableListControl.ItemDrawer<T> drawItem, float itemHeight, ReorderableListFlags flags)

Parameters

Type	Name	Description
Rect	position
IList<T>	list
ReorderableListControl.ItemDrawer<T>	drawItem
Single	itemHeight
ReorderableListFlags	flags

Type Parameters

Name	Description
T

ListFieldAbsolute<T>(Rect, IList<T>, ReorderableListControl.ItemDrawer<T>, ReorderableListControl.DrawEmptyAbsolute)

Declaration

public static void ListFieldAbsolute<T>(Rect position, IList<T> list, ReorderableListControl.ItemDrawer<T> drawItem, ReorderableListControl.DrawEmptyAbsolute drawEmpty)

Parameters

Type	Name	Description
Rect	position
IList<T>	list
ReorderableListControl.ItemDrawer<T>	drawItem
ReorderableListControl.DrawEmptyAbsolute	drawEmpty

Type Parameters

Name	Description
T

ListFieldAbsolute<T>(Rect, IList<T>, ReorderableListControl.ItemDrawer<T>, ReorderableListControl.DrawEmptyAbsolute, Single)

Declaration

public static void ListFieldAbsolute<T>(Rect position, IList<T> list, ReorderableListControl.ItemDrawer<T> drawItem, ReorderableListControl.DrawEmptyAbsolute drawEmpty, float itemHeight)

Parameters

Type	Name	Description
Rect	position
IList<T>	list
ReorderableListControl.ItemDrawer<T>	drawItem
ReorderableListControl.DrawEmptyAbsolute	drawEmpty
Single	itemHeight

Type Parameters

Name	Description
T

ListFieldAbsolute<T>(Rect, IList<T>, ReorderableListControl.ItemDrawer<T>, ReorderableListControl.DrawEmptyAbsolute, Single, ReorderableListFlags)

Declaration

public static void ListFieldAbsolute<T>(Rect position, IList<T> list, ReorderableListControl.ItemDrawer<T> drawItem, ReorderableListControl.DrawEmptyAbsolute drawEmpty, float itemHeight, ReorderableListFlags flags)

Parameters

Type	Name	Description
Rect	position
IList<T>	list
ReorderableListControl.ItemDrawer<T>	drawItem
ReorderableListControl.DrawEmptyAbsolute	drawEmpty
Single	itemHeight
ReorderableListFlags	flags

Type Parameters

Name	Description
T

ListFieldAbsolute<T>(Rect, IList<T>, ReorderableListControl.ItemDrawer<T>, ReorderableListControl.DrawEmptyAbsolute, ReorderableListFlags)

Declaration

public static void ListFieldAbsolute<T>(Rect position, IList<T> list, ReorderableListControl.ItemDrawer<T> drawItem, ReorderableListControl.DrawEmptyAbsolute drawEmpty, ReorderableListFlags flags)

Parameters

Type	Name	Description
Rect	position
IList<T>	list
ReorderableListControl.ItemDrawer<T>	drawItem
ReorderableListControl.DrawEmptyAbsolute	drawEmpty
ReorderableListFlags	flags

Type Parameters

Name	Description
T

ListFieldAbsolute<T>(Rect, IList<T>, ReorderableListControl.ItemDrawer<T>, ReorderableListFlags)

Declaration

public static void ListFieldAbsolute<T>(Rect position, IList<T> list, ReorderableListControl.ItemDrawer<T> drawItem, ReorderableListFlags flags)

Parameters

Type	Name	Description
Rect	position
IList<T>	list
ReorderableListControl.ItemDrawer<T>	drawItem
ReorderableListFlags	flags

Type Parameters

Name	Description
T

TextFieldItemDrawer(Rect, String)

Draws text field allowing list items to be edited.

Declaration

public static string TextFieldItemDrawer(Rect position, string item)

Parameters

Type	Name	Description
Rect	position	Position to draw list item control(s).
String	item	Value of list item.

Returns

Type	Description
String	Modified value of list item.

Remarks

Null values are automatically changed to empty strings since null values cannot be edited using a text field.

Value of GUI.changed is set to true if value of item is modified.

Title(String)

Draw title control for list field.

Declaration

public static void Title(string title)

Parameters

Type	Name	Description
String	title	Text for title control.

Remarks

When needed, should be shown immediately before list field.

Examples

ReorderableListGUI.Title("Your Title");
ReorderableListGUI.ListField(list, DynamicListGU.TextFieldItemDrawer);

ReorderableListGUI.Title('Your Title');
ReorderableListGUI.ListField(list, DynamicListGU.TextFieldItemDrawer);

Title(GUIContent)

Draw title control for list field.

Declaration

public static void Title(GUIContent title)

Parameters

Type	Name	Description
GUIContent	title	Content for title control.

Remarks

When needed, should be shown immediately before list field.

Examples

ReorderableListGUI.Title(titleContent);
ReorderableListGUI.ListField(list, DynamicListGU.TextFieldItemDrawer);

ReorderableListGUI.Title(titleContent);
ReorderableListGUI.ListField(list, DynamicListGU.TextFieldItemDrawer);

Title(Rect, String)

Draw title control for list field with absolute positioning.

Declaration

public static void Title(Rect position, string text)

Parameters

Type	Name	Description
Rect	position	Position of control.
String	text	Text for title control.

Title(Rect, GUIContent)

Draw title control for list field with absolute positioning.

Declaration

public static void Title(Rect position, GUIContent title)

Parameters

Type	Name	Description
Rect	position	Position of control.
GUIContent	title	Content for title control.