Struct TextInput 

pub struct TextInput { /* private fields */ }

Single-line editable text input widget state.

Wraps the text string, cursor byte-offset, selection, horizontal scroll, and optional password masking. All editing operations keep the cursor and selection consistent.

Implementations

impl TextInput

pub fn new() -> Self

Create an empty TextInput with no masking.

pub fn with_text(text: impl Into<String>) -> Self

Create a TextInput pre-populated with text, cursor at the end.

pub fn with_password(self) -> Self

Enable password masking with the bullet character U+2022.

pub fn text(&self) -> &str

Borrow the raw (un-masked) text.

pub fn cursor(&self) -> usize

Current cursor byte offset.

pub fn selection(&self) -> &Selection

Current selection.

pub fn scroll_offset(&self) -> f32

Current horizontal scroll offset in logical pixels.

pub fn is_password(&self) -> bool

Returns true when password masking is active.

pub fn is_showing_password(&self) -> bool

Returns true when the underlying password text is currently visible.

pub fn display_text(&self) -> String

The text to display — masked when in password mode (unless show-password is toggled on).

pub fn toggle_show_password(&mut self)

Toggle the show/hide state for password fields. No-op on plain fields.

pub fn selected_text(&self) -> &str

Borrow the currently selected slice of the raw text.

Returns an empty string when the selection is collapsed.

pub fn insert(&mut self, s: &str)

Insert a string at the cursor position, replacing any active selection.

pub fn insert_char(&mut self, c: char)

Insert a single character at the cursor position.

pub fn delete_backward(&mut self)

Delete the character immediately before the cursor (backspace).

If there is an active selection, deletes the selection instead.

pub fn delete_forward(&mut self)

Delete the character immediately after the cursor (Delete key).

If there is an active selection, deletes the selection instead.

pub fn move_left(&mut self, shift: bool)

Move the cursor one character to the left.

When shift is false and there is an active selection, the cursor jumps to the start of the selection without extending it.

pub fn move_right(&mut self, shift: bool)

Move the cursor one character to the right.

When shift is false and there is an active selection, the cursor jumps to the end of the selection without extending it.

pub fn move_home(&mut self, shift: bool)

Move the cursor to the beginning of the text (Home key).

pub fn move_end(&mut self, shift: bool)

Move the cursor to the end of the text (End key).

pub fn move_word_left(&mut self, shift: bool)

Move the cursor one word to the left (Ctrl+Left).

pub fn move_word_right(&mut self, shift: bool)

Move the cursor one word to the right (Ctrl+Right).

pub fn move_cursor_to_x(&mut self, x: f32, layout: &TextLayout, shift: bool)

Move the cursor to the byte position nearest to the pixel x-coordinate.

Uses TextLayout::hit_test for positioning. When shift is true, the selection anchor is preserved (keyboard-extend behaviour).

pub fn click(&mut self, x: f32, layout: &TextLayout)

Single-click — move the cursor and collapse the selection.

pub fn double_click(&mut self, x: f32, layout: &TextLayout)

Double-click — select the word nearest to the click position.

pub fn triple_click(&mut self)

Triple-click — select all text.

pub fn select_all(&mut self)

Select all text (Ctrl+A equivalent).

Trait Implementations

impl Clone for TextInput

fn clone(&self) -> TextInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TextInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TextInput

fn default() -> Self

Returns the “default value” for a type.