Struct TextInputState 

pub struct TextInputState {

    pub area: Rect,
    pub inner: Rect,
    pub rendered: Size,
    pub offset: upos_type,
    pub dark_offset: (u16, u16),
    pub scroll_to_cursor: bool,
    pub value: TextCore<TextString>,
    pub invalid: bool,
    pub passwd: bool,
    pub overwrite: bool,
    pub on_focus_gained: TextFocusGained,
    pub on_focus_lost: TextFocusLost,
    pub focus: FocusFlag,
    pub mouse: MouseFlags,
    pub non_exhaustive: NonExhaustive,
}

State for TextInput.

Fields

area: Rect

The whole area with block. read only renewed with each render.

inner: Rect

Area inside a possible block. read only renewed with each render.

rendered: Size

Rendered dimension. This may differ from (inner.width, inner.height) if the text area has been relocated. read only renewed with each render.

offset: upos_type

Display offset read+write

dark_offset: (u16, u16)

Dark offset due to clipping. read only secondary offset due to clipping.

scroll_to_cursor: bool

read+write use scroll_cursor_to_visible().

value: TextCore<TextString>

Editing core

invalid: bool

Display as invalid. read+write

passwd: bool

Display as password. read only

overwrite: bool

The next user edit clears the text for doing any edit. It will reset this flag. Other interactions may reset this flag too.

on_focus_gained: TextFocusGained

Focus behaviour. read only

on_focus_lost: TextFocusLost

Focus behaviour. read only

focus: FocusFlag

Current focus state. read+write

mouse: MouseFlags

Mouse selection in progress. read+write

non_exhaustive: NonExhaustive

Construct with ..Default::default()

Implementations

impl TextInputState

pub fn new() -> Self

pub fn named(name: &str) -> Self

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

Renders the widget in invalid style.

pub fn get_invalid(&self) -> bool

👎Deprecated since 1.0.5: wrong convention

Renders the widget in invalid style.

pub fn invalid(&self) -> bool

Renders the widget in invalid style.

pub fn set_overwrite(&mut self, overwrite: bool)

The next edit operation will overwrite the current content instead of adding text. Any move operations will cancel this overwrite.

pub fn overwrite(&self) -> bool

Will the next edit operation overwrite the content?

pub fn set_show_ctrl(&mut self, show_ctrl: bool)

Show glyphs for control characters.

pub fn show_ctrl(&self) -> bool

Show glyphs for control characters.

impl TextInputState

