HikoGUI
A low latency retained GUI
|
#include <hikogui/widgets/label_widget.hpp>
Public Types | |
using | super = widget |
Public Member Functions | |
template<label_widget_attribute... Attributes> | |
label_widget (widget_intf const *parent, Attributes &&...attributes) noexcept | |
Construct a label widget. | |
Public Member Functions inherited from hi::v1::widget | |
widget (widget_intf const *parent) noexcept | |
Constructor for creating sub views. | |
widget () noexcept | |
Constructor for creating sub views. | |
widget (const widget &)=delete | |
widget & | operator= (const widget &)=delete |
widget (widget &&)=delete | |
widget & | operator= (widget &&)=delete |
generator< widget_intf & > | children (bool include_invisible) noexcept override |
Get a list of child widgets. | |
hitbox | hitbox_test (point2 position) const noexcept override |
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. | |
bool | accepts_keyboard_focus (keyboard_focus_group group) const noexcept override |
Check if the widget will accept keyboard focus. | |
box_constraints | update_constraints () noexcept override |
Update the constraints of the widget. | |
void | set_layout (widget_layout const &context) noexcept override |
Update the internal layout of the widget. | |
void | draw (draw_context const &context) noexcept override |
Draw the widget. | |
bool | process_event (gui_event const &event) const noexcept override |
Send a event to the window. | |
void | request_redraw () const noexcept override |
Request the widget to be redrawn on the next frame. | |
bool | handle_event (gui_event const &event) noexcept override |
Handle command. | |
bool | handle_event_recursive (gui_event const &event, std::vector< widget_id > const &reject_list=std::vector< widget_id >{}) noexcept override |
Handle command recursive. | |
virtual widget_id | find_next_widget (widget_id current_keyboard_widget, keyboard_focus_group group, keyboard_focus_direction direction) const noexcept override |
Find the next widget that handles keyboard focus. | |
void | scroll_to_show (hi::aarectangle rectangle) noexcept override |
Scroll to show the given rectangle on the window. | |
void | set_window (gui_window *window) noexcept override |
Set the window for this tree of widgets. | |
gui_window * | window () const noexcept override |
Get the window that the widget is owned by. | |
hi::theme const & | theme () const noexcept |
gfx_surface const * | surface () const noexcept |
virtual color | background_color () const noexcept |
virtual color | foreground_color () const noexcept |
virtual color | focus_color () const noexcept |
virtual color | accent_color () const noexcept |
virtual color | label_color () const noexcept |
virtual generator< widget_intf & > | children (bool include_invisible) noexcept=0 |
Get a list of child widgets. | |
virtual generator< widget_intf const & > | children (bool include_invisible) const noexcept final |
Get a list of child widgets. | |
virtual void | scroll_to_show (hi::aarectangle rectangle) noexcept=0 |
Scroll to show the given rectangle on the window. | |
void | scroll_to_show () noexcept |
Scroll to show the important part of the widget. | |
Public Member Functions inherited from hi::v1::widget_intf | |
widget_intf (widget_intf const *parent) noexcept | |
template<forward_of< void()> Func> | |
callback< void()> | subscribe (Func &&func, callback_flags flags=callback_flags::synchronous) noexcept |
Subscribe a callback to be called when an action is completed by the widget. | |
auto | operator co_await () const noexcept |
Await until an action is completed by the widget. | |
size_t | layer () const noexcept |
void | set_layer (size_t new_layer) noexcept |
widget_mode | mode () const noexcept |
void | set_mode (widget_mode new_mode) noexcept |
widget_value | value () const noexcept |
void | set_value (widget_value new_value) noexcept |
widget_phase | phase () const noexcept |
void | set_pressed (bool pressed) noexcept |
void | set_hover (bool hover) noexcept |
void | set_active (bool active) noexcept |
bool | focus () const noexcept |
void | set_focus (bool new_focus) noexcept |
widget_layout const & | layout () const noexcept |
Get the current layout for this widget. | |
std::vector< widget_id > | parent_chain () const noexcept |
Get a list of parents of a given widget. | |
void | scroll_to_show () noexcept |
Scroll to show the important part of the widget. | |
Data Fields | |
observer< label > | label |
The label to display. | |
observer< alignment > | alignment = hi::alignment::top_flush() |
How the label and icon are aligned. | |
observer< semantic_text_style > | text_style = semantic_text_style::label |
The text style to display the label's text in and color of the label's (non-color) icon. | |
Data Fields inherited from hi::v1::widget | |
observer< extent2 > | minimum = extent2{} |
The minimum size this widget is allowed to be. | |
observer< extent2 > | maximum = extent2::large() |
The maximum size this widget is allowed to be. | |
Data Fields inherited from hi::v1::widget_intf | |
widget_id | id = {} |
The numeric identifier of a widget. | |
widget_intf * | parent = nullptr |
Pointer to the parent widget. | |
notifier< void()> | notifier |
Notifier which is called after an action is completed by a widget. | |
observer< widget_state > | state |
The current state of the widget. | |
The GUI widget displays and lays out text together with an icon.
This widget is often used by other widgets. For example checkboxes display a label representing their state next to the checkbox itself.
The alignment of icon and text is shown in the following image:
Here is an example on how to create a label:
|
inlinenoexcept |
Construct a label widget.
label_widget::alignment
parent | The parent widget that owns this radio button widget. |
attributes | Different attributes used to configure the label widget: a label , alignment or text_style |
How the label and icon are aligned.
Different layouts:
alignment::top_left
: icon and text are inline with each other, with the icon in the top-left corner.alignment::top_right
: icon and text are inline with each other, with the icon in the top-right corner.alignment::middle_left
: icon and text are inline with each other, with the icon in the middle-left.alignment::middle_right
: icon and text are inline with each other, with the icon in the middle-right.alignment::bottom_left
: icon and text are inline with each other, with the icon in the bottom-left.alignment::bottom_right
: icon and text are inline with each other, with the icon in the bottom-right.alignment::top_center
: Larger icon above the text, both center aligned.alignment::bottom_center
: Larger icon below the text, both center aligned. used with a pixmap
icon. observer<label> hi::v1::label_widget::label |
The label to display.
observer<semantic_text_style> hi::v1::label_widget::text_style = semantic_text_style::label |
The text style to display the label's text in and color of the label's (non-color) icon.