This page has been translated automatically.
视频教程
界面
要领
高级
实用建议
专业(SIM)
UnigineEditor
界面概述
资源工作流程
版本控制
设置和首选项
项目开发
调整节点参数
Setting Up Materials
设置属性
照明
Sandworm
使用编辑器工具执行特定任务
如何擴展編輯器功能
嵌入式节点类型
Nodes
Objects
Effects
Decals
光源
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
编程
基本原理
搭建开发环境
使用范例
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
材质和着色器
Rebuilding the Engine Tools
GUI
VR Development
双精度坐标
应用程序接口
Animations-Related Classes
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
VR-Related Classes
创建内容
内容优化
材质
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Unigine::Widget Class

Header: #include <UnigineWidgets.h>

This base class is used to create graphical user interface widgets of different types. The Widget class doesn't provide creating of a widget: you can create the required widget by using a constructor of the corresponding class inherited from the Widget class.

Widgets can be used separately or form a hierarchy.

Working with Widgets#

The example below demonstrates how to create a single widget, a hierarchy of widgets, and subscribe for a widget's event.

AppWorldLogic.cpp

Source code (C++)
#include "AppWorldLogic.h"
#include <UnigineWidgets.h>

using namespace Unigine;

void on_button_click()
{
	Log::message("world button click\n");
}

int AppWorldLogic::init()
{
	// create a single widget
	WidgetButtonPtr button = WidgetButton::create("WORLD_BUTTON");
	// subscribe for the Clicked event
	button->getEventClicked().connect(on_button_click);
	// add the button to WindowManager
	WindowManager::getMainWindow()->addChild(button);

	// create a hierarchy of widgets
	WidgetHBoxPtr hbox = WidgetHBox::create();
	hbox->setBackground(1);
	hbox->setBackgroundColor(Math::vec4_white);
	WindowManager::getMainWindow()->addChild(hbox, Gui::ALIGN_EXPAND);

	WidgetGroupBoxPtr group = WidgetGroupBox::create();
	group->setBackground(1);
	group->setText("Widgets Hierarchy");
	hbox->addChild(group);

	group->addChild(WidgetLabel::create("hierarchy_label_0"));
	group->addChild(WidgetLabel::create("hierarchy_label_1"));

	return 1;
}

Lifetime of Widgets#

By default each new widget's lifetime matches the lifetime of the Engine (i.e. the widget shall be deleted on Engine shutdown). But you can choose widget's lifetime to be managed:

  • By a separate window — in this case the widget is deleted automatically on deleting the window.
  • By the world — in this case the widget is deleted when the world is closed.
  • Manually — in this case the widget should be deleted manually.

The examples below show how the different lifetime management types work.

Managing Lifetime by the World#

In this example, the widgets appear on loading the world. When you reload or exit the world, or close the Engine window, the widgets are deleted as their lifetime is managed by the world. The corresponding messages will be shown in the console.

AppWorldLogic.cpp

Source code (C++)
#include "AppWorldLogic.h"
#include <UnigineWidgets.h>

using namespace Unigine;

void on_button_click(const WidgetPtr &button, int mbuttons)
{
	Log::message("world button click\n");
}

void on_button_remove(const WidgetPtr &button)
{
	Log::message("world button removed\n");
}

void on_hbox_remove(const WidgetPtr &hbox)
{
	Log::message("world hbox hierarchy removed\n");
}

int AppWorldLogic::init()
{

	// single world widget
	WidgetButtonPtr button = WidgetButton::create("WORLD_BUTTON");
	button->setLifetime(Widget::LIFETIME_WORLD);
	button->getEventClicked().connect(on_button_click);
	button->getEventRemove().connect(on_button_remove);
	WindowManager::getMainWindow()->addChild(button);

	// world hierarchy
	WidgetHBoxPtr hbox = WidgetHBox::create();
	hbox->setLifetime(Widget::LIFETIME_WORLD);
	hbox->getEventRemove().connect(on_hbox_remove);
	hbox->setBackground(1);
	hbox->setBackgroundColor(Math::vec4_red);
	WindowManager::getMainWindow()->addChild(hbox, Gui::ALIGN_EXPAND);

	WidgetGroupBoxPtr group = WidgetGroupBox::create();
	group->setBackground(1);
	group->setText("World Hierarchy");
	hbox->addChild(group);

	group->addChild(WidgetLabel::create("hierarchy_world_label_0"));
	group->addChild(WidgetLabel::create("hierarchy_world_label_1"));

	return 1;
}
Managing Lifetime by the Window#

In this example, widgets appear in a separate window. When you close the window, the widgets are deleted as their lifetime is managed by this window. The console shows the following information:

  • Whether the window, button and hbox hierarchy are deleted or not.
  • Whether the remove callbacks are fired or not.
  • Messages from the remove callbacks.

After closing, the window can be re-created by pressing T.

AppSystemLogic.cpp

Source code (C++)
#include "AppSystemLogic.h"
#include <UnigineWidgets.h>

using namespace Unigine;

EngineWindowViewportPtr window;

WidgetButtonPtr button;
WidgetHBoxPtr hbox;

bool button_remove_handler = false;
bool hbox_remove_handler = false;

void on_window_button_click()
{
	Log::message("window button click\n");
}

void on_window_button_remove()
{
	Log::message("window button removed\n");
	button_remove_handler = true;
}

void on_window_hbox_remove()
{
	Log::message("window hbox hierarchy removed\n");
	hbox_remove_handler = true;
}

void create_window()
{

	button_remove_handler = false;
	hbox_remove_handler = false;

	window = EngineWindowViewport::create("Test", 512, 256, EngineWindow::FLAGS_SHOWN);

	// single window widget
	button = WidgetButton::create("WINDOW_BUTTON");
	button->setLifetime(Widget::LIFETIME_WINDOW);
	button->getEventClicked().connect(on_window_button_click);
	button->getEventRemove().connect(on_window_button_remove);
	window->addChild(button);

	// window hierarchy
	hbox = WidgetHBox::create();
	hbox->setLifetime(Widget::LIFETIME_WINDOW);
	hbox->getEventRemove().connect(on_window_hbox_remove);
	hbox->setBackground(1);
	hbox->setBackgroundColor(Math::vec4_red);
	window->addChild(hbox, Gui::ALIGN_EXPAND);

	WidgetGroupBoxPtr group = WidgetGroupBox::create();
	group->setBackground(1);
	group->setText("Window Hierarchy");
	hbox->addChild(group);

	group->addChild(WidgetLabel::create("hierarchy_window_label_0"));
	group->addChild(WidgetLabel::create("hierarchy_window_label_1"));

}

int AppSystemLogic::init()
{	

	create_window();

	return 1;
}

int AppSystemLogic::update()
{

	if (Input::isKeyDown(Input::KEY_T) && window.isDeleted())
		create_window();

	Log::message("window deleted: %d, button deleted: %d, hbox deleted: %d, button remove handler: %d, hbox remove handler: %d\n",
		window.isDeleted(), button.isDeleted(), hbox.isDeleted(), button_remove_handler, hbox_remove_handler);

	return 1;
}
Managing Lifetime by the Engine#

Widgets are created on Engine initialization, and then added to a separate window. The console shows the following information:

  • Whether the window, button and hbox hierarchy are deleted or not.
  • Whether the remove callbacks are fired or not.
  • Messages from the remove callbacks.

If you close the window, it will be deleted and the information in the console will change. All the other widgets are deleted only on Engine shutdown, as their lifetime is managed by the Engine.

If the separate window is closed, press T to re-create it.

AppSystemLogic.cpp

Source code (C++)
#include "AppSystemLogic.h"
#include <UnigineWidgets.h>

using namespace Unigine;

EngineWindowViewportPtr engine_window;

WidgetButtonPtr engine_button;
WidgetHBoxPtr engine_hbox;

bool engine_button_remove_handler = false;
bool engine_hbox_remove_handler = false;

void on_engine_button_click(const WidgetPtr &button, int mbuttons)
{
	Log::message("engine button click\n");
}

void on_engine_button_remove(const WidgetPtr &button)
{
	Log::message("engine button removed\n");
	engine_button_remove_handler = true;
}

void on_engine_hbox_remove(const WidgetPtr &hbox)
{
	Log::message("engine hbox hierarchy removed\n");
	engine_hbox_remove_handler = true;
}

void create_engine_window()
{

	engine_window = EngineWindowViewport::create("Test", 512, 256, EngineWindow::FLAGS_SHOWN);

	engine_window->addChild(engine_button);
	engine_window->addChild(engine_hbox, Gui::ALIGN_EXPAND);

}

