hi::v1::toolbar_widget Class Reference

#include <hikogui/widgets/toolbar_widget.hpp>

Inheritance diagram for hi::v1::toolbar_widget:

Public Types
using	super = widget

Public Member Functions
	toolbar_widget (widget *parent) noexcept
	Constructs an empty row/column widget.
template<typename Widget , horizontal_alignment Alignment = horizontal_alignment::left, typename... Args>
Widget &	make_widget (Args &&...args)
	Add a widget directly to this toolbar-widget.
Public Member Functions inherited from hi::v1::widget
	widget (widget *parent) noexcept
	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.
widget_layout const &	layout () const noexcept override
	Get the current layout for this 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.
widget_id	find_first_widget (keyboard_focus_group group) const noexcept override
widget_id	find_last_widget (keyboard_focus_group group) const noexcept override
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.
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	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 *parent) noexcept
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.

Additional Inherited Members
Data Fields inherited from hi::v1::widget
observer< widget_mode >	mode = widget_mode::enabled
	The widget mode.
observer< bool >	hover = false
	Mouse cursor is hovering over the widget.
observer< bool >	focus = false
	The widget has keyboard focus.
int	semantic_layer = 0
	The draw layer of the widget.
int	logical_layer = 0
	The logical layer of the 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.

Detailed Description

A toolbar widget is located at the top of a window and lays out its children horizontally.

The toolbar widget is shown at the top of a window, it is drawn with a different background than the window's content to differentiate from it.

Child widgets may be added on both the left side and right side of the toolbar, a small space in the center is added for visual separation.

Child widgets are drawn to full height of the toolbar determined by the preferred size of all contained widgets. The width of each widget is determined by their preferred size

Constructor & Destructor Documentation

toolbar_widget()

hi::v1::toolbar_widget::toolbar_widget ( widget * parent )

inlinenoexcept

Constructs an empty row/column widget.

Parameters

parent

The parent widget.

Member Function Documentation

make_widget()

template<typename Widget , horizontal_alignment Alignment = horizontal_alignment::left, typename... Args>

Widget & hi::v1::toolbar_widget::make_widget ( Args &&... args )

inline

Add a widget directly to this toolbar-widget.

When Alignment is horizontal_alignment::left the new widget is added to the right of the previous added widget on the left side of the toolbar.

When Alignment is horizontal_alignment::right the new widget is added to the left of the previous added widget on the right side of the toolbar.

Template Parameters

Widget	The type of the widget to be constructed.
Alignment	Add widgets to the left, or right.

Parameters

args	The arguments passed to the constructor of the widget.

Returns

A reference to the widget that was created.

---

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

• hikogui/src/hikogui/widgets/toolbar_widget.hpp