HikoGUI
A low latency retained GUI
Loading...
Searching...
No Matches
gui_event_type.hpp
Go to the documentation of this file.
1// Copyright Take Vos 2022.
2// Distributed under the Boost Software License, Version 1.0.
3// (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
4
9#pragma once
10
11#include "../utility.hpp"
12#include "../enum_metadata.hpp"
13#include <string>
14#include <string_view>
15#include <ostream>
16
17namespace hi { inline namespace v1 {
18
22enum class gui_event_type {
23 none,
24
25 // raw-keyboard-events
26 keyboard_down,
27 keyboard_up,
28 keyboard_grapheme,
29 keyboard_partial_grapheme,
30 keyboard_enter,
31 keyboard_exit,
32
33 // raw-mouse-events
34 mouse_move,
35 mouse_drag,
36 mouse_down,
37 mouse_up,
38 mouse_wheel,
39 mouse_enter,
40 mouse_exit,
41 mouse_exit_window,
42
43 // window-events
56
57 // commands
58 text_cursor_left_char,
59 text_cursor_right_char,
60 text_cursor_down_char,
61 text_cursor_up_char,
62 text_cursor_left_word,
63 text_cursor_right_word,
64 text_cursor_begin_line,
65 text_cursor_end_line,
66 text_cursor_begin_sentence,
67 text_cursor_end_sentence,
68 text_cursor_begin_document,
69 text_cursor_end_document,
70 text_select_left_char,
71 text_select_right_char,
72 text_select_down_char,
73 text_select_up_char,
74 text_select_word,
75 text_select_left_word,
76 text_select_right_word,
77 text_select_begin_line,
78 text_select_end_line,
79 text_select_begin_sentence,
80 text_select_end_sentence,
81 text_select_document,
82 text_select_begin_document,
83 text_select_end_document,
84 text_delete_char_prev,
85 text_delete_char_next,
86 text_delete_word_prev,
87 text_delete_word_next,
88 text_swap_chars,
89 text_edit_paste,
90 text_edit_copy,
91 text_edit_cut,
92 text_undo,
93 text_redo,
94 text_insert_line,
95 text_insert_line_up,
96 text_insert_line_down,
97 text_mode_insert,
98
99 // GUI navigation.
100 gui_widget_next,
101 gui_widget_prev,
102 gui_menu_next,
103 gui_menu_prev,
104 gui_toolbar_open,
105 gui_toolbar_next,
106 gui_toolbar_prev,
107 gui_activate,
108 gui_activate_next,
109 gui_cancel,
110};
111
112// clang-format off
113constexpr auto gui_event_type_metadata = enum_metadata{
114 gui_event_type::none, "none",
115 gui_event_type::keyboard_down, "keyboard_down",
116 gui_event_type::keyboard_grapheme, "keyboard_grapheme",
117 gui_event_type::keyboard_partial_grapheme, "keyboard_partial_grapheme",
118 gui_event_type::keyboard_enter, "keyboard_enter",
119 gui_event_type::keyboard_exit, "keyboard_exit",
120 gui_event_type::mouse_move, "mouse_move",
121 gui_event_type::mouse_drag, "mouse_drag",
122 gui_event_type::mouse_down, "mouse_down",
123 gui_event_type::mouse_up, "mouse_up",
124 gui_event_type::mouse_wheel, "mouse_wheel",
125 gui_event_type::mouse_enter, "mouse_enter",
126 gui_event_type::mouse_exit, "mouse_exit",
127 gui_event_type::mouse_exit_window, "mouse_exit_window",
128 gui_event_type::window_redraw, "window_redraw",
129 gui_event_type::window_relayout, "window_relayout",
130 gui_event_type::window_reconstrain, "window_reconstrain",
131 gui_event_type::window_resize, "window_resize",
132 gui_event_type::window_minimize, "window_minimize",
133 gui_event_type::window_maximize, "window_maximize",
134 gui_event_type::window_normalize, "window_normalize",
135 gui_event_type::window_open_sysmenu, "window_open_sysmenu",
136 gui_event_type::window_close, "window_close",
137 gui_event_type::window_set_keyboard_target, "window_set_keyboard_target",
138 gui_event_type::window_remove_keyboard_target, "window_remove_keyboard_target",
139 gui_event_type::window_set_clipboard, "window_set_clipboard",
140 gui_event_type::text_cursor_left_char, "text_cursor_left_char",
141 gui_event_type::text_cursor_right_char, "text_cursor_right_char",
142 gui_event_type::text_cursor_down_char, "text_cursor_down_char",
143 gui_event_type::text_cursor_up_char, "text_cursor_up_char",
144 gui_event_type::text_cursor_left_word, "text_cursor_left_word",
145 gui_event_type::text_cursor_right_word, "text_cursor_right_word",
146 gui_event_type::text_cursor_begin_line, "text_cursor_begin_line",
147 gui_event_type::text_cursor_end_line, "text_cursor_end_line",
148 gui_event_type::text_cursor_begin_sentence, "text_cursor_begin_sentence",
149 gui_event_type::text_cursor_end_sentence, "text_cursor_end_sentence",
150 gui_event_type::text_cursor_begin_document, "text_cursor_begin_document",
151 gui_event_type::text_cursor_end_document, "text_cursor_end_document",
152 gui_event_type::text_select_left_char, "text_select_left_char",
153 gui_event_type::text_select_right_char, "text_select_right_char",
154 gui_event_type::text_select_down_char, "text_select_down_char",
155 gui_event_type::text_select_up_char, "text_select_up_char",
156 gui_event_type::text_select_word, "text_select_word",
157 gui_event_type::text_select_left_word, "text_select_left_word",
158 gui_event_type::text_select_right_word, "text_select_right_word",
159 gui_event_type::text_select_begin_line, "text_select_begin_line",
160 gui_event_type::text_select_end_line, "text_select_end_line",
161 gui_event_type::text_select_begin_sentence, "text_select_begin_sentence",
162 gui_event_type::text_select_end_sentence, "text_select_end_sentence",
163 gui_event_type::text_select_begin_document, "text_select_begin_document",
164 gui_event_type::text_select_end_document, "text_select_end_document",
165 gui_event_type::text_select_document, "text_select_document",
166 gui_event_type::text_delete_char_prev, "text_delete_char_prev",
167 gui_event_type::text_delete_char_next, "text_delete_char_next",
168 gui_event_type::text_delete_word_prev, "text_delete_word_prev",
169 gui_event_type::text_delete_word_next, "text_delete_word_next",
170 gui_event_type::text_insert_line, "text_insert_line",
171 gui_event_type::text_insert_line_up, "text_insert_line_up",
172 gui_event_type::text_insert_line_down, "text_insert_line_down",
173 gui_event_type::text_swap_chars, "text_swap_chars",
174 gui_event_type::text_edit_paste, "text_edit_paste",
175 gui_event_type::text_edit_copy, "text_edit_copy",
176 gui_event_type::text_edit_cut, "text_edit_cut",
177 gui_event_type::text_undo, "text_undo",
178 gui_event_type::text_redo, "text_redo",
179 gui_event_type::text_mode_insert, "text_mode_insert",
180 gui_event_type::gui_widget_next, "gui_widget_next",
181 gui_event_type::gui_widget_prev, "gui_widget_prev",
182 gui_event_type::gui_menu_next, "gui_menu_next",
183 gui_event_type::gui_menu_prev, "gui_menu_prev",
184 gui_event_type::gui_toolbar_open, "gui_toolbar_open",
185 gui_event_type::gui_toolbar_next, "gui_toolbar_next",
186 gui_event_type::gui_toolbar_prev, "gui_toolbar_prev",
187 gui_event_type::gui_activate, "gui_activate",
188 gui_event_type::gui_activate_next, "gui_activate_next",
189 gui_event_type::gui_cancel, "gui_cancel"
190};
191// clang-format on
192
195inline std::string_view to_string(gui_event_type rhs) noexcept
196{
197 return gui_event_type_metadata[rhs];
198}
199
202constexpr gui_event_type to_gui_event_type(std::string_view name) noexcept
203{
204 return gui_event_type_metadata.at(name, gui_event_type::none);
205}
206
207}} // namespace hi::inline v1
208
Utilities used by the HikoGUI library itself.
constexpr std::string to_string(std::u32string_view rhs) noexcept
Conversion from UTF-32 to UTF-8.
Definition to_string.hpp:215
gui_event_type
GUI event type.
Definition gui_event_type.hpp:22
@ window_redraw
Request that part of the window gets redrawn on the next frame.
@ window_normalize
Request the window to be restored to the original size after a minimize and maximize commands.
@ window_open_sysmenu
Open the operating system provided menu for the window.
@ window_minimize
Request the window to minimize.
@ window_close
Request the window to be closed.
@ window_set_keyboard_target
Change the keyboard target widget for this window.
@ window_maximize
Request the window to maximize.
@ window_relayout
Request that widgets get laid out on the next frame.
@ window_reconstrain
Request that widget get constraint on the next frame.
@ window_remove_keyboard_target
Remove a widget as keyboard target.
@ window_set_clipboard
Place data on the clipboard.
@ window_resize
Request that the window resizes to desired constraints on the next frame.
DOXYGEN BUG.
Definition algorithm.hpp:15
The HikoGUI namespace.
Definition ascii.hpp:19
constexpr gui_event_type to_gui_event_type(std::string_view name) noexcept
Convert a name to a GUI event type.
Definition gui_event_type.hpp:202