v1::row_column_widget< Axis > Class Template Reference

#include <hikogui/widgets/row_column_widget.hpp>

Inheritance diagram for v1::row_column_widget< Axis >:

Public Types
using	super = widget
using	delegate_type = row_column_delegate<Axis>

Public Member Functions
	row_column_widget (gui_window &window, widget *parent, std::weak_ptr< delegate_type > delegate={}) noexcept
	Constructs an empty row/column widget.
template<typename Widget , typename... Args>
Widget &	make_widget (Args &&...args)
	Add a widget directly to this grid-widget.
void	clear () noexcept
	Remove and deallocate all child widgets.
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 (gui_event const &event) noexcept
	Handle command.
virtual bool	handle_event_recursive (gui_event const &event, std::vector< widget const * > const &reject_list=std::vector< widget const * >{}) noexcept
	Handle command recursive.
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

Static Public Attributes
static constexpr hi::axis	axis = Axis

Additional Inherited Members
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< widget_mode >	mode = widget_mode::enabled
	The widget mode.
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

template<axis Axis>
class v1::row_column_widget< Axis >

A row/column widget lays out child widgets along a row or column.

Columns are laid out from left to right, and rows from top to bottom.

The row/column widget will calculate the size of the row or column based on the minimum, preferred and maximum size of each child widget contained in them. Margins are also taken into account in the spacing between the child-widgets.

When laid out, each child is sized to where it will occupy the full width of a column, or full height of the row; and divide the length of the column or row with the other children.

Template Parameters

Axis	the axis to lay out child widgets. Either axis::horizontal or axis::vertical.

Constructor & Destructor Documentation

row_column_widget()

template<axis Axis>

v1::row_column_widget< Axis >::row_column_widget ( gui_window & window, widget * parent, std::weak_ptr< delegate_type > delegate = {} )

inlinenoexcept

Constructs an empty row/column widget.

Parameters

window	The window.
parent	The parent widget.
delegate	An optional delegate can be used to populate the row/column widget during initialization.

Member Function Documentation

clear()

template<axis Axis>

void v1::row_column_widget< Axis >::clear ( )

inlinenoexcept

Remove and deallocate all child widgets.

make_widget()

template<axis Axis>

template<typename Widget , typename... Args>

Widget & v1::row_column_widget< Axis >::make_widget ( Args &&... args )

inline

Add a widget directly to this grid-widget.

In a column-widget the newly added widget is added below previously added child-widgets.

In a row-widget the newly added widget is added to the right of previously added child-widgets.

Template Parameters

Widget

The type of the widget to be constructed.

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 files:

• hikogui/src/hikogui/widgets/row_column_delegate.hpp
• hikogui/src/hikogui/widgets/row_column_widget.hpp