Struct TextArea 

pub struct TextArea { /* private fields */ }

A multi-line text editor.

Implementations

impl TextArea

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

Insert one character, replacing the selection if there is one.

pub fn insert_str(&mut self, text: &str) -> bool

Insert a string, replacing the selection if there is one. Newlines in text split lines.

pub fn replace_before_cursor(&mut self, count: usize, text: &str) -> bool

Replace the count characters before the cursor, on its line, with text: a completion taking over the word typed so far.

pub fn insert_newline(&mut self) -> bool

Split the current line at the cursor.

pub fn insert_tab(&mut self) -> bool

Insert spaces up to the next tab stop.

pub fn delete_prev_char(&mut self) -> bool

Delete the selection, or the character before the cursor.

pub fn delete_next_char(&mut self) -> bool

Delete the selection, or the character after the cursor.

pub fn delete_prev_word(&mut self) -> bool

Delete backwards to the start of the previous word, yanking it.

pub fn delete_next_word(&mut self) -> bool

Delete forwards to the start of the next word, yanking it.

pub fn delete_line_by_end(&mut self) -> bool

Delete from the cursor to the end of the line, yanking it. At the end of a line this joins the line below, matching readline’s kill-line. A selection is killed instead, as the word kills do.

pub fn delete_line_by_head(&mut self) -> bool

Delete from the start of the line to the cursor, yanking it. At the start of a line this joins onto the line above. A selection is killed instead.

pub fn copy(&mut self) -> bool

Copy the selection into the yank buffer.

pub fn cut(&mut self) -> bool

Move the selection into the yank buffer.

pub fn paste(&mut self) -> bool

Insert the yank buffer at the cursor.

pub fn undo(&mut self) -> bool

Undo the most recent edit.

pub fn redo(&mut self) -> bool

Redo the most recently undone edit.

pub fn move_cursor(&mut self, movement: CursorMove) -> bool

Move the cursor, dropping any selection.

pub fn move_cursor_selecting(&mut self, movement: CursorMove) -> bool

Move the cursor, extending the selection from where it was.

impl TextArea

pub fn input(&mut self, input: impl Into<Input>) -> bool

Apply one key press, returning whether it changed the buffer or the cursor.

impl TextArea

pub fn display_col(&self, row: usize, col: usize) -> usize

Display column of a character position, with tabs expanded.

impl TextArea

pub fn set_wrap(&mut self, wrap: bool)

Break long lines onto the rows below rather than scrolling sideways.

pub fn visual_rows(&self, width: u16) -> usize

Rows the buffer takes at width columns: one per line without wrapping.

impl TextArea

pub fn new() -> Self

An empty editor holding a single empty line.

pub fn set_text(&mut self, text: &str)

Replace the whole buffer, moving the cursor to the end and discarding undo history, selection and scroll position.

pub fn clear(&mut self)

Empty the buffer.

pub fn lines(&self) -> &[String]

The buffer, one entry per line. Always holds at least one line.

pub fn text(&self) -> String

The buffer as a single newline-joined string.

pub fn line_count(&self) -> usize

Number of lines in the buffer.

pub fn line(&self, row: usize) -> Option<&str>

The line at row, if it exists.

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

Cursor position as (row, character column).

pub fn selection(&self) -> Option<((usize, usize), (usize, usize))>

Selected range as (start, end) with start <= end, if a selection is active and non-empty.

pub fn cancel_selection(&mut self)

Drop any selection, leaving the cursor where it is.

pub fn select_all(&mut self)

Select the entire buffer.

pub fn set_style(&mut self, style: Style)

pub fn set_cursor_style(&mut self, style: Style)

pub fn set_selection_style(&mut self, style: Style)

pub fn set_cursor_visible(&mut self, visible: bool)

Whether the cursor cell is highlighted. Unfocused inputs hide it.

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

Scroll position as (first visible row, first visible terminal column) from the last render.

Trait Implementations

impl Clone for TextArea

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 TextArea

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

Formats the value using the given formatter.

impl Default for TextArea

fn default() -> Self

Returns the “default value” for a type.

impl StatefulWidget for &TextArea

type State = (usize, usize)

Receives the scroll position settled on by this frame, as (first visible row, first visible column).

fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.

impl Widget for &TextArea

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.