Struct below_view::command_palette::CommandPalette

pub struct CommandPalette { /* fields omitted */ }

TextView that used to display extra information

Currently, we will use command palette to display extra information like full cgroup name. But the idea for this view is something like vim’s command palette that use for input operation command like search, filter, rearrange, apply config, etc.

Implementations

impl CommandPalette

pub fn new<V: 'static + ViewBridge>(
    name: &'static str,
    content: &str,
    cmd_controllers: Rc<RefCell<HashMap<&'static str, Controllers>>>
) -> Self

Create a new CommandPalette

pub fn run_cmd<V: 'static + ViewBridge>(
    name: &'static str,
    c: &mut Cursive,
    cmd: &str
)

Run the captured command

pub fn reset_cmd(&mut self)

pub fn invoke_cmd(&mut self)

Turn cmd_palette into command input mode

pub fn is_cmd_mode(&self) -> bool

Check if command palette is in command mode

pub fn set_info<T: Into<String>>(&mut self, content: T)

Set the display info

pub fn set_alert<T: Into<String>>(&mut self, content: T)

Set alert This will preempt the command palette mode.

pub fn set_filter(&mut self, filter: Option<String>)

pub fn toggle_fold(&mut self)

pub fn is_alerting(&self) -> bool

pub fn get_content<'a>(&'a self) -> &'a str

Trait Implementations

impl View for CommandPalette

fn draw(&self, printer: &Printer<'_, '_>)

Draws the view with the given printer (includes bounds) and focus.

fn on_event(&mut self, event: Event) -> EventResult

Called when an event is received (key press, mouse event, …).

fn required_size(&mut self, constraint: Vec2) -> Vec2

Returns the minimum size the view requires with the given restrictions.

fn layout(&mut self, XY<usize>)

Called once the size for this view has been decided.

fn needs_relayout(&self) -> bool

Should return true if the view content changed since the last call to layout().

fn call_on_any(
    &mut self,
    &Selector<'_>,
    &'a mut (dyn FnMut(&mut (dyn View + 'static)) + 'a)
)

Runs a closure on the view identified by the given selector.

fn focus_view(&mut self, &Selector<'_>) -> Result<(), ViewNotFound>

Moves the focus to the view identified by the given selector.

fn take_focus(&mut self, source: Direction) -> bool

This view is offered focus. Will it take it?

fn important_area(&self, view_size: XY<usize>) -> Rect

What part of the view is important and should be visible?

fn type_name(&self) -> &'static str

Returns the type of this view.