Skip to content

Class: rtoken_list

Ordered list of string tokens for runtime-selectable editor values.

Source

C++ class rtoken_list

Custom Constructor

rtoken_list

Remarks

Used by editor property rows that need a list of strings computed at runtime.

Constructors

Constructor

ts
new rtoken_list(): rtoken_list;

Create an empty token list.

Returns

rtoken_list

Methods

add()

ts
add(token: string): void;

Append a token.

Parameters

ParameterTypeDescription
tokenstringToken text.

Returns

void


clear()

ts
clear(): void;

Remove all tokens.

Returns

void


count()

ts
count(): number;

Get number of tokens in the list.

Returns

number

Token count.


get()

ts
get(index: number): Nullable<string>;

Get token text by zero-based index.

Parameters

ParameterTypeDescription
indexnumberToken index.

Returns

Nullable<string>

Token text, or null from native code when index is out of range.


remove()

ts
remove(index: number): void;

Remove token by zero-based index.

Parameters

ParameterTypeDescription
indexnumberToken index.

Returns

void

Remarks

Out-of-range indexes are ignored.