Struct Layers 

pub struct Layers<'a, M> { /* private fields */ }

A base component with Layers over it (#480): modal dialogs and popovers. The top layer takes the keys; a modal also traps focus (Tab cycles inside it) and dims the base. Escape dismisses the top layer when the layer does not use it, and a layer that cancels is dismissed rather than cancelling the host. With no layer open, the host is its base.

Implementations

impl<'a, M> Layers<'a, M>

pub fn new(base: impl Component<Output = M> + 'a) -> Layers<'a, M>

pub fn handle(&self) -> LayerHandle<'a, M>

A handle that opens and closes layers here.

pub fn open(&mut self, layer: Layer<'a, M>)

Open layer now.

pub fn close(&mut self) -> bool

Close the top layer; false when none is open.

pub fn open_on( self, action: &str, keys: impl IntoIterator<Item = Key>, description: &str, layer: impl FnMut() -> Layer<'a, M> + 'a, ) -> Self

where M: 'a,

Open a layer made by layer when one of keys reaches the host unused, with no layer open: a help dialog on ?, a palette on Ctrl+P.

pub fn backdrop_style(self, style: Style) -> Self

The style put over the base under a modal (default: dim).

pub fn border_style(self, style: Style) -> Self

The style of a layer’s border (default: none).

pub fn on( self, action: &str, keys: impl IntoIterator<Item = Key>, description: &str, handler: impl FnMut() -> Flow<M> + 'a, ) -> Self

Run handler when one of keys bubbles up unused by the focused child: an action of yours, listed in the keymap under this container’s context.

pub fn shortcut( self, action: &str, keys: impl IntoIterator<Item = Key>, description: &str, handler: impl FnMut() -> Flow<M> + 'a, ) -> Self

Run handler when one of keys is pressed, before the focused child sees it.

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

Make keys do this container’s action (focus-next, and the container’s own); no keys unbinds it.

pub fn own_keymap(&self) -> &Keymap

This container’s own bindings, without its children’s.

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

Report the mouse even when no child asks for it: for a click to focus a child, or a border to drag.

pub fn depth(&self) -> usize

How many layers are open.

pub fn base(&self) -> &(dyn Component<Output = M> + 'a)

pub fn base_mut(&mut self) -> &mut (dyn Component<Output = M> + 'a)

pub fn placements(&self, context: &Context<'_>) -> Vec<(Rect, Rect)>

Each open layer’s outer and inner rectangles at context.

Trait Implementations

impl<M> Component for Layers<'_, M>

type Output = M

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

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<M>

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 tick(&self) -> Option<Duration>

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

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 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.

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

Move focus to the next (forward) or previous focus stop inside this component, for Tab and Shift+Tab. false when there is none after the current one, so the container moves on to its next child. The default, for a component that is one stop: false.

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

Take focus from outside: at the first stop inside when forward, at the last otherwise. false when nothing in it can take focus. The default: whether the component is focusable.

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

The value to return when the terminal is not interactive and the policy asks for defaults. None: there is none.

fn prompt(&mut self, io: &mut dyn LineIo) -> Result<Option<M>, 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.