Struct tty_form::TextBlockStep

pub struct TextBlockStep { /* private fields */ }

A multi-line text input step.

Examples

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

let mut form = Form::new();

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

Implementations

impl TextBlockStep

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

Create a new, default text block step.

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

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

Trait Implementations

impl Step for TextBlockStep

fn initialize(&mut self)

Perform any post-configuration initialization actions for this step.

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

Render this step at the specified position.

fn handle_input(&mut self, event: KeyEvent) -> Option<InputResult>

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

fn add_to_form(self, form: &mut Form)

Complete configuration and add this step to the form.

fn get_result(&self) -> String

Retrieves this step’s final WYSIWYG result.