tt::overlay_widget Class Reference

#include <ttauri/widgets/overlay_widget.hpp>

Inheritance diagram for tt::overlay_widget:

Public Types
using	super = widget
using	delegate_type = overlay_delegate

Public Member Functions
	overlay_widget (gui_window &window, widget *parent, std::weak_ptr< delegate_type > delegate={}) noexcept
	Constructs an empty overlay widget.
template<typename Widget , typename... Args>
Widget &	make_widget (Args &&...args) noexcept
	Add a content widget directly to this overlay widget.
Public Member Functions inherited from tt::widget
	widget (gui_window &window, widget *parent) noexcept
	widget (const widget &)=delete
widget &	operator= (const widget &)=delete
	widget (widget &&)=delete
widget &	operator= (widget &&)=delete
virtual float	margin () const noexcept
	Get the margin around the Widget.
extent2	minimum_size () const noexcept
	Minimum size.
extent2	preferred_size () const noexcept
	Preferred size.
extent2	maximum_size () const noexcept
	Maximum size.
void	set_layout_parameters (geo::transformer auto const &local_to_parent, extent2 size, aarectangle const &clipping_rectangle) noexcept
	Set the location and size of the widget inside the window.
void	set_layout_parameters_from_parent (aarectangle child_rectangle, aarectangle parent_clipping_rectangle, float draw_layer_delta) noexcept
void	set_layout_parameters_from_parent (aarectangle child_rectangle) noexcept
matrix3	parent_to_local () const noexcept
matrix3	local_to_parent () const noexcept
matrix3	window_to_local () const noexcept
matrix3	local_to_window () const noexcept
extent2	size () const noexcept
float	width () const noexcept
float	height () const noexcept
aarectangle	rectangle () const noexcept
	Get the rectangle in local coordinates.
virtual float	base_line () const noexcept
	Return the base-line where the text should be located.
aarectangle	clipping_rectangle () const noexcept
virtual hitbox	hitbox_test (point2 position) const noexcept
	Find the widget that is under the mouse cursor.
virtual bool	accepts_keyboard_focus (keyboard_focus_group group) const noexcept
	Check if the widget will accept keyboard focus.
virtual color	focus_color () const noexcept
virtual color	accent_color () const noexcept
virtual color	label_color () const noexcept
virtual void	request_redraw () const noexcept
virtual bool	handle_event (command command) noexcept
	Handle command.
virtual bool	handle_event (std::vector< command > const &commands) noexcept
virtual bool	handle_command_recursive (command command, std::vector< widget const * > const &reject_list) noexcept
	Handle command recursive.
virtual bool	handle_event (mouse_event const &event) noexcept
virtual bool	handle_event (keyboard_event const &event) noexcept
	Handle keyboard event.
virtual widget const *	find_next_widget (widget const *current_keyboard_widget, keyboard_focus_group group, keyboard_focus_direction direction) const noexcept
	Find the next widget that handles keyboard focus.
widget const *	find_first_widget (keyboard_focus_group group) const noexcept
widget const *	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.
std::vector< widget const * >	parent_chain () const noexcept
	Get a list of parents of a given widget.
void	clear () noexcept
	Remove and deallocate all child widgets.
widget &	add_widget (std::unique_ptr< widget > widget) noexcept
	Add a widget directly to this widget.

Additional Inherited Members
Data Fields inherited from tt::widget
gui_window &	window
	Convenient reference to the Window.
widget *const	parent
	Pointer to the parent widget.
std::string	id
	A name of widget, should be unique between siblings.
observable< bool >	enabled = true
	The widget is enabled.
observable< bool >	visible = true
	The widget is visible.
float	draw_layer
	The draw layer of the widget.
int	semantic_layer
	The draw layer of the widget.
int	logical_layer
	The logical layer 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()

tt::overlay_widget::overlay_widget ( gui_window & window, widget * parent, std::weak_ptr< delegate_type > delegate = {} )

noexcept

Constructs an empty overlay widget.

Parameters

window	The window.
parent	The parent widget.
delegate	An optional delegate can be used to populate the overlay widget during initialization.

Member Function Documentation

make_widget()

template<typename Widget , typename... Args>

Widget & tt::overlay_widget::make_widget ( 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/ttauri/widgets/overlay_widget.hpp