v1::label_widget Class Reference

#include <hikogui/widgets/label_widget.hpp>

Inheritance diagram for v1::label_widget:

Public Types
using	super = widget

Public Member Functions
template<typename Label , typename Alignment = hi::alignment, typename TextStyle = hi::theme_text_style>
	label_widget (gui_window &window, widget *parent, Label &&label, Alignment &&alignment=hi::alignment::middle_right(), TextStyle &&text_style=theme_text_style::label) noexcept
	Construct a label widget.
Public Member Functions inherited from v1::widget
	widget (gui_window &window, widget *parent) noexcept
	widget (const widget &)=delete
widget &	operator= (const widget &)=delete
	widget (widget &&)=delete
widget &	operator= (widget &&)=delete
bool	is_gui_thread () const noexcept
hi::theme const &	theme () const noexcept
	Get the theme.
hi::font_book &	font_book () const noexcept
	Get the font book.
virtual hitbox	hitbox_test_from_parent (point3 position) const noexcept
	Call hitbox_test from a parent widget.
virtual hitbox	hitbox_test_from_parent (point3 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.
widget_constraints const &	constraints () const noexcept
widget_layout const &	layout () const noexcept
	Get the current layout for this widget.
virtual void	request_redraw () const noexcept
	Request the widget to be redrawn on the next frame.
void	request_relayout () const noexcept
	Request the window to be relayout on the next frame.
void	request_reconstrain () const noexcept
	Request the window to be reconstrain on the next frame.
void	request_resize () const noexcept
	Request the window to be resize based on the preferred size of the widgets.
virtual bool	handle_event (command command) noexcept
	Handle command.
virtual bool	handle_event (std::vector< command > const &commands) noexcept
virtual bool	handle_command_recursive (command command, std::vector< widget const * > const &reject_list=std::vector< widget const * >{}) noexcept
	Handle command recursive.
virtual bool	handle_event (mouse_event const &event) noexcept
virtual bool	handle_event (keyboard_event const &event) noexcept
	Handle keyboard event.
virtual widget const *	find_next_widget (widget const *current_keyboard_widget, keyboard_focus_group group, keyboard_focus_direction direction) const noexcept
	Find the next widget that handles keyboard focus.
widget const *	find_first_widget (keyboard_focus_group group) const noexcept
widget const *	find_last_widget (keyboard_focus_group group) const noexcept
bool	is_first (keyboard_focus_group group) const noexcept
	Is this widget the first widget in the parent container.
bool	is_last (keyboard_focus_group group) const noexcept
	Is this widget the last widget in the parent container.
virtual void	scroll_to_show (hi::aarectangle rectangle) noexcept
	Scroll to show the given rectangle on the window.
void	scroll_to_show () noexcept
	Scroll to show the important part of the widget.
std::vector< widget const * >	parent_chain () const noexcept
	Get a list of parents of a given widget.
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

Data Fields
observable< label >	label
	The label to display.
observable< alignment >	alignment = hi::alignment{horizontal_alignment::right, vertical_alignment::middle}
	How the label and icon are aligned.
observable< theme_text_style >	text_style = theme_text_style::label
	The text style to display the label's text in and color of the label's (non-color) icon.
observable< text_widget::edit_mode_type >	edit_mode = text_widget::edit_mode_type::selectable
	The edit-mode of the embedded text widget.
Data Fields inherited from v1::widget
gui_window &	window
	Convenient reference to the Window.
widget *const	parent
	Pointer to the parent widget.
std::string	id
	A name of widget, should be unique between siblings.
observable< bool >	enabled = true
	The widget is enabled.
observable< bool >	visible = true
	The widget is visible.
observable< bool >	hover = false
	Mouse cursor is hovering over the widget.
observable< bool >	focus = false
	The widget has keyboard focus.
int	semantic_layer
	The draw layer of the widget.
int	logical_layer
	The logical layer of the widget.

Detailed Description

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:

Constructor & Destructor Documentation

label_widget()

template<typename Label , typename Alignment = hi::alignment, typename TextStyle = hi::theme_text_style>

v1::label_widget::label_widget ( gui_window & window, widget * parent, Label && label, Alignment && alignment = hi::alignment::middle_right(), TextStyle && text_style = theme_text_style::label )

inlinenoexcept

Construct a label widget.

See also

label_widget::alignment

Parameters

window	The window that this widget belongs to.
parent	The parent widget that owns this radio button widget.
label	The label to show next to the radio button.
alignment	The alignment of the label. The default alignment is middle_right, because the most common usage for a label by an application programmer is to add the label to the left of another widget.
text_style	The text style of the label, and color of non-color icons.

Field Documentation

alignment

observable<alignment> v1::label_widget::alignment = hi::alignment{horizontal_alignment::right, vertical_alignment::middle}

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.
• alignment::middle_center: text drawn across a large icon. Should only be used with a pixmap icon.

edit_mode

observable<text_widget::edit_mode_type> v1::label_widget::edit_mode = text_widget::edit_mode_type::selectable

The edit-mode of the embedded text widget.

label

observable<label> v1::label_widget::label

The label to display.

text_style

observable<theme_text_style> v1::label_widget::text_style = theme_text_style::label

The text style to display the label's text in and color of the label's (non-color) icon.

---

The documentation for this class was generated from the following file:

• hikogui/src/hikogui/widgets/label_widget.hpp