index (int): If the index is equal to or higher than the total number of items, the new item is appended to the list of existing items. If the index is zero or negative, the new item is prepended to the list of existing items.

text (string): Item text.

suppressEvents (bool, default: true): if true, no event will be generated from this call

keyboard_modifiers

Script functions

Script functions are used to call some lua code from the plugin side (tipically used for event handlers).

onclickCallback

Description

Callback for button click event.

Lua synopsis

simUI.onclickCallback(int handle, int id)

Lua parameters

handle (int): ui handle

id (int): the ID of the clicked button

Lua return values

-

See also

onLinkActivatedCallback

Description

Callback for when a link is clicked.

Lua synopsis

simUI.onLinkActivatedCallback(int handle, int id, string link)

Lua parameters

handle (int): ui handle

id (int): the ID of the clicked button

link (string): the href attribute of the activated link

Lua return values

-

See also

onchangeIntCallback

Description

Callback for widget change event.

Lua synopsis

simUI.onchangeIntCallback(int handle, int id, int value)

Lua parameters

handle (int): ui handle

id (int): the ID of the widget

value (int): the new value

Lua return values

-

See also

onchangeDoubleCallback

Description

Callback for widget change event.

Lua synopsis

simUI.onchangeDoubleCallback(int handle, int id, float value)

Lua parameters

handle (int): ui handle

id (int): the ID of the widget

value (float): the new value

Lua return values

-

See also

onchangeStringCallback

Description

Callback for widget change event.

Lua synopsis

simUI.onchangeStringCallback(int handle, int id, string value)

Lua parameters

handle (int): ui handle

id (int): the ID of the widget

value (string): the new value

Lua return values

-

See also

oneditingfinishedCallback

Description

Callback for editing finished event.

Lua synopsis

simUI.oneditingfinishedCallback(int handle, int id, string value)

Lua parameters

handle (int): ui handle

id (int): the ID of the widget

value (string): the new value

Lua return values

-

See also

oncloseCallback

Description

Callback for window close event. It will be called when the user clicks the close button of the window. When an onclose callback is specified, the window will not close automatically when the user clicks the window close button.