|
HikoGUI
A low latency retained GUI
|
The HikoGUI API version 1. More...
Namespaces | |
| namespace | geo |
| HikoGUI geometry types. | |
Data Structures | |
| class | abstract_button_widget |
| Base class for implementing button widgets. More... | |
| class | audio_device_widget |
| Audio device configuration widget. More... | |
| class | button_delegate |
| A button delegate controls the state of a button widget. More... | |
| class | cancel_error |
| Cancel error is caused by user pressing cancel. More... | |
| struct | char_converter |
| A converter between character encodings. More... | |
| struct | char_map |
| Character encoder/decoder template. More... | |
| struct | char_map<"ascii"> |
| ASCII (7-bit) character map. More... | |
| struct | char_map<"cp-1252"> |
| CP-1252 / Windows-1252 character map. More... | |
| struct | char_map<"iso-8859-1"> |
| ISO-8859-1 / Latin-1 character map. More... | |
| struct | char_map<"utf-16"> |
| Unicode UTF-16 encoding. More... | |
| struct | char_map<"utf-32"> |
| Unicode UTF-32 encoding. More... | |
| struct | char_map<"utf-8"> |
| Unicode UTF-8 encoding. More... | |
| class | checkbox_widget |
| A GUI widget that permits the user to make a binary choice. More... | |
| class | default_radio_button_delegate |
| A default radio button delegate. More... | |
| class | default_selection_delegate |
| A delegate that control the state of a selection_widget. More... | |
| class | default_tab_delegate |
| A delegate that control the state of a tab_widget. More... | |
| class | default_text_delegate |
| A default text delegate. More... | |
| class | default_text_delegate< gstring > |
A default text delegate specialization for gstring. More... | |
| class | default_text_delegate< std::string > |
A default text delegate specialization for std::string. More... | |
| class | default_text_delegate< text > |
A default text delegate specialization for text. More... | |
| class | default_text_delegate< translate > |
A default text delegate specialization for translate. More... | |
| class | default_text_field_delegate |
| A default text delegate. More... | |
| class | default_text_field_delegate< T > |
A default text delegate specialization for std::integral<T>. More... | |
| class | default_toggle_button_delegate |
| A default toggle button delegate. More... | |
| class | glob_pattern |
| class | grid_layout |
| Grid layout is used to layout widgets along an axis. More... | |
| class | grid_widget |
| A GUI widget that lays out child-widgets in a grid with variable sized cells. More... | |
| class | gui_error |
| class | gui_event |
| A user interface event. More... | |
| class | icon_widget |
| An simple GUI widget that displays an icon. More... | |
| class | io_error |
| Exception thrown during I/O on an error. More... | |
| class | key_error |
| class | label_widget |
| The GUI widget displays and lays out text together with an icon. More... | |
| class | log |
| class | menu_button_widget |
| A button that is part of a menu. More... | |
| class | momentary_button_widget |
| A momentary button widget. More... | |
| struct | mouse_event_data |
| Information for a mouse event. More... | |
| class | operation_error |
| Exception thrown during execution of a dynamic operation. More... | |
| class | os_error |
| Exception thrown during an operating system call. More... | |
| class | overlay_widget |
| A GUI widget which may exist anywhere on a window overlaid above any other widget. More... | |
| class | parse_error |
| Exception thrown during parsing on an error. More... | |
| class | radio_button_widget |
| A graphical control element that allows the user to choose only one of a predefined set of mutually exclusive options. More... | |
| class | row_column_widget |
| A row/column widget lays out child widgets along a row or column. More... | |
| class | scroll_aperture_widget |
| A scroll aperture widget. More... | |
| class | scroll_bar_widget |
Scroll bar widget This widget is used in a pair of a vertical and horizontal scrollbar as a child of the scroll_widget. More... | |
| class | scroll_widget |
| The scroll widget allows a content widget to be shown in less space than is required. More... | |
| class | selection_delegate |
| A delegate that controls the state of a selection_widget. More... | |
| class | selection_widget |
| A graphical control element that allows the user to choose only one of a predefined set of mutually exclusive options. More... | |
| class | system_menu_widget |
| The system menu widget. More... | |
| class | tab_delegate |
| A delegate that controls the state of a tab_widget. More... | |
| class | tab_widget |
| A graphical element that shows only one of a predefined set of mutually exclusive child widgets. More... | |
| class | text_delegate |
| A delegate that controls the state of a text_widget. More... | |
| class | text_field_delegate |
| A delegate that controls the state of a text_field_widget. More... | |
| class | text_field_widget |
| A single line text field. More... | |
| class | text_widget |
| A text widget. More... | |
| class | toggle_widget |
| A GUI widget that permits the user to make a binary choice. More... | |
| class | toolbar_button_widget |
| A momentary button used as a child in the toolbar. More... | |
| class | toolbar_tab_button_widget |
A graphical control element that allows the user to choose only one of a predefined set of mutually exclusive views of a tab_widget. More... | |
| class | toolbar_widget |
| A toolbar widget is located at the top of a window and lays out its children horizontally. More... | |
| class | URI |
| class | uri_error |
| class | URL |
| Universal Resource Locator. More... | |
| class | url_error |
| class | vulkan_widget |
| A widget that draws directly into the swap-chain. More... | |
| class | widget |
| An interactive graphical object as part of the user-interface. More... | |
| class | widget_baseline |
| The base-line of a widget on which to set the text and graphics. More... | |
| class | widget_constraints |
| The constraints of a widget. More... | |
| class | widget_layout |
| The layout of a widget. More... | |
| class | window_traffic_lights_widget |
| Window control button widget. More... | |
| class | window_widget |
| The top-level window widget. More... | |
Concepts | |
| concept | button_widget_attribute |
| concept | icon_widget_attribute |
| concept | label_widget_attribute |
| concept | selection_widget_attribute |
| concept | text_field_widget_attribute |
| concept | text_widget_attribute |
Typedefs | |
| using | ssize_t = std::ptrdiff_t |
| Signed size/index into an array. | |
| using | row_widget = row_column_widget<axis::row> |
| Lays out children in a row. | |
| using | column_widget = row_column_widget<axis::column> |
| Lays out children in a column. | |
| using | horizontal_scroll_bar_widget = scroll_bar_widget<axis::horizontal> |
| using | vertical_scroll_bar_widget = scroll_bar_widget<axis::vertical> |
| template<bool ControlsWindow = false> | |
| using | vertical_scroll_widget = scroll_widget<axis::vertical, ControlsWindow> |
| Vertical scroll widget. | |
| template<bool ControlsWindow = false> | |
| using | horizontal_scroll_widget = scroll_widget<axis::horizontal, ControlsWindow> |
| Horizontal scroll widget. | |
Enumerations | |
| enum class | 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 , 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_sysmenu_open , gui_toolbar_open , gui_toolbar_next , gui_toolbar_prev , gui_activate , gui_activate_next , gui_cancel } |
| GUI event type. More... | |
| enum class | gui_event_variant { gui_event_variant::other , gui_event_variant::mouse , gui_event_variant::keyboard , gui_event_variant::grapheme } |
| A granular gui event type. More... | |
| enum class | button_state { button_state::off , button_state::on , button_state::other } |
| The state of a button. More... | |
| enum class | widget_mode { widget_mode::collapse , widget_mode::invisible , widget_mode::disabled , widget_mode::display , widget_mode::select , widget_mode::partial , widget_mode::enabled } |
| The mode that the widget is operating at. More... | |
Functions | |
| char32_t | random_char () noexcept |
| constexpr std::u32string | to_u32string (std::u32string_view rhs) noexcept |
| Identity conversion from UTF-32 to UTF-32. | |
| constexpr std::u32string | to_u32string (std::u16string_view rhs) noexcept |
| Conversion from UTF-16 to UTF-32. | |
| constexpr std::u32string | to_u32string (std::u8string_view rhs) noexcept |
| Conversion from UTF-8 to UTF-32. | |
| constexpr std::u32string | to_u32string (std::wstring_view rhs) noexcept |
| Conversion from wide-string (UTF-16/32) to UTF-32. | |
| constexpr std::u32string | to_u32string (std::string_view rhs) noexcept |
| Conversion from UTF-8 to UTF-32. | |
| constexpr std::u16string | to_u16string (std::u32string_view rhs) noexcept |
| Conversion from UTF-32 to UTF-16. | |
| constexpr std::u16string | to_u16string (std::u16string_view rhs) noexcept |
| Identity conversion from UTF-16 to UTF-16. | |
| constexpr std::u16string | to_u16string (std::u8string_view rhs) noexcept |
| Conversion from UTF-8 to UTF-16. | |
| constexpr std::u16string | to_u16string (std::wstring_view rhs) noexcept |
| Conversion from wide-string (UTF-16/32) to UTF-16. | |
| constexpr std::u16string | to_u16string (std::string_view rhs) noexcept |
| Conversion from UTF-8 to UTF-16. | |
| constexpr std::u8string | to_u8string (std::u32string_view rhs) noexcept |
| Conversion from UTF-32 to UTF-8. | |
| constexpr std::u8string | to_u8string (std::u16string_view rhs) noexcept |
| Conversion from UTF-16 to UTF-8. | |
| constexpr std::u8string | to_u8string (std::u8string_view rhs) noexcept |
| Identity conversion from UTF-8 to UTF-8. | |
| constexpr std::u8string | to_u8string (std::wstring_view rhs) noexcept |
| Conversion from wide-string (UTF-16/32) to UTF-8. | |
| constexpr std::u8string | to_u8string (std::string_view rhs) noexcept |
| Conversion from UTF-8 to UTF-8. | |
| constexpr std::wstring | to_wstring (std::u32string_view rhs) noexcept |
| Conversion from UTF-32 to wide-string (UTF-16/32). | |
| constexpr std::wstring | to_wstring (std::u16string_view rhs) noexcept |
| Conversion from UTF-16 to wide-string (UTF-16/32). | |
| constexpr std::wstring | to_wstring (std::u8string_view rhs) noexcept |
| Conversion from UTF-8 to wide-string (UTF-16/32). | |
| constexpr std::wstring | to_wstring (std::wstring_view rhs) noexcept |
| Identity conversion from wide-string (UTF-16/32) to wide-string (UTF-16/32). | |
| constexpr std::wstring | to_wstring (std::string_view rhs) noexcept |
| Conversion from UTF-8 to wide-string (UTF-16/32). | |
| constexpr std::string | to_string (std::u32string_view rhs) noexcept |
| Conversion from UTF-32 to UTF-8. | |
| constexpr std::string | to_string (std::u16string_view rhs) noexcept |
| Conversion from UTF-16 to UTF-8. | |
| constexpr std::string | to_string (std::u8string_view rhs) noexcept |
| Identity conversion from UTF-8 to UTF-8. | |
| constexpr std::string | to_string (std::wstring_view rhs) noexcept |
| Conversion from wide-string (UTF-16/32) to UTF-8. | |
| constexpr std::string | to_string (std::string_view rhs) noexcept |
| Conversion from UTF-8 to UTF-8. | |
| void | terminate_handler () noexcept |
| The HikoGUI terminate handler. | |
| generator< std::filesystem::path > | glob (glob_pattern const &pattern) |
| generator< std::filesystem::path > | glob (std::string_view pattern) |
| generator< std::filesystem::path > | glob (std::string const &pattern) |
| generator< std::filesystem::path > | glob (char const *pattern) |
| generator< std::filesystem::path > | glob (std::filesystem::path const &pattern) |
| generator< std::filesystem::path > | glob (URL const &pattern) |
| std::string_view | to_string (gui_event_type rhs) noexcept |
| Convert a GUI event type to a string. | |
| constexpr gui_event_type | to_gui_event_type (std::string_view name) noexcept |
| Convert a name to a GUI event type. | |
| constexpr gui_event_variant | to_gui_event_variant (gui_event_type type) noexcept |
| Convert a gui event type, to an gui event variant. | |
| std::string | get_last_error_message () noexcept |
| Get the OS error message from the last error received on this thread. | |
| template<typename Functor > | |
| void | process_call (Functor &&functor, std::string_view data) |
| Call a function in a new process. | |
| constexpr std::size_t | operator""_uz (unsigned long long lhs) noexcept |
| constexpr std::size_t | operator""_zu (unsigned long long lhs) noexcept |
| constexpr std::ptrdiff_t | operator""_z (unsigned long long lhs) noexcept |
| std::shared_ptr< button_delegate > | make_default_radio_button_delegate (auto &&value, auto &&on_value) noexcept |
| Make a shared pointer to a radio-button delegate. | |
| std::shared_ptr< button_delegate > | make_default_toggle_button_delegate (auto &&value, auto &&...args) noexcept |
| Make a shared pointer to a toggle-button delegate. | |
| std::shared_ptr< selection_delegate > | make_default_selection_delegate (auto &&value, auto &&options, auto &&...off_value) noexcept |
| Create a shared pointer to a default selection delegate. | |
| std::shared_ptr< tab_delegate > | make_default_tab_delegate (auto &&value) noexcept |
| Create a shared pointer to a default tab delegate. | |
| std::shared_ptr< text_delegate > | make_default_text_delegate (auto &&value) noexcept |
| Create a shared pointer to a default text delegate. | |
| std::shared_ptr< text_field_delegate > | make_default_text_field_delegate (auto &&value) noexcept |
| Create a shared pointer to a default text delegate. | |
Variables | |
| std::atomic< char const * > | terminate_message = nullptr |
| Message to show when the application is terminated. | |
| std::terminate_handler | old_terminate_handler |
| The old terminate handler. | |
| constexpr auto | gui_event_type_metadata |
| log | log_global |
The HikoGUI API version 1.
| using hi::v1::ssize_t = std::ptrdiff_t |
Signed size/index into an array.
|
noexcept |
Get the OS error message from the last error received on this thread.
| void hi::v1::process_call | ( | Functor && | functor, |
| std::string_view | data ) |
Call a function in a new process.
| functor | A functor void(std::string_view) to call in a different process. You can pass for example a non-capturing lambda |
| data | Data to pass to the functor. |
|
noexcept |
The HikoGUI terminate handler.
This handler will print an error message on the console or popup a dialogue box..
hi_set_terminate_message() to set a message.
|
constexprnoexcept |
Convert a name to a GUI event type.
|
inlinenoexcept |
Convert a GUI event type to a string.
|
inline |
The old terminate handler.
This is the handlr returned by std::set_terminate().
|
inline |
Message to show when the application is terminated.
1.10.0