Struct KeyMap 

pub struct KeyMap {
    pub bindings: BTreeMap<Action, KeyboardShortcut>,
}

Action → KeyboardShortcut. Serialisable (KeyboardShortcut is serde in egui), so a host can save/load a remapped keymap (KEY-6). Uses Modifiers::COMMAND which egui maps to ⌘ on macOS / Ctrl elsewhere (KEY-3).

Fields

bindings: BTreeMap<Action, KeyboardShortcut>

Implementations

impl KeyMap

pub fn windows() -> Self

Windows preset: Ctrl-based, Ctrl+Home/End doc, Ctrl+←/→ word, F6/Shift+F6 between panes (FOC-1).

pub fn macos() -> Self

macOS preset: ⌘←/→ line, ⌥←/→ word, ⌘↑/↓ doc (KEY-5).

pub fn device() -> Self

Device preset: explicit, conservative — no accidental chordless single keys for destructive actions (KEY-5). Mirrors Windows nav but keeps the arrows for movement only.

pub fn shortcut(&self, action: Action) -> Option<KeyboardShortcut>

The chord bound to action, if any.

pub fn set(&mut self, action: Action, chord: KeyboardShortcut)

Remap an action to a new chord (the serialisable remap UI’s mutation).

pub fn consume(&self, action: Action, ui: &mut Ui) -> bool

Consume action’s chord from this frame’s input — the single resolution point. Returns true if the chord fired (and consumes it). Components call this; they never inspect Key/Modifiers directly (COH-2, KEY-2).

pub fn label(&self, action: Action, ctx: &Context) -> String

Human-readable label for an action’s chord (for buttons/menus, KEY-3).

Trait Implementations

impl Clone for KeyMap

fn clone(&self) -> KeyMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyMap

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

Formats the value using the given formatter.

impl Default for KeyMap

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KeyMap

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for KeyMap

impl PartialEq for KeyMap

fn eq(&self, other: &KeyMap) -> 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 Serialize for KeyMap

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KeyMap