C++ namespace Util::UI
UI

Description

Classes

struct	Util::UI::ButtonEvent
class	Util::UI::Cursor
union	Util::UI::Event
class	Util::UI::EventContext Context to store event-related data.
class	Util::UI::EventQueue Data structure for event handling.
struct	Util::UI::JoyAxisEvent
struct	Util::UI::JoyButtonEvent
struct	Util::UI::JoyHatEvent
struct	Util::UI::KeyboardEvent
struct	Util::UI::MotionEvent
struct	Util::UI::QuitEvent
struct	Util::UI::ResizeEvent
class	Util::UI::SplashScreen
class	Util::UI::Window
class	Util::UI::WindowSDL

Enumerations

enum	EventType_t {EVENT_QUIT, EVENT_RESIZE, EVENT_KEYBOARD, EVENT_MOUSE_BUTTON, EVENT_MOUSE_MOTION, EVENT_JOY_AXIS, EVENT_JOY_BUTTON, EVENT_JOY_HAT}
enum	Key {KEY_NONE, KEY_BACKSPACE, KEY_TAB, KEY_LINEFEED, KEY_CLEAR, KEY_RETURN, KEY_PAUSE, KEY_SCROLLLOCK, KEY_SYSREQ, KEY_ESCAPE, KEY_DELETE, KEY_MULTIKEY, KEY_HOME, KEY_LEFT, KEY_UP, KEY_RIGHT, KEY_DOWN, KEY_PAGEUP, KEY_PAGEDOWN, KEY_END, KEY_PRINT, KEY_INSERT, KEY_UNDO, KEY_REDO, KEY_MENU, KEY_HELP, KEY_BREAK, KEY_MODESWITCH, KEY_NUMLOCK, KEY_KPENTER, KEY_KPEQUAL, KEY_KPMULTIPLY, KEY_KPADD, KEY_KPSEPARATOR, KEY_KPSUBTRACT, KEY_KPDIVIDE, KEY_KP0, KEY_KP1, KEY_KP2, KEY_KP3, KEY_KP4, KEY_KP5, KEY_KP6, KEY_KP7, KEY_KP8, KEY_KP9, KEY_F1, KEY_F2, KEY_F3, KEY_F4, KEY_F5, KEY_F6, KEY_F7, KEY_F8, KEY_F9, KEY_F10, KEY_F11, KEY_F12, KEY_F13, KEY_F14, KEY_F15, KEY_SHIFTL, KEY_SHIFTR, KEY_CONTROLL, KEY_CONTROLR, KEY_METAL, KEY_METAR, KEY_ALTL, KEY_ALTR, KEY_SUPERL, KEY_SUPERR, KEY_CAPSLOCK, KEY_SPACE, KEY_EXCLAMATION, KEY_QUOTATION, KEY_NUMBERSIGN, KEY_DOLLAR, KEY_PERCENT, KEY_AMPERSAND, KEY_APOSTROPHE, KEY_PARENLEFT, KEY_PARENRIGHT, KEY_ASTERISK, KEY_PLUS, KEY_COMMA, KEY_MINUS, KEY_PERIOD, KEY_SLASH, KEY_0, KEY_1, KEY_2, KEY_3, KEY_4, KEY_5, KEY_6, KEY_7, KEY_8, KEY_9, KEY_COLON, KEY_SEMICOLON, KEY_LESS, KEY_EQUAL, KEY_GREATER, KEY_QUESTION, KEY_AT, KEY_A, KEY_B, KEY_C, KEY_D, KEY_E, KEY_F, KEY_G, KEY_H, KEY_I, KEY_J, KEY_K, KEY_L, KEY_M, KEY_N, KEY_O, KEY_P, KEY_Q, KEY_R, KEY_S, KEY_T, KEY_U, KEY_V, KEY_W, KEY_X, KEY_Y, KEY_Z, KEY_BRACKETLEFT, KEY_BACKSLASH, KEY_BRACKETRIGHT, KEY_CIRCUMFLEX, KEY_UNDERSCORE, KEY_GRAVE, KEY_BRACELEFT, KEY_BAR, KEY_BRACERIGHT, KEY_TILDE, KEY_EUROSIGN}
enum	Button {MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE, MOUSE_BUTTON_RIGHT, MOUSE_WHEEL_UP, MOUSE_WHEEL_DOWN, MOUSE_BUTTON_OTHER}

