Unigine::UserInterface Class

Header:

#include <UnigineUserInterface.h>

The class is used to work with widgets that are created by loading a UI file.

Methods:

Name	Description View: Sort by:
*create*	UserInterface constructor.
getCallback	Returns the number of a given callback function.
addCallback	Adds a callback function of the specified type for the widget with the specified name.
removeCallback	Removes the specified callback from the list of callbacks of the specified type added for the widget with the given name.
clearCallbacks	Clears all callbacks of the specified type added for the widget with the given name.
getCallbackInstanceData	Returns the callback instance data.
getCallbackName	Returns the name of a given callback function.
getCallbackStringData	Returns the callback string data.
getCallbackVariableData	Returns the callback variable data.
getCallbackWidgetData	Returns the callback widget data.
getNumCallbacks	Returns the total number of callbacks for a given widget.
getNumWidgets	Returns the number of associated widgets.
isOwner	Returns the owner flag.
getWidget	Returns pointer to the widget with a given number.
getWidgetExport	Returns a value indicating if a given widget is exported into a script.
getWidgetName	Returns widget name by its number.
getWidgetNext	Returns the name of the widget, which will be focused next.
findWidget	Searches a widget by its name.
grab	Sets the owner flag to 1 for the UserInterface pointer.
release	Releases the UserInterface (sets the owner flag to 0 for the pointer).
updateWidgets	Updates all widgets belonging to the user interface.

UserInterface Class

Members

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

UserInterface constructor.

Arguments

const Ptr<Gui> & gui - GUI smart pointer.
const char * name - User interface name.
const char * prefix - Names prefix.

int getCallback( int num, int callback )

Returns the number of a given callback function.

Arguments

int num - Widget number.
int callback - Callback type number. One of the callbacks defined in the Gui class (for example, CLICK, SHOW, HIDE, etc).

Return value

Callback number.

void * addCallback( const char * name, int callback, Unigine::CallbackBase * func )

Adds a callback function of the specified type for the widget with the specified name.The signature of the callback function must be as follows:

Source code (C++)

void callback_function_name();

Arguments

const char * name - Widget name.
int callback - Callback type number. One of the callbacks defined in the Gui class (for example, CLICK, SHOW, HIDE, etc).
Unigine::CallbackBase * func - Callback pointer.

Return value

ID of the last added callback, if the callback was added successfully; otherwise, nullptr. This ID can be used to remove this callback when necessary.

void * addCallback( const char * name, int callback, Unigine::CallbackBase1< Ptr<Widget> > * func )

Adds a callback function of the specified type for the widget with the specified name.The signature of the callback function must be as follows:

Source code (C++)

void callback_function_name(WidgetPtr widget);

Arguments

const char * name - Widget name.
int callback - Callback type number. One of the callbacks defined in the Gui class (for example, CLICK, SHOW, HIDE, etc).
Unigine::CallbackBase1< Ptr<Widget> > * func - Callback pointer.

Return value

ID of the last added callback, if the callback was added successfully; otherwise, nullptr. This ID can be used to remove this callback when necessary.

void * addCallback( const char * name, int callback, Unigine::CallbackBase2< Ptr<Widget>, Ptr<Widget> > * func )

Adds a callback function of the specified type for the widget with the specified name.The signature of the callback function must be as follows:

Source code (C++)

void callback_function_name(WidgetPtr widget1, WidgetPtr widget2);

Arguments

const char * name - Widget name.
int callback - Callback type number. One of the callbacks defined in the Gui class (for example, CLICK, SHOW, HIDE, etc).
Unigine::CallbackBase2< Ptr<Widget>, Ptr<Widget> > * func - Callback pointer.

Return value

ID of the last added callback, if the callback was added successfully; otherwise, nullptr. This ID can be used to remove this callback when necessary.

void * addCallback( const char * name, int callback, Unigine::CallbackBase3< Ptr<Widget>, Ptr<Widget>, int > * func )

Adds a callback function of the specified type for the widget with the specified name.The signature of the callback function must be as follows:

Source code (C++)

void callback_function_name(WidgetPtr widget1, WidgetPtr widget2, int arg3);

Arguments

const char * name - Widget name.
int callback - Callback type number. One of the callbacks defined in the Gui class (for example, CLICK, SHOW, HIDE, etc).
Unigine::CallbackBase3< Ptr<Widget>, Ptr<Widget>, int > * func - Callback pointer.

Return value

ID of the last added callback, if the callback was added successfully; otherwise, nullptr. This ID can be used to remove this callback when necessary.

bool removeCallback( const char * name, int callback, void * id )

Removes the specified callback from the list of callbacks of the specified type added for the widget with the given name.

Arguments

const char * name - Widget name.
int callback - Callback type number. One of the callbacks defined in the Gui class (for example, CLICK, SHOW, HIDE, etc).
void * id - Callback ID obtained when adding it.

Return value

True if the callback with the given ID was removed successfully; otherwise false.

void clearCallbacks( const char * name, int callback )

Clears all callbacks of the specified type added for the widget with the given name.

Arguments

const char * name - Widget name.
int callback - Callback type number. One of the callbacks defined in the Gui class (for example, CLICK, SHOW, HIDE, etc).

const char * getCallbackInstanceData( int num, int callback )

Returns the callback instance data.

Arguments

int num - Widget number.
int callback - Callback type number. One of the callbacks defined in the Gui class (for example, CLICK, SHOW, HIDE, etc).

Return value

Callback instance data.

const char * getCallbackName( int num, int callback )

Returns the name of a given callback function.

Arguments

int num - Widget number.
int callback - Callback type number. One of the callbacks defined in the Gui class (for example, CLICK, SHOW, HIDE, etc).

Return value

Callback function name.

const char * getCallbackStringData( int num, int callback )

Returns the callback string data.

Arguments

int num - Widget number.
int callback - Callback type number. One of the callbacks defined in the Gui class (for example, CLICK, SHOW, HIDE, etc).

Return value

Callback string data.

const char * getCallbackVariableData( int num, int callback )

Returns the callback variable data.

Arguments

int num - Widget number.
int callback - Callback type number. One of the callbacks defined in the Gui class (for example, CLICK, SHOW, HIDE, etc).

Return value

Callback variable data.

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

Returns the callback widget data.

Arguments

int num - Widget number.
int callback - Callback type number. One of the callbacks defined in the Gui class (for example, CLICK, SHOW, HIDE, etc).

Return value

Widget data.

int getNumCallbacks( int num )

Returns the total number of callbacks for a given widget.

Arguments

int num - Widget number.

Return value

Number of callbacks.

int getNumWidgets( )

Returns the number of associated widgets.

Return value

Number of associated widgets.

int isOwner( )

Returns the owner flag. If the pointer is the owner, on its deletion the UserInterface also will be deleted. Use grab() and release() functions to change ownership.

Return value

1 if the pointer is the owner; otherwise, 0.

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.

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.

const char * getWidgetName( int num )

Returns widget name by its number.

Arguments

int num - Widget number.

Return value

Widget 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.

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.

void grab( )

Sets the owner flag to 1 for the UserInterface pointer. The UserInterface should not be handled by the class after this function is called

void release( )

Releases the UserInterface (sets the owner flag to 0 for the pointer). The UserInterface should be handled by the class after this function is called

void updateWidgets( )

Updates all widgets belonging to the user interface. This function should be called, for example, after change of the interface language.

Last update: 2018-12-27

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)