Unigine::Widget Class

Widget Class

Enums

TYPE#

Members

bool isCallback ( int callback ) #

Arguments

• int callback - Callback number: one of the Gui:: Enumeration (for example, SHOW, HIDE, etc).

Return value

void * addCallback ( Gui::CALLBACK_INDEX callback, Unigine::CallbackBase * func ) #

void callback_function_name();

Arguments

• Gui::CALLBACK_INDEX 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

void * addCallback ( Gui::CALLBACK_INDEX callback, Unigine::CallbackBase1< Ptr<Widget> > * func ) #

void callback_function_name(WidgetPtr sender);

Arguments

• Gui::CALLBACK_INDEX 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

void * addCallback ( Gui::CALLBACK_INDEX callback, Unigine::CallbackBase2< Ptr<Widget>, Ptr<Widget> > * func ) #

void callback_function_name(WidgetPtr sender, WidgetPtr pointer);

• sender - the widget that caused the callback function to be called, i.e. the one on which the action took place (e.g. a button, that was clicked).
• pointer - this parameter is used to identify a target widget of a Drag&Drop operation. You can find an example in the widgets/sprite_03 UnigineScript sample included in the SDK.

Arguments

• Gui::CALLBACK_INDEX 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

void * addCallback ( Gui::CALLBACK_INDEX callback, Unigine::CallbackBase3< Ptr<Widget>, Ptr<Widget>, int > * func ) #

void callback_function_name(WidgetPtr sender, WidgetPtr pointer, int data);

• sender - the widget that caused the callback function to be called, i.e. the one on which the action took place (e.g. a button, that was clicked).
• pointer - this parameter is used to identify a target widget of a Drag&Drop operation. You can find an example in the widgets/sprite_03 UnigineScript sample included in the SDK.
• data - this parameter is used for getting mouse or keyboard button state, when a widget is clicked or pressed (callbacks: CLICKED, PRESSED, KEY_PRESSED).

Arguments

• Gui::CALLBACK_INDEX 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

bool removeCallback ( Gui::CALLBACK_INDEX callback, void * id ) #

Arguments

• Gui::CALLBACK_INDEX 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

void clearCallbacks ( Gui::CALLBACK_INDEX callback ) #

Arguments

• Gui::CALLBACK_INDEX callback - Callback type number. One of the callbacks defined in the Gui class (for example, CLICK, SHOW, HIDE, etc).

void setCallbackAccel ( Gui::CALLBACK_INDEX callback, unsigned int key, int ctrl, int alt, int shift ) #

Arguments

• Gui::CALLBACK_INDEX callback - Callback number: one of the Gui:: Enumeration (for example, SHOW, HIDE, etc).
• unsigned int key - ASCII key code: one of the App:: Enumeration with KEY_* prefixes.
• int ctrl - CTRL key modifier.
• int alt - ALT key modifier.
• int shift - SHIFT key modifier.

bool getCallbackAccel ( Gui::CALLBACK_INDEX callback, unsigned int & key, int & ctrl, int & alt, int & shift ) #

Arguments

• Gui::CALLBACK_INDEX callback - Callback number: one of the Gui:: Enumeration (for example, SHOW, HIDE, etc).
• unsigned int & key - ASCII key code: one of the App:: Enumeration with KEY_* prefixes.
• int & ctrl - CTRL key modifier.
• int & alt - ALT key modifier.
• int & shift - SHIFT key modifier.

Return value

int isCallbackAccel ( unsigned int key, int ctrl, int alt, int shift ) #

Arguments

• unsigned int key - One of the standard ASCII keycodes or one of the APP_KEY_* pre-defined variables.
• int ctrl - 1 if the CTRL key modifier is used; otherwise, 0.
• int alt - 1 if the ALT key modifier is used; otherwise, 0.
• int shift - 1 if the SHIFT key modifier is used; otherwise, 0.

Return value

void setCallbackEnabled ( Gui::CALLBACK_INDEX callback, bool enabled ) #

Arguments

• Gui::CALLBACK_INDEX callback - Callback number: one of the Gui:: Enumeration (for example, SHOW, HIDE, etc).
• bool enabled - 1 to enable the callback, 0 to disable it.

int isCallbackEnabled ( Gui::CALLBACK_INDEX callback ) #

