Struct HelpContent 

pub struct HelpContent {
    pub short: String,
    pub long: Option<String>,
    pub keybindings: Vec<Keybinding>,
    pub see_also: Vec<HelpId>,
}

Structured help content for a widget.

Fields

short: String

Short tooltip-length description (one line).

long: Option<String>

Optional longer description shown in a detail panel.

keybindings: Vec<Keybinding>

Keybindings available when this widget is focused.

see_also: Vec<HelpId>

Related widget help IDs for “see also” links.

Implementations

impl HelpContent

pub fn short(desc: impl Into<String>) -> Self

Create minimal help content with just a short description.

Trait Implementations

impl Clone for HelpContent

fn clone(&self) -> HelpContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HelpContent

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

Formats the value using the given formatter.

impl PartialEq for HelpContent

fn eq(&self, other: &HelpContent) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for HelpContent

impl StructuralPartialEq for HelpContent