Struct CommandLine 

pub struct CommandLine { /* private fields */ }

A command line’s state: open it in a Mode, ask a question, show an error. Made by CommandLine::new while the app is built and given to command_line; Copy, so key bindings take it.

Implementations

impl CommandLine

pub fn new() -> CommandLine

A closed command line.

pub fn open(&self, cx: &mut Ctx, mode: Mode)

Open the line in mode, taking the focus (given back when it closes).

pub fn confirm( &self, cx: &mut Ctx, question: impl Into<String>, on_yes: impl FnOnce(&mut Ctx) + 'static, )

Ask question (markup) in the bar: y runs on_yes, n or Esc does not, and either closes it; other keys are ignored.

pub fn confirm_keys( &self, cx: &mut Ctx, question: impl Into<String>, keys: &str, on_yes: impl FnOnce(&mut Ctx) + 'static, )

confirm answered yes by keys ("x": press x again to confirm a delete, as taskwarrior-tui asks); n, q and Esc answer no.

pub fn error(&self, message: impl Into<String>)

Show message (plain text) in red until the next open or message; while typing, over the line’s title, the line kept open.

pub fn message(&self, markup: impl Into<String>)

Show markup in the closed bar (a hint, a count).

pub fn close(&self, cx: &mut Ctx)

Close it (an error or message goes too), giving the focus back.

pub fn is_open(&self) -> bool

Whether it is open (typing or asking), subscribing.

pub fn text(&self) -> String

The line as typed, subscribing.

Trait Implementations

impl Clone for CommandLine

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for CommandLine

impl Default for CommandLine

fn default() -> CommandLine

Returns the “default value” for a type.