Variables

const uint8_t	MASK_NO_BUTTON
const uint8_t	MASK_MOUSE_BUTTON_LEFT
const uint8_t	MASK_MOUSE_BUTTON_MIDDLE
const uint8_t	MASK_MOUSE_BUTTON_RIGHT
const uint8_t	MASK_HAT_CENTER
const uint8_t	MASK_HAT_UP
const uint8_t	MASK_HAT_RIGHT
const uint8_t	MASK_HAT_DOWN
const uint8_t	MASK_HAT_LEFT

Functions

std::unique_ptr< Cursor >	createCursor(const Reference < Bitmap > & image, unsigned int hotSpotX, unsigned int hotSpotY)
std::unique_ptr< SplashScreen >	createSplashScreen(const std::string & splashTitle, const Reference < Bitmap > & splashImage)
Util::Reference < Window >	createWindow(const Window::Properties & properties)

---

Documentation

enum
Util::UI::EventType_t

public

enum EventType_t

Enumerator		Description
Enumerator		Description
EVENT_QUIT
EVENT_RESIZE
EVENT_KEYBOARD
EVENT_MOUSE_BUTTON
EVENT_MOUSE_MOTION
EVENT_JOY_AXIS
EVENT_JOY_BUTTON
EVENT_JOY_HAT

_{Defined in Util/UI/Event.h:20}

---

enum
Util::UI::Key

public

enum Key

Enumerator		Description
Enumerator		Description
KEY_NONE
KEY_BACKSPACE
KEY_TAB
KEY_LINEFEED
KEY_CLEAR
KEY_RETURN
KEY_PAUSE
KEY_SCROLLLOCK
KEY_SYSREQ
KEY_ESCAPE
KEY_DELETE
KEY_MULTIKEY
KEY_HOME
KEY_LEFT
KEY_UP
KEY_RIGHT
KEY_DOWN
KEY_PAGEUP
KEY_PAGEDOWN
KEY_END
KEY_PRINT
KEY_INSERT
KEY_UNDO
KEY_REDO
KEY_MENU
KEY_HELP
KEY_BREAK
KEY_MODESWITCH
KEY_NUMLOCK
KEY_KPENTER
KEY_KPEQUAL
KEY_KPMULTIPLY
KEY_KPADD
KEY_KPSEPARATOR
KEY_KPSUBTRACT
KEY_KPDIVIDE
KEY_KP0
KEY_KP1
KEY_KP2
KEY_KP3
KEY_KP4
KEY_KP5
KEY_KP6
KEY_KP7
KEY_KP8
KEY_KP9
KEY_F1
KEY_F2
KEY_F3
KEY_F4
KEY_F5
KEY_F6
KEY_F7
KEY_F8
KEY_F9
KEY_F10
KEY_F11
KEY_F12
KEY_F13
KEY_F14
KEY_F15
KEY_SHIFTL
KEY_SHIFTR
KEY_CONTROLL
KEY_CONTROLR
KEY_METAL
KEY_METAR
KEY_ALTL
KEY_ALTR
KEY_SUPERL
KEY_SUPERR
KEY_CAPSLOCK
KEY_SPACE
KEY_EXCLAMATION
KEY_QUOTATION
KEY_NUMBERSIGN
KEY_DOLLAR
KEY_PERCENT
KEY_AMPERSAND
KEY_APOSTROPHE
KEY_PARENLEFT
KEY_PARENRIGHT
KEY_ASTERISK
KEY_PLUS
KEY_COMMA
KEY_MINUS
KEY_PERIOD
KEY_SLASH
KEY_0
KEY_1
KEY_2
KEY_3
KEY_4
KEY_5
KEY_6
KEY_7
KEY_8
KEY_9
KEY_COLON
KEY_SEMICOLON
KEY_LESS
KEY_EQUAL
KEY_GREATER
KEY_QUESTION
KEY_AT
KEY_A
KEY_B
KEY_C
KEY_D
KEY_E
KEY_F
KEY_G
KEY_H
KEY_I
KEY_J
KEY_K
KEY_L
KEY_M
KEY_N
KEY_O
KEY_P
KEY_Q
KEY_R
KEY_S
KEY_T
KEY_U
KEY_V
KEY_W
KEY_X
KEY_Y
KEY_Z
KEY_BRACKETLEFT
KEY_BACKSLASH
KEY_BRACKETRIGHT
KEY_CIRCUMFLEX
KEY_UNDERSCORE
KEY_GRAVE
KEY_BRACELEFT
KEY_BAR
KEY_BRACERIGHT
KEY_TILDE
KEY_EUROSIGN

