Struct cursive::views::TextArea

pub struct TextArea { /* fields omitted */ }

Multi-lines text editor.

A TextArea will attempt to grow vertically and horizontally dependent on the content. Wrap it in a BoxView to constrain its size.

Methods

impl TextArea

pub fn new() -> Self

Creates a new, empty TextArea.

pub fn get_content(&self) -> &str

Retrieves the content of the view.

pub fn cursor(&self) -> usize

Returns the position of the cursor in the content string.

pub fn set_cursor(&mut self, cursor: usize)

Moves the cursor to the given position.

Panics

This method panics if cursor is not the beginning of a character in the content string.

pub fn set_content<S: Into<String>>(&mut self, content: S)

Sets the content of the view.

pub fn content<S: Into<String>>(self, content: S) -> Self

Sets the content of the view.

Chainable variant.

pub fn disable(&mut self)

Disables this view.

A disabled view cannot be selected.

pub fn disabled(self) -> Self

Disables this view.

Chainable variant.

pub fn enable(&mut self)

Re-enables this view.

pub fn enabled(self) -> Self

Re-enables this view.

Chainable variant.

pub fn is_enabled(&self) -> bool

Returns true if this view is enabled.

Trait Implementations

impl Default for TextArea

fn default() -> Self

Returns the "default value" for a type.

impl View for TextArea

fn required_size(&mut self, constraint: Vec2) -> Vec2

Returns the minimum size the view requires with the given restrictions.

fn draw(&self, printer: &Printer)

Draws the view with the given printer (includes bounds) and focus.

fn on_event(&mut self, event: Event) -> EventResult

Called when an event is received (key press, mouse event, ...).

fn take_focus(&mut self, _: Direction) -> bool

This view is offered focus. Will it take it?

fn layout(&mut self, size: Vec2)

Called once the size for this view has been decided.

fn important_area(&self, _: Vec2) -> Rect

What part of the view is important and should be visible?

fn needs_relayout(&self) -> bool

Returns true if the view content changed since last layout phase.

fn call_on_any<'a>(&mut self, _: &Selector, _: AnyCb<'a>)

Runs a closure on the view identified by the given selector.

fn focus_view(&mut self, &Selector) -> Result<(), ()>

Moves the focus to the view identified by the given selector.