UserInterface Class
UserInterface Class
Members
string getCallbackVariableData (int num, int callback)
Returns the callback variable data.Arguments
- int num - Widget number.
- int callback - Callback number.
Return value
Callback variable data (i.e. string data specified in the variable parameter of the callback).string getCallbackName (int num, int callback)
Returns the name of a given callback function.Arguments
- int num - Widget number.
- int callback - Callback number.
Return value
Callback function name.string getWidgetNext (int num)
Returns the name of the widget, which will be focused next.Arguments
- int num - Widget number.
Return value
Widget name.string getWidgetName (int num)
Returns widget name by ID.Arguments
- int num - Widget ID.
Return value
Widget name.int getNumCallbacks (int num)
Returns the total number of callbacks for a given widget.Arguments
- int num - Widget number.
Return value
Number of callbacks.Widget getWidget (int num)
Returns reference to widget with the given ID.Arguments
- int num - Widget ID.
Return value
Reference to widget with the given ID.void updateWidgets ()
Updates all widgets belonging to the user interface. This function should be called, for example, after change of the interface language.int getCallback (int num, int callback)
Returns the number of a given callback function.Arguments
- int num - Widget number.
- int callback - Callback number.
Return value
Callback number.int getWidgetExport (int num)
Returns a value indicating if a given widget is exported into a script (has export="1" flag in UI file).Arguments
- int num - Widget ID.
Return value
1 if the widget is exported; otherwise, 0.Widget getCallbackWidgetData (int num, int callback)
Returns the callback widget data.Arguments
- int num - Widget number.
- int callback - Callback number.
Return value
Widget data (i.e. reference to a widget specified in the widget parameter of the callback).string getCallbackStringData (int num, int callback)
Returns the callback string data.Arguments
- int num - Widget number.
- int callback - Callback number.
Return value
Callback string data (i.e. string data specified in the string parameter of the callback).int getNumWidgets ()
Returns number of associated widgets.Return value
Number of associated widgets.int findWidget (string name)
Searches a widget by its name.Arguments
- string name - Widget name.
Return value
Returns the number of the widget if exists; otherwise, -1.string getCallbackInstanceData (int num, int callback)
Returns the callback instance data.Arguments
- int num - Widget number.
- int callback - Callback number.
Return value
Instance data.Last update: 2017-07-03
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)