hi::v1::text_field_widget< Name > Class Template Reference

#include <hikogui/widgets/text_field_widget.hpp>

Inheritance diagram for hi::v1::text_field_widget< Name >:

Public Types
using	delegate_type = text_field_delegate
using	super = widget
Public Types inherited from hi::v1::widget
using	callback_token = notifier<void()>::callback_token
using	awaiter_type = notifier<void()>::awaiter_type

Public Member Functions
	text_field_widget (widget *parent, std::shared_ptr< delegate_type > delegate) noexcept
	text_field_widget (widget *parent, std::shared_ptr< delegate_type > delegate, text_field_widget_attribute auto &&...attributes) noexcept
	text_field_widget (widget *parent, different_from< std::shared_ptr< delegate_type > > auto &&value, text_field_widget_attribute auto &&...attributes) noexcept
	Construct a text field widget.
Public Member Functions inherited from hi::v1::widget
	widget (widget *parent) noexcept
	widget (widget const &)=delete
	widget (widget &&)=delete
widget &	operator= (widget &&)=delete
widget &	operator= (widget const &)=delete
generator< widget & >	children (bool include_invisible) noexcept
virtual hitbox	hitbox_test_from_parent (point2i position) const noexcept
	Call hitbox_test from a parent widget.
virtual hitbox	hitbox_test_from_parent (point2i position, hitbox sibling_hitbox) const noexcept
	Call hitbox_test from a parent widget.
void	reset_layout (gfx_surface *new_surface, float new_scale) noexcept
	Reset the layout.
virtual sub_theme_selector_type	sub_theme_selector () const noexcept
virtual bool	process_event (gui_event const &event) const noexcept
virtual void	request_redraw () const noexcept
	Request the widget to be redrawn on the next frame.
virtual bool	handle_event_recursive (gui_event const &event, std::vector< widget_id > const &reject_list=std::vector< widget_id >{}) noexcept
	Handle command recursive.
virtual widget_id	find_next_widget (widget_id current_keyboard_widget, keyboard_focus_group group, keyboard_focus_direction direction) const noexcept
	Find the next widget that handles keyboard focus.
widget_id	find_first_widget (keyboard_focus_group group) const noexcept
widget_id	find_last_widget (keyboard_focus_group group) const noexcept
bool	is_first (keyboard_focus_group group) const noexcept
bool	is_last (keyboard_focus_group group) const noexcept
virtual void	scroll_to_show (hi::aarectanglei rectangle) noexcept
	Scroll to show the given rectangle on the window.
std::vector< widget_id >	parent_chain () const noexcept
	Get a list of parents of a given widget.
virtual bool	is_tab_button () const noexcept
	Check if this widget is a tab-button.
template<forward_of< void()> Callback>
callback_token	subscribe (Callback &&callback, callback_flags flags=callback_flags::synchronous) const noexcept
awaiter_type	operator co_await () const noexcept

Data Fields
std::shared_ptr< delegate_type >	delegate
observer< bool >	continues = false
	Continues update mode.
observer< alignment >	alignment = alignment::middle_flush()
	The alignment of the text.
Data Fields inherited from hi::v1::widget
widget_id	id = {}
	The numeric identifier of a widget.
widget *	parent = nullptr
	Pointer to the parent widget.
gfx_surface *	surface = nullptr
	The surface this widget is drawn on.
observer< widget_mode >	mode = widget_mode::enabled
	The widget mode.
observer< bool >	hover = false
	Mouse cursor is hovering over the widget.
observer< bool >	clicked = false
	The widget is being clicked by the mouse.
observer< bool >	focus = false
	The widget has keyboard focus.
observer< widget_state >	state = widget_state::off
	The state of the widget.
size_t	semantic_layer = 0_uz
	The draw layer of the widget.
observer< extent2i >	minimum = extent2i{}
	The minimum size this widget is allowed to be.
observer< extent2i >	maximum = extent2i::large()
	The maximum size this widget is allowed to be.
widget_layout	layout

Static Public Attributes
static constexpr auto	prefix = Name / "text-field"

Detailed Description

template<fixed_string Name = "">
class hi::v1::text_field_widget< Name >

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.

Constructor & Destructor Documentation

text_field_widget()

template<fixed_string Name = "">

hi::v1::text_field_widget< Name >::text_field_widget ( widget * parent, different_from< std::shared_ptr< delegate_type > > auto && value, text_field_widget_attribute auto &&... attributes )

inlinenoexcept

Construct a text field widget.

Parameters

parent	The owner of this widget.
value	The value or observer value which represents the state of the text-field.
attributes	A set of attributes used to configure the text widget: a alignment.

Field Documentation

alignment

template<fixed_string Name = "">

observer<alignment> hi::v1::text_field_widget< Name >::alignment = alignment::middle_flush()

The alignment of the text.

continues

template<fixed_string Name = "">

observer<bool> hi::v1::text_field_widget< Name >::continues = false

Continues update mode.

If true then the value will update on every edit of the text field.

---

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

• hikogui/src/hikogui/widgets/text_field_widget.hpp