[−][src]Struct druid_shell::hotkey::HotKey
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
[src]
pub fn new(mods: impl Into<Option<RawMods>>, key: impl Into<KeyCompare>) -> Self
[src]
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
[src]
Returns true
if this KeyEvent
matches this HotKey
.
Trait Implementations
Auto Trait Implementations
impl Send for HotKey
impl Sync for HotKey
impl Unpin for HotKey
impl UnwindSafe for HotKey
impl RefUnwindSafe for HotKey
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> RoundFrom<T> for T
fn round_from(x: T) -> T
impl<T, U> RoundInto<U> for T where
U: RoundFrom<T>,
U: RoundFrom<T>,