Graphical User Interface

Topics
	Graphics
	Widgets

Files
file	gui_event.hpp
	Definition of GUI event types.
file	gui_event_type.hpp
	Definition of GUI event type.
file	gui_event_variant.hpp
	Definition of a GUI event variant.

Data Structures
struct	hi::v1::mouse_event_data
	Information for a mouse event. More...
class	hi::v1::gui_event
	A user interface event. More...

Enumerations
enum class	hi::v1::gui_event_type {   none , keyboard_down , keyboard_up , keyboard_grapheme ,   keyboard_partial_grapheme , keyboard_enter , keyboard_exit , mouse_move ,   mouse_drag , mouse_down , mouse_up , mouse_wheel ,   mouse_enter , mouse_exit , mouse_exit_window , hi::v1::gui_event_type::window_redraw ,   hi::v1::gui_event_type::window_relayout , hi::v1::gui_event_type::window_reconstrain , hi::v1::gui_event_type::window_resize , hi::v1::gui_event_type::window_minimize ,   hi::v1::gui_event_type::window_maximize , hi::v1::gui_event_type::window_normalize , hi::v1::gui_event_type::window_close , hi::v1::gui_event_type::window_open_sysmenu ,   hi::v1::gui_event_type::window_set_keyboard_target , hi::v1::gui_event_type::window_set_clipboard , hi::v1::gui_event_type::window_activate , hi::v1::gui_event_type::window_deactivate ,   text_cursor_left_char , text_cursor_right_char , text_cursor_down_char , text_cursor_up_char ,   text_cursor_left_word , text_cursor_right_word , text_cursor_begin_line , text_cursor_end_line ,   text_cursor_begin_sentence , text_cursor_end_sentence , text_cursor_begin_document , text_cursor_end_document ,   text_select_left_char , text_select_right_char , text_select_down_char , text_select_up_char ,   text_select_word , text_select_left_word , text_select_right_word , text_select_begin_line ,   text_select_end_line , text_select_begin_sentence , text_select_end_sentence , text_select_document ,   text_select_begin_document , text_select_end_document , text_delete_char_prev , text_delete_char_next ,   text_delete_word_prev , text_delete_word_next , text_swap_chars , text_edit_paste ,   text_edit_copy , text_edit_cut , text_undo , text_redo ,   text_insert_line , text_insert_line_up , text_insert_line_down , text_mode_insert ,   gui_widget_next , gui_widget_prev , gui_menu_next , gui_menu_prev ,   gui_toolbar_open , gui_toolbar_next , gui_toolbar_prev , gui_activate ,   gui_activate_stay , gui_activate_next , gui_cancel }
	GUI event type. More...
enum class	hi::v1::gui_event_variant {   hi::v1::gui_event_variant::other , hi::v1::gui_event_variant::mouse , hi::v1::gui_event_variant::keyboard , hi::v1::gui_event_variant::keyboard_target ,   hi::v1::gui_event_variant::grapheme , hi::v1::gui_event_variant::rectangle , hi::v1::gui_event_variant::clipboard_data }
	A granular gui event type. More...

Functions
constexpr gui_event_variant	hi::v1::to_gui_event_variant (gui_event_type type) noexcept
	Convert a gui event type, to an gui event variant.

Detailed Description

Operating System interface to windows, keyboard and mouse handling

Enumeration Type Documentation

gui_event_type

enum class hi::v1::gui_event_type

strong

GUI event type.

Enumerator
window_redraw	Request that part of the window gets redrawn on the next frame.
window_relayout	Request that widgets get laid out on the next frame.
window_reconstrain	Request that widget get constraint on the next frame.
window_resize	Request that the window resizes to desired constraints on the next frame.
window_minimize	Request the window to minimize.
window_maximize	Request the window to maximize.
window_normalize	Request the window to be restored to the original size after a minimize and maximize commands.
window_close	Request the window to be closed.
window_open_sysmenu	Open the operating system provided menu for the window.
window_set_keyboard_target	Change the keyboard target widget for this window.
window_set_clipboard	Place data on the clipboard.
window_activate	The window becomes the top-window.
window_deactivate	The window is not longer the top-window.

gui_event_variant

enum class hi::v1::gui_event_variant

strong

A granular gui event type.

Enumerator
other	The gui_event does not have associated data.
mouse	The gui_event has mouse data.
keyboard	The gui_event has keyboard data.
keyboard_target	The gui_event has keyboard target data.
grapheme	The gui_event has grapheme data.
rectangle	The gui_event has rectangle data.
clipboard_data	The gui_event has clipboard data.

Function Documentation

to_gui_event_variant()

constexpr gui_event_variant hi::v1::to_gui_event_variant ( gui_event_type type )

constexprnoexcept

Convert a gui event type, to an gui event variant.