Struct rat_input::input::TextInputState

pub struct TextInputState {
    pub cursor: Option<Position>,
    pub area: Rect,
    pub mouse: MouseFlags,
    pub value: InputCore,
    pub non_exhaustive: NonExhaustive,
}

Input state data.

Fields

cursor: Option<Position>

The position of the cursor in screen coordinates. Can be directly used for [Frame::set_cursor()]

area: Rect

Area inside a possible block.

mouse: MouseFlags

Mouse selection in progress.

value: InputCore

Editing core

non_exhaustive: NonExhaustive

Construct with ..Default::default()

Implementations

impl TextInputState

pub fn reset(&mut self)

Reset to empty.

pub fn offset(&self) -> usize

Offset shown.

pub fn set_offset(&mut self, offset: usize)

Offset shown. This is corrected if the cursor wouldn’t be visible.

pub fn set_cursor(&mut self, cursor: usize, extend_selection: bool)

Set the cursor position, reset selection.

pub fn cursor(&self) -> usize

Cursor position.

pub fn set_value<S: Into<String>>(&mut self, s: S)

Set text.

pub fn value(&self) -> &str

Text.

pub fn as_str(&self) -> &str

Text

pub fn is_empty(&self) -> bool

Empty.

pub fn len(&self) -> usize

Text length as grapheme count.

pub fn has_selection(&self) -> bool

Selection.

pub fn set_selection(&mut self, anchor: usize, cursor: usize)

Selection.

pub fn select_all(&mut self)

Selection.

pub fn selection(&self) -> Range<usize>

Selection.

pub fn selection_str(&self) -> &str

Selection.

pub fn prev_word_boundary(&self) -> usize

Previous word boundary

pub fn next_word_boundary(&self) -> usize

Next word boundary

pub fn set_visual_cursor(&mut self, rpos: isize, extend_selection: bool)

Set the cursor position from a visual position relative to the origin.

pub fn screen_cursor(&self) -> Option<Position>

The current text cursor as an absolute screen position.

pub fn move_to_next(&mut self, extend_selection: bool)

Move to the next char.

pub fn move_to_prev(&mut self, extend_selection: bool)

Move to the previous char.

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

Insert a char a the current position.

pub fn replace(&mut self, range: Range<usize>, new: &str)

Replace the given range with a new string.

pub fn delete_prev_char(&mut self)

Delete the char before the cursor.

pub fn delete_next_char(&mut self)

Delete the char after the cursor.

Trait Implementations

impl Clone for TextInputState

fn clone(&self) -> TextInputState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextInputState

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

Formats the value using the given formatter.

impl Default for TextInputState

fn default() -> Self

Returns the “default value” for a type.

impl HandleEvent<Event, FocusKeys, Outcome> for TextInputState

fn handle(&mut self, event: &Event, _keymap: FocusKeys) -> Outcome

Handle an event.

impl HandleEvent<Event, MouseOnly, Outcome> for TextInputState

fn handle(&mut self, event: &Event, _keymap: MouseOnly) -> Outcome

Handle an event.