Struct druid::HotKey

pub struct HotKey { /* fields omitted */ }

A description of a keyboard shortcut.

This type is only intended to be used to describe shortcuts, and recognize them when they arrive.

Examples

SysMods matches the Command key on macOS and Ctrl elsewhere:

use druid_shell::hotkey::{HotKey, RawMods, SysMods};
use druid_shell::keyboard::{KeyEvent, KeyCode};

let hotkey = HotKey::new(SysMods::Cmd, "a");

#[cfg(target_os = "macos")]
assert!(hotkey.matches(KeyEvent::for_test(RawMods::Meta, "a", KeyCode::KeyA)));

#[cfg(target_os = "windows")]
assert!(hotkey.matches(KeyEvent::for_test(RawMods::Ctrl, "a", KeyCode::KeyA)));

None matches only the key without modifiers:

use druid_shell::hotkey::{HotKey, RawMods, SysMods};
use druid_shell::keyboard::{KeyEvent, KeyCode};

let hotkey = HotKey::new(None, KeyCode::ArrowLeft);

assert!(hotkey.matches(KeyEvent::for_test(RawMods::None, "", KeyCode::ArrowLeft)));
assert!(!hotkey.matches(KeyEvent::for_test(RawMods::Ctrl, "", KeyCode::ArrowLeft)));

Methods

impl HotKey

pub fn new(
    mods: impl Into<Option<RawMods>>,
    key: impl Into<KeyCompare>
) -> HotKey

Create a new hotkey.

The first argument describes the keyboard modifiers. This can be None, or an instance of either SysMods, or RawMods. SysMods unify the 'Command' key on macOS with the 'Ctrl' key on other platforms.

The second argument describes the non-modifier key. This can be either a &'static str or a KeyCode. If it is a &str, it will be compared against the unmodified text for a given key event; if it is a KeyCode it will be compared against the event's key code.

In general, KeyCode should be preferred for non-printing keys, like the arrows or backspace.

Examples

use druid_shell::hotkey::{HotKey, RawMods, SysMods};
use druid_shell::keyboard::{KeyEvent, KeyCode};

let select_all = HotKey::new(SysMods::Cmd, "a");
let esc = HotKey::new(None, KeyCode::Escape);
let macos_fullscreen = HotKey::new(RawMods::CtrlMeta, "f");

pub fn matches(&self, event: impl Borrow<KeyEvent>) -> bool

Returns true if this KeyEvent matches this HotKey.

Trait Implementations

impl Debug for HotKey

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

Formats the value using the given formatter.

impl Clone for HotKey

fn clone(&self) -> HotKey

Returns a copy of the value.

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

Performs copy-assignment from source.