#include <hikogui/widgets/grid_widget.hpp>

Inheritance diagram for hi::v1::grid_widget< Name >:

Public Types
using	super = widget

Public Types inherited from hi::v1::widget
using	callback_token = notifier<void()>::callback_token

using	awaiter_type = notifier<void()>::awaiter_type

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 (widget const &)=delete

	widget (widget &&)=delete

widget &	operator= (widget &&)=delete

widget &	operator= (widget const &)=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.

void	reset_layout (gfx_surface *new_surface, float new_scale) noexcept
	Reset the layout.

virtual sub_theme_selector_type	sub_theme_selector () const noexcept

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

bool	is_last (keyboard_focus_group group) const noexcept

virtual void	scroll_to_show (hi::aarectanglei rectangle) noexcept
	Scroll to show the given rectangle on the window.

std::vector< widget_id >	parent_chain () const noexcept
	Get a list of parents of a given widget.

virtual bool	is_tab_button () const noexcept
	Check if this widget is a tab-button.

template<forward_of< void()> Callback>
callback_token	subscribe (Callback &&callback, callback_flags flags=callback_flags::synchronous) const noexcept

awaiter_type	operator co_await () const noexcept

Static Public Attributes
static constexpr auto	prefix = Name / "grid"

Additional Inherited Members
Data Fields inherited from hi::v1::widget
widget_id	id = {}
	The numeric identifier of a widget.

widget *	parent = nullptr
	Pointer to the parent widget.

gfx_surface *	surface = nullptr
	The surface this widget is drawn on.

observer< widget_mode >	mode = widget_mode::enabled
	The widget mode.

observer< bool >	hover = false
	Mouse cursor is hovering over the widget.

observer< bool >	clicked = false
	The widget is being clicked by the mouse.

observer< bool >	focus = false
	The widget has keyboard focus.

observer< widget_state >	state = widget_state::off
	The state of the widget.

size_t	semantic_layer = 0_uz
	The draw 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.

widget_layout	layout

Detailed Description

template<fixed_string Name = "">
class hi::v1::grid_widget< Name >

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()

template<fixed_string Name = "">

hi::v1::grid_widget< Name >::grid_widget ( widget * parent )

inlinenoexcept

Constructs an empty grid widget.

Parameters

parent The parent widget.

Member Function Documentation

◆ make_widget() [1/3]

template<fixed_string Name = "">

template<typename Widget , typename... Args>

Widget & hi::v1::grid_widget< Name >::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<fixed_string Name = "">

template<typename Widget , typename... Args>

Widget & hi::v1::grid_widget< Name >::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<fixed_string Name = "">

template<typename Widget , typename... Args>

Widget & hi::v1::grid_widget< Name >::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

Static Public Attributes

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]