hi::v1::text_field_widget Class Reference

#include <hikogui/widgets/text_field_widget.hpp>

Inheritance diagram for hi::v1::text_field_widget:

Public Types
using	delegate_type = text_field_delegate
using	super = widget

Public Member Functions
	text_field_widget (widget_intf const *parent, std::shared_ptr< delegate_type > delegate) noexcept
template<text_field_widget_attribute... Attributes>
	text_field_widget (widget_intf const *parent, std::shared_ptr< delegate_type > delegate, Attributes &&...attributes) noexcept
template<incompatible_with< std::shared_ptr< delegate_type > > Value, text_field_widget_attribute... Attributes> requires requires { make_default_text_field_delegate(std::forward<Value>(value)); }
	text_field_widget (widget_intf const *parent, Value &&value, Attributes &&...attributes) noexcept
	Construct a text field widget.
Public Member Functions inherited from hi::v1::widget
	widget (widget_intf const *parent) noexcept
	Constructor for creating sub views.
	widget () noexcept
	Constructor for creating sub views.
	widget (const widget &)=delete
widget &	operator= (const widget &)=delete
	widget (widget &&)=delete
widget &	operator= (widget &&)=delete
generator< widget_intf & >	children (bool include_invisible) noexcept override
	Get a list of child widgets.
hitbox	hitbox_test (point2 position) const noexcept override
	Find the widget that is under the mouse cursor.
virtual hitbox	hitbox_test_from_parent (point2 position) const noexcept
	Call hitbox_test from a parent widget.
virtual hitbox	hitbox_test_from_parent (point2 position, hitbox sibling_hitbox) const noexcept
	Call hitbox_test from a parent widget.
bool	accepts_keyboard_focus (keyboard_focus_group group) const noexcept override
	Check if the widget will accept keyboard focus.
box_constraints	update_constraints () noexcept override
	Update the constraints of the widget.
void	set_layout (widget_layout const &context) noexcept override
	Update the internal layout of the widget.
void	draw (draw_context const &context) noexcept override
	Draw the widget.
bool	process_event (gui_event const &event) const noexcept override
	Send a event to the window.
void	request_redraw () const noexcept override
	Request the widget to be redrawn on the next frame.
bool	handle_event (gui_event const &event) noexcept override
	Handle command.
bool	handle_event_recursive (gui_event const &event, std::vector< widget_id > const &reject_list=std::vector< widget_id >{}) noexcept override
	Handle command recursive.
virtual widget_id	find_next_widget (widget_id current_keyboard_widget, keyboard_focus_group group, keyboard_focus_direction direction) const noexcept override
	Find the next widget that handles keyboard focus.
void	scroll_to_show (hi::aarectangle rectangle) noexcept override
	Scroll to show the given rectangle on the window.
void	set_window (gui_window *window) noexcept override
	Set the window for this tree of widgets.
gui_window *	window () const noexcept override
	Get the window that the widget is owned by.
hi::theme const &	theme () const noexcept
gfx_surface const *	surface () 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 generator< widget_intf & >	children (bool include_invisible) noexcept=0
	Get a list of child widgets.
virtual generator< widget_intf const & >	children (bool include_invisible) const noexcept final
	Get a list of child widgets.
virtual void	scroll_to_show (hi::aarectangle rectangle) noexcept=0
	Scroll to show the given rectangle on the window.
void	scroll_to_show () noexcept
	Scroll to show the important part of the widget.
Public Member Functions inherited from hi::v1::widget_intf
	widget_intf (widget_intf const *parent) noexcept
template<forward_of< void()> Func>
callback< void()>	subscribe (Func &&func, callback_flags flags=callback_flags::synchronous) noexcept
	Subscribe a callback to be called when an action is completed by the widget.
auto	operator co_await () const noexcept
	Await until an action is completed by the widget.
size_t	layer () const noexcept
void	set_layer (size_t new_layer) noexcept
widget_mode	mode () const noexcept
void	set_mode (widget_mode new_mode) noexcept
widget_value	value () const noexcept
void	set_value (widget_value new_value) noexcept
widget_phase	phase () const noexcept
void	set_pressed (bool pressed) noexcept
void	set_hover (bool hover) noexcept
void	set_active (bool active) noexcept
bool	focus () const noexcept
void	set_focus (bool new_focus) noexcept
widget_layout const &	layout () const noexcept
	Get the current layout for this widget.
std::vector< widget_id >	parent_chain () const noexcept
	Get a list of parents of a given widget.
void	scroll_to_show () noexcept
	Scroll to show the important part of the widget.

Data Fields
std::shared_ptr< delegate_type >	delegate
observer< bool >	continues = false
	Continues update mode.
observer< semantic_text_style >	text_style = semantic_text_style::label
	The style of the text.
observer< alignment >	alignment = alignment::middle_flush()
	The alignment of the text.
Data Fields inherited from hi::v1::widget
observer< extent2 >	minimum = extent2{}
	The minimum size this widget is allowed to be.
observer< extent2 >	maximum = extent2::large()
	The maximum size this widget is allowed to be.
Data Fields inherited from hi::v1::widget_intf
widget_id	id = {}
	The numeric identifier of a widget.
widget_intf *	parent = nullptr
	Pointer to the parent widget.
notifier< void()>	notifier
	Notifier which is called after an action is completed by a widget.
observer< widget_state >	state
	The current state of the widget.

Detailed Description

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<incompatible_with< std::shared_ptr< delegate_type > > Value, text_field_widget_attribute... Attributes>
requires requires { make_default_text_field_delegate(std::forward<Value>(value)); }

hi::v1::text_field_widget::text_field_widget ( widget_intf const * parent, Value && value, Attributes &&... 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 or semantic_text_style.

Field Documentation

alignment

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

The alignment of the text.

continues

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

Continues update mode.

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

text_style

observer<semantic_text_style> hi::v1::text_field_widget::text_style = semantic_text_style::label

The style of the text.

---

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

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