Skip to main content

TextInput

Struct TextInput 

Source
pub struct TextInput { /* private fields */ }
Expand description

A multi-line text input with its own wrapping, cursor tracking, and rendering.

Implementations§

Source§

impl TextInput

Source

pub fn new() -> Self

Source

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

Source

pub fn insert_str(&mut self, s: &str)

Insert an arbitrary string at the cursor (e.g. from a bracketed paste). The cursor advances to the end of the inserted text.

Line breaks are normalized to \n (see [normalize_line_breaks]).

Source

pub fn backspace(&mut self)

Source

pub fn delete(&mut self)

Source

pub fn move_left(&mut self)

Source

pub fn move_right(&mut self)

Source

pub fn move_home(&mut self)

Source

pub fn move_end(&mut self)

Source

pub fn move_up(&mut self)

Move the cursor up one visual (wrapped) line. If the cursor is already on the first line, it moves to the beginning.

Source

pub fn move_down(&mut self)

Move the cursor down one visual (wrapped) line. If the cursor is already on the last line, it moves to the end.

Source

pub fn move_word_left(&mut self)

Move cursor one word to the left (Option+Left / Ctrl+Left).

Source

pub fn move_word_right(&mut self)

Move cursor one word to the right (Option+Right / Ctrl+Right).

Source

pub fn delete_word_left(&mut self)

Delete the word to the left of the cursor (Option+Backspace).

Source

pub fn insert_newline(&mut self)

Insert a newline at the cursor (Shift+Enter).

Source

pub fn handle_keystroke(&mut self, key: KeyEvent) -> KeyResult

Handle a key event. Returns KeyResult::Captured if the event was consumed by the input area, KeyResult::NotCaptured if it should fall through to other handlers.

Source

pub fn take_text(&mut self) -> String

Take the current text, clear the buffer, and reset the cursor.

Source

pub fn text(&self) -> &str

Source

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

Source

pub fn is_empty(&self) -> bool

Source

pub fn preferred_height(&self, outer_width: u16) -> u16

The total height this widget wants given a particular outer width. Includes top/bottom padding rows.

Source

pub fn render(&self, area: Rect, buf: &mut Buffer) -> RenderResult

Render into the given area and return the cursor screen position.

Trait Implementations§

Source§

impl Component for TextInput

Source§

impl Default for TextInput

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more