Struct KeyHints 

pub struct KeyHints { /* private fields */ }

A bar of key hints such as tab next ctrl q quit, fed from the keymap and from hints the application adds for the current screen.

Keys sit on a raised surface and labels are faint; nothing is bracketed. When the bar is too narrow, hints are dropped from the end of the left group first; the right group stays. Style keys: key-hints (bg, padding), key-hint-key, key-hint-label, and key-hint-key.faint, key-hint-label.faint for a faint bar.

Implementations

impl KeyHints

pub fn new() -> Self

An empty bar.

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

Adds a hint on the left: key such as "↑↓" and its label.

pub fn action(self, scope: Scope, action: impl Into<String>) -> Self

Adds a keymap action on the left; its keys and translated label come from the keymap and the locale.

pub fn action_first(self, scope: Scope, action: impl Into<String>) -> Self

Adds a keymap action before every plain hint, resolved like action. When the bar is too narrow it is the last of the left group to drop, for the one key a screen cannot do without, such as the key that brings a closed panel back.

pub fn action_labelled( self, scope: Scope, action: impl Into<String>, label: impl Into<String>, ) -> Self

Adds a keymap action on the left with the application’s own label: the key comes from the keymap, so it follows the person’s bindings, and the words from the application, for a key whose meaning changes with the screen, such as enter saying “install” or “open”. Like action, an action without a chord draws nothing.

pub fn action_right(self, scope: Scope, action: impl Into<String>) -> Self

Adds a keymap action on the right.

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

Draws the whole bar in the faint tone, keys and labels alike, for a screen that has gone quiet, as Breadcrumb::faint does for a path.

Trait Implementations

impl Clone for KeyHints

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyHints

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for KeyHints

fn default() -> Self

Returns the “default value” for a type.

impl<Msg: 'static> Widget<Msg> for KeyHints

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.