Struct TextBox 

pub struct TextBox<'a, I: ApplicationInfo = EmptyInfo> { /* private fields */ }

Widget for rendering a multi-line text box.

Implementations

impl<'a, I> TextBox<'a, I>

where I: ApplicationInfo,

pub fn new() -> Self

Create a new widget.

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

Set the style to use for rendering text within the TextBoxState.

pub fn block(self, block: Block<'a>) -> Self

Wrap this text box in a Block.

pub fn oneline(self) -> Self

Force the text to render on a single line. LF and CR will be rendered as ^J and ^M respectively.

Any gutters will not be shown.

pub fn prompt(self, prompt: impl Into<Span<'a>>) -> Self

Display a prompt in the top left of the text box when focused.

pub fn left_gutter(self, lw: u16) -> Self

Set the width of the left gutter.

pub fn right_gutter(self, rw: u16) -> Self

Set the width of the right gutter.

Trait Implementations

impl<I> Default for TextBox<'_, I>

where I: ApplicationInfo,

fn default() -> Self

Returns the “default value” for a type.

impl<I> StatefulWidget for TextBox<'_, I>

where I: ApplicationInfo,

type State = TextBoxState<I>

State associated with the stateful widget.

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.