The gui namespace contains useful classes for easy creation of a graphical user interface. More...

Classes
struct	SCursorSprite
	structure used to set sprites as cursors. More...
class	ICursorControl
	Interface to manipulate the mouse cursor. More...

Enumerations
enum	ECURSOR_ICON { ECI_NORMAL , ECI_CROSS , ECI_HAND , ECI_HELP , ECI_IBEAM , ECI_NO , ECI_WAIT , ECI_SIZEALL , ECI_SIZENESW , ECI_SIZENWSE , ECI_SIZENS , ECI_SIZEWE , ECI_UP , ECI_COUNT }
	Default icons for cursors.
enum	ECURSOR_PLATFORM_BEHAVIOR { ECPB_NONE = 0 , ECPB_X11_CACHE_UPDATES = 1 }
	platform specific behavior flags for the cursor More...
enum	EGUI_EVENT_TYPE { EGET_ELEMENT_FOCUS_LOST = 0 , EGET_ELEMENT_FOCUSED , EGET_ELEMENT_HOVERED , EGET_ELEMENT_LEFT , EGET_ELEMENT_CLOSED , EGET_BUTTON_CLICKED , EGET_SCROLL_BAR_CHANGED , EGET_CHECKBOX_CHANGED , EGET_LISTBOX_CHANGED , EGET_LISTBOX_SELECTED_AGAIN , EGET_FILE_SELECTED , EGET_DIRECTORY_SELECTED , EGET_FILE_CHOOSE_DIALOG_CANCELLED , EGET_MESSAGEBOX_YES , EGET_MESSAGEBOX_NO , EGET_MESSAGEBOX_OK , EGET_MESSAGEBOX_CANCEL , EGET_EDITBOX_ENTER , EGET_EDITBOX_CHANGED , EGET_EDITBOX_MARKING_CHANGED , EGET_TAB_CHANGED , EGET_MENU_ITEM_SELECTED , EGET_COMBO_BOX_CHANGED , EGET_SPINBOX_CHANGED , EGET_TABLE_CHANGED , EGET_TABLE_HEADER_CHANGED , EGET_TABLE_SELECTED_AGAIN , EGET_TREEVIEW_NODE_DESELECT , EGET_TREEVIEW_NODE_SELECT , EGET_TREEVIEW_NODE_EXPAND , EGET_TREEVIEW_NODE_COLLAPSE , EGET_TREEVIEW_NODE_COLLAPS = EGET_TREEVIEW_NODE_COLLAPSE , EGET_COUNT }
	Enumeration for all events which are sendable by the gui system. More...

Variables
const c8 *const	GUICursorIconNames [ECI_COUNT+1]
	Names for ECURSOR_ICON.

Detailed Description

The gui namespace contains useful classes for easy creation of a graphical user interface.

Enumeration Type Documentation

◆ ECURSOR_PLATFORM_BEHAVIOR

enum irr::gui::ECURSOR_PLATFORM_BEHAVIOR

platform specific behavior flags for the cursor

Enumerator

ECPB_NONE

default - no platform specific behavior

ECPB_X11_CACHE_UPDATES

On X11 try caching cursor updates as XQueryPointer calls can be expensive.

Update cursor positions only when the irrlicht timer has been updated or the timer is stopped. This means you usually get one cursor update per device->run() which will be fine in most cases. See this forum-thread for a more detailed explanation: http://irrlicht.sourceforge.net/forum/viewtopic.php?f=7&t=45525

◆ EGUI_EVENT_TYPE

enum irr::gui::EGUI_EVENT_TYPE

Enumeration for all events which are sendable by the gui system.

Enumerator
EGET_ELEMENT_FOCUS_LOST	A gui element has lost its focus. GUIEvent.Caller is losing the focus to GUIEvent.Element. If the event is absorbed then the focus will not be changed.
EGET_ELEMENT_FOCUSED	A gui element has got the focus. If the event is absorbed then the focus will not be changed.
EGET_ELEMENT_HOVERED	The mouse cursor hovered over a gui element. If an element has sub-elements you also get this message for the subelements
EGET_ELEMENT_LEFT	The mouse cursor left the hovered element. If an element has sub-elements you also get this message for the subelements
EGET_ELEMENT_CLOSED	An element would like to close. Windows and context menus use this event when they would like to close, this can be cancelled by absorbing the event.
EGET_BUTTON_CLICKED	A button was clicked.
EGET_SCROLL_BAR_CHANGED	A scrollbar has changed its position.
EGET_CHECKBOX_CHANGED	A checkbox has changed its check state.
EGET_LISTBOX_CHANGED	A new item in a listbox was selected. NOTE: You also get this event currently when the same item was clicked again after more than 500 ms.
EGET_LISTBOX_SELECTED_AGAIN	An item in the listbox was selected, which was already selected. NOTE: You get the event currently only if the item was clicked again within 500 ms or selected by "enter" or "space".
EGET_FILE_SELECTED	A file has been selected in the file dialog.
EGET_DIRECTORY_SELECTED	A directory has been selected in the file dialog.
EGET_FILE_CHOOSE_DIALOG_CANCELLED	A file open dialog has been closed without choosing a file.
EGET_MESSAGEBOX_YES	'Yes' was clicked on a messagebox
EGET_MESSAGEBOX_NO	'No' was clicked on a messagebox
EGET_MESSAGEBOX_OK	'OK' was clicked on a messagebox
EGET_MESSAGEBOX_CANCEL	'Cancel' was clicked on a messagebox
EGET_EDITBOX_ENTER	In an editbox 'ENTER' was pressed.
EGET_EDITBOX_CHANGED	The text in an editbox was changed. This does not include automatic changes in text-breaking.
EGET_EDITBOX_MARKING_CHANGED	The marked area in an editbox was changed.
EGET_TAB_CHANGED	The tab was changed in an tab control.
EGET_MENU_ITEM_SELECTED	A menu item was selected in a (context) menu.
EGET_COMBO_BOX_CHANGED	The selection in a combo box has been changed.
EGET_SPINBOX_CHANGED	The value of a spin box has changed.
EGET_TABLE_CHANGED	A table has changed.
EGET_TREEVIEW_NODE_DESELECT	A tree view node lost selection. See IGUITreeView::getLastEventNode().
EGET_TREEVIEW_NODE_SELECT	A tree view node was selected. See IGUITreeView::getLastEventNode().
EGET_TREEVIEW_NODE_EXPAND	A tree view node was expanded. See IGUITreeView::getLastEventNode().
EGET_TREEVIEW_NODE_COLLAPSE	A tree view node was collapsed. See IGUITreeView::getLastEventNode().
EGET_TREEVIEW_NODE_COLLAPS	deprecated - use EGET_TREEVIEW_NODE_COLLAPSE instead. This may be removed by Irrlicht 1.9
EGET_COUNT	No real event. Just for convenience to get number of events.

Variable Documentation

◆ GUICursorIconNames

const c8* const irr::gui::GUICursorIconNames[ECI_COUNT+1]

Initial value:

                              =
{
    "normal",
    "cross",
    "hand",
    "help",
    "ibeam",
    "no",
    "wait",
    "sizeall",
    "sizenesw",
    "sizenwse",
    "sizens",
    "sizewe",
    "sizeup",
    0
}

Names for ECURSOR_ICON.

Classes