#include <hikogui/widgets/text_field_widget.hpp>
Inheritance diagram for v1::text_field_widget:
Public Types | |
| using | delegate_type = text_field_delegate |
| using | super = widget |
Public Member Functions | |
| text_field_widget (gui_window &window, widget *parent, std::weak_ptr< delegate_type > delegate) noexcept | |
|
template<typename Value > requires (not std::is_convertible_v<Value, weak_or_unique_ptr<delegate_type>>) | |
| text_field_widget (gui_window &window, widget *parent, Value &&value) noexcept | |
 Public Member Functions inherited from v1::widget | |
| widget (gui_window &window, widget *parent) noexcept | |
| widget (const widget &)=delete | |
| widget & | operator= (const widget &)=delete |
| widget (widget &&)=delete | |
| widget & | operator= (widget &&)=delete |
| bool | is_gui_thread () const noexcept |
| hi::theme const & | theme () const noexcept |
| Get the theme. | |
| hi::font_book & | font_book () const noexcept |
| Get the font book. | |
| virtual hitbox | hitbox_test_from_parent (point3 position) const noexcept |
| Call hitbox_test from a parent widget. | |
| virtual hitbox | hitbox_test_from_parent (point3 position, hitbox sibling_hitbox) const noexcept |
| Call hitbox_test from a parent widget. | |
| widget_constraints const & | constraints () const noexcept |
| widget_layout const & | layout () const noexcept |
| Get the current layout for this widget. | |
| virtual void | request_redraw () const noexcept |
| Request the widget to be redrawn on the next frame. | |
| void | request_relayout () const noexcept |
| Request the window to be relayout on the next frame. | |
| void | request_reconstrain () const noexcept |
| Request the window to be reconstrain on the next frame. | |
| void | request_resize () const noexcept |
| Request the window to be resize based on the preferred size of the widgets. | |
| virtual bool | handle_event (std::vector< command > const &commands) noexcept |
| virtual bool | handle_command_recursive (command command, std::vector< widget const * > const &reject_list=std::vector< widget const * >{}) noexcept |
| Handle command recursive. | |
| virtual bool | handle_event (mouse_event const &event) noexcept |
| virtual bool | handle_event (keyboard_event const &event) noexcept |
| Handle keyboard event. | |
| virtual widget const * | find_next_widget (widget const *current_keyboard_widget, keyboard_focus_group group, keyboard_focus_direction direction) const noexcept |
| Find the next widget that handles keyboard focus. | |
| widget const * | find_first_widget (keyboard_focus_group group) const noexcept |
| widget const * | find_last_widget (keyboard_focus_group group) const noexcept |
| 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. | |
| virtual void | scroll_to_show (hi::aarectangle rectangle) noexcept |
| Scroll to show the given rectangle on the window. | |
| void | scroll_to_show () noexcept |
| Scroll to show the important part of the widget. | |
| std::vector< widget const * > | parent_chain () const noexcept |
| Get a list of parents of a given widget. | |
| virtual color | background_color () const noexcept |
| virtual color | foreground_color () const noexcept |
| virtual color | accent_color () const noexcept |
| virtual color | label_color () const noexcept |
Data Fields | |
| observable< bool > | continues = false |
| Continues update mode. | |
| observable< theme_text_style > | text_style = theme_text_style::label |
| The style of the text. | |
| Data Fields inherited from v1::widget | |
| gui_window & | window |
| Convenient reference to the Window. | |
| widget *const | parent |
| Pointer to the parent widget. | |
| std::string | id |
| A name of widget, should be unique between siblings. | |
| observable< bool > | enabled = true |
| The widget is enabled. | |
| observable< bool > | visible = true |
| The widget is visible. | |
| observable< bool > | hover = false |
| Mouse cursor is hovering over the widget. | |
| observable< bool > | focus = false |
| The widget has keyboard focus. | |
| int | semantic_layer |
| The draw layer of the widget. | |
| int | logical_layer |
| The logical layer 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.
Field Documentation
◆ continues
| observable<bool> 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
| observable<theme_text_style> v1::text_field_widget::text_style = theme_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
