Struct TextArea 

pub struct TextArea { /* private fields */ }

Multi-line text editor widget.

Implementations

impl TextArea

pub fn new() -> Self

Create a new empty text area.

pub fn handle_event(&mut self, event: &Event) -> bool

Handle a terminal event.

Returns true if the state changed.

pub fn with_text(self, text: &str) -> Self

Set initial text content (builder).

pub fn with_placeholder(self, text: impl Into<String>) -> Self

Set placeholder text (builder).

pub fn with_focus(self, focused: bool) -> Self

Set focused state (builder).

pub fn with_line_numbers(self, show: bool) -> Self

Enable line numbers (builder).

pub fn with_style(self, style: Style) -> Self

Set base style (builder).

pub fn with_cursor_line_style(self, style: Style) -> Self

Set cursor line highlight style (builder).

pub fn with_selection_style(self, style: Style) -> Self

Set selection style (builder).

pub fn with_soft_wrap(self, wrap: bool) -> Self

Enable soft wrapping (builder).

pub fn with_max_height(self, max: usize) -> Self

Set maximum height in lines (builder). 0 = fill available area.

pub fn text(&self) -> String

Get the full text content.

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

Set the full text content (resets cursor and undo history).

pub fn line_count(&self) -> usize

Number of lines.

pub fn cursor(&self) -> CursorPosition

Current cursor position.

pub fn set_cursor_position(&mut self, pos: CursorPosition)

Set cursor position (clamped to bounds). Clears selection.

pub fn is_empty(&self) -> bool

Whether the textarea is empty.

pub fn selection(&self) -> Option<Selection>

Current selection, if any.

pub fn selected_text(&self) -> Option<String>

Get selected text.

pub fn is_focused(&self) -> bool

Whether the widget has focus.

pub fn set_focused(&mut self, focused: bool)

Set focus state.

pub fn editor(&self) -> &Editor

Access the underlying editor.

pub fn editor_mut(&mut self) -> &mut Editor

Mutable access to the underlying editor.

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

Insert text at cursor.

pub fn insert_char(&mut self, ch: char)

Insert a single character.

pub fn insert_newline(&mut self)

Insert a newline.

pub fn delete_backward(&mut self)

Delete backward (backspace).

pub fn delete_forward(&mut self)

Delete forward (delete key).

pub fn delete_word_backward(&mut self)

Delete word backward (Ctrl+Backspace).

pub fn delete_to_end_of_line(&mut self)

Delete to end of line (Ctrl+K).

pub fn undo(&mut self)

Undo last edit.

pub fn redo(&mut self)

Redo last undo.

pub fn move_left(&mut self)

Move cursor left.

pub fn move_right(&mut self)

Move cursor right.

pub fn move_up(&mut self)

Move cursor up.

pub fn move_down(&mut self)

Move cursor down.

pub fn move_word_left(&mut self)

Move cursor left by word.

pub fn move_word_right(&mut self)

Move cursor right by word.

pub fn move_to_line_start(&mut self)

Move to start of line.

pub fn move_to_line_end(&mut self)

Move to end of line.

pub fn move_to_document_start(&mut self)

Move to start of document.

pub fn move_to_document_end(&mut self)

Move to end of document.

pub fn select_left(&mut self)

Extend selection left.

pub fn select_right(&mut self)

Extend selection right.

pub fn select_up(&mut self)

Extend selection up.

pub fn select_down(&mut self)

Extend selection down.

pub fn select_all(&mut self)

Select all.

pub fn clear_selection(&mut self)

Clear selection.

pub fn page_up(&mut self, state: &TextAreaState)

Page up (move viewport and cursor up by viewport height).

pub fn page_down(&mut self, state: &TextAreaState)

Page down (move viewport and cursor down by viewport height).

Trait Implementations

impl Clone for TextArea

fn clone(&self) -> TextArea

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 = TextAreaState

The state type associated with this widget.

fn render(&self, area: Rect, frame: &mut Frame<'_>, state: &mut Self::State)

Render the widget into the frame, potentially modifying state.

impl Widget for TextArea

fn render(&self, area: Rect, frame: &mut Frame<'_>)

Render the widget into the frame at the given area.

fn is_essential(&self) -> bool

Whether this widget is essential and should always render.