Struct tty_form::control::SelectInput

pub struct SelectInput { /* private fields */ }

An option selection field.

Examples

use tty_interface::Style;

use tty_form::{
    step::CompoundStep,
    control::{Control, SelectInput},
};

let mut step = CompoundStep::new();
SelectInput::new("Select favorite food:", vec![
    ("Pizza", "A supreme pizza."),
    ("Burgers", "A hamburger with cheese."),
    ("Fries", "Simple potato french-fries."),
]).add_to(&mut step);

Implementations

impl SelectInput

pub fn new(prompt: &str, options: Vec<(&str, &str)>) -> Self

Create a new option-selection input with the specified prompt and options.

pub fn set_prompt(&mut self, prompt: &str)

Update this input’s prompt text.

pub fn add_option(&mut self, option: SelectInputOption)

Add an option to this input’s list.

pub fn set_options(&mut self, options: Vec<SelectInputOption>)

Set this input’s options.

Trait Implementations

impl Control for SelectInput

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.