Struct HelpLayer 

pub struct HelpLayer<Msg> { /* private fields */ }

A layer listing every key binding: the hints of the current screen first, then the application’s keymap actions, then the framework’s. Labels come from the language files (keys.<action> and quvyta.keys.<action>), keys from the keymap, so rebinding a key or switching the language updates the list.

Typing filters the list with fuzzy matching (matched characters take the match colour); ↑/↓, PgUp/PgDn and the wheel scroll it. It is dismissable by default: Esc and the close mark × at the top right send the close message; dismissable(false) turns both off. Add it to the view while it should be shown; it opens as a modal layer (see Modal), with the same pillar down its left edge. Applications usually open it from the global help action, bound to ?.

Style keys: modal, modal-title, close-mark, layer-backdrop, layer-filter, layer-filter-mark, layer-filter-placeholder, layer-filter-cursor, layer-match, help-group, help-key, help-label, layer-hint-key, layer-hint-label. Text: quvyta.help.*, quvyta.layer.*.

Implementations

impl<Msg: Clone + 'static> HelpLayer<Msg>

pub fn new(on_close: Msg) -> Self

A help layer; Esc and its close mark send on_close.

pub fn dismissable(self, dismissable: bool) -> Self

Whether Esc and the close mark close the layer; true by default. With false neither works, the mark is not drawn and the application closes the layer itself.

pub fn hint(self, key: impl Into<String>, label: impl Into<String>) -> Self

Adds a key of the current screen that is not in the keymap, e.g. ("↑↓", "move"). These come first, under “This screen”.

pub fn width(self, cells: u16) -> Self

Width in cells, padding included; 64 by default. Narrow screens shrink it.

Trait Implementations

impl<Msg: Clone + 'static> Widget<Msg> for HelpLayer<Msg>

fn measure(&self, _cx: &mut MeasureCx<'_>, _available: Size) -> Size

The size the widget wants when it may use up to available.

fn paint(&self, cx: &mut PaintCx<'_>, area: Rect)

Draws the widget into area.

fn paint_overlay(&self, cx: &mut PaintCx<'_>, _anchor: Rect)

Draws the widget’s overlay after the whole view was painted, when it asked for one with PaintCx::request_overlay. anchor is the area the widget was painted in.

fn event(&self, cx: &mut EventCx<'_, Msg>, event: &Event) -> bool

Handles input. Returns true when the event was used; unused key and scroll events bubble to the parent widget.

fn focusable(&self) -> bool

Whether the widget can take keyboard focus.

fn children(&self) -> &[Node<Msg>]

Child nodes, for widgets that contain other widgets.

fn children_mut(&mut self) -> &mut [Node<Msg>]

Mutable child nodes, used to assign ids.