#include <hikogui/widgets/window_widget.hpp>

Inheritance diagram for hi::v1::window_widget:

Public Types
using	super = widget

Public Member Functions
	window_widget (forward_of< observer< label > > auto &&title) noexcept

color	background_color () noexcept
	The background color of the window.

grid_widget &	content () noexcept
	Get a reference to the window's content widget.

toolbar_widget &	toolbar () noexcept
	Get a reference to window's 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

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.

widget_layout const &	layout () const noexcept override
	Get the current layout for this widget.

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

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.

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 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.

Data Fields
observer< label >	title

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

The top-level window widget.

This widget is the top-level widget that is owned by the gui_window. It contains as childs the toolbar and content grid_widget.

Member Function Documentation

◆ background_color()

color hi::v1::window_widget::background_color ( )

inlinenoexcept

The background color of the window.

This function is used during rendering to use the optimized GPU clear function.

◆ content()

grid_widget & hi::v1::window_widget::content ( )

inlinenoexcept

Get a reference to the window's content widget.

See also: grid_widget

Returns: A reference to a grid_widget.

◆ toolbar()

toolbar_widget & hi::v1::window_widget::toolbar ( )

inlinenoexcept

Get a reference to window's toolbar widget.

See also: toolbar_widget

Returns: A reference to a toolbar_widget.

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

hikogui/src/hikogui/widgets/window_widget.hpp

Public Types

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ background_color()

◆ content()

◆ toolbar()