tt::toggle_widget Class Reference

Inheritance diagram for tt::toggle_widget:

Public Types
using	super = abstract_bool_toggle_button_widget
Public Types inherited from tt::abstract_toggle_button_widget< bool >
using	super
using	value_type
Public Types inherited from tt::abstract_button_widget< T >
using	super = widget
using	value_type = T
using	notifier_type = notifier<void()>
using	callback_type = typename notifier_type::callback_type
using	callback_ptr_type = typename notifier_type::callback_ptr_type

Public Member Functions
template<typename Value = observable<bool>>
	toggle_widget (gui_window &window, std::shared_ptr< abstract_container_widget > parent, Value &&value=observable< bool >{}) noexcept
bool	update_constraints (hires_utc_clock::time_point display_time_point, bool need_reconstrain) noexcept override
	Update the constraints of the widget.
void	update_layout (hires_utc_clock::time_point display_time_point, bool need_layout) noexcept override
	Update the internal layout of the widget.
void	draw (draw_context context, hires_utc_clock::time_point display_time_point) noexcept override
	Draw the widget.
Public Member Functions inherited from tt::abstract_bool_toggle_button_widget
template<typename Value >
	abstract_bool_toggle_button_widget (gui_window &window, std::shared_ptr< abstract_container_widget > parent, Value &&value) noexcept
Public Member Functions inherited from tt::abstract_toggle_button_widget< bool >
	abstract_toggle_button_widget (gui_window &window, std::shared_ptr< abstract_container_widget > parent, value_type true_value, value_type false_value, Value &&value={}) noexcept
void	toggle () noexcept
Public Member Functions inherited from tt::abstract_button_widget< T >
template<typename Value = observable<value_type>>
	abstract_button_widget (gui_window &window, std::shared_ptr< abstract_container_widget > parent, value_type true_value, Value &&value={})
draw_context	make_draw_context (draw_context context) const noexcept override
	Make a draw context for this widget.
bool	accepts_keyboard_focus (keyboard_focus_group group) const noexcept
	Check if the widget will accept keyboard focus.
bool	handle_event (command command) noexcept
	Handle command.
bool	handle_event (mouse_event const &event) noexcept final
hit_box	hitbox_test (f32x4 window_position) const noexcept final
	Find the widget that is under the mouse cursor.
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, std::shared_ptr< abstract_container_widget > parent) noexcept
	widget (const widget &)=delete
widget &	operator= (const widget &)=delete
	widget (widget &&)=delete
widget &	operator= (widget &&)=delete
virtual void	init () noexcept
	Should be called right after allocating and constructing a widget.
float	margin () const noexcept
	Get the margin around the Widget.
float	draw_layer () const noexcept
	The first drawing layer of the widget.
int	logical_layer () const noexcept
	The logical layer of the widget.
int	semantic_layer () const noexcept
	The semantic layer of the widget.
ranged_int< 3 >	width_resistance () const noexcept
	Get the resistance in width.
ranged_int< 3 >	height_resistance () const noexcept
	Get the resistance in height.
interval_vec2	preferred_size () const noexcept
	Get the size-range of the widget.
relative_base_line	preferred_base_line () const noexcept
	Get the relative_base_line of the widget.
void	set_layout_parameters (aarect const &window_rectangle, aarect const &window_clipping_rectangle, float window_base_line=std::numeric_limits< float >::infinity()) noexcept
	Set the location and size of the widget inside the window.
aarect	window_rectangle () const noexcept
	Get the rectangle in window coordinates.
virtual aarect	window_clipping_rectangle () const noexcept
	Get the clipping-rectangle in window coordinates.
float	window_base_line () const noexcept
	Get the base-line distance from the bottom of the window.
aarect	rectangle () const noexcept
	Get the rectangle in local coordinates.
float	base_line () const noexcept
	Get the base-line in local coordinates.
gui_device *	device () const noexcept
virtual bool	handle_event (std::vector< command > const &commands) noexcept
virtual bool	handle_command_recursive (command command, std::vector< std::shared_ptr< widget > > const &reject_list) noexcept
	Handle command recursive.
virtual bool	handle_event (keyboard_event const &event) noexcept
	Handle keyboard event.
