Struct rat_widget::textarea::RTextAreaState

pub struct RTextAreaState {
    pub widget: TextAreaState,
    pub non_exhaustive: NonExhaustive,
}

Fields

widget: TextAreaState

non_exhaustive: NonExhaustive

Implementations

impl RTextAreaState

pub fn new() -> Self

pub fn clear(&mut self) -> bool

Reset to empty.

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

Offset shown.

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

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

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, reset selection.

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

Selection anchor.

pub fn value(&self) -> String

Text.

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 Btes iterator.

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

Set text.

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

Text length as grapheme 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

Selection.

pub fn selection(&self) -> TextRange

Selection.

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

Selection.

pub fn select_all(&mut self) -> bool

Selection.

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 char at the current position.

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

Delete the char after the cursor.

pub fn delete_prev_char(&mut self) -> bool

Delete the char before the cursor.

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_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)>

The current text cursor as an absolute screen position.

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

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

Trait Implementations

impl Clone for RTextAreaState

fn clone(&self) -> RTextAreaState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RTextAreaState

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

Formats the value using the given formatter.

impl Default for RTextAreaState

fn default() -> Self

Returns the “default value” for a type.

impl HandleEvent<Event, FocusKeys, TextOutcome> for RTextAreaState

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

Handle an event.

impl HandleEvent<Event, MouseOnly, TextOutcome> for RTextAreaState

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

Handle an event.

impl HandleEvent<Event, ReadOnly, TextOutcome> for RTextAreaState

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

Handle an event.

impl HasFocusFlag for RTextAreaState

fn focus(&self) -> &FocusFlag

Access to the flag for the rest.

fn area(&self) -> Rect

Access the area for mouse focus.

fn is_focused(&self) -> bool

Focused?

fn lost_focus(&self) -> bool

Just lost focus.

fn gained_focus(&self) -> bool

Just gained focus.

impl ScrollingState for RTextAreaState

fn vertical_max_offset(&self) -> usize

Maximum offset that is accessible with scrolling.

fn vertical_offset(&self) -> usize

Current vertical offset.

fn vertical_page(&self) -> usize

Vertical page-size at the current offset.

fn horizontal_max_offset(&self) -> usize

Maximum offset that is accessible with scrolling.

fn horizontal_offset(&self) -> usize

Current horizontal offset.

fn horizontal_page(&self) -> usize

Horizontal page-size at the current offset.

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

Change the vertical offset.

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

Change the horizontal offset.

fn vertical_scroll(&self) -> usize

Suggested scroll per scroll-event.

fn horizontal_scroll(&self) -> usize

Suggested scroll per scroll-event.

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

Scroll up by n items. The widget returns true if the offset changed at all.

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

Scroll down by n items. The widget returns true if the offset changed at all.

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

Scroll up by n items. The widget returns true if the offset changed at all.

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

Scroll down by n items. The widget returns true if the offset changed at all.

impl<'a> ScrollingWidget<RTextAreaState> for RTextArea<'a>

fn need_scroll(&self, area: Rect, state: &mut RTextAreaState) -> (bool, bool)

Widget wants a (horizontal, vertical) scrollbar. This gets combined with the ScrollbarPolicy.