pub fn set_clipboard(&mut self, clip: Option<impl Clipboard + 'static>)

Clipboard used. Default is to use the global_clipboard().

pub fn clipboard(&self) -> Option<&dyn Clipboard>

Clipboard used. Default is to use the global_clipboard().

pub fn copy_to_clip(&mut self) -> bool

Copy to internal buffer

pub fn cut_to_clip(&mut self) -> bool

Cut to internal buffer

pub fn paste_from_clip(&mut self) -> bool

Paste from internal buffer.

impl TextInputState

pub fn set_undo_buffer(&mut self, undo: Option<impl UndoBuffer + 'static>)

Set undo buffer.

pub fn undo_buffer(&self) -> Option<&dyn UndoBuffer>

Undo

pub fn undo_buffer_mut(&mut self) -> Option<&mut dyn UndoBuffer>

Undo

pub fn recent_replay_log(&mut self) -> Vec<UndoEntry>

Get all recent replay recordings.

pub fn replay_log(&mut self, replay: &[UndoEntry])

Apply the replay recording.

pub fn undo(&mut self) -> bool

Undo operation

pub fn redo(&mut self) -> bool

Redo operation

impl TextInputState

pub fn set_styles(&mut self, styles: Vec<(Range<usize>, usize)>)

Set and replace all styles.

The ranges are byte-ranges into the text. Each byte-range maps to an index into the styles set with the widget.

Any style-idx that don’t have a match there are just ignored. You can use this to store other range based information. The ranges are corrected during edits, no need to recalculate everything after each keystroke.

pub fn add_style(&mut self, range: Range<usize>, style: usize)

Add a style for a TextRange.

The style-idx refers to one of the styles set with the widget. Missing styles are just ignored.

pub fn add_range_style( &mut self, range: Range<upos_type>, style: usize, ) -> Result<(), TextError>

Add a style for char range. The style-nr refers to one of the styles set with the widget.

pub fn remove_style(&mut self, range: Range<usize>, style: usize)

Remove the exact char-range and style.

pub fn remove_range_style( &mut self, range: Range<upos_type>, style: usize, ) -> Result<(), TextError>

Remove the exact Range<upos_type> and style.

pub fn styles_in( &self, range: Range<usize>, buf: &mut Vec<(Range<usize>, usize)>, )

Find all styles that touch the given range.

pub fn styles_at(&self, byte_pos: usize, buf: &mut Vec<(Range<usize>, usize)>)

All styles active at the given position.

pub fn style_match(&self, byte_pos: usize, style: usize) -> Option<Range<usize>>

Check if the given style applies at the position and return the complete range for the style.

pub fn styles(&self) -> Option<impl Iterator<Item = (Range<usize>, usize)> + '_>

List of all styles.

impl TextInputState

pub fn offset(&self) -> upos_type

Offset shown.

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

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

pub fn cursor(&self) -> upos_type

Cursor position.

pub fn anchor(&self) -> upos_type

Selection anchor.

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

Set the cursor position. Scrolls the cursor to a visible position.

pub fn has_selection(&self) -> bool

Selection.

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

Selection.

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

Selection. Scrolls the cursor to a visible position.

pub fn select_all(&mut self) -> bool

Selection. Scrolls the cursor to a visible position.

pub fn selected_text(&self) -> &str

Selection.

impl TextInputState

pub fn is_empty(&self) -> bool

Empty.

pub fn value<T: for<'a> From<&'a str>>(&self) -> T

Text value.

pub fn text(&self) -> &str

Text value.

pub fn str_slice_byte(&self, range: Range<usize>) -> Cow<'_, str>

Text slice as Cow<str>. Uses a byte range.

pub fn try_str_slice_byte( &self, range: Range<usize>, ) -> Result<Cow<'_, str>, TextError>

Text slice as Cow<str>. Uses a byte range.

pub fn str_slice(&self, range: Range<upos_type>) -> Cow<'_, str>

Text slice as Cow<str>

pub fn try_str_slice( &self, range: Range<upos_type>, ) -> Result<Cow<'_, str>, TextError>

Text slice as Cow<str>

pub fn len(&self) -> upos_type

Length as grapheme count.

pub fn line_width(&self) -> upos_type

Length as grapheme count.

pub fn glyphs( &self, screen_offset: u16, screen_width: u16, ) -> impl Iterator<Item = Glyph<'_>>

👎Deprecated since 1.1.0: discontinued api

Iterator for the glyphs of the lines in range. Glyphs here a grapheme + display length.

pub fn text_graphemes(&self, pos: upos_type) -> impl Cursor<Item = Grapheme<'_>>

Get a cursor over all the text with the current position set at pos.

pub fn try_text_graphemes( &self, pos: upos_type, ) -> Result<impl Cursor<Item = Grapheme<'_>>, TextError>

Get a cursor over all the text with the current position set at pos.

pub fn graphemes( &self, range: Range<upos_type>, pos: upos_type, ) -> impl Cursor<Item = Grapheme<'_>>

Get a cursor over the text-range the current position set at pos.

pub fn try_graphemes( &self, range: Range<upos_type>, pos: upos_type, ) -> Result<impl Cursor<Item = Grapheme<'_>>, TextError>

Get a cursor over the text-range the current position set at pos.

pub fn byte_at(&self, pos: upos_type) -> Range<usize>

Grapheme position to byte position. This is the (start,end) position of the single grapheme after pos.

pub fn try_byte_at(&self, pos: upos_type) -> Result<Range<usize>, TextError>

Grapheme position to byte position. This is the (start,end) position of the single grapheme after pos.

pub fn bytes_at_range(&self, range: Range<upos_type>) -> Range<usize>

Grapheme range to byte range.

pub fn try_bytes_at_range( &self, range: Range<upos_type>, ) -> Result<Range<usize>, TextError>

Grapheme range to byte range.

pub fn byte_pos(&self, byte: usize) -> upos_type

Byte position to grapheme position. Returns the position that contains the given byte index.

pub fn try_byte_pos(&self, byte: usize) -> Result<upos_type, TextError>

Byte position to grapheme position. Returns the position that contains the given byte index.

pub fn byte_range(&self, bytes: Range<usize>) -> Range<upos_type>

Byte range to grapheme range.

pub fn try_byte_range( &self, bytes: Range<usize>, ) -> Result<Range<upos_type>, TextError>

Byte range to grapheme range.

impl TextInputState

pub fn clear(&mut self) -> bool

Reset to empty.

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

Set text.

Returns an error if the text contains line-breaks.

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

Set text.

Returns an error if the text contains line-breaks.

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

Insert a char at the current position.

pub fn insert_tab(&mut self) -> bool

Insert a tab character at the cursor position. Removes the selection and inserts the tab.

pub fn insert_str(&mut self, t: impl AsRef<str>) -> bool

Insert a str at the current position.

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

Deletes the given range.

pub fn try_delete_range( &mut self, range: Range<upos_type>, ) -> Result<bool, TextError>

Deletes the given range.

impl TextInputState

pub fn delete_next_char(&mut self) -> bool

Delete the char after the cursor.

pub fn delete_prev_char(&mut self) -> bool

Delete the char before the cursor.

pub fn next_word_start(&self, pos: upos_type) -> upos_type

Find the start of the next word. Word is everything that is not whitespace.

pub fn try_next_word_start( &self, pos: upos_type, ) -> Result<upos_type, TextError>

Find the start of the next word. Word is everything that is not whitespace.

pub fn next_word_end(&self, pos: upos_type) -> upos_type

Find the end of the next word. Skips whitespace first, then goes on until it finds the next whitespace.

pub fn try_next_word_end(&self, pos: upos_type) -> Result<upos_type, TextError>

Find the end of the next word. Skips whitespace first, then goes on until it finds the next whitespace.

pub fn prev_word_start(&self, pos: upos_type) -> upos_type

Find prev word. Skips whitespace first. Attention: start/end are mirrored here compared to next_word_start/next_word_end, both return start<=end!

pub fn try_prev_word_start( &self, pos: upos_type, ) -> Result<upos_type, TextError>

Find prev word. Skips whitespace first. Attention: start/end are mirrored here compared to next_word_start/next_word_end, both return start<=end!

pub fn prev_word_end(&self, pos: upos_type) -> upos_type

Find the end of the previous word. Word is everything that is not whitespace. Attention: start/end are mirrored here compared to next_word_start/next_word_end, both return start<=end!

pub fn try_prev_word_end(&self, pos: upos_type) -> Result<upos_type, TextError>

Find the end of the previous word. Word is everything that is not whitespace. Attention: start/end are mirrored here compared to next_word_start/next_word_end, both return start<=end!

pub fn is_word_boundary(&self, pos: upos_type) -> bool

Is the position at a word boundary?

pub fn try_is_word_boundary(&self, pos: upos_type) -> Result<bool, TextError>

Is the position at a word boundary?

pub fn word_start(&self, pos: upos_type) -> upos_type

Find the start of the word at pos.

pub fn try_word_start(&self, pos: upos_type) -> Result<upos_type, TextError>

Find the start of the word at pos.

pub fn word_end(&self, pos: upos_type) -> upos_type

Find the end of the word at pos.

pub fn try_word_end(&self, pos: upos_type) -> Result<upos_type, TextError>

Find the end of the word at pos.

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 move_right(&mut self, extend_selection: bool) -> bool

Move to the next char.

pub fn move_left(&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

End of line

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

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

impl TextInputState

pub fn screen_to_col(&self, scx: i16) -> upos_type

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

pub fn col_to_screen(&self, pos: upos_type) -> Option<u16>

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

pub fn set_screen_cursor(&mut self, cursor: i16, 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 set_screen_cursor_words( &mut self, screen_cursor: i16, extend_selection: bool, ) -> bool

Set the cursor position from screen coordinates, rounds the position to the next word start/end.

The cursor positions are relative to the inner rect. They may be negative too, this allows setting the cursor to a position that is currently scrolled away.

pub fn scroll_left(&mut self, delta: upos_type) -> bool

Scrolling

pub fn scroll_right(&mut self, delta: upos_type) -> bool

Scrolling

pub fn scroll_cursor_to_visible(&mut self)

Change the offset in a way that the cursor is visible.

Trait Implementations

impl Clone for TextInputState

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

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

Handle an event.

impl HasFocus for TextInputState

fn build(&self, builder: &mut FocusBuilder)

Build the focus-structure for the container.

fn focus(&self) -> FocusFlag

Access to the flag for the rest.

fn area(&self) -> Rect

Area for mouse focus.

fn id(&self) -> usize

Provide a unique id for the widget.

fn area_z(&self) -> u16

Z value for the area.

fn navigable(&self) -> Navigation

Declares how the widget interacts with focus.

fn is_focused(&self) -> bool

Focused?

fn lost_focus(&self) -> bool

Just lost focus.

fn gained_focus(&self) -> bool

Just gained focus.

impl HasScreenCursor for TextInputState

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

The current text cursor as an absolute screen position.

impl RelocatableState for TextInputState

fn relocate(&mut self, shift: (i16, i16), clip: Rect)

Relocate the areas in this widgets state.