virtual std::shared_ptr< widget >	find_next_widget (std::shared_ptr< widget > const &current_keyboard_widget, keyboard_focus_group group, keyboard_focus_direction direction) const noexcept
	Find the next widget that handles keyboard focus.
std::shared_ptr< abstract_container_widget const >	shared_parent () const noexcept
	Get a shared_ptr to the parent.
std::shared_ptr< abstract_container_widget >	shared_parent () noexcept
	Get a shared_ptr to the parent.
abstract_container_widget const &	parent () const noexcept
	Get a reference to the parent.
abstract_container_widget &	parent () noexcept
	Get a reference to the parent.
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.
Public Member Functions inherited from std::enable_shared_from_this< widget >
T	enable_shared_from_this (T... args)
T	operator= (T... args)
T	shared_from_this (T... args)
T	~enable_shared_from_this (T... args)

Data Fields
observable< label >	on_label
observable< label >	off_label
Data Fields inherited from tt::abstract_toggle_button_widget< bool >
value_type const	false_value
Data Fields inherited from tt::abstract_button_widget< T >
value_type const	true_value
observable< value_type >	value
Data Fields inherited from tt::widget
gui_window &	window
	Convenient reference to the Window.
observable< bool >	enabled = true
	The widget is enabled.

Additional Inherited Members
Static Public Member Functions inherited from tt::widget
static std::vector< std::shared_ptr< widget > >	parent_chain (std::shared_ptr< tt::widget > const &child_widget) noexcept
	Get a list of parents of a given widget.

Member Function Documentation

draw()

void tt::toggle_widget::draw ( draw_context context, hires_utc_clock::time_point display_time_point )

inlineoverridevirtualnoexcept

Draw the widget.

This function is called by the window (optionally) on every frame. It should recursively call this function on every visible child. This function is only called when updateLayout() has returned true.

The overriding function should call the base class's draw(), the place where the call this function will determine the order of the vertices into each buffer. This is important when needing to do the painters algorithm for alpha-compositing. However the pipelines are always drawn in the same order.

Precondition

mutex must be locked by current thread.

Parameters

context	The context to where the widget will draw.
display_time_point	The time point when the widget will be shown on the screen.

Reimplemented from tt::widget.

update_constraints()

bool tt::toggle_widget::update_constraints ( hires_utc_clock::time_point display_time_point, bool need_reconstrain )

inlineoverridevirtualnoexcept

Update the constraints of the widget.

This function is called on each vertical sync, even if no drawing is to be done. It should recursively call updateConstraints() on each of the visible children, so they get a chance to update.

This function may be used for expensive calculations, such as text-shaping, which should only be done when the data changes. Because this function is called on every vertical sync it should cache these calculations.

Subclasses should call updateConstraints() on its base-class to check if the constraints where changed. Widget::update_constraints() will check if requestConstraints was set. Container::update_constraints() will check if any of the children changed constraints.

If the container, due to a change in constraints, wants the window to resize to the minimum size it should set window.requestResize to true.

This function will change what is returned by preferred_size() and preferred_base_line().

Precondition

mutex must be locked by current thread.

Parameters

display_time_point	The time point when the widget will be shown on the screen.
need_reconstrain	Force the widget to re-constrain.

Returns

True if its or any children's constraints has changed.

Reimplemented from tt::widget.

update_layout()

void tt::toggle_widget::update_layout ( hires_utc_clock::time_point display_time_point, bool need_layout )

inlineoverridevirtualnoexcept

Update the internal layout of the widget.

This function is called on each vertical sync, even if no drawing is to be done. It should recursively call updateLayout() on each of the visible children, so they get a chance to update.

This function may be used for expensive calculations, such as geometry calculations, which should only be done when the data or sizes change. Because this function is called on every vertical sync it should cache these calculations.

This function will likely call set_window_rectangle() and set_window_base_line() on its children, before calling updateLayout() on that child.

Subclasses should call updateLayout() on its children, call updateLayout() on its base class with forceLayout argument to the result of layoutRequest.exchange(false).

Precondition

mutex must be locked by current thread.

Parameters

display_time_point	The time point when the widget will be shown on the screen.
need_layout	Force the widget to layout

Reimplemented from tt::widget.

---

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

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