Struct tty_form::SelectInput

pub struct SelectInput { /* private fields */ }

An option selection field.

Examples

use tty_form::{CompoundStep, Control, SelectInput};
use tty_interface::Style;

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_step(&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 is_focusable(&self) -> bool

Whether this control is a focusable input.

fn handle_input(&mut self, key_event: KeyEvent)

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

fn get_help(&self) -> Option<String>

Get this control’s descriptive help text, if available.

fn get_text(&self) -> (String, Option<u16>)

Get this control’s rendered result contents.

fn get_drawer(&self) -> Option<Vec<String>>

Get this control’s drawer contents, if available.

fn add_to_step(self, step: &mut CompoundStep)

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

impl Default for SelectInput

fn default() -> Self

Create a new option-selection input with no options.