Struct HintBar 

pub struct HintBar { /* private fields */ }

A row of key chips. Primary action first, Esc last; chips that do not fit are dropped whole from the right, never clipped mid-word.

Every chip is a key of one screen’s registry entries (Self::screen), so a dialog’s footer says what its help says.

Implementations

impl HintBar

pub fn with_styles( key_style: Style, label_style: Style, accent_label_style: Style, ) -> Self

A bar with explicit styles, for the footer’s background-filled row.

pub fn from_ctx(ctx: &RenderContext) -> Self

A bar styled from the theme snapshot, for Surface footers.

pub fn screen(self, context: Context) -> Self

The screen whose registry entries the chips that follow are.

pub fn group(self, group: &'static str) -> Self

The group of the screen’s entries the chips that follow are, where the screen lists a key twice.

pub fn key(self, keys: &str) -> Self

A chip for keys, with the registry’s word for them.

pub fn key_as(self, keys: &str, label: &'static str) -> Self

A chip for keys saying label, one of the registry’s words for them.

pub fn push(self, hint: Hint) -> Self

A chip built elsewhere from the registry.

pub fn weight(self, weight: i32) -> Self

The weight of the last chip; see Chip::weight.

pub fn accent(self, key: &str) -> Self

Accent the label of the chip whose key is key.

pub fn flush_width_in(&self, width: u16) -> u16

The columns a bar drawn with Self::render_flush uses in a row of width: the last chip’s trailing gap is not counted.

pub fn render_flush(&self, area: Rect, buf: &mut Buffer)

Draw a bar that nothing follows on its row, such as a Surface footer: a chip fits when its label does, without the gap a next chip would need.

Trait Implementations

impl Clone for HintBar

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 HintBar

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

Formats the value using the given formatter.

impl Widget for &HintBar

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.