Struct rat_widget::textarea::TextAreaState

pub struct TextAreaState {
    pub focus: FocusFlag,
    pub area: Rect,
    pub inner: Rect,
    pub value: InputCore,
    pub hscroll: ScrollState,
    pub vscroll: ScrollState,
    pub mouse: MouseFlags,
    pub non_exhaustive: NonExhaustive,
}

State for the text-area.

Fields

focus: FocusFlag

Current focus state.

area: Rect

Complete area.

inner: Rect

Area inside the borders.

value: InputCore

Text edit core

hscroll: ScrollState

Horizontal scroll

vscroll: ScrollState

mouse: MouseFlags

Helper for mouse.

non_exhaustive: NonExhaustive

Implementations

impl TextAreaState

pub fn new() -> Self

New State.

pub fn clear(&mut self) -> bool

Clear everything.

pub fn offset(&self) -> (usize, usize)

Current offset for scrolling.

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

Set the offset for scrolling.

pub fn cursor(&self) -> (usize, usize)

Cursor position.

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

Set the cursor position. This doesn’t scroll the cursor to a visible position. Use TextAreaState::scroll_cursor_to_visible() for that.

pub fn anchor(&self) -> (usize, usize)

Selection anchor.

pub fn value(&self) -> String

Text value

pub fn value_range(&self, range: TextRange) -> Option<RopeSlice<'_>>

Text value

pub fn value_as_bytes(&self) -> Bytes<'_>

Text as Bytes iterator.

pub fn value_as_chars(&self) -> Chars<'_>

Text as Bytes iterator.

pub fn set_value<S: AsRef<str>>(&mut self, s: S)

Set the text value. Resets all internal state.

pub fn set_value_rope(&mut self, s: Rope)

Set the text value as a Rope. Resets all internal state.

pub fn is_empty(&self) -> bool

Empty.

pub fn line_len(&self) -> usize

Line count.

pub fn line_width(&self, n: usize) -> Option<usize>

Line width as grapheme count.

pub fn line(&self, n: usize) -> Option<RopeGraphemes<'_>>

Grapheme iterator for a given line. This contains the \n at the end.

pub fn has_selection(&self) -> bool

Has a selection?

pub fn selection(&self) -> TextRange

Current selection.

pub fn set_selection(&mut self, range: TextRange) -> bool

Set the selection.

pub fn select_all(&mut self) -> bool

Select all.

pub fn selected_value(&self) -> Option<RopeSlice<'_>>

Selection.

pub fn clear_styles(&mut self)

Clear all set styles.

pub fn add_style(&mut self, range: TextRange, style: usize)

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

pub fn styles_at(&self, pos: (usize, usize), result: &mut Vec<usize>)

All styles active at the given position.

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

Convert a byte position to a text area position. Uses grapheme based column indexes.

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

Convert a text area position to a byte range. Uses grapheme based column indexes. Returns (byte-start, byte-end) of the grapheme at the given position.

pub fn char_pos(&self, byte: usize) -> Option<(usize, usize)>

Convert a char position to a text area position. Uses grapheme based column indexes.

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

Convert a text area position to a char position. Uses grapheme based column indexes.

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

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

pub fn insert_newline(&mut self) -> bool

Insert a line break at the cursor position.

pub fn delete_range(&mut self, range: TextRange) -> bool

Deletes the given range.

pub fn delete_next_char(&mut self) -> bool

Deletes the next char or the current selection. Returns true if there was any real change.

pub fn delete_prev_char(&mut self) -> bool

Deletes the previous char or the selection. Returns true if there was any real change.

pub fn delete_next_word(&mut self) -> bool

pub fn delete_prev_word(&mut self) -> bool

pub fn move_left(&mut self, n: usize, extend_selection: bool) -> bool

Move the cursor left. Scrolls the cursor to visible. Returns true if there was any real change.

pub fn move_right(&mut self, n: usize, extend_selection: bool) -> bool

Move the cursor right. Scrolls the cursor to visible. Returns true if there was any real change.

pub fn move_up(&mut self, n: usize, extend_selection: bool) -> bool

Move the cursor up. Scrolls the cursor to visible. Returns true if there was any real change.

pub fn move_down(&mut self, n: usize, extend_selection: bool) -> bool

Move the cursor down. Scrolls the cursor to visible. Returns true if there was any real change.

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

Move the cursor to the start of the line. Scrolls the cursor to visible. Returns true if there was any real change.

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

Move the cursor to the end of the line. Scrolls to visible, if necessary. Returns true if there was any real change.

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

Move the cursor to the document start.

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

Move the cursor to the document end.

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

Move the cursor to the start of the visible area.

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

Move the cursor to the end of the visible area.

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 from_screen_col(&self, row: usize, x: usize) -> Option<usize>

Converts from a widget relative screen coordinate to a grapheme index. Row is a row-index into the value, not a screen-row. x is the relative screen position.

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

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

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

Cursor position on the screen.

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

Set the cursor position from screen coordinates.

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.

impl TextAreaState

pub fn vertical_max_offset(&self) -> usize

Maximum offset that is accessible with scrolling.

This is shorter than the length of the content by whatever fills the last page. This is the base for the scrollbar content_length.

pub fn vertical_offset(&self) -> usize

Current vertical offset.

pub fn vertical_page(&self) -> usize

Vertical page-size at the current offset.

pub fn vertical_scroll(&self) -> usize

Suggested scroll per scroll-event.

pub fn horizontal_max_offset(&self) -> usize

Maximum offset that is accessible with scrolling.

This is currently set to usize::MAX.

pub fn horizontal_offset(&self) -> usize

Current horizontal offset.

pub fn horizontal_page(&self) -> usize

Horizontal page-size at the current offset.

pub fn horizontal_scroll(&self) -> usize

Suggested scroll per scroll-event.

pub fn set_vertical_offset(&mut self, row_offset: usize) -> bool

Change the vertical offset.

Due to overscroll it’s possible that this is an invalid offset for the widget. The widget must deal with this situation.

The widget returns true if the offset changed at all.

pub fn set_horizontal_offset(&mut self, col_offset: usize) -> bool

Change the horizontal offset.

Due to overscroll it’s possible that this is an invalid offset for the widget. The widget must deal with this situation.

The widget returns true if the offset changed at all.

pub fn scroll_to_row(&mut self, pos: usize) -> bool

Scroll to position.

pub fn scroll_to_col(&mut self, pos: usize) -> bool

Scroll to position.

pub fn scroll_up(&mut self, delta: usize) -> bool

Scrolling

pub fn scroll_down(&mut self, delta: usize) -> bool

Scrolling

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

Scrolling

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

Scrolling

Trait Implementations

impl Clone for TextAreaState

fn clone(&self) -> TextAreaState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextAreaState

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

Formats the value using the given formatter.

impl Default for TextAreaState

fn default() -> Self

Returns the “default value” for a type.

impl HandleEvent<Event, FocusKeys, TextOutcome> for TextAreaState

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

Handle an event.

impl HandleEvent<Event, MouseOnly, TextOutcome> for TextAreaState

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

Handle an event.

impl HandleEvent<Event, ReadOnly, TextOutcome> for TextAreaState

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

Handle an event.

impl HasFocusFlag for TextAreaState

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.