int AppSystemLogic::init()
{	

	engine_button_remove_handler = false;
	engine_hbox_remove_handler = false;

	// single engine widget
	engine_button = WidgetButton::create("ENGINE_BUTTON");
	engine_button->setLifetime(Widget::LIFETIME_ENGINE);
	engine_button->getEventClicked().connect(on_engine_button_click);
	engine_button->getEventRemove().connect(on_engine_button_remove);

	// engine hierarchy
	engine_hbox = WidgetHBox::create();
	engine_hbox->setLifetime(Widget::LIFETIME_ENGINE);
	engine_hbox->getEventRemove().connect(on_engine_hbox_remove);
	engine_hbox->setBackground(1);
	engine_hbox->setBackgroundColor(Math::vec4_red);

	WidgetGroupBoxPtr engine_group = WidgetGroupBox::create();
	engine_group->setBackground(1);
	engine_group->setText("Engine Hierarchy");
	engine_hbox->addChild(engine_group);

	engine_group->addChild(WidgetLabel::create("hierarchy_engine_label_0"));
	engine_group->addChild(WidgetLabel::create("hierarchy_engine_label_1"));

	create_engine_window();

	return 1;
}

int AppSystemLogic::update()
{

	if (Input::isKeyDown(Input::KEY_T) && engine_window.isDeleted())
		create_engine_window();

	Log::message("engine window deleted: %d, engine button deleted: %d, engine hbox deleted: %d, engine button remove handler: %d, engine hbox remove handler: %d\n",
		engine_window.isDeleted(), engine_button.isDeleted(), engine_hbox.isDeleted(), engine_button_remove_handler, engine_hbox_remove_handler);

	return 1;
}

See Also#

  • Widgets sample set in CPP Samples suite
  • Widgets sample in C# Component Samples suite
  • A set of UnigineScript API samples located in the <UnigineSDK>/data/samples/widgets/ folder

Widget Class

Enums

TYPE#

Name说明/描 述
WIDGET_VBOX = 0Vertical box. See also: WidgetVBox.
WIDGET_HBOX = 1Horizontal box. See also: WidgetHBox.
WIDGET_GRID_BOX = 2Grid box. See also: WidgetGridBox.
WIDGET_VPANED = 3Vertical box that allows resizing of its children. See also: WidgetVPaned.
WIDGET_HPANED = 4Horizontal box that allows resizing of its children. See also: WidgetHPaned.
WIDGET_LABEL = 5Text label. See also: WidgetLabel.
WIDGET_BUTTON = 6Simple button. See also: WidgetButton.
WIDGET_EDIT_LINE = 7Text field. See also: WidgetEditline.
WIDGET_EDIT_TEXT = 8Multiline text field. See also: WidgetEdittext.
WIDGET_CHECK_BOX = 9Checkbox. See also: WidgetCheckbox.
WIDGET_COMBO_BOX = 10Combobox. See also: WidgetCombobox.
WIDGET_CANVAS = 11Canvas widget for drawing text, lines and polygons. See also: WidgetCanvas.
WIDGET_GROUP_BOX = 12Group box. See also: WidgetGroupBox.
WIDGET_LIST_BOX = 13List box. See also: WidgetListBox.
WIDGET_TREE_BOX = 14Tree box. See also: WidgetTreeBox.
WIDGET_TAB_BOX = 15Tabbed box. See also: WidgetTabBox.
WIDGET_SCROLL = 16A scrollbar: horizontal or vertical one. See also: WidgetScroll.
WIDGET_SCROLL_BOX = 17Box with scrolling. See also: WidgetScrollBox.
WIDGET_SPACER = 18Spacer: horizontal or vertical one. See also: WidgetSpacer.
WIDGET_SLIDER = 19A slider: horizontal or vertical one. See also: WidgetSlider.
WIDGET_SPIN_BOX = 20Spinbox. See also: WidgetSpinBox.
WIDGET_SPIN_BOX_DOUBLE = 21Spinbox with double values. See also: WidgetSpinBoxDouble.
WIDGET_ICON = 22Icon. See also: WidgetIcon.
WIDGET_SPRITE = 23Sprite. See also: WidgetSprite.
WIDGET_SPRITE_VIDEO = 24Video Sprite. See also: WidgetSpriteVideo.
WIDGET_SPRITE_SHADER = 25Shader Sprite. See also: WidgetSpriteShader.
WIDGET_SPRITE_VIEWPORT = 26Viewport Sprite. See also: WidgetSpriteViewport.
WIDGET_SPRITE_NODE = 27Node Sprite. See also: WidgetSpriteNode.
WIDGET_MENU_BAR = 28Menu bar. See also: WidgetMenuBar.
WIDGET_MENU_BOX = 29Menu. See also: WidgetMenuBox.
WIDGET_WINDOW = 30Window. See also: WidgetWindow.
WIDGET_DIALOG = 31Dialog window. See also: WidgetDialog.
WIDGET_DIALOG_MESSAGE = 32Message Dialog. See also: WidgetDialogMessage.
WIDGET_DIALOG_FILE = 33File Dialog. See also: WidgetDialogFile.
WIDGET_DIALOG_COLOR = 34Color Dialog. See also: WidgetDialogColor.
WIDGET_DIALOG_IMAGE = 35Image Dialog. See also: WidgetDialogImage.
WIDGET_MANIPULATOR = 36Manipulator widget. See also: WidgetManipulator.
WIDGET_MANIPULATOR_TRANSLATOR = 37Translator Manipulator. See also: WidgetManipulatorTranslator.
WIDGET_MANIPULATOR_ROTATOR = 38Rotator Manipulator. See also: WidgetManipulatorRotator.
WIDGET_MANIPULATOR_SCALER = 39Scaler Manipulator. See also: WidgetManipulatorScaler.
WIDGET_EXTERN = 40External widget.
WIDGET_ENGINE = 41Engine-specific widget (manipulator). See also: WidgetManipulator.
WIDGET_HIT_TEST_AREA = 42Hit-Test Area. See also: WidgetHitTestArea.
NUM_WIDGETS = 43Total number of widget types.

LIFETIME#

Name说明/描 述
LIFETIME_WORLD = 0Lifetime of the widget or user interface is managed by the world. The widget/user interface will be deleted automatically on closing the world.
LIFETIME_WINDOW = 1Lifetime of the widget or user interface is managed by the window. The widget/user interface will be deleted automatically on deleting the window.
LIFETIME_ENGINE = 2Lifetime of the widget or user interface is managed by the Engine. The widget/user interface will be deleted automatically on Engine shutdown.
Notice
When using this lifetime management type, the GUI instance can be empty for the widget: it will be assigned automatically when adding the widget to a window. For a user interface, the Gui instance must be set via the setGui() method.
LIFETIME_MANUAL = 3Lifetime of the widget or user interface is managed by the user. The widget/user interface should be deleted manually.
Notice
When using this lifetime management type, the GUI instance can be empty for the widget: it will be assigned automatically when adding the widget to a window. For a user interface, the Gui instance must be set via the setGui() method.

Members

getNumChildren() const#

Returns the current The number of child widgets.

Return value

Current

getMouseY() const#

Returns the current The y coordinate of the mouse pointer position in the widget's local space.

Return value

Current

getMouseX() const#

Returns the current The x coordinate of the mouse pointer position in the widget's local space.

Return value

Current

getScreenPositionY() const#

Returns the current The screen position of the widget (its top left corner) on the screen along the y axis.

Return value

Current

getScreenPositionX() const#

Returns the current The screen position of the widget (its top left corner) on the screen along the x axis.

Return value

Current

void setPositionY ( ) #

Sets a new The y coordinate of the widget position relative to its parent.

Arguments

  • y - The

getPositionY() const#

Returns the current The y coordinate of the widget position relative to its parent.

Return value

Current

void setPositionX ( ) #

Sets a new

Arguments

  • x - The

getPositionX() const#

Returns the current

Return value

Current

getParentGui() const#

Returns the current The parent gui smart pointer.

Return value

Current

void setGui ( ) #

Sets a new The gui smart pointer.

Arguments

  • gui - The

getGui() const#

Returns the current The gui smart pointer.

Return value

Current

getTypeName() const#

Returns the current The name of the widget type.

Return value

Current

getType() const#

Returns the current The type of the widget.

Return value

Current

bool isLayout() const#

Returns the current The value indicating if the widget is a layout.

Return value

true if is enabled; otherwise false.

bool isFixed() const#

Returns the current The value indicating if the widget is fixed.

Return value

true if is enabled; otherwise false.

bool isBackground() const#

Returns the current The value indicating if the widget is a background one.

Return value

true if is enabled; otherwise false.

bool isOverlapped() const#

Returns the current The value indicating if the widget is overlapped.

Return value

true if is enabled; otherwise false.

bool isExpanded() const#

Returns the current The value indicating if the widget is expanded.

Return value

true if is enabled; otherwise false.

float getDpiScale() const#

Returns the current

Return value

Current

int getRenderHeight() const#

Returns the current

Return value

Current

int getRenderWidth() const#

Returns the current

Return value

Current

Event<const Ptr<Widget> &> getEventRemove() const#

Event triggered when a widget is removed. You can subscribe to events via connect()  and unsubscribe via disconnect(). You can also use EventConnection  and EventConnections  classes for convenience (see examples below).

Usage Example

Source code (C++)
// implement the Remove event handler
void remove_event_handler(const Ptr<Widget> & widget)
{
	Log::message("\Handling Remove event\n");
}


//////////////////////////////////////////////////////////////////////////////
//  1. Multiple subscriptions can be linked to an instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections remove_event_connections;

