hi::v1::overlay_widget Class Reference

#include <hikogui/widgets/overlay_widget.hpp>

Inheritance diagram for hi::v1::overlay_widget:

Public Types
using	super = widget

Public Member Functions
	overlay_widget (widget_intf const *parent) noexcept
	Constructs an empty overlay widget.
void	set_widget (std::unique_ptr< widget > new_widget) noexcept
template<typename Widget , typename... Args>
Widget &	emplace (Args &&...args) noexcept
	Add a content widget directly to this overlay widget.
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	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 which may exist anywhere on a window overlaid above any other widget.

The overlay widget allows a content widget to be shown on top of other widgets in the window. It may be used for pop-up widgets, dialog boxes and sheets.

The size of the overlay widget is based on the widget::minimum_size(), widget::preferred_size() and widget::maximum_size(). Unlike other container widgets the clipping rectangle is made tightly around the container widget so that no drawing will happen outside of the overlay. The overlay itself will draw outside the clipping rectangle, for drawing a border and potentially a shadow.

As an overlay widget still confined to a window, like other widgets, when setting its layout parameters, it is recommended to use widget::make_overlay_rectangle() to make a rectangle that will fit inside the window.

It is recommended that the content of an overlay widget is a scroll widget so that when the overlay widget is drawn smaller than the requested rectangle the content will behave correctly.

Constructor & Destructor Documentation

overlay_widget()

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

inlinenoexcept

Constructs an empty overlay widget.

Parameters

parent

The parent widget.

Member Function Documentation

emplace()

template<typename Widget , typename... Args>

Widget & hi::v1::overlay_widget::emplace ( Args &&... args )

inlinenoexcept

Add a content widget directly to this overlay widget.

This widget is added as the content widget.

Precondition

No content widgets have been added before.

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

• hikogui/src/hikogui/widgets/overlay_widget.hpp