#include <hikogui/widgets/grid_widget.hpp>

Inheritance diagram for hi::v1::grid_widget:

Public Types
using	super = widget

Public Member Functions
	grid_widget (widget_intf const *parent) noexcept
	Constructs an empty grid widget.

widget &	insert (std::size_t first_column, std::size_t first_row, std::size_t last_column, std::size_t last_row, std::unique_ptr< widget > widget) noexcept

widget &	push_front (std::unique_ptr< widget > widget) noexcept
	Insert a widget to the front of the grid.

widget &	push_back (std::unique_ptr< widget > widget) noexcept
	Insert a widget to the back of the grid.

widget &	push_top (std::unique_ptr< widget > widget) noexcept
	Insert a widget to the top of the grid.

widget &	push_bottom (std::unique_ptr< widget > widget) noexcept
	Insert a widget to the bottom of the grid.

template<typename Widget , typename... Args>
Widget &	emplace (std::size_t first_column, std::size_t first_row, std::size_t last_column, std::size_t last_row, Args &&...args)
	Add a widget directly to this grid-widget.

template<typename Widget , typename... Args>
Widget &	emplace (std::size_t column, std::size_t row, Args &&...args)
	Add a widget directly to this grid-widget.

template<typename Widget , typename... Args>
Widget &	emplace (std::string_view address, Args &&...args)
	Add a widget directly to this grid-widget.

template<typename Widget , typename... Args>
Widget &	emplace_front (Args &&...args)
	Emplace a widget to the front.

template<typename Widget , typename... Args>
Widget &	emplace_back (Args &&...args)
	Emplace a widget to the back.

template<typename Widget , typename... Args>
Widget &	emplace_top (Args &&...args)
	Emplace a widget to the back.

template<typename Widget , typename... Args>
Widget &	emplace_bottom (Args &&...args)
	Emplace a widget to the back.

void	clear () noexcept
	Remove all child widgets.

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.

Additional Inherited Members
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.

Detailed Description

A GUI widget that lays out child-widgets in a grid with variable sized cells.

The grid widget lays out child widgets in a grid pattern. Each child widget occupies a single cell, which belongs into a single column and a single row.

Columns are laid out from left to right, and rows from top to bottom. The row and columns number may be specified as integers, or using an spreadsheet-like cell-address:

grid_widget::emplace<T>(std::size_t column_nr, std::size_t row_nr, ...)
grid_widget::emplace<T>(std::string address, ...)

The grid widget will calculate the size of each row and 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 columns and between rows.

When laid out, each child is sized to where it will occupy the full width and height of each cell.

Constructor & Destructor Documentation

◆ grid_widget()

hi::v1::grid_widget::grid_widget ( widget_intf const * parent )

inlinenoexcept

Constructs an empty grid widget.

Parameters

parent The parent widget.

Member Function Documentation

◆ clear()

void hi::v1::grid_widget::clear ( )

inlinenoexcept

Remove all child widgets.

◆ emplace() [1/3]

template<typename Widget , typename... Args>

Widget & hi::v1::grid_widget::emplace	(	std::size_t	column,
		std::size_t	row,
		Args &&...	args )

inline

Add a widget directly to this grid-widget.

Template Parameters

Widget The type of the widget to be constructed.

Parameters

column	The zero-based index from left-to-right.
row	The zero-based index from top-to-bottom.
args	The arguments passed to the constructor of the widget.

Returns: A reference to the widget that was created.

◆ emplace() [2/3]

template<typename Widget , typename... Args>

Widget & hi::v1::grid_widget::emplace	(	std::size_t	first_column,
		std::size_t	first_row,
		std::size_t	last_column,
		std::size_t	last_row,
		Args &&...	args )

inline

Add a widget directly to this grid-widget.

Template Parameters

Widget The type of the widget to be constructed.

Parameters

first_column	The first (left-most) column to place the widget in.
first_row	The first (top-most) row to place the widget in.
last_column	One beyond the last column to place the widget in.
last_row	One beyond the last row to place the widget in.
args	The arguments passed to the constructor of the widget.

Returns: A reference to the widget that was created.

◆ emplace() [3/3]

template<typename Widget , typename... Args>

Widget & hi::v1::grid_widget::emplace	(	std::string_view	address,
		Args &&...	args )

inline

Add a widget directly to this grid-widget.

Template Parameters

Widget The type of the widget to be constructed.

Parameters

address	The spreadsheet-like address of the cell, see `parse_spreadsheet_address()`.
args	The arguments passed to the constructor of the widget.

Returns: A reference to the widget that was created.

◆ emplace_back()

template<typename Widget , typename... Args>

Widget & hi::v1::grid_widget::emplace_back ( Args &&... args )

inline

Emplace a widget to the back.

The widget is places at back-top.

In left-to-right mode 'front' means 'left'.

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.

◆ emplace_bottom()

template<typename Widget , typename... Args>

Widget & hi::v1::grid_widget::emplace_bottom ( Args &&... args )

inline

Emplace a widget to the back.

The widget is places at front-bottom.

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.

◆ emplace_front()

template<typename Widget , typename... Args>

Widget & hi::v1::grid_widget::emplace_front ( Args &&... args )

inline

Emplace a widget to the front.

All the widgets currently on the grid are moved 1 backward and the new widget is added to the front-top cell.

In left-to-right mode 'front' means 'left'.

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.

◆ emplace_top()

template<typename Widget , typename... Args>

Widget & hi::v1::grid_widget::emplace_top ( Args &&... args )

inline

Emplace a widget to the back.

All the widgets currently on the grid are moved 1 lower and the new widget is added to the front-top cell.

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.

◆ push_back()

widget & hi::v1::grid_widget::push_back ( std::unique_ptr< widget > widget )

inlinenoexcept

Insert a widget to the back of the grid.

The widget is places at back-top.

In left-to-right mode 'front' means 'left'.

Parameters

widget The widget to take ownership of

Returns: A reference to the widget being added.

◆ push_bottom()

widget & hi::v1::grid_widget::push_bottom ( std::unique_ptr< widget > widget )

inlinenoexcept

Insert a widget to the bottom of the grid.

The widget is places at front-bottom.

Parameters

widget The widget to take ownership of

Returns: A reference to the widget being added.

◆ push_front()

widget & hi::v1::grid_widget::push_front ( std::unique_ptr< widget > widget )

inlinenoexcept

Insert a widget to the front of the grid.

All the widgets currently on the grid are moved 1 backward and the new widget is added to the front-top cell.

In left-to-right mode 'front' means 'left'.

Parameters

widget The widget to take ownership of

Returns: A reference to the widget being added.

◆ push_top()

widget & hi::v1::grid_widget::push_top ( std::unique_ptr< widget > widget )

inlinenoexcept

Insert a widget to the top of the grid.

All the widgets currently on the grid are moved 1 lower and the new widget is added to the front-top cell.

Parameters

widget The widget to take ownership of

Returns: A reference to the widget being added.

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

hikogui/src/hikogui/widgets/grid_widget.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ grid_widget()

Member Function Documentation

◆ clear()

◆ emplace() [1/3]

◆ emplace() [2/3]

◆ emplace() [3/3]

◆ emplace_back()

◆ emplace_bottom()

◆ emplace_front()

◆ emplace_top()

◆ push_back()

◆ push_bottom()

◆ push_front()

◆ push_top()