tt::toggle_widget Class Reference

#include <ttauri/widgets/toggle_widget.hpp>

Inheritance diagram for tt::toggle_widget:

Public Types
using	super = abstract_button_widget
using	delegate_type = typename super::delegate_type
using	callback_ptr_type = typename delegate_type::callback_ptr_type
Public Types inherited from tt::abstract_button_widget
using	super = widget
using	delegate_type = button_delegate
using	callback_ptr_type = typename delegate_type::callback_ptr_type

Public Member Functions
	toggle_widget (gui_window &window, widget *parent, std::unique_ptr< delegate_type > delegate) noexcept
	Construct a toggle widget.
template<typename Value , typename... Args> requires (not std::is_convertible_v<Value, weak_or_unique_ptr<delegate_type>>)
	toggle_widget (gui_window &window, widget *parent, Value &&value, Args &&...args) noexcept
	Construct a toggle widget with a default button delegate.
Public Member Functions inherited from tt::abstract_button_widget
template<typename Label >
void	set_label (Label const &rhs) noexcept
	Set on/off/other labels of the button to the same value.
button_state	state () const noexcept
	Get the current state of the button.
template<typename Callback >
callback_ptr_type	subscribe (Callback &&callback) noexcept
	Subscribe a callback to call when the button is activated.
void	unsubscribe (callback_ptr_type &callback_ptr) noexcept
	Unsubscribe a callback.
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	foreground_color () const noexcept
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 (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.

Additional Inherited Members
Data Fields inherited from tt::abstract_button_widget
observable< label >	on_label = l10n("on")
	The label to show when the button is in the 'on' state.
observable< label >	off_label = l10n("off")
	The label to show when the button is in the 'off' state.
observable< label >	other_label = l10n("other")
	The label to show when the button is in the 'other' state.
observable< alignment >	label_alignment
	The alignment of the on/off/other 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 GUI widget that permits the user to make a binary choice.

A toggle is very similar to a checkbox_widget. The semantic difference between a checkbox and a toggle is:

• A toggle is immediately active, turning on and off a feature or service at the moment you toggle it.
• A checkbox determines what happens when another action takes place. Or only becomes active after pressing the "Apply" or "Save" button on a form. Or becomes part of a record together with other information to be stored together in a database of some sort.

A toggle is a button with three different states with different visual representation:

• on: The switch is thrown to the right and is highlighted, and the toggle_widget::on_label is shown.
• off: The switch is thrown to the left and is not highlighted, and the toggle_widget::off_label is shown.
• other: The switch is thrown to the left and is not highlighted, and the toggle_widget::other_label is shown.

Each time a user activates the toggle-button it toggles between the 'on' and 'off' states. If the toggle is in the 'other' state an activation will switch it to the 'off' state.

A toggle cannot itself switch state to 'other', this state may be caused by external factors.

In the following example we create a toggle widget on the window which observes value. When the value is 1 the toggle is 'on', when the value is 2 the toggle is 'off'.

    observable<int> value = 0;
 
    auto &tb = window.content().make_widget<toggle_widget>("B1", value, 1, 2);
    tb.on_label = l10n("on");
    tb.off_label = l10n("off");
    tb.other_label = l10n("other");

Constructor & Destructor Documentation

toggle_widget() [1/2]

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

noexcept

Construct a toggle widget.

Parameters

window	The window that this widget belongs to.
parent	The parent widget that owns this toggle widget.
delegate	The delegate to use to manage the state of the toggle button.

toggle_widget() [2/2]

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

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

inlinenoexcept

Construct a toggle widget with a default button delegate.

See also

default_button_delegate

Parameters

window	The window that this widget belongs to.
parent	The parent widget that owns this toggle widget.
value	The value or observable value which represents the state of the toggle.
args	An optional on-value, followed by an optional off-value. These two values are used to determine which value yields an on/off state.

---

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

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