_{Defined in Util/UI/Event.h:41}

---

enum
Util::UI::Button

public

enum Button

Enumerator		Description
Enumerator		Description
MOUSE_BUTTON_LEFT
MOUSE_BUTTON_MIDDLE
MOUSE_BUTTON_RIGHT
MOUSE_WHEEL_UP
MOUSE_WHEEL_DOWN
MOUSE_BUTTON_OTHER

_{Defined in Util/UI/Event.h:197}

---

variable
Util::UI::MASK_NO_BUTTON

public

const uint8_t MASK_NO_BUTTON

_{Defined in Util/UI/Event.h:213}

---

variable
Util::UI::MASK_MOUSE_BUTTON_LEFT

public

const uint8_t MASK_MOUSE_BUTTON_LEFT

_{Defined in Util/UI/Event.h:214}

---

variable
Util::UI::MASK_MOUSE_BUTTON_MIDDLE

public

const uint8_t MASK_MOUSE_BUTTON_MIDDLE

_{Defined in Util/UI/Event.h:215}

---

variable
Util::UI::MASK_MOUSE_BUTTON_RIGHT

public

const uint8_t MASK_MOUSE_BUTTON_RIGHT

_{Defined in Util/UI/Event.h:216}

---

variable
Util::UI::MASK_HAT_CENTER

public

const uint8_t MASK_HAT_CENTER

_{Defined in Util/UI/Event.h:240}

---

variable
Util::UI::MASK_HAT_UP

public

const uint8_t MASK_HAT_UP

_{Defined in Util/UI/Event.h:241}

---

variable
Util::UI::MASK_HAT_RIGHT

public

const uint8_t MASK_HAT_RIGHT

_{Defined in Util/UI/Event.h:242}

---

variable
Util::UI::MASK_HAT_DOWN

public

const uint8_t MASK_HAT_DOWN

_{Defined in Util/UI/Event.h:243}

---

variable
Util::UI::MASK_HAT_LEFT

public

const uint8_t MASK_HAT_LEFT

_{Defined in Util/UI/Event.h:244}

---

function
Util::UI::createCursor

public

std::unique_ptr< Cursor > createCursor(	const Reference < Bitmap > &	image,
	unsigned int	hotSpotX,
	unsigned int	hotSpotY
)

Factory function to create a new Cursor . This will automatically select the preferred implementation of this class.

Parameters

image

Bitmap that will be used as cursor image

hotSpotX

Horizontal coordinate of the hot spot of the cursor

hotSpotY

Vertical coordinate of the hot spot of the cursor

Returns

Object of preferred Cursor implementation. If no implementation was found or an error occurred,nullptrwill be returned.

_{Defined in Util/UI/UI.h:32}

---

function
Util::UI::createSplashScreen

public

std::unique_ptr< SplashScreen > createSplashScreen(	const std::string &	splashTitle,
	const Reference < Bitmap > &	splashImage
)

Factory function to create a new SplashScreen . This will automatically select the preferred implementation of this class.

Parameters

splashTitle

Window title for the splash screen.

splashImage

Bitmap that will be displayed by the splash screen. The bitmap is not copied and the pointer has to stay valid for the time the splash screen is displayed.

Returns

Object of preferred SplashScreen implementation. If no implementation was found or an error occurred,nullptrwill be returned.

_{Defined in Util/UI/UI.h:43}

---

function
Util::UI::createWindow

public

Util::Reference < Window > createWindow(	const Window::Properties &	properties )

Factory function to create a new Window . This will automatically select the preferred implementation of this class.

Parameters

properties

See also: Window.h.

Returns

Object of preferred Window implementation. If no implementation was found or an error occurred,nullptrwill be returned.

_{Defined in Util/UI/UI.h:52}

---