Struct tty_form::step::CompoundStep

pub struct CompoundStep { /* private fields */ }

A single-line step which controls multple controls including static and input elements.

Examples

use tty_form::{
    Form,
    step::{Step, CompoundStep},
    control::{Control, StaticText, TextInput},
};

let mut form = Form::new();

let mut step = CompoundStep::new();
StaticText::new("Welcome, ").add_to(&mut step);
TextInput::new("Enter your name:", false).add_to(&mut step);
step.add_to(&mut form);

Implementations

impl CompoundStep

pub fn new() -> Self

Create a new compound step with no controls.

pub fn add_control(&mut self, control: Box<dyn Control>)

Append the specified control to this step.

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

Set this step’s maximum total line length.

Trait Implementations

impl Step for CompoundStep

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.