Struct TextInput 

pub struct TextInput<Msg> { /* private fields */ }

A text field with real editing: cursor, selection, word jumps, undo and clipboard.

The application owns the value and receives every change through on_change; cursor, selection and undo history live in the runtime.

Keys: ←/→ move (with Ctrl by word, with Shift selecting), Home/End, Backspace/Delete, Ctrl+W deletes a word, Ctrl+U deletes to the start, Ctrl+A selects all, Ctrl+Z undo, Ctrl+Y or Ctrl+Shift+Z redo, Ctrl+C and Ctrl+X copy and cut the selection, Enter submits. With a selection, ← and → clear it and move one step on from its left or right end. Pasting inserts text. Clicking places the cursor; dragging selects.

select_on_focus opens the field with part of its text selected, such as the name without its extension in a rename dialog; typing then replaces just that part.

A right click (or Shift+F10 and the menu key) opens an edit menu with Cut, Copy, Paste and Select all. A right click inside the selection keeps it; elsewhere it first places the cursor there. Cut and Copy are disabled without a selection, and always in password fields, which never copy; Paste is disabled while there is nothing to paste. Paste reads the system clipboard, then the terminal’s, then the text the application copied last. Entry names are quvyta.edit.*.

Style keys: text-input (bg, fg, padding) with hover, focus, invalid, disabled; text-input-prompt, text-input-placeholder, text-input-selection, text-input-cursor.

Implementations

impl<Msg: 'static> TextInput<Msg>

pub fn new(value: impl Into<String>) -> Self

A field showing value.

pub fn placeholder(self, text: impl Into<String>) -> Self

Faint text shown while the field is empty.

pub fn password(self, password: bool) -> Self

Masks every character.

pub fn invalid(self, invalid: bool) -> Self

Marks the value as failing validation.

pub fn disabled(self, disabled: bool) -> Self

Makes the field read-only and unfocusable.

pub fn max_length(self, max: usize) -> Self

Limits the value to max characters.

pub fn on_change(self, message: impl Fn(String) -> Msg + 'static) -> Self

Message carrying the new value after every edit.

pub fn on_submit(self, message: impl Fn(String) -> Msg + 'static) -> Self

Message carrying the value when Enter is pressed.

pub fn select_on_focus(self, range: Range<usize>) -> Self

Selects the characters in range each time the field gains focus, with the cursor at the range’s end, e.g. 0..4 to select main in main.rs. The range counts characters, not bytes, and is cut to the text. From then on the selection is the user’s: typing replaces it, the arrows drop it, and a value changed from outside does not bring it back. A click that gives the field focus places the cursor instead.

pub fn select_all_on_focus(self) -> Self

Selects the whole text each time the field gains focus, like select_on_focus with a range covering every character.

Trait Implementations

impl<Msg: 'static> Widget<Msg> for TextInput<Msg>

fn measure(&self, cx: &mut MeasureCx<'_>, available: Size) -> Size

The size the widget wants when it may use up to available.

fn paint(&self, cx: &mut PaintCx<'_>, area: Rect)

Draws the widget into area.

fn paint_overlay(&self, cx: &mut PaintCx<'_>, anchor: Rect)

Draws the widget’s overlay after the whole view was painted, when it asked for one with PaintCx::request_overlay. anchor is the area the widget was painted in.

fn event(&self, cx: &mut EventCx<'_, Msg>, event: &Event) -> bool

Handles input. Returns true when the event was used; unused key and scroll events bubble to the parent widget.

fn focusable(&self) -> bool

Whether the widget can take keyboard focus.

fn children(&self) -> &[Node<Msg>]

Child nodes, for widgets that contain other widgets.

fn children_mut(&mut self) -> &mut [Node<Msg>]

Mutable child nodes, used to assign ids.