#include <ttauri/widgets/text_field_widget.hpp>

Inheritance diagram for tt::text_field_widget< T >:

Public Types
using	value_type = T

using	delegate_type = text_field_delegate<value_type>

using	super = widget

Public Member Functions
template<typename Value = observable<value_type>>
	text_field_widget (gui_window &window, std::shared_ptr< abstract_container_widget > parent, std::weak_ptr< delegate_type > delegate, Value &&value={}) noexcept

template<typename Value = observable<value_type>>
	text_field_widget (gui_window &window, std::shared_ptr< abstract_container_widget > parent, Value &&value={}) noexcept

void	set_delegate (std::weak_ptr< delegate_type > &&delegate) noexcept
	Set the delegate The delegate is used to convert between the value type and the string the user sees and enters.

void	set_continues (bool flag) noexcept
	Set or unset continues mode.

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.

bool	handle_event (command command) noexcept override
	Handle command.

bool	handle_event (mouse_event const &event) noexcept override

bool	handle_event (keyboard_event const &event) noexcept override
	Handle keyboard event.

hit_box	hitbox_test (point2 position) const noexcept override
	Find the widget that is under the mouse cursor.

bool	accepts_keyboard_focus (keyboard_focus_group group) const noexcept override
	Check if the widget will accept keyboard focus.

color	focus_color () const noexcept override

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_extent2	preferred_size () const noexcept
	Get the size-range of the widget.

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

gui_device *	device () 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< std::shared_ptr< widget > > const &reject_list) noexcept
	Handle command recursive.

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< 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::text_field_widget< T >

A single line text field.

A text field has the following visual elements:

A text field box which surrounds the user-editable text. It will use a color to show when the text-field has keyboard focus. It will use another color to show when the editable text is incorrect. Inside this box are the following elements:
- Prefix: an icon describing the meaning, such as a search icon, or password, or popup-chevron.
- Editable text
- Suffix: text that follows the editable text, such as a SI base units like " kg" or " Hz".
Outside the text field box is an optional error message.
A popup window can be used to select between suggestions.

Two commit modes:

on-activate: When pressing enter or changing keyboard focus using tab or clicking in another field; as long as the text value can be validly converted. The text will be converted to the observed object and committed. When pressing escape, the text reverts to the observed object value.
continues: Every change of the text value of the input value is immediately converted and committed to the observed object; as long as the text value can be validly converted.

The observed object needs to be convertible to and from a string using to_string() and from_string(). If from_string() throws a parse_error() its message will be displayed next to the text field.

A custom validate function can be passed to validate the string and display a message next to the text field.

A custom transform function can be used to filter text on a modification-by-modification basis. The filter takes the previous text and the new text after modification and returns the text that should be shown in the field. This allows the filter to reject certain characters or limit the size.

The maximum width of the text field is defined in the number of EM of the current selected font.

Member Function Documentation

◆ accepts_keyboard_focus()

template<typename T >

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

inlineoverridevirtualnoexcept

Check if the widget will accept keyboard focus.

Precondition: mutex must be locked by current thread.

Reimplemented from tt::widget.

◆ draw()

template<typename T >

void tt::text_field_widget< T >::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.

◆ focus_color()

template<typename T >

color tt::text_field_widget< T >::focus_color ( ) const

inlineoverridevirtualnoexcept

Reimplemented from tt::widget.

◆ handle_event() [1/3]

template<typename T >

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

inlineoverridevirtualnoexcept

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.

◆ handle_event() [2/3]

template<typename T >

bool tt::text_field_widget< T >::handle_event ( keyboard_event const & event )

inlineoverridevirtualnoexcept

Handle keyboard event.

Called by the operating system when editing text, or entering special keys

Parameters

event The keyboard event.

Returns: If this widget has handled the keyboard event.

Reimplemented from tt::widget.

◆ handle_event() [3/3]

template<typename T >

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

inlineoverridevirtualnoexcept

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::text_field_widget< T >::hitbox_test ( point2 position ) const

inlineoverridevirtualnoexcept

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

position The coordinate of the mouse local to the widget.

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

Reimplemented from tt::widget.

◆ set_continues()

template<typename T >

void tt::text_field_widget< T >::set_continues ( bool flag )

inlinenoexcept

Set or unset continues mode.

Parameters

flag	If true then the value will update on every edit of the text field. If false then the value will only update when the focus changes.

◆ set_delegate()

template<typename T >

void tt::text_field_widget< T >::set_delegate ( std::weak_ptr< delegate_type > && delegate )

inlinenoexcept

Set the delegate The delegate is used to convert between the value type and the string the user sees and enters.

Parameters

delegate The delegate for this text field

◆ update_constraints()

template<typename T >

bool tt::text_field_widget< T >::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()

template<typename T >

void tt::text_field_widget< T >::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_layout_parameters() on its children.

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 files:

hikogui/src/ttauri/widgets/text_field_delegate.hpp
hikogui/src/ttauri/widgets/text_field_widget.hpp

Public Types

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ accepts_keyboard_focus()

◆ draw()

◆ focus_color()

◆ handle_event() [1/3]

◆ handle_event() [2/3]

◆ handle_event() [3/3]

◆ hitbox_test()

◆ set_continues()

◆ set_delegate()

◆ update_constraints()

◆ update_layout()