#include <hikogui/widgets/icon_widget.hpp>
Inheritance diagram for hi::v1::icon_widget< Name >:
Public Types | |
| using | super = widget |
 Public Types inherited from hi::v1::widget | |
| using | callback_token = notifier<void()>::callback_token |
| using | awaiter_type = notifier<void()>::awaiter_type |
Public Member Functions | |
| icon_widget (widget *parent, icon_widget_attribute auto &&...attributes) noexcept | |
| void | set_attributes () noexcept |
| void | set_attributes (icon_widget_attribute auto &&first, icon_widget_attribute auto &&...rest) noexcept |
| Public Member Functions inherited from hi::v1::widget | |
| widget (widget *parent) noexcept | |
| widget (widget const &)=delete | |
| widget (widget &&)=delete | |
| widget & | operator= (widget &&)=delete |
| widget & | operator= (widget const &)=delete |
| virtual generator< widget const & > | children (bool include_invisible) const noexcept |
| Get a list of child widgets. | |
| generator< widget & > | children (bool include_invisible) noexcept |
| virtual hitbox | hitbox_test (point2 position) const noexcept |
| Find the widget that is under the mouse cursor. | |
| virtual hitbox | hitbox_test_from_parent (point2 position) const noexcept |
| Call hitbox_test from a parent widget. | |
| virtual hitbox | hitbox_test_from_parent (point2 position, hitbox sibling_hitbox) const noexcept |
| Call hitbox_test from a parent widget. | |
| virtual bool | accepts_keyboard_focus (keyboard_focus_group group) const noexcept |
| Check if the widget will accept keyboard focus. | |
| void | reset_layout (gfx_surface *new_surface, float new_scale) noexcept |
| Reset the layout. | |
| virtual sub_theme_selector_type | sub_theme_selector () const noexcept |
| virtual bool | process_event (gui_event const &event) const noexcept |
| virtual void | request_redraw () const noexcept |
| Request the widget to be redrawn on the next frame. | |
| virtual bool | handle_event (gui_event const &event) noexcept |
| Handle command. | |
| virtual bool | handle_event_recursive (gui_event const &event, std::vector< widget_id > const &reject_list=std::vector< widget_id >{}) noexcept |
| Handle command recursive. | |
| virtual widget_id | find_next_widget (widget_id current_keyboard_widget, keyboard_focus_group group, keyboard_focus_direction direction) const noexcept |
| Find the next widget that handles keyboard focus. | |
| widget_id | find_first_widget (keyboard_focus_group group) const noexcept |
| widget_id | find_last_widget (keyboard_focus_group group) const noexcept |
| bool | is_first (keyboard_focus_group group) const noexcept |
| bool | is_last (keyboard_focus_group group) const noexcept |
| virtual void | scroll_to_show (hi::aarectangle rectangle) noexcept |
| Scroll to show the given rectangle on the window. | |
| std::vector< widget_id > | parent_chain () const noexcept |
| Get a list of parents of a given widget. | |
| virtual bool | is_tab_button () const noexcept |
| Check if this widget is a tab-button. | |
| template<forward_of< void()> Callback> | |
| callback_token | subscribe (Callback &&callback, callback_flags flags=callback_flags::synchronous) const noexcept |
| awaiter_type | operator co_await () const noexcept |
Data Fields | |
| observer< icon > | icon = hi::icon{} |
| The icon to be displayed. | |
| observer< alignment > | alignment = hi::alignment::middle_center() |
| Alignment of the icon inside the widget. | |
| extent2 | minimum |
| extent2 | maximum |
| Data Fields inherited from hi::v1::widget | |
| widget_id | id = {} |
| The numeric identifier of a widget. | |
| widget * | parent = nullptr |
| Pointer to the parent widget. | |
| gfx_surface * | surface = nullptr |
| The surface this widget is drawn on. | |
| observer< widget_mode > | mode = widget_mode::enabled |
| The widget mode. | |
| observer< bool > | hover = false |
| Mouse cursor is hovering over the widget. | |
| observer< bool > | clicked = false |
| The widget is being clicked by the mouse. | |
| observer< bool > | focus = false |
| The widget has keyboard focus. | |
| observer< widget_state > | state = widget_state::off |
| The state of the widget. | |
| size_t | semantic_layer = 0_uz |
| The draw layer of the widget. | |
| grid_cell | cell |
Static Public Attributes | |
| static constexpr auto | prefix = Name / "icon" |
Detailed Description
template<fixed_string Name = "">
class hi::v1::icon_widget< Name >
class hi::v1::icon_widget< Name >
An simple GUI widget that displays an icon.
The icon is scaled to the size of the widget, parent widgets will use this scaling to set the correct size.
Field Documentation
◆ alignment
template<fixed_string Name = "">
| observer<alignment> hi::v1::icon_widget< Name >::alignment = hi::alignment::middle_center() |
Alignment of the icon inside the widget.
◆ icon
template<fixed_string Name = "">
| observer<icon> hi::v1::icon_widget< Name >::icon = hi::icon{} |
The icon to be displayed.
The documentation for this class was generated from the following file:
- hikogui/src/hikogui/widgets/icon_widget.hpp