Arguments

• Gui::CALLBACK_INDEX callback - Callback number: one of the Gui:: Enumeration (for example, SHOW, HIDE, etc).

Return value

Ptr<Widget> getChild ( int num ) #

Arguments

• int num - Number of the child widget.

Return value

int isChild ( const Ptr<Widget> & w ) #

Arguments

• const Ptr<Widget> & w - Widget to check.

Return value

void setData ( const char * data ) #

Arguments

• const char * data - string data. Data can be an xml formatted string.

const char * getData ( ) #

Return value

void setEnabled ( bool enabled ) #

Arguments

• bool enabled - 1 to enable the widget, 0 to disable it.

bool isEnabled ( ) #

Return value

void setFlags ( int flags ) #

Arguments

• int flags - flags.

int getFlags ( ) #

Return value

void setFocus ( ) #

int isFocused ( ) #

Return value

void setFont ( const char * name ) #

Arguments

• const char * name - Path to the font file (*.ttf).

void setFontColor ( const Math::vec4 & color ) #

Arguments

• const Math::vec4 & color - Font color.

Math::vec4 getFontColor ( ) #

Return value

void setFontHOffset ( int hoffset ) #

Arguments

• int hoffset - Horizontal offset value in pixels.

int getFontHOffset ( ) #

Return value

void setFontHSpacing ( int hspacing ) #

Arguments

• int hspacing - Horizontal spacing value.

int getFontHSpacing ( ) #

Return value

void setFontOutline ( int outline ) #

Arguments

• int outline - Outline offset:
  • Positive values set offset in the bottom-right corner direction.
  • Negative values set offset in the top-left corner direction (the outline will overlap widget text).
  • 0 is not to use font outlining.

int getFontOutline ( ) #

Return value

void setFontPermanent ( int permanent ) #

Arguments

• int permanent - 1 not to change text color; 0 to change it.

int getFontPermanent ( ) #

Return value

void setFontRich ( int rich ) #

Arguments

• int rich - 1 to use rich text formatting, 0 to use plain text formatting.

int getFontRich ( ) #

Return value

void setFontSize ( int size ) #

Arguments

• int size - Font size in pixels.

int getFontSize ( ) #

Return value

void setFontVOffset ( int voffset ) #

Arguments

• int voffset - Vertical offset value, in pixels.

int getFontVOffset ( ) #

Return value

void setFontVSpacing ( int vspacing ) #

Arguments

• int vspacing - Vertical spacing value.

int getFontVSpacing ( ) #

Return value

void setFontWrap ( int wrap ) #

Arguments

• int wrap - 1 to enable text wrapping, 0 to disable it. The default is 0.

int getFontWrap ( ) #

Return value

Ptr<Gui> getGui ( ) #

Return value

void setHeight ( int height ) #

Arguments

• int height - Widget's minimal height. If a negative value is provided, the 0 will be used instead.

int getHeight ( ) #

Return value

void setHidden ( bool hidden ) #

Arguments

• bool hidden - true to hide the widget, false to render it.

bool isHidden ( ) #

Return value

int getIntersection ( int x, int y ) #

Arguments

• int x - Local X coordinate.
• int y - Local Y coordinate.

Return value

int getKeyActivity ( unsigned int key ) #

Arguments

• unsigned int key - ASCII key code: one of the KEY_* pre-defined variables.

Return value

void setMouseCursor ( int cursor ) #

Arguments

• int cursor - Mouse pointer. See the list of available pointers with CURSOR_* prefixes in the article on Gui class functions.

int getMouseCursor ( ) #

Return value

int getMouseX ( ) #

Return value

int getMouseY ( ) #

Return value

void setNextFocus ( const Ptr<Widget> & focus ) #

Arguments

• const Ptr<Widget> & focus - Next widget.

Ptr<Widget> getNextFocus ( ) #

Return value

int getNumChildren ( ) #

Return value

void setOrder ( int order ) #

Unigine::Vector<Unigine::WidgetSpritePtr> sprites;

