Struct tty_form::step::TextBlockStep

pub struct TextBlockStep { /* private fields */ }

A multi-line text input step.

Examples

use tty_form::{
    Form,
    step::{Step, TextBlockStep},
};

let mut form = Form::new();

let mut step = TextBlockStep::new("Enter your story:");
step.set_max_line_length(100);
step.add_to(&mut form);

Implementations

impl TextBlockStep

pub fn new(prompt: &str) -> Self

Create a new, default text block step.

pub fn set_margins(&mut self, top_margin: Option<u16>, bottom_margin: Option<u16>)

Set this text block’s top and bottom margins.

pub fn set_max_line_length(&mut self, max_length: u16)

Set this text block step’s optional maximum line grapheme length.

pub fn set_trim_trailing_whitespace(&mut self, trim: bool)

Set whether this text block should trim trailing whitespace.

Trait Implementations

impl Step for TextBlockStep

fn initialize(&mut self, _dependency_state: &mut DependencyState, _index: usize)

Perform any post-configuration initialization actions for this step.

fn render(
    &self,
    interface: &mut Interface<'_>,
    _dependency_state: &DependencyState,
    position: Position,
    is_focused: bool
) -> u16

Render this step at the specified position and return the height of the rendered content.

fn update(
    &mut self,
    _dependency_state: &mut DependencyState,
    input: KeyEvent
) -> Option<InputResult>

Handle the specified input event, optionally returning an instruction for the form.

fn help(&self) -> Segment

Retrieve this step’s current help text.

fn drawer(&self) -> Option<DrawerContents>

Retrieve this step’s current drawer contents, if applicable.

fn result(&self, _dependency_state: &DependencyState) -> String

Retrieves this step’s final WYSIWYG result.

fn add_to(self, form: &mut Form)

Complete configuration and add this step to the form.