// link to this instance when subscribing for an event (subscription for various events can be linked)
widget->getEventRemove().connect(remove_event_connections, remove_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
widget->getEventRemove().connect(remove_event_connections, [](const Ptr<Widget> & widget) { 
		Log::message("\Handling Remove event (lambda).\n");
	}
);

// ...

// later all of these linked subscriptions can be removed with a single line
remove_event_connections.disconnectAll();

//////////////////////////////////////////////////////////////////////////////
//  2. You can subscribe and unsubscribe via an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection remove_event_connection;

// subscribe for the Remove event with a handler function keeping the connection
widget->getEventRemove().connect(remove_event_connection, remove_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
remove_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
remove_event_connection.setEnabled(true);

// ...

// remove subscription for the Remove event via the connection
remove_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A Remove event handler implemented as a class member
	void event_handler(const Ptr<Widget> & widget)
	{
		Log::message("\Handling Remove event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
widget->getEventRemove().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe for the Remove event with a handler function
widget->getEventRemove().connect(remove_event_handler);


// remove subscription for the Remove event later by the handler function
widget->getEventRemove().disconnect(remove_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId remove_handler_id;

// subscribe for the Remove event with a lambda handler function and keeping connection ID
remove_handler_id = widget->getEventRemove().connect([](const Ptr<Widget> & widget) { 
		Log::message("\Handling Remove event (lambda).\n");
	}
);

// remove the subscription later using the ID
widget->getEventRemove().disconnect(remove_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all Remove events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
widget->getEventRemove().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
widget->getEventRemove().setEnabled(true);
Notice
For more details see the Event Handling article.
The event handler signature is as follows: myhandler(const Ptr<Widget> & widget)

Return value

Current

Event<const Ptr<Widget> &, const Ptr<Widget> &> getEventDragDrop() const#

Event triggered when a drag-and-drop operation is performed with a widget. Supported by all widgets.. You can subscribe to events via connect()  and unsubscribe via disconnect(). You can also use EventConnection  and EventConnections  classes for convenience (see examples below).

Usage Example

Source code (C++)
// implement the DragDrop event handler
void dragdrop_event_handler(const Ptr<Widget> & widget,  const Ptr<Widget> & target_widget)
{
	Log::message("\Handling DragDrop event\n");
}


//////////////////////////////////////////////////////////////////////////////
//  1. Multiple subscriptions can be linked to an instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections dragdrop_event_connections;

// link to this instance when subscribing for an event (subscription for various events can be linked)
widget->getEventDragDrop().connect(dragdrop_event_connections, dragdrop_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
widget->getEventDragDrop().connect(dragdrop_event_connections, [](const Ptr<Widget> & widget,  const Ptr<Widget> & target_widget) { 
		Log::message("\Handling DragDrop event (lambda).\n");
	}
);

// ...

// later all of these linked subscriptions can be removed with a single line
dragdrop_event_connections.disconnectAll();

//////////////////////////////////////////////////////////////////////////////
//  2. You can subscribe and unsubscribe via an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection dragdrop_event_connection;

// subscribe for the DragDrop event with a handler function keeping the connection
widget->getEventDragDrop().connect(dragdrop_event_connection, dragdrop_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
dragdrop_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
dragdrop_event_connection.setEnabled(true);

// ...

// remove subscription for the DragDrop event via the connection
dragdrop_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A DragDrop event handler implemented as a class member
	void event_handler(const Ptr<Widget> & widget,  const Ptr<Widget> & target_widget)
	{
		Log::message("\Handling DragDrop event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
widget->getEventDragDrop().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe for the DragDrop event with a handler function
widget->getEventDragDrop().connect(dragdrop_event_handler);


// remove subscription for the DragDrop event later by the handler function
widget->getEventDragDrop().disconnect(dragdrop_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId dragdrop_handler_id;

// subscribe for the DragDrop event with a lambda handler function and keeping connection ID
dragdrop_handler_id = widget->getEventDragDrop().connect([](const Ptr<Widget> & widget,  const Ptr<Widget> & target_widget) { 
		Log::message("\Handling DragDrop event (lambda).\n");
	}
);

// remove the subscription later using the ID
widget->getEventDragDrop().disconnect(dragdrop_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all DragDrop events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
widget->getEventDragDrop().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
widget->getEventDragDrop().setEnabled(true);
Notice
For more details see the Event Handling article.
The event handler signature is as follows: myhandler(const Ptr<Widget> & widget, const Ptr<Widget> & target_widget)

Return value

Current

Event<const Ptr<Widget> &, const Ptr<Widget> &> getEventDragMove() const#

Event triggered when a focused widget is moved. You can subscribe to events via connect()  and unsubscribe via disconnect(). You can also use EventConnection  and EventConnections  classes for convenience (see examples below).

Usage Example

Source code (C++)
// implement the DragMove event handler
void dragmove_event_handler(const Ptr<Widget> & widget,  const Ptr<Widget> & underlying_widget)
{
	Log::message("\Handling DragMove event\n");
}


//////////////////////////////////////////////////////////////////////////////
//  1. Multiple subscriptions can be linked to an instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections dragmove_event_connections;

// link to this instance when subscribing for an event (subscription for various events can be linked)
widget->getEventDragMove().connect(dragmove_event_connections, dragmove_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
widget->getEventDragMove().connect(dragmove_event_connections, [](const Ptr<Widget> & widget,  const Ptr<Widget> & underlying_widget) { 
		Log::message("\Handling DragMove event (lambda).\n");
	}
);

// ...

// later all of these linked subscriptions can be removed with a single line
dragmove_event_connections.disconnectAll();

//////////////////////////////////////////////////////////////////////////////
//  2. You can subscribe and unsubscribe via an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection dragmove_event_connection;

// subscribe for the DragMove event with a handler function keeping the connection
widget->getEventDragMove().connect(dragmove_event_connection, dragmove_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
dragmove_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
dragmove_event_connection.setEnabled(true);

// ...

// remove subscription for the DragMove event via the connection
dragmove_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A DragMove event handler implemented as a class member
	void event_handler(const Ptr<Widget> & widget,  const Ptr<Widget> & underlying_widget)
	{
		Log::message("\Handling DragMove event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
widget->getEventDragMove().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe for the DragMove event with a handler function
widget->getEventDragMove().connect(dragmove_event_handler);


// remove subscription for the DragMove event later by the handler function
widget->getEventDragMove().disconnect(dragmove_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId dragmove_handler_id;

// subscribe for the DragMove event with a lambda handler function and keeping connection ID
dragmove_handler_id = widget->getEventDragMove().connect([](const Ptr<Widget> & widget,  const Ptr<Widget> & underlying_widget) { 
		Log::message("\Handling DragMove event (lambda).\n");
	}
);

// remove the subscription later using the ID
widget->getEventDragMove().disconnect(dragmove_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all DragMove events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
widget->getEventDragMove().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
widget->getEventDragMove().setEnabled(true);
Notice
For more details see the Event Handling article.
The event handler signature is as follows: myhandler(const Ptr<Widget> & widget, const Ptr<Widget> & underlying_widget)

Return value

Current

Event<const Ptr<Widget> &> getEventLeave() const#

Event triggered when the mouse pointer leaves a widget. Supported by all widgets. You can subscribe to events via connect()  and unsubscribe via disconnect(). You can also use EventConnection  and EventConnections  classes for convenience (see examples below).

Usage Example

Source code (C++)
// implement the Leave event handler
void leave_event_handler(const Ptr<Widget> & widget)
{
	Log::message("\Handling Leave event\n");
}


//////////////////////////////////////////////////////////////////////////////
//  1. Multiple subscriptions can be linked to an instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections leave_event_connections;

// link to this instance when subscribing for an event (subscription for various events can be linked)
widget->getEventLeave().connect(leave_event_connections, leave_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
widget->getEventLeave().connect(leave_event_connections, [](const Ptr<Widget> & widget) { 
		Log::message("\Handling Leave event (lambda).\n");
	}
);

// ...

// later all of these linked subscriptions can be removed with a single line
leave_event_connections.disconnectAll();

//////////////////////////////////////////////////////////////////////////////
//  2. You can subscribe and unsubscribe via an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection leave_event_connection;

// subscribe for the Leave event with a handler function keeping the connection
widget->getEventLeave().connect(leave_event_connection, leave_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
leave_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
leave_event_connection.setEnabled(true);

// ...

// remove subscription for the Leave event via the connection
leave_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A Leave event handler implemented as a class member
	void event_handler(const Ptr<Widget> & widget)
	{
		Log::message("\Handling Leave event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
widget->getEventLeave().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe for the Leave event with a handler function
widget->getEventLeave().connect(leave_event_handler);


// remove subscription for the Leave event later by the handler function
widget->getEventLeave().disconnect(leave_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId leave_handler_id;

// subscribe for the Leave event with a lambda handler function and keeping connection ID
leave_handler_id = widget->getEventLeave().connect([](const Ptr<Widget> & widget) { 
		Log::message("\Handling Leave event (lambda).\n");
	}
);

// remove the subscription later using the ID
widget->getEventLeave().disconnect(leave_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all Leave events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
widget->getEventLeave().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
widget->getEventLeave().setEnabled(true);
Notice
For more details see the Event Handling article.
The event handler signature is as follows: myhandler(const Ptr<Widget> & widget)

Return value

Current

Event<const Ptr<Widget> &> getEventEnter() const#

Event triggered when the mouse pointer enters a widget. Supported by all widgets. You can subscribe to events via connect()  and unsubscribe via disconnect(). You can also use EventConnection  and EventConnections  classes for convenience (see examples below).

Usage Example

Source code (C++)
// implement the Enter event handler
void enter_event_handler(const Ptr<Widget> & widget)
{
	Log::message("\Handling Enter event\n");
}


//////////////////////////////////////////////////////////////////////////////
//  1. Multiple subscriptions can be linked to an instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections enter_event_connections;

// link to this instance when subscribing for an event (subscription for various events can be linked)
widget->getEventEnter().connect(enter_event_connections, enter_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
widget->getEventEnter().connect(enter_event_connections, [](const Ptr<Widget> & widget) { 
		Log::message("\Handling Enter event (lambda).\n");
	}
);

// ...

// later all of these linked subscriptions can be removed with a single line
enter_event_connections.disconnectAll();

//////////////////////////////////////////////////////////////////////////////
//  2. You can subscribe and unsubscribe via an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection enter_event_connection;

// subscribe for the Enter event with a handler function keeping the connection
widget->getEventEnter().connect(enter_event_connection, enter_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
enter_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
enter_event_connection.setEnabled(true);

// ...

// remove subscription for the Enter event via the connection
enter_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A Enter event handler implemented as a class member
	void event_handler(const Ptr<Widget> & widget)
	{
		Log::message("\Handling Enter event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
widget->getEventEnter().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe for the Enter event with a handler function
widget->getEventEnter().connect(enter_event_handler);


// remove subscription for the Enter event later by the handler function
widget->getEventEnter().disconnect(enter_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId enter_handler_id;

// subscribe for the Enter event with a lambda handler function and keeping connection ID
enter_handler_id = widget->getEventEnter().connect([](const Ptr<Widget> & widget) { 
		Log::message("\Handling Enter event (lambda).\n");
	}
);

// remove the subscription later using the ID
widget->getEventEnter().disconnect(enter_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all Enter events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
widget->getEventEnter().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
widget->getEventEnter().setEnabled(true);
Notice
For more details see the Event Handling article.
The event handler signature is as follows: myhandler(const Ptr<Widget> & widget)

Return value

Current

Event<const Ptr<Widget> &, unsigned int> getEventTextPressed() const#

Event triggered when a virtual key is pressed while a widget is in focus. Supported by the following widgets: Virtual key - is a value to which a scan code was converted by an Operating System (e.g., the Q scan code will have the Q virtual key on a QWERTY-keyboard, while on an AZERTY-keyboard it will have the A virtual key; or NUMPAD_DIGIT_7 scan code can be translated into virtual NUMPAD_HOME or NUMPAD_DIGIT_7 depending on the current Num Lock state. Virtual keys are used, when it is important to know what exactly did user type (not just the physical button, but rather a letter).
You can subscribe to events via connect()  and unsubscribe via disconnect(). You can also use EventConnection  and EventConnections  classes for convenience (see examples below).

Usage Example

Source code (C++)
// implement the TextPressed event handler
void textpressed_event_handler(const Ptr<Widget> & widget,  unsigned int unicode)
{
	Log::message("\Handling TextPressed event\n");
}


//////////////////////////////////////////////////////////////////////////////
//  1. Multiple subscriptions can be linked to an instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections textpressed_event_connections;

// link to this instance when subscribing for an event (subscription for various events can be linked)
widget->getEventTextPressed().connect(textpressed_event_connections, textpressed_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
widget->getEventTextPressed().connect(textpressed_event_connections, [](const Ptr<Widget> & widget,  unsigned int unicode) { 
		Log::message("\Handling TextPressed event (lambda).\n");
	}
);

// ...

// later all of these linked subscriptions can be removed with a single line
textpressed_event_connections.disconnectAll();

//////////////////////////////////////////////////////////////////////////////
//  2. You can subscribe and unsubscribe via an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection textpressed_event_connection;

// subscribe for the TextPressed event with a handler function keeping the connection
widget->getEventTextPressed().connect(textpressed_event_connection, textpressed_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
textpressed_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
textpressed_event_connection.setEnabled(true);

// ...

// remove subscription for the TextPressed event via the connection
textpressed_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A TextPressed event handler implemented as a class member
	void event_handler(const Ptr<Widget> & widget,  unsigned int unicode)
	{
		Log::message("\Handling TextPressed event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
widget->getEventTextPressed().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe for the TextPressed event with a handler function
widget->getEventTextPressed().connect(textpressed_event_handler);


// remove subscription for the TextPressed event later by the handler function
widget->getEventTextPressed().disconnect(textpressed_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId textpressed_handler_id;

// subscribe for the TextPressed event with a lambda handler function and keeping connection ID
textpressed_handler_id = widget->getEventTextPressed().connect([](const Ptr<Widget> & widget,  unsigned int unicode) { 
		Log::message("\Handling TextPressed event (lambda).\n");
	}
);

// remove the subscription later using the ID
widget->getEventTextPressed().disconnect(textpressed_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all TextPressed events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
widget->getEventTextPressed().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
widget->getEventTextPressed().setEnabled(true);
Notice
For more details see the Event Handling article.
The event handler signature is as follows: myhandler(const Ptr<Widget> & widget, unsigned int unicode)

Return value

Current

Event<const Ptr<Widget> &, int> getEventKeyPressed() const#

Event triggered when when a key (by a scan code) is pressed while a widget is in focus. Supported by the following widgets: Scan code - is a code assigned to avery key on the keyboard. Keyboard drivers use scan codes to detect which key is pressed. Scan codes are assigned to keys on the hardware level and are not affected by the states of modifiers like Caps Lock, Num Lock, Scroll Lock, Shift, Alt, and Ctrl making it possible to implement identical control on different types of keyboards (uiQWERTY, AZERTY, QWERTC, etc.). Scan codes are used when only a physical position of a key (a button) is important (e.g. in the ControlsApp class or Console key).
You can subscribe to events via connect()  and unsubscribe via disconnect(). You can also use EventConnection  and EventConnections  classes for convenience (see examples below).

Usage Example

Source code (C++)
// implement the KeyPressed event handler
void keypressed_event_handler(const Ptr<Widget> & widget,  int key)
{
	Log::message("\Handling KeyPressed event\n");
}


//////////////////////////////////////////////////////////////////////////////
//  1. Multiple subscriptions can be linked to an instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections keypressed_event_connections;

// link to this instance when subscribing for an event (subscription for various events can be linked)
widget->getEventKeyPressed().connect(keypressed_event_connections, keypressed_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
widget->getEventKeyPressed().connect(keypressed_event_connections, [](const Ptr<Widget> & widget,  int key) { 
		Log::message("\Handling KeyPressed event (lambda).\n");
	}
);

// ...

// later all of these linked subscriptions can be removed with a single line
keypressed_event_connections.disconnectAll();

//////////////////////////////////////////////////////////////////////////////
//  2. You can subscribe and unsubscribe via an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection keypressed_event_connection;

// subscribe for the KeyPressed event with a handler function keeping the connection
widget->getEventKeyPressed().connect(keypressed_event_connection, keypressed_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
keypressed_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
keypressed_event_connection.setEnabled(true);

// ...

// remove subscription for the KeyPressed event via the connection
keypressed_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A KeyPressed event handler implemented as a class member
	void event_handler(const Ptr<Widget> & widget,  int key)
	{
		Log::message("\Handling KeyPressed event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
widget->getEventKeyPressed().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe for the KeyPressed event with a handler function
widget->getEventKeyPressed().connect(keypressed_event_handler);


// remove subscription for the KeyPressed event later by the handler function
widget->getEventKeyPressed().disconnect(keypressed_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId keypressed_handler_id;

// subscribe for the KeyPressed event with a lambda handler function and keeping connection ID
keypressed_handler_id = widget->getEventKeyPressed().connect([](const Ptr<Widget> & widget,  int key) { 
		Log::message("\Handling KeyPressed event (lambda).\n");
	}
);

// remove the subscription later using the ID
widget->getEventKeyPressed().disconnect(keypressed_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all KeyPressed events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
widget->getEventKeyPressed().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
widget->getEventKeyPressed().setEnabled(true);
Notice
For more details see the Event Handling article.
The event handler signature is as follows: myhandler(const Ptr<Widget> & widget, int key)

Return value

Current

Event<const Ptr<Widget> &, int> getEventReleased() const#

Event triggered when the mouse is released after clicking somewhere on a widget. Supported by the following widgets: You can subscribe to events via connect()  and unsubscribe via disconnect(). You can also use EventConnection  and EventConnections  classes for convenience (see examples below).

Usage Example

Source code (C++)
// implement the Released event handler
void released_event_handler(const Ptr<Widget> & widget,  int mouse_buttons)
{
	Log::message("\Handling Released event\n");
}


//////////////////////////////////////////////////////////////////////////////
//  1. Multiple subscriptions can be linked to an instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections released_event_connections;

// link to this instance when subscribing for an event (subscription for various events can be linked)
widget->getEventReleased().connect(released_event_connections, released_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
widget->getEventReleased().connect(released_event_connections, [](const Ptr<Widget> & widget,  int mouse_buttons) { 
		Log::message("\Handling Released event (lambda).\n");
	}
);

// ...

// later all of these linked subscriptions can be removed with a single line
released_event_connections.disconnectAll();

//////////////////////////////////////////////////////////////////////////////
//  2. You can subscribe and unsubscribe via an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection released_event_connection;

// subscribe for the Released event with a handler function keeping the connection
widget->getEventReleased().connect(released_event_connection, released_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
released_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
released_event_connection.setEnabled(true);

// ...

// remove subscription for the Released event via the connection
released_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A Released event handler implemented as a class member
	void event_handler(const Ptr<Widget> & widget,  int mouse_buttons)
	{
		Log::message("\Handling Released event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
widget->getEventReleased().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe for the Released event with a handler function
widget->getEventReleased().connect(released_event_handler);


// remove subscription for the Released event later by the handler function
widget->getEventReleased().disconnect(released_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId released_handler_id;

// subscribe for the Released event with a lambda handler function and keeping connection ID
released_handler_id = widget->getEventReleased().connect([](const Ptr<Widget> & widget,  int mouse_buttons) { 
		Log::message("\Handling Released event (lambda).\n");
	}
);

// remove the subscription later using the ID
widget->getEventReleased().disconnect(released_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all Released events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
widget->getEventReleased().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
widget->getEventReleased().setEnabled(true);
Notice
For more details see the Event Handling article.
The event handler signature is as follows: myhandler(const Ptr<Widget> & widget, int mouse_buttons)

Return value

Current

Event<const Ptr<Widget> &, int> getEventPressed() const#

Event triggered when a mouse button or ENTER (RETURN) is pressed, while the mouse pointer is somewhere on a widget. Supported by the following widgets: You can subscribe to events via connect()  and unsubscribe via disconnect(). You can also use EventConnection  and EventConnections  classes for convenience (see examples below).

Usage Example

Source code (C++)
// implement the Pressed event handler
void pressed_event_handler(const Ptr<Widget> & widget,  int mouse_buttons)
{
	Log::message("\Handling Pressed event\n");
}


//////////////////////////////////////////////////////////////////////////////
//  1. Multiple subscriptions can be linked to an instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections pressed_event_connections;

// link to this instance when subscribing for an event (subscription for various events can be linked)
widget->getEventPressed().connect(pressed_event_connections, pressed_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
widget->getEventPressed().connect(pressed_event_connections, [](const Ptr<Widget> & widget,  int mouse_buttons) { 
		Log::message("\Handling Pressed event (lambda).\n");
	}
);

// ...

// later all of these linked subscriptions can be removed with a single line
pressed_event_connections.disconnectAll();

//////////////////////////////////////////////////////////////////////////////
//  2. You can subscribe and unsubscribe via an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection pressed_event_connection;

// subscribe for the Pressed event with a handler function keeping the connection
widget->getEventPressed().connect(pressed_event_connection, pressed_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
pressed_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
pressed_event_connection.setEnabled(true);

// ...

// remove subscription for the Pressed event via the connection
pressed_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A Pressed event handler implemented as a class member
	void event_handler(const Ptr<Widget> & widget,  int mouse_buttons)
	{
		Log::message("\Handling Pressed event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
widget->getEventPressed().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe for the Pressed event with a handler function
widget->getEventPressed().connect(pressed_event_handler);


// remove subscription for the Pressed event later by the handler function
widget->getEventPressed().disconnect(pressed_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId pressed_handler_id;

// subscribe for the Pressed event with a lambda handler function and keeping connection ID
pressed_handler_id = widget->getEventPressed().connect([](const Ptr<Widget> & widget,  int mouse_buttons) { 
		Log::message("\Handling Pressed event (lambda).\n");
	}
);

// remove the subscription later using the ID
widget->getEventPressed().disconnect(pressed_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all Pressed events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
widget->getEventPressed().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
widget->getEventPressed().setEnabled(true);
Notice
For more details see the Event Handling article.
The event handler signature is as follows: myhandler(const Ptr<Widget> & widget, int mouse_buttons)

Return value

Current

Event<const Ptr<Widget> &> getEventDoubleClicked() const#

Event triggered when the mouse is double-clicked somewhere on a widget. Supported by the following widgets: You can subscribe to events via connect()  and unsubscribe via disconnect(). You can also use EventConnection  and EventConnections  classes for convenience (see examples below).

Usage Example

Source code (C++)
// implement the DoubleClicked event handler
void doubleclicked_event_handler(const Ptr<Widget> & widget)
{
	Log::message("\Handling DoubleClicked event\n");
}


//////////////////////////////////////////////////////////////////////////////
//  1. Multiple subscriptions can be linked to an instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections doubleclicked_event_connections;

// link to this instance when subscribing for an event (subscription for various events can be linked)
widget->getEventDoubleClicked().connect(doubleclicked_event_connections, doubleclicked_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
widget->getEventDoubleClicked().connect(doubleclicked_event_connections, [](const Ptr<Widget> & widget) { 
		Log::message("\Handling DoubleClicked event (lambda).\n");
	}
);

// ...

// later all of these linked subscriptions can be removed with a single line
doubleclicked_event_connections.disconnectAll();

//////////////////////////////////////////////////////////////////////////////
//  2. You can subscribe and unsubscribe via an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection doubleclicked_event_connection;

// subscribe for the DoubleClicked event with a handler function keeping the connection
widget->getEventDoubleClicked().connect(doubleclicked_event_connection, doubleclicked_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
doubleclicked_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
doubleclicked_event_connection.setEnabled(true);

// ...

// remove subscription for the DoubleClicked event via the connection
doubleclicked_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A DoubleClicked event handler implemented as a class member
	void event_handler(const Ptr<Widget> & widget)
	{
		Log::message("\Handling DoubleClicked event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
widget->getEventDoubleClicked().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe for the DoubleClicked event with a handler function
widget->getEventDoubleClicked().connect(doubleclicked_event_handler);


// remove subscription for the DoubleClicked event later by the handler function
widget->getEventDoubleClicked().disconnect(doubleclicked_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId doubleclicked_handler_id;

// subscribe for the DoubleClicked event with a lambda handler function and keeping connection ID
doubleclicked_handler_id = widget->getEventDoubleClicked().connect([](const Ptr<Widget> & widget) { 
		Log::message("\Handling DoubleClicked event (lambda).\n");
	}
);

// remove the subscription later using the ID
widget->getEventDoubleClicked().disconnect(doubleclicked_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all DoubleClicked events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
widget->getEventDoubleClicked().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
widget->getEventDoubleClicked().setEnabled(true);
Notice
For more details see the Event Handling article.
The event handler signature is as follows: myhandler(const Ptr<Widget> & widget)

Return value

Current

Event<const Ptr<Widget> &, int> getEventClicked() const#

Event triggered when the mouse is clicked somewhere on a widget. Supported by the following widgets: You can subscribe to events via connect()  and unsubscribe via disconnect(). You can also use EventConnection  and EventConnections  classes for convenience (see examples below).

Usage Example

Source code (C++)
// implement the Clicked event handler
void clicked_event_handler(const Ptr<Widget> & widget,  int mouse_buttons)
{
	Log::message("\Handling Clicked event\n");
}


//////////////////////////////////////////////////////////////////////////////
//  1. Multiple subscriptions can be linked to an instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections clicked_event_connections;

// link to this instance when subscribing for an event (subscription for various events can be linked)
widget->getEventClicked().connect(clicked_event_connections, clicked_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
widget->getEventClicked().connect(clicked_event_connections, [](const Ptr<Widget> & widget,  int mouse_buttons) { 
		Log::message("\Handling Clicked event (lambda).\n");
	}
);

// ...

// later all of these linked subscriptions can be removed with a single line
clicked_event_connections.disconnectAll();

//////////////////////////////////////////////////////////////////////////////
//  2. You can subscribe and unsubscribe via an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection clicked_event_connection;

// subscribe for the Clicked event with a handler function keeping the connection
widget->getEventClicked().connect(clicked_event_connection, clicked_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
clicked_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
clicked_event_connection.setEnabled(true);

// ...

// remove subscription for the Clicked event via the connection
clicked_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A Clicked event handler implemented as a class member
	void event_handler(const Ptr<Widget> & widget,  int mouse_buttons)
	{
		Log::message("\Handling Clicked event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
widget->getEventClicked().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe for the Clicked event with a handler function
widget->getEventClicked().connect(clicked_event_handler);


// remove subscription for the Clicked event later by the handler function
widget->getEventClicked().disconnect(clicked_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId clicked_handler_id;

// subscribe for the Clicked event with a lambda handler function and keeping connection ID
clicked_handler_id = widget->getEventClicked().connect([](const Ptr<Widget> & widget,  int mouse_buttons) { 
		Log::message("\Handling Clicked event (lambda).\n");
	}
);

// remove the subscription later using the ID
widget->getEventClicked().disconnect(clicked_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all Clicked events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
widget->getEventClicked().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
widget->getEventClicked().setEnabled(true);
Notice
For more details see the Event Handling article.
The event handler signature is as follows: myhandler(const Ptr<Widget> & widget, int mouse_buttons)

Return value

Current

Event<const Ptr<Widget> &> getEventChanged() const#

Event triggered when a widget has changed its state. Supported by the following widgets: You can subscribe to events via connect()  and unsubscribe via disconnect(). You can also use EventConnection  and EventConnections  classes for convenience (see examples below).

Usage Example

Source code (C++)
// implement the Changed event handler
void changed_event_handler(const Ptr<Widget> & widget)
{
	Log::message("\Handling Changed event\n");
}


//////////////////////////////////////////////////////////////////////////////
//  1. Multiple subscriptions can be linked to an instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections changed_event_connections;

// link to this instance when subscribing for an event (subscription for various events can be linked)
widget->getEventChanged().connect(changed_event_connections, changed_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
widget->getEventChanged().connect(changed_event_connections, [](const Ptr<Widget> & widget) { 
		Log::message("\Handling Changed event (lambda).\n");
	}
);

// ...

// later all of these linked subscriptions can be removed with a single line
changed_event_connections.disconnectAll();

//////////////////////////////////////////////////////////////////////////////
//  2. You can subscribe and unsubscribe via an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection changed_event_connection;

// subscribe for the Changed event with a handler function keeping the connection
widget->getEventChanged().connect(changed_event_connection, changed_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
changed_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
changed_event_connection.setEnabled(true);

// ...

// remove subscription for the Changed event via the connection
changed_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A Changed event handler implemented as a class member
	void event_handler(const Ptr<Widget> & widget)
	{
		Log::message("\Handling Changed event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
widget->getEventChanged().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe for the Changed event with a handler function
widget->getEventChanged().connect(changed_event_handler);


// remove subscription for the Changed event later by the handler function
widget->getEventChanged().disconnect(changed_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId changed_handler_id;

// subscribe for the Changed event with a lambda handler function and keeping connection ID
changed_handler_id = widget->getEventChanged().connect([](const Ptr<Widget> & widget) { 
		Log::message("\Handling Changed event (lambda).\n");
	}
);

// remove the subscription later using the ID
widget->getEventChanged().disconnect(changed_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all Changed events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
widget->getEventChanged().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
widget->getEventChanged().setEnabled(true);
Notice
For more details see the Event Handling article.
The event handler signature is as follows: myhandler(const Ptr<Widget> & widget)

Return value

Current

Event<const Ptr<Widget> &> getEventFocusOut() const#

Event triggered when a widget loses focus. Supported by all widgets. You can subscribe to events via connect()  and unsubscribe via disconnect(). You can also use EventConnection  and EventConnections  classes for convenience (see examples below).

Usage Example

Source code (C++)
// implement the FocusOut event handler
void focusout_event_handler(const Ptr<Widget> & widget)
{
	Log::message("\Handling FocusOut event\n");
}


//////////////////////////////////////////////////////////////////////////////
//  1. Multiple subscriptions can be linked to an instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections focusout_event_connections;

// link to this instance when subscribing for an event (subscription for various events can be linked)
widget->getEventFocusOut().connect(focusout_event_connections, focusout_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
widget->getEventFocusOut().connect(focusout_event_connections, [](const Ptr<Widget> & widget) { 
		Log::message("\Handling FocusOut event (lambda).\n");
	}
);

// ...

// later all of these linked subscriptions can be removed with a single line
focusout_event_connections.disconnectAll();

//////////////////////////////////////////////////////////////////////////////
//  2. You can subscribe and unsubscribe via an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection focusout_event_connection;

// subscribe for the FocusOut event with a handler function keeping the connection
widget->getEventFocusOut().connect(focusout_event_connection, focusout_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
focusout_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
focusout_event_connection.setEnabled(true);

// ...

// remove subscription for the FocusOut event via the connection
focusout_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A FocusOut event handler implemented as a class member
	void event_handler(const Ptr<Widget> & widget)
	{
		Log::message("\Handling FocusOut event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
widget->getEventFocusOut().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe for the FocusOut event with a handler function
widget->getEventFocusOut().connect(focusout_event_handler);


// remove subscription for the FocusOut event later by the handler function
widget->getEventFocusOut().disconnect(focusout_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId focusout_handler_id;

// subscribe for the FocusOut event with a lambda handler function and keeping connection ID
focusout_handler_id = widget->getEventFocusOut().connect([](const Ptr<Widget> & widget) { 
		Log::message("\Handling FocusOut event (lambda).\n");
	}
);

// remove the subscription later using the ID
widget->getEventFocusOut().disconnect(focusout_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all FocusOut events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
widget->getEventFocusOut().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
widget->getEventFocusOut().setEnabled(true);
Notice
For more details see the Event Handling article.
The event handler signature is as follows: myhandler(const Ptr<Widget> & widget)

Return value

Current

Event<const Ptr<Widget> &> getEventFocusIn() const#

Event triggered when a widget is focused. Supported by all widgets. You can subscribe to events via connect()  and unsubscribe via disconnect(). You can also use EventConnection  and EventConnections  classes for convenience (see examples below).

Usage Example

Source code (C++)
// implement the FocusIn event handler
void focusin_event_handler(const Ptr<Widget> & widget)
{
	Log::message("\Handling FocusIn event\n");
}


//////////////////////////////////////////////////////////////////////////////
//  1. Multiple subscriptions can be linked to an instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections focusin_event_connections;

// link to this instance when subscribing for an event (subscription for various events can be linked)
widget->getEventFocusIn().connect(focusin_event_connections, focusin_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
widget->getEventFocusIn().connect(focusin_event_connections, [](const Ptr<Widget> & widget) { 
		Log::message("\Handling FocusIn event (lambda).\n");
	}
);

// ...

// later all of these linked subscriptions can be removed with a single line
focusin_event_connections.disconnectAll();

//////////////////////////////////////////////////////////////////////////////
//  2. You can subscribe and unsubscribe via an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection focusin_event_connection;

// subscribe for the FocusIn event with a handler function keeping the connection
widget->getEventFocusIn().connect(focusin_event_connection, focusin_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
focusin_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
focusin_event_connection.setEnabled(true);

// ...

// remove subscription for the FocusIn event via the connection
focusin_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A FocusIn event handler implemented as a class member
	void event_handler(const Ptr<Widget> & widget)
	{
		Log::message("\Handling FocusIn event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
widget->getEventFocusIn().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe for the FocusIn event with a handler function
widget->getEventFocusIn().connect(focusin_event_handler);


// remove subscription for the FocusIn event later by the handler function
widget->getEventFocusIn().disconnect(focusin_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId focusin_handler_id;

// subscribe for the FocusIn event with a lambda handler function and keeping connection ID
focusin_handler_id = widget->getEventFocusIn().connect([](const Ptr<Widget> & widget) { 
		Log::message("\Handling FocusIn event (lambda).\n");
	}
);

// remove the subscription later using the ID
widget->getEventFocusIn().disconnect(focusin_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all FocusIn events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
widget->getEventFocusIn().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
widget->getEventFocusIn().setEnabled(true);
Notice
For more details see the Event Handling article.
The event handler signature is as follows: myhandler(const Ptr<Widget> & widget)

Return value

Current

Event<const Ptr<Widget> &> getEventHide() const#

Event triggered when a widget is removed using Gui::removeChild(). Supported by all widgets. You can subscribe to events via connect()  and unsubscribe via disconnect(). You can also use EventConnection  and EventConnections  classes for convenience (see examples below).

Usage Example

Source code (C++)
// implement the Hide event handler
void hide_event_handler(const Ptr<Widget> & widget)
{
	Log::message("\Handling Hide event\n");
}


//////////////////////////////////////////////////////////////////////////////
//  1. Multiple subscriptions can be linked to an instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections hide_event_connections;

// link to this instance when subscribing for an event (subscription for various events can be linked)
widget->getEventHide().connect(hide_event_connections, hide_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
widget->getEventHide().connect(hide_event_connections, [](const Ptr<Widget> & widget) { 
		Log::message("\Handling Hide event (lambda).\n");
	}
);

// ...

// later all of these linked subscriptions can be removed with a single line
hide_event_connections.disconnectAll();

//////////////////////////////////////////////////////////////////////////////
//  2. You can subscribe and unsubscribe via an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection hide_event_connection;

// subscribe for the Hide event with a handler function keeping the connection
widget->getEventHide().connect(hide_event_connection, hide_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
hide_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
hide_event_connection.setEnabled(true);

// ...

// remove subscription for the Hide event via the connection
hide_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A Hide event handler implemented as a class member
	void event_handler(const Ptr<Widget> & widget)
	{
		Log::message("\Handling Hide event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
widget->getEventHide().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe for the Hide event with a handler function
widget->getEventHide().connect(hide_event_handler);


// remove subscription for the Hide event later by the handler function
widget->getEventHide().disconnect(hide_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId hide_handler_id;

// subscribe for the Hide event with a lambda handler function and keeping connection ID
hide_handler_id = widget->getEventHide().connect([](const Ptr<Widget> & widget) { 
		Log::message("\Handling Hide event (lambda).\n");
	}
);

// remove the subscription later using the ID
widget->getEventHide().disconnect(hide_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all Hide events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
widget->getEventHide().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
widget->getEventHide().setEnabled(true);
Notice
For more details see the Event Handling article.
The event handler signature is as follows: myhandler(const Ptr<Widget> & widget)

Return value

Current

Event<const Ptr<Widget> &> getEventShow() const#

Event triggered when a widget is shown. Supported by all widgets. You can subscribe to events via connect()  and unsubscribe via disconnect(). You can also use EventConnection  and EventConnections  classes for convenience (see examples below).

Usage Example

Source code (C++)
// implement the Show event handler
void show_event_handler(const Ptr<Widget> & widget)
{
	Log::message("\Handling Show event\n");
}


//////////////////////////////////////////////////////////////////////////////
//  1. Multiple subscriptions can be linked to an instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections show_event_connections;

// link to this instance when subscribing for an event (subscription for various events can be linked)
widget->getEventShow().connect(show_event_connections, show_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
widget->getEventShow().connect(show_event_connections, [](const Ptr<Widget> & widget) { 
		Log::message("\Handling Show event (lambda).\n");
	}
);

// ...

// later all of these linked subscriptions can be removed with a single line
show_event_connections.disconnectAll();

//////////////////////////////////////////////////////////////////////////////
//  2. You can subscribe and unsubscribe via an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection show_event_connection;

// subscribe for the Show event with a handler function keeping the connection
widget->getEventShow().connect(show_event_connection, show_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
show_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
show_event_connection.setEnabled(true);

// ...

// remove subscription for the Show event via the connection
show_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A Show event handler implemented as a class member
	void event_handler(const Ptr<Widget> & widget)
	{
		Log::message("\Handling Show event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
widget->getEventShow().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe for the Show event with a handler function
widget->getEventShow().connect(show_event_handler);


// remove subscription for the Show event later by the handler function
widget->getEventShow().disconnect(show_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId show_handler_id;

// subscribe for the Show event with a lambda handler function and keeping connection ID
show_handler_id = widget->getEventShow().connect([](const Ptr<Widget> & widget) { 
		Log::message("\Handling Show event (lambda).\n");
	}
);

// remove the subscription later using the ID
widget->getEventShow().disconnect(show_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all Show events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
widget->getEventShow().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
widget->getEventShow().setEnabled(true);
Notice
For more details see the Event Handling article.
The event handler signature is as follows: myhandler(const Ptr<Widget> & widget)

Return value

Current

Ptr<Widget> getChild ( int num ) const#

Returns a child widget with a given number.

Arguments

  • int num - Number of the child widget.

Return value

Pointer to the child widget.

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

Checks if a given widget is a child of the current one.

Arguments

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

Return value

1 if the widget in question is a child; otherwise, 0.

void setData ( const char * data ) #

Sets user data associated with the widget.

Arguments

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

const char * getData ( ) const#

Returns user data associated with the widget.

Return value

User string data. Data can be an xml formatted string.

void setEnabled ( bool enabled ) #

Enables or disables the widget.

Arguments

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

bool isEnabled ( ) const#

Returns a value indicating if the widget is enabled.

Return value

Returns true if the widget is enabled; otherwise, false.

void setFlags ( int flags ) #

Sets widget flags.

Arguments

  • int flags - flags.

int getFlags ( ) const#

Returns widget flags.

Return value

Widget flags: one of the Gui:: Enumeration with ALIGN_* prefixes. This is an optional parameter.

void setFocus ( ) #

Sets focus on the widget.

int isFocused ( ) const#

Returns a value indicating if the widget is in focus.

Return value

1 if the widget is in focus; otherwise, 0.

void setFont ( const char * name ) #

Sets a font that will be used to render text on the widget.

Arguments

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

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

Sets a font color that will be used to render text on the widget.

Arguments

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

Math::vec4 getFontColor ( ) const#

Returns the color of the font used by the widget.

Return value

Font color.

void setFontHOffset ( int hoffset ) #

Sets the horizontal offset of the font used by the widget.

Arguments

  • int hoffset - Horizontal offset value in pixels.

int getFontHOffset ( ) const#

Returns the horizontal offset of the font used by the widget.

Return value

Horizontal offset value in pixels.

void setFontHSpacing ( int hspacing ) #

Sets the spacing (in pixels) between widget text characters.

Arguments

  • int hspacing - Horizontal spacing value.

int getFontHSpacing ( ) const#

Returns the spacing (in pixels) between widget text characters.

Return value

Horizontal spacing value.

void setFontOutline ( int outline ) #

Sets a value indicating if widget text should be rendered casting a shadow. Positive or negative values set the distance in pixels to offset the font outline. The default is 0 (no outlining).

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 ( ) const#

Returns a value indicating if widget text is rendered casting a shadow. Positive or negative values determine the distance in pixels used to offset the font outline.

Return value

Positive value if outline is offset in the bottom-right corner direction. Negative value if outline is offset in the top-left corner direction. 0 if font is not outlined.

void setFontPermanent ( int permanent ) #

Sets a flag to prevent color change for the widget text (for example, when the widget becomes non-active or loses focus).

Arguments

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

int getFontPermanent ( ) const#

Returns a value indicating if color of the widget text is not changed even when it is disabled (non active), transparent (enabled option on non-active window), or widget loses focus.

Return value

1 if color of the widget text does not change; otherwise, 0.

void setFontRich ( int rich ) #

Sets a value indicating if rich text formatting should be used. The default is 0.

Arguments

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

int getFontRich ( ) const#

Returns a value indicating if rich text formatting is used.

Return value

1 if rich text formatting is used; otherwise, 0.

void setFontSize ( int size ) #

Sets a font size that will be used to render text on the widget.

Arguments

  • int size - Font size in pixels.

int getFontSize ( ) const#

Returns the size of the font used by the widget.

Return value

Font size.

void setFontVOffset ( int voffset ) #

Sets the vertical offset of the font used by the widget.

Arguments

  • int voffset - Vertical offset value, in pixels.

int getFontVOffset ( ) const#

Returns the vertical offset of the font, used by the widget.

Return value

Vertical offset value, in pixels.

void setFontVSpacing ( int vspacing ) #

Sets the spacing (in pixels) between widget text lines.

Arguments

  • int vspacing - Vertical spacing value.

int getFontVSpacing ( ) const#

Returns the spacing (in pixels) between widget text lines.

Return value

Vertical spacing value.

void setFontWrap ( int wrap ) #

Enables or disables text wrapping to widget width.

Arguments

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

int getFontWrap ( ) const#

Returns a value indicating if text wrapping to widget width is enabled.

Return value

1 if text wrapping is enabled; otherwise, 0.

Ptr<Gui> getGui ( ) const#

Returns a Gui instance that currently renders the widget. (This function can be used if the widget is created and used in two different GUIs, for example, in case of the Interface plugin.) It can be called only by root widgets. For child widgets, see getParentGui().

Return value

Current GUI instance used for the widget.

void setHeight ( int height ) #

Sets the minimal height of the widget, in pixels.
Notice
The widget cannot be smaller than its content (the texture, video, etc.). With setHeight() and setWidth() functions, it is only possible to make the widget bigger then the size of its content. For example, WidgetButton can be made bigger than its texture, but it cannot be made any smaller than the texture dimensions.

Arguments

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

int getHeight ( ) const#

Returns the current widget height ,in pixels.
Notice
You may need to call arrange() first, if you have added a new widget and want to get its height in the same frame. Otherwise, zero will be returned.

Return value

Widget's height, in pixels.

void setHidden ( bool hidden ) #

Hides or shows the widget. When a widget is hidden, space occupied by it is left empty, and other widgets are not re-arranged.

Arguments

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

bool isHidden ( ) const#

Returns a value indicating if the widget is hidden. When a widget is hidden, space occupied by it is left empty, and other widgets are not re-arranged.

Return value

true if the widget is hidden; otherwise, false.

bool getIntersection ( int local_pos_x, int local_pos_y ) const#

Checks for an intersection with the widget's bounds for the given point.

Arguments

  • int local_pos_x - Local X coordinate.
  • int local_pos_y - Local Y coordinate.

Return value

true if the input coordinate is inside the widget; otherwise, false.

Ptr<Widget> getHierarchyIntersection ( int screen_pos_x, int screen_pos_y ) #

Checks for an intersection with a widget that belongs to the hierarchy of the current widget.

Arguments

  • int screen_pos_x - The X coordinate of the screen position.
  • int screen_pos_y - The Y coordinate of the screen position.

Return value

Widget the intersection with which is found.

void setIntersectionEnabled ( bool enabled ) #

Sets a value indicating if intersection detection is enabled for the widget.

Arguments

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

bool isIntersectionEnabled ( ) const#

Returns a value indicating if intersection detection is enabled for the widget.

Return value

true if intersection detection is enabled for the widget; otherwise, false.

int getKeyActivity ( unsigned int key ) const#

Checks if a given key already has a special purpose for the widget.

Arguments

  • unsigned int key - ASCII key code: one of the Input::KEY_*values.

Return value

1 if the key cannot be used; otherwise, 0.

void setMouseCursor ( int cursor ) #

Sets a mouse pointer to display over a widget.

Arguments

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

int getMouseCursor ( ) const#

Returns the type of mouse pointer displayed over a widget.

Return value

Mouse pointer. One of the available pointers with CURSOR_* prefixes described in the article on Gui class functions.

int getMouseX ( ) const#

Returns the X coordinate of the mouse pointer position in the widget's local space.

Return value

X coordinate of the mouse pointer position in the widget's local space.

int getMouseY ( ) const#

Returns the Y coordinate of the mouse pointer position in the widget's local space.

Return value

Y coordinate of the mouse pointer position in the widget's local space.

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

Sets a widget which will be focused next if the user presses TAB.

Arguments

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

Ptr<Widget> getNextFocus ( ) const#

Returns a widget which will be focused next if the user presses TAB.

Return value

Next widget.

int getNumChildren ( ) const#

Returns the number of children of the widget.

Return value

Number of child widgets.

void setOrder ( int order ) #

Sets rendering order (Z-order) for the widget. The higher the value, the higher the order of the widget will be.
Notice
Works only for widgets added to GUI via the Gui::addChild() function with the Gui::ALIGN_OVERLAP flag specified (should not be Gui::ALIGN_FIXED).
Source code (C++)
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 ( ) const#

Returns rendering order (Z-order) for the widget.

Return value

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

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

Sets a parent widget for the current one.

Arguments

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

Ptr<Widget> getParent ( ) const#

Returns the pointer to the parent widget.

Return value

Parent widget smart pointer.

Ptr<Gui> getParentGui ( ) const#

Returns a Gui instance that currently renders the widget's parent, if the widget has a parent. (This function can be used if the widget is created and used in two different GUIs, for example, in case of the Interface plugin.)

Return value

Current GUI instance used for the widget's parent.

void setPermanentFocus ( ) #

Sets permanent focus on the widget (it means that the widget is always in focus).

void setPosition ( int x, int y ) #

Sets a position of the widget relative to its parent.

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 ( ) const#

Returns the X coordinate of the widget position relative to its parent.

Return value

The relative X coordinate.

int getPositionY ( ) const#

Returns the Y coordinate of the widget position relative to its parent.

Return value

Relative Y coordinate.

int getScreenPositionX ( ) const#

Returns the screen position of the widget (its top left corner) on the screen along the X axis.

Return value

Screen position along the X axis in pixels.

int getScreenPositionY ( ) const#

Returns the screen position of the widget (its top left corner) on the screen along the Y axis.

Return value

Screen position along the Y axis in pixels.

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

Sets a tooltip for the widget.

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 ( ) const#

Returns the widget's tooltip text.

Return value

Tooltip text.

Widget::TYPE getType ( ) const#

Returns the type of the widget.

Return value

Widget type identifier.

const char * getTypeName ( ) const#

Returns the name of the widget type.

Return value

Widget type name.

void setWidth ( int width ) #

Sets the minimal width of the widget, in pixels.
Notice
The widget cannot be smaller than its content (the texture, video, etc.). With setHeight() and setWidth() functions, it is only possible to make the widget bigger then the size of its content. For example, WidgetButton can be made bigger than its texture, but it cannot be made any smaller than the texture dimensions.

Arguments

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

int getWidth ( ) const#

Returns the current widget width, in pixels.
Notice
You may need to call arrange() first, if you have added a new widget and want to get its width in the same frame. Otherwise, zero will be returned.

Return value

Widget width, in pixels.

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

Attaches a given widget to the current one. When applied to checkboxes, converts them into a group of radio buttons. A horizontal/vertical slider can be attached to a label or a text field. The text field can be attached to any of the sliders.

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 ) #

Adds a child to the widget.

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 ( ) #

Rearranges the widget and its children to lay them out neatly. This function forces to recalculate widget size and allows to get updated GUI layout data in the current frame. If this function is not called, widget modifications made in the current update() will be available only in the next frame (i.e. with one-frame lag), as GUI is calculated and rendered after the script update() function has been executed.

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

Brings a given widget to the top.
Notice
Works only for widgets added to GUI via the Gui::addChild() function with the Gui::ALIGN_OVERLAP flag specified (should not be Gui::ALIGN_FIXED).

Arguments

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

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

Detaches a given widget from the current one.

Arguments

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

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

Removes a child widget from the list of the widget's children.

Arguments

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

void removeFocus ( ) #

Removes focus from the widget.

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

Replaces one child widget with another.

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.

bool isExpanded ( ) const#

Returns a value indicating if the widget is expanded.

Return value

true if the widget is expanded; otherwise, false.

bool isOverlapped ( ) const#

Returns a value indicating if the widget is overlapped.

Return value

true if the widget is overlapped; otherwise, false.

bool isBackground ( ) const#

Returns a value indicating if the widget is a background one.

Return value

true if the widget a background one; otherwise, false.

bool isFixed ( ) const#

Returns a value indicating if the widget is fixed.

Return value

true if the widget is fixed; otherwise, false.

bool isLayout ( ) const#

Returns a value indicating if the widget is of a type that is responsible for the layout.

Return value

true if the widget is a layout; otherwise, false.

Widget::LIFETIME getLifetimeSelf ( ) const#

Returns the lifetime management type set for the widget.
Notice
Lifetime of each widget in the hierarchy is defined by it's root. Setting lifetime management type for a child widget different from the one set for the root has no effect.

void setLifetime ( Widget::LIFETIME lifetime ) #

Sets the lifetime management type for the widget. By default, the LIFETIME_ENGINE type is used.

Arguments

Widget::LIFETIME getLifetime ( ) const#

Returns the lifetime management type for the root of the widget, or for the widget itself (if it is not a child for another widget).
Notice
Lifetime of each widget in the hierarchy is defined by its root. Thus, lifetime management type set for a child widget that differs from the one set for the root is ignored.

Return value

Lifetime management type.

int getRenderWidth ( ) const#

Returns the widget frame width in pixels.

Return value

The widget frame width in pixels.

int getRenderHeight ( ) const#

Returns the widget frame height in pixels.

Return value

The widget frame height in pixels.

float getDpiScale ( ) const#

Returns the current DPI scale applied to the widget.

Return value

The current DPI scale applied to the widget.

int toRenderSize ( int unit_size ) #

Transforms the unit value to the pixel value.

Arguments

  • int unit_size - Size in units.

Return value

Size in pixels.

int toUnitSize ( int render_size ) #

Transforms the pixel value to the unit value.

Arguments

  • int render_size - Size in pixels.

Return value

Size in units.

Math::ivec2 toRenderSize ( const Math::ivec2 & unit_size ) #

Transforms the unit value to the pixel value.

Arguments

  • const Math::ivec2 & unit_size - Size in units.

Return value

Size in pixels.

Math::ivec2 toUnitSize ( const Math::ivec2 & render_size ) #

Transforms the pixel value to the unit value.

Arguments

  • const Math::ivec2 & render_size - Size in pixels.

Return value

Size in units.

Math::ivec2 getTextRenderSize ( const char * OUT_text ) const#

Arguments

  • const char * OUT_text

void runEventShow ( ) #

Emulates the Show event.

void runEventHide ( ) #

Emulates the Hide event.

void runEventFocusIn ( ) #

Emulates the FocusIn event.

void runEventFocusOut ( ) #

Emulates the FocusOut event.

void runEventChanged ( ) #

Emulates the Changed event.

void runEventClicked ( int mouse_buttons ) #

Emulates the Clicked event.

Arguments

  • int mouse_buttons - Mouse button. One of the MOUSE_BUTTON values.

void runEventDoubleClicked ( ) #

Emulates the DoubleClicked event.

void runEventPressed ( int mouse_buttons ) #

Emulates the Pressed event.

Arguments

  • int mouse_buttons - Mouse button. One of the MOUSE_BUTTON values.

void runEventReleased ( int mouse_buttons ) #

Emulates the Released event.

Arguments

  • int mouse_buttons - Mouse button. One of the MOUSE_BUTTON values.

void runEventKeyPressed ( int key ) #

Emulates the KeyPressed event.

Arguments

  • int key - Key scan code.

void runEventTextPressed ( unsigned int code ) #

Emulates the TextPressed event.

Arguments

  • unsigned int code - Vistual key.

void runEventEnter ( ) #

Emulates the Enter event.

void runEventLeave ( ) #

Emulates the Leave event.

void runEventDragMove ( const Ptr<Widget> & pointer ) #

Emulates the DragMove event.

Arguments

  • const Ptr<Widget> & pointer - Underlying widget.

void runEventDragDrop ( const Ptr<Widget> & pointer ) #

Emulates the DragDrop event.

Arguments

  • const Ptr<Widget> & pointer - Target widget.
Last update: 2024-01-16
Build: ()