int AppWorldLogic::init()
{
	// create 3 squares with different colors
	for (int i = 0; i < 3; i++)
	{
		WidgetSpritePtr &sprite = sprites.append();
		sprite = WidgetSprite::create(Gui::get(), "white.dds");
		sprite->setPosition(i * 40 + 50, i * 40 + 50);
		sprite->setWidth(100);
		sprite->setHeight(100);
		Gui::get()->addChild(sprite, Gui::ALIGN_OVERLAP);
	}

	sprites[0]->setColor(vec4(1, 0.3f, 0.3f, 1));
	sprites[1]->setColor(vec4(0.3f, 1, 0.3f, 1));
	sprites[2]->setColor(vec4(0.3f, 0.3f, 1, 1));

	return 1;
}

int AppWorldLogic::update()
{
	// press space key to random reorder squares
	if (App::clearKeyState(' '))
	{
		for (int i = 0; i < 3; i++)
		{
			sprites[i]->setOrder(Game::getRandomInt(0, 10));
			
			Gui::get()->removeChild(sprites[i]);
			Gui::get()->addChild(sprites[i]);

			Log::message("%d ", sprites[i]->getOrder());
		}
		Log::message("\n");
	}
	return 1;
}

Arguments

• int order - Rendering order (Z-order) of the widget, in the range [-128;127]. (126 for the Profiler, 127 for the Console).

int getOrder ( ) #

Return value

void setParent ( const Ptr<Widget> & parent ) #

Arguments

• const Ptr<Widget> & parent - Parent widget to set.

Ptr<Widget> getParent ( ) #

Return value

Ptr<Gui> getParentGui ( ) #

Return value

void setPermanentFocus ( ) #

void setPosition ( int x, int y ) #

Arguments

• int x - X coordinate of the upper left corner of the widget.
• int y - Y coordinate of the upper left corner of the widget.

int getPositionX ( ) #

Return value

int getPositionY ( ) #

Return value

int getScreenPositionX ( ) #

Return value

int getScreenPositionY ( ) #

Return value

void setToolTip ( const char * str, int reset = 0 ) #

Arguments

• const char * str - Tooltip text.
• int reset - 1 to recalculate a tooltip location if the mouse cursor was relocated; otherwise - 0(by default).

const char * getToolTip ( ) #

Return value

Widget::TYPE getType ( ) #

Return value

const char * getTypeName ( ) #

Return value

void setWidth ( int width ) #

Arguments

• int width - Widget's minimal width. If a negative value is provided, the 0 will be used instead.

int getWidth ( ) #

Return value

void addAttach ( const Ptr<Widget> & w, const char * format = 0, int multiplier = 1, int flags = 0 ) #

Arguments

• const Ptr<Widget> & w - Widget to attach.
• const char * format - Format string or values entered into the attached widget. If none specified, "%d" is implied. This is an optional parameter.
• int multiplier - Multiplier value, which is used to scale values provided by the attached widget. This is an optional parameter.
• int flags - Attachment flags: one of the Gui:: Enumeration with ATTACH_* prefixes. This is an optional parameter.

void addChild ( const Ptr<Widget> & w, int flags = 0 ) #

Arguments

• const Ptr<Widget> & w - Child widget.
• int flags - Widget flags: one of the Gui:: Enumeration with ALIGN_* prefixes. This is an optional parameter.

void arrange ( ) #

void raise ( const Ptr<Widget> & w ) #

Arguments

• const Ptr<Widget> & w - Widget to be brought up.

void removeAttach ( const Ptr<Widget> & w ) #

Arguments

• const Ptr<Widget> & w - Widget to detach.

void removeChild ( const Ptr<Widget> & w ) #

Arguments

• const Ptr<Widget> & w - Child widget smart pointer.

void removeFocus ( ) #

void replaceChild ( const Ptr<Widget> & w, const Ptr<Widget> & old_w, int flags = 0 ) #

Arguments

• const Ptr<Widget> & w - New child widget smart pointer.
• const Ptr<Widget> & old_w - Widget to be replaced.
• int flags - Widget flags: one of the Gui:: Enumeration with ALIGN_* prefixes. This is an optional parameter.

void runCallback ( int callback ) #

Arguments

• int callback - Callback number: one of the Gui:: Enumeration (for example, SHOW, HIDE, etc).

void setIntersectionEnabled ( bool enabled ) #

Arguments

• bool enabled - true to enable intersection detection for the widget, false - to disable it.

bool isIntersectionEnabled ( ) #

Return value