Struct TextInput 

pub struct TextInput { /* private fields */ }

A themed, optionally history-backed text field.

Implementations

impl TextInput

pub fn new() -> Self

A single-line field.

pub fn multiline() -> Self

A multi-line field.

pub fn statement() -> Self

A field for a statement: Enter runs it, Alt+Enter breaks the line.

pub fn with_theme(self, theme: &Theme) -> Self

Take text and cursor colours from the theme.

pub fn with_history(self, history_id: String) -> Self

Persist and recall values under history_id, which names the cache file.

pub fn with_history_limit(self, limit: usize) -> Self

Cap how many entries the history keeps.

pub fn set_focused(&mut self, focused: bool)

Show or hide the cursor. Only the focused field draws one.

pub fn is_focused(&self) -> bool

pub fn value(&self) -> &str

The current contents. Multi-line values are newline separated.

pub fn set_value(&mut self, value: impl AsRef<str>)

Replace the contents, leaving the cursor at the end.

pub fn suggest(&mut self, value: impl AsRef<str>)

Fill with a proposed default: until the first key it is selected while focused (a printable replaces it, Backspace or Delete clears it, movement or Enter keeps it); leaving drops the selection.

pub fn is_suggested(&self) -> bool

Whether the value is still the untouched default from TextInput::suggest.

pub fn select_all(&mut self)

Select the whole value, so the next printable replaces it while any cursor movement drops the selection and edits in place.

pub fn clear(&mut self)

Empty the field and stop any history walk in progress.

pub fn is_empty(&self) -> bool

pub fn cursor(&self) -> usize

Cursor position as a character offset into TextInput::value.

pub fn cursor_line(&self) -> usize

Line the cursor is on, counting from zero.

pub fn cursor_col(&self) -> usize

Character offset of the cursor within its line.

pub fn move_cursor_by_lines(&mut self, delta: isize)

Move the cursor up or down by whole lines, clamped at the ends.

pub fn line_count(&self) -> usize

Number of lines in the value; always at least one.

pub fn line_at(&self, line: usize) -> Option<&str>

The text of one line, if it exists.

pub fn visual_rows(&self, width: u16) -> usize

Rows the value takes when drawn width columns wide: its lines, or for a statement, its lines as wrapped.

pub fn replace_before_cursor(&mut self, count: usize, text: &str)

Replace the count characters before the cursor with text.

pub fn save_to_history(&mut self, cache: &CacheManager) -> Result<()>

Add the current value to the history and persist it.

pub fn navigate_history_up(&mut self, cache: Option<&CacheManager>)

Replace the value with an older history entry.

pub fn navigate_history_down(&mut self)

Replace the value with a newer history entry, or the value that was being edited before the walk started.

pub fn handle_key( &mut self, event: &KeyEvent, cache: Option<&CacheManager>, ) -> TextInputEvent

Handle one key press; cache only for inputs with history (None skips disk).

Trait Implementations

impl Clone for TextInput

fn clone(&self) -> Self

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.

impl Widget for &TextInput

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.