Struct CmdLine

pub struct CmdLine<U: Ui> { /* private fields */ }

A multi purpose text widget

This widget, as the name implies, is most associated with running commands. However, it can have a variety of modes, granting it differing functionality. In Duat, there are 3 predefined modes:

• RunCommands, which runs commands (duh);
• ShowNotifications, which shows notifications, usually about commands;
• IncSearch<Inc>, which will perform an incremental search, based on Inc.

By default, Duat will have the "CmdLineNotifications" hook active. This hook changes the mode of the CmdLine to ShowNotifications whenever it is unfocused. If you don’t want this functionality, or want notifications somewhere else, you can use hooks::remove.

Trait Implementations

impl<U: Ui> Widget<U> for CmdLine<U>

type Cfg = CmdLineCfg<U>

The configuration type

fn cfg() -> Self::Cfg

Returns a WidgetCfg, for use in layout construction

fn update(&mut self, _area: &<U as Ui>::Area)

Updates the widget, allowing the modification of its Area

fn text(&self) -> &Text

The text that this widget prints out

fn text_mut(&mut self) -> &mut Text

A mutable reference to the Text that is printed

fn print_cfg(&self) -> PrintCfg

The configuration for how to print Text

fn once() -> Result<(), Error<()>>

Actions taken when this widget opens for the first time

fn on_focus(&mut self, _area: &U::Area)

Actions to do whenever this Widget is focused.

fn on_unfocus(&mut self, _area: &<U as Ui>::Area)

Actions to do whenever this Widget is unfocused.

fn cursors(&self) -> Option<&Cursors>

The Cursors that are used on the Text, if they exist

fn cursors_mut(&mut self) -> Option<&mut Cursors>

A mutable reference to the Cursors, if they exist

fn print(&mut self, area: &U::Area)

Prints the widget