Struct rat_widget::input::TextInputState

pub struct TextInputState {
    pub focus: FocusFlag,
    pub invalid: bool,
    pub area: Rect,
    pub inner: Rect,
    pub mouse: MouseFlags,
    pub value: InputCore,
    pub non_exhaustive: NonExhaustive,
}

Textinput data & event-handling.

Fields

focus: FocusFlag

Current focus state.

invalid: bool

Display as invalid.

area: Rect

The whole area with block.

inner: 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 new() -> Self

pub fn set_invalid(&mut self, invalid: bool)

Renders the widget in invalid style.

pub fn get_invalid(&self) -> bool

Renders the widget in invalid style.

pub fn clear(&mut self) -> bool

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 cursor(&self) -> usize

Cursor position.

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

Set the cursor position, reset selection.

pub fn anchor(&self) -> usize

Selection anchor.

pub fn value(&self) -> &str

Text.

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

Set 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 selection(&self) -> Range<usize>

Selection.

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

Selection.

pub fn select_all(&mut self) -> bool

Selection.

pub fn selected_value(&self) -> &str

Selection.

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

Insert a char at the current position.

pub fn delete_range(&mut self, range: Range<usize>) -> bool

Deletes the given range.

pub fn delete_next_word(&mut self) -> bool

Deletes the next word.

pub fn delete_prev_word(&mut self) -> bool

Deletes the given range.

pub fn delete_prev_char(&mut self) -> bool

Delete the char before the cursor.

pub fn delete_next_char(&mut self) -> bool

Delete the char after the cursor.

pub fn move_to_next_word(&mut self, extend_selection: bool) -> bool

pub fn move_to_prev_word(&mut self, extend_selection: bool) -> bool

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

Move to the next char.

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

Move to the previous char.

pub fn move_to_line_start(&mut self, extend_selection: bool) -> bool

Start of line

pub fn move_to_line_end(&mut self, extend_selection: bool) -> bool

pub fn to_screen_col(&self, pos: usize) -> Option<u16>

Converts a grapheme based position to a screen position relative to the widget area.

pub fn from_screen_col(&self, x: usize) -> Option<usize>

Converts from a widget relative screen coordinate to a grapheme index. x is the relative screen position.

pub fn set_screen_cursor( &mut self, cursor: isize, extend_selection: bool, ) -> bool

Set the cursor position from a screen position relative to the origin of the widget. This value can be negative, which selects a currently not visible position and scrolls to it.

pub fn screen_cursor(&self) -> Option<(u16, u16)>

The current text cursor as an absolute screen position.

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, TextOutcome> for TextInputState

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

Handle an event.

impl HandleEvent<Event, MouseOnly, TextOutcome> for TextInputState

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

Handle an event.

impl HandleEvent<Event, ReadOnly, TextOutcome> for TextInputState

fn handle(&mut self, event: &Event, _keymap: ReadOnly) -> TextOutcome

Handle an event.

impl HasFocusFlag for TextInputState

fn focus(&self) -> &FocusFlag

Access to the flag for the rest.

fn area(&self) -> Rect

Access the area for mouse focus.

fn z_areas(&self) -> &[ZRect]

The widget might have several disjointed areas. This is the case if it is showing a popup, but there might be other causes.

fn navigable(&self) -> bool

If the widget is focusable, but doesn’t want to partake in keyboard navigation it returns false here.

fn is_focused(&self) -> bool

Focused?

fn lost_focus(&self) -> bool

Just lost focus.

fn gained_focus(&self) -> bool

Just gained focus.