Struct tty_form::control::TextInput

pub struct TextInput { /* private fields */ }

A single-line text field input. May be used as an evaluation for dependent form elements.

Examples

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

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

Implementations

impl TextInput

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

Create a new text input control with the specified prompt and casing-rules.

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

Update this input’s prompt text.

pub fn set_force_lowercase(&mut self, force: bool)

Specify whether this input should force its value to be lowercase.

pub fn set_evaluation(&mut self, evaluation: Evaluation) -> DependencyId

Sets the dependency evaluation which other form elements can react to.

Trait Implementations

impl Control for TextInput

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.