Trait tty_form::control::Control

pub trait Control {
    fn focusable(&self) -> bool;
    fn update(&mut self, input: KeyEvent);
    fn help(&self) -> Option<Segment>;
    fn text(&self) -> (Segment, Option<u16>);
    fn drawer(&self) -> Option<DrawerContents>;
    fn evaluation(&self) -> Option<(DependencyId, Evaluation)>;
    fn dependency(&self) -> Option<(DependencyId, Action)>;
    fn evaluate(&self, evaluation: &Evaluation) -> bool;
    fn add_to(self, step: &mut CompoundStep);
}

An element of a CompoundStep which may be a focusable input.

Required Methods

fn focusable(&self) -> bool

Whether this control is a focusable input.

fn update(&mut self, input: KeyEvent)

Updates the control’s state from the given input event.

fn help(&self) -> Option<Segment>

This control’s descriptive help text, if available.

fn text(&self) -> (Segment, Option<u16>)

This control’s rendered contents and an optional offset for the cursor.

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

This control’s drawer contents, if available.

fn evaluation(&self) -> Option<(DependencyId, Evaluation)>

This control’s dependency evaluation which other controls may react to.

fn dependency(&self) -> Option<(DependencyId, Action)>

This control’s dependency which it may react to.

fn evaluate(&self, evaluation: &Evaluation) -> bool

Perform an evaluation against this control’s current state.

fn add_to(self, step: &mut CompoundStep)

Finish configuration and add this control to the specified form step.

Implementors

impl Control for SelectInput

impl Control for StaticText

impl Control for TextInput