tt::selection_widget Class Reference

#include <ttauri/widgets/selection_widget.hpp>

Inheritance diagram for tt::selection_widget:

Public Types
using	super = widget
using	delegate_type = selection_delegate

Public Member Functions
	selection_widget (gui_window &window, widget *parent, std::weak_ptr< delegate_type > delegate) noexcept
	Construct a selection widget with a delegate.
template<typename OptionList , typename Value , typename... Args> requires (not std::is_convertible_v<Value, weak_or_unique_ptr<delegate_type>>)
	selection_widget (gui_window &window, widget *parent, OptionList &&option_list, Value &&value, Args &&...args) noexcept
	Construct a selection widget which will monitor an option list and a value.
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 color	background_color () const noexcept
virtual color	foreground_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 (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 (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.
virtual void	scroll_to_show (tt::rectangle rectangle) noexcept
	Scroll to show the given rectangle on the window.
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.

Data Fields
observable< label >	unknown_label
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 graphical control element that allows the user to choose only one of a predefined set of mutually exclusive options.

The following example creates a selection widget with three options. which will monitor and modify value to display the options from the option_list. At application startup, value is zero and none of the options is selected:

    auto option_list = std::vector<std::pair<int,label>>{
        {1, l10n("one")},
        {2, l10n("two")},
        {3, l10n("three")}
    };
 
    observable<int> value = 0;
    window.content().make_widget<selection_widget>("A2", option_list, value);

Constructor & Destructor Documentation

selection_widget() [1/2]

tt::selection_widget::selection_widget ( gui_window & window, widget * parent, std::weak_ptr< delegate_type > delegate )

noexcept

Construct a selection widget with a delegate.

Parameters

window	The window the selection widget will be displayed on.
parent	The owner of the selection widget.
delegate	The delegate which will control the selection widget.

selection_widget() [2/2]

template<typename OptionList , typename Value , typename... Args>
requires (not std::is_convertible_v<Value, weak_or_unique_ptr<delegate_type>>)

tt::selection_widget::selection_widget ( gui_window & window, widget * parent, OptionList && option_list, Value && value, Args &&... args )

inlinenoexcept

Construct a selection widget which will monitor an option list and a value.

Template Parameters

Value

The type of value. Must be convertible to size_t.

Parameters

window	The window the selection widget will be displayed on.
parent	The owner of the selection widget.
option_list	An vector or an observable vector of pairs of keys and labels. The keys are of the same type as the value. The labels are of type label.
value	The value or observable value to monitor.

---

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

• hikogui/src/ttauri/widgets/selection_widget.hpp