Struct KeyBinding 

pub struct KeyBinding {
    pub key: KeyCode,
    pub modifiers: KeyModifiers,
    pub action: &'static str,
    pub description: &'static str,
    pub show: bool,
}

A key binding declaration on a widget. Widgets return these from key_bindings() to declare keyboard shortcuts.

Fields

key: KeyCode

The key that triggers this binding.

modifiers: KeyModifiers

Required modifier keys (e.g., CONTROL, SHIFT). Use KeyModifiers::NONE for no modifiers.

action: &'static str

Action string dispatched to on_action when this binding fires.

description: &'static str

Human-readable description (shown in Footer widget).

show: bool

Whether to display this binding in the Footer. Set false for internal bindings.

Implementations

impl KeyBinding

pub fn matches(&self, key: KeyCode, modifiers: KeyModifiers) -> bool

Check if a key event matches this binding.

Trait Implementations

impl Clone for KeyBinding

fn clone(&self) -> KeyBinding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyBinding

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

Formats the value using the given formatter.