tt::abstract_button_widget< T > Class Template Reference

#include <ttauri/widgets/abstract_button_widget.hpp>

Inheritance diagram for tt::abstract_button_widget< T >:

Public Types
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<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	update_constraints (hires_utc_clock::time_point display_time_point, bool need_reconstrain) noexcept
	Update the constraints of the widget.
virtual void	update_layout (hires_utc_clock::time_point display_time_point, bool need_layout) noexcept
	Update the internal layout of the widget.
virtual void	draw (draw_context context, hires_utc_clock::time_point display_time_point) noexcept
	Draw the widget.
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
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.

Detailed Description

template<typename T>
class tt::abstract_button_widget< T >

An abstract button widget.

This widgets implements the behavior for a widget where its whole area is clickable, accepts and responds to gui_activate commands.

Member Function Documentation

accepts_keyboard_focus()

template<typename T >

bool tt::abstract_button_widget< T >::accepts_keyboard_focus ( keyboard_focus_group group ) const

inlinevirtualnoexcept

Check if the widget will accept keyboard focus.

Precondition

mutex must be locked by current thread.

Reimplemented from tt::widget.

Reimplemented in tt::menu_item_widget< T >, tt::menu_item_widget< value_type >, and tt::toolbar_tab_button_widget< T >.

handle_event() [1/2]

template<typename T >

bool tt::abstract_button_widget< T >::handle_event ( command command )

inlinevirtualnoexcept

Handle command.

If a widget does not fully handle a command it should pass the command to the super class' handle_event().

Reimplemented from tt::widget.

Reimplemented in tt::menu_item_widget< T >, tt::menu_item_widget< value_type >, and tt::toolbar_tab_button_widget< T >.

handle_event() [2/2]

template<typename T >

bool tt::abstract_button_widget< T >::handle_event ( mouse_event const & event )

inlinefinalvirtualnoexcept

Handle mouse event. Called by the operating system to show the position and button state of the mouse. This is called very often so it must be made efficient. This function is also used to determine the mouse cursor.

In most cased overriding methods should call the super's handle_event() at the start of the function, to detect hover.

When this method does not handle the event the window will call handle_event() on the widget's parent.

Parameters

event

The mouse event, positions are in window coordinates.

Returns

If this widget has handled the mouse event.

Reimplemented from tt::widget.

hitbox_test()

template<typename T >

hit_box tt::abstract_button_widget< T >::hitbox_test ( f32x4 window_position ) const

inlinefinalvirtualnoexcept

Find the widget that is under the mouse cursor.

This function will recursively test with visual child widgets, when widgets overlap on the screen the hitbox object with the highest elevation is returned.

Parameters

window_position

The coordinate of the mouse on the window. Use fromWindowTransform to convert to widget-local coordinates.

Returns

A hit_box object with the cursor-type and a reference to the widget.

Reimplemented from tt::widget.

make_draw_context()

template<typename T >

draw_context tt::abstract_button_widget< T >::make_draw_context ( draw_context context ) const

inlineoverridevirtualnoexcept

Make a draw context for this widget.

This function will make a draw context with the correct transformation and default color values.

Precondition

mutex must be locked by current thread.

Parameters

context

A template drawing context. This template may be taken from the parent's draw call.

Returns

A new draw context for drawing the current widget in the local coordinate system.

Reimplemented from tt::widget.

subscribe()

template<typename T >

template<typename Callback >

callback_ptr_type tt::abstract_button_widget< T >::subscribe ( Callback && callback )

inlinenoexcept

Subscribe a callback to call when the button is activated.

See also

notifier::subscribe()

unsubscribe()

template<typename T >

void tt::abstract_button_widget< T >::unsubscribe ( callback_ptr_type & callback_ptr )

inlinenoexcept

Unsubscribe a callback.

See also

notifier::subscribe()

---

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

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