Struct TimePicker 

pub struct TimePicker(/* private fields */);

Pick a time of day, field by field. Returns the Time.

use rich_interact::datetime::Time;
use rich_interact::headless::{self, Script};
use rich_interact::{Outcome, TimePicker};

let picker = TimePicker::new("Start").value(Time::new(9, 0, 0));
let script = Script::new().text("1415").keys("enter");
let (outcome, _) = headless::run(picker, script, 40, 6);
assert_eq!(outcome.unwrap(), Outcome::Done(Time::new(14, 15, 0)));

Implementations

impl TimePicker

pub fn new(prompt: impl Into<String>) -> TimePicker

pub fn theme(self, theme: Theme) -> Self

pub fn with_mouse(self, on: bool) -> Self

Report the mouse (#476): a click selects a day (a second click on it picks it) or focuses a time field, and the wheel turns the month or the focused field.

pub fn rebind(self, action: &str, keys: impl IntoIterator<Item = Key>) -> Self

Make keys do action (see date_keymap) on this picker only; no keys unbinds it.

pub fn seconds(self, on: bool) -> Self

Pick the seconds too. Without them (the default) the picker works to the minute, whatever order the builders come in: the start, the default and a typed answer drop their seconds, the earliest rounds up to a minute and the latest down.

pub fn twelve_hour(self, on: bool) -> Self

Show a 12-hour clock with AM and PM (a and p set them).

pub fn value(self, time: Time) -> Self

Start at this time.

pub fn default(self, time: Time) -> Self

Answer this time without a terminal and to an empty line, and start at it unless value says where to start.

pub fn min(self, time: Time) -> Self

The earliest time that can be picked.

pub fn max(self, time: Time) -> Self

The latest time that can be picked.

pub fn validate( self, check: impl Fn(Time) -> Result<(), String> + Send + Sync + 'static, ) -> Self

Refuse a time check returns an error for: Enter shows the error and waits.

pub fn selected(&self) -> Time

The time selected so far.

Trait Implementations

impl Component for TimePicker

fn focus_step(&mut self, forward: bool) -> bool

Tab inside: the next part, if there is one.

fn focus_enter(&mut self, forward: bool) -> bool

Tab from outside: the first part, or the last going back.

fn default_value(&self) -> Option<Time>

The default, unless the picker would refuse it: outside the range, or refused by the validator.

type Output = Time

fn start(&mut self, _context: &Context<'_>) -> Flow<Time>

Called once, before the component is first painted, with the terminal’s size: for work that needs it, such as rendering content at the width. Returning Done or Cancel finishes the component without waiting for an event. The default does nothing.

fn handle(&mut self, event: &Event, _context: &Context<'_>) -> Flow<Time>

Handle one event. Ctrl+C never arrives here: the event loop ends the component with Outcome::Interrupted.

fn render(&self, context: &Context<'_>) -> View

Render the current state.

fn mouse(&self) -> bool

Whether the component wants mouse events (#476): clicks, drags and the wheel. Off by default, since reporting the mouse takes text selection away from the terminal; a component turns it on when its caller opts in, and run then enables mouse reporting for the session.

fn keymap(&self) -> Keymap

The bindings this component has right now, for a help overlay, a shortcut list or status-bar hints to read (see keymap). A container’s include its focused child’s, before its own. The default declares none.

fn prompt( &mut self, io: &mut dyn LineIo, ) -> Result<Option<Time>, NotInteractive>

Ask for the value line by line, for when the terminal is not interactive and the policy asks for a prompt. The default says the component has no line-based form.

fn tick(&self) -> Option<Duration>

How often the component wants Event::Tick, for a spinner or a countdown. None (the default): never.

fn focusable(&self) -> bool

Whether the component takes focus in a container: Tab stops on it and keys go to it. The default: yes. A label, or a component that has finished, says no.