UserInterface Class

UserInterface Class

Members

---

UserInterface (const Ptr<Gui> & gui, const char * name, const char * prefix = 0)

Arguments

• const Ptr<Gui> & gui
• const char * name
• const char * prefix

const char * getCallbackVariableData (int num, int callback)

Returns the callback variable data.

Arguments

• int num - Widget number.
• int callback - Callback number.

Return value

Callback variable data.

const char * 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.

const char * getWidgetNext (int num)

Returns the name of the widget, which will be focused next.

Arguments

• int num - Current widget number.

Return value

Next Widget name.

const char * getWidgetName (int num)

Returns widget name by its number.

Arguments

• int num - Widget number.

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.

Ptr<Widget> getWidget (int num)

Returns pointer to the widget with a given number.

Arguments

• int num - Widget number.

Return value

Pointer to the widget with the given number.

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.

Arguments

• int num - Widget number.

Return value

Returns 1 if the widget is exported; otherwise, 0.

Ptr<Widget> getCallbackWidgetData (int num, int callback)

Returns the callback widget data.

Arguments

• int num - Widget number.
• int callback - Callback number.

Return value

Widget data.

const char * getCallbackStringData (int num, int callback)

Returns the callback string data.

Arguments

• int num - Widget number.
• int callback - Callback number.

Return value

Callback string data.

int getNumWidgets ()

Returns the number of associated widgets.

Return value

Number of associated widgets.

int findWidget (const char * name)

Searches a widget by its name.

Arguments

• const char * name - Widget name.

Return value

Returns the number of the widget if exists; otherwise, -1.

const char * getCallbackInstanceData (int num, int callback)

Returns the callback instance data.

Arguments

• int num - Widget number.
• int callback - Callback number.

Return value

Callback instance data.