Struct TMP_RichTextTagStack<T>

Structure used to track XML tags of various types.

Namespace: TMPro
Syntax
public struct TMP_RichTextTagStack<T>
Type Parameters
Name Description
T

Constructors

TMP_RichTextTagStack(T[])

Constructor to create a new item stack.

Declaration
public TMP_RichTextTagStack(T[] tagStack)
Parameters
Type Name Description
T[] tagStack

TMP_RichTextTagStack(Int32)

Constructor for a new item stack with the given capacity.

Declaration
public TMP_RichTextTagStack(int capacity)
Parameters
Type Name Description
Int32 capacity

Fields

m_Index

Declaration
public int m_Index
Field Value
Type Description
Int32

m_ItemStack

Declaration
public T[] m_ItemStack
Field Value
Type Description
T[]

Methods

Add(T)

Function to add a new item to the stack.

Declaration
public void Add(T item)
Parameters
Type Name Description
T item

Clear()

Function to clear and reset stack to first item.

Declaration
public void Clear()

CurrentItem()

Declaration
public T CurrentItem()
Returns
Type Description
T

Peek()

Declaration
public T Peek()
Returns
Type Description
T

Pop()

Declaration
public T Pop()
Returns
Type Description
T

PreviousItem()

Function to retrieve the previous item without affecting the stack.

Declaration
public T PreviousItem()
Returns
Type Description
T

Push(T)

Declaration
public void Push(T item)
Parameters
Type Name Description
T item

Remove()

Function to retrieve an item from the stack.

Declaration
public T Remove()
Returns
Type Description
T

SetDefault(T)

Function to set the first item on the stack and reset index.

Declaration
public void SetDefault(T item)
Parameters
Type Name Description
T item

Did you find this page useful? Please give it a rating: