#include <hikogui/widgets/grid_widget.hpp>

Inheritance diagram for hi::v1::grid_widget:

Public Types
using	super = widget

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

template<typename Widget , typename... Args>
Widget &	make_widget (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 &	make_widget (std::size_t column, std::size_t row, Args &&...args)
	Add a widget directly to this grid-widget.

template<typename Widget , typename... Args>
Widget &	make_widget (std::string_view address, Args &&...args)
	Add a widget directly to this grid-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 & >	children (bool include_invisible) noexcept

virtual hitbox	hitbox_test_from_parent (point2i position) const noexcept
	Call hitbox_test from a parent widget.

virtual hitbox	hitbox_test_from_parent (point2i 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_layout const &	layout () const noexcept
	Get the current layout for this widget.

virtual bool	process_event (gui_event const &event) const noexcept

virtual void	request_redraw () const noexcept
	Request the widget to be redrawn on the next frame.

virtual bool	handle_event (gui_event const &event) noexcept
	Handle command.

virtual bool	handle_event_recursive (gui_event const &event, std::vector< widget_id > const &reject_list=std::vector< widget_id >{}) noexcept
	Handle command recursive.

virtual widget_id	find_next_widget (widget_id current_keyboard_widget, keyboard_focus_group group, keyboard_focus_direction direction) const noexcept
	Find the next widget that handles keyboard focus.

widget_id	find_first_widget (keyboard_focus_group group) const noexcept

widget_id	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::aarectanglei 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_id >	parent_chain () const noexcept
	Get a list of parents of a given widget.

virtual gui_window *	window () const noexcept

virtual hi::theme const &	theme () const noexcept

virtual 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

Public Member Functions inherited from std::enable_shared_from_this< widget >
T	enable_shared_from_this (T... args)

T	operator= (T... args)

T	shared_from_this (T... args)

T	~enable_shared_from_this (T... args)

Additional Inherited Members
Data Fields inherited from hi::v1::widget
widget *	parent = nullptr
	Pointer to the parent widget.

widget_id	id = {}
	The numeric identifier of a 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< extent2i >	minimum = extent2i{}
	The minimum size this widget is allowed to be.

observer< extent2i >	maximum = extent2i::large()
	The maximum size this widget is allowed to be.

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::make_widget<T>(std::size_t column_nr, std::size_t row_nr, ...)
grid_widget::make_widget<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 * parent )

noexcept

Constructs an empty grid widget.

Parameters

parent The parent widget.

Member Function Documentation

◆ make_widget() [1/3]

template<typename Widget , typename... Args>

Widget & hi::v1::grid_widget::make_widget	(	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.

◆ make_widget() [2/3]

template<typename Widget , typename... Args>

Widget & hi::v1::grid_widget::make_widget	(	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.

◆ make_widget() [3/3]

template<typename Widget , typename... Args>

Widget & hi::v1::grid_widget::make_widget	(	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.

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

◆ make_widget() [1/3]

◆ make_widget() [2/3]

◆ make_widget() [3/3]