Struct Shortcut 

pub struct Shortcut { /* private fields */ }

A semantic shortcut whose display and matching use platform conventions.

Implementations

impl Shortcut

pub fn command(key: impl Into<String>) -> Shortcut

pub fn key(key: impl Into<String>) -> Shortcut

A key pressed on its own, without the command modifier: F3, Delete, or a single letter a view answers while it has focus.

pub fn chord<'a>( modifiers: impl IntoIterator<Item = &'a str>, key: &str, ) -> Shortcut

A chord as the desktop’s shortcut table stores it: modifier names (Super, Ctrl, Alt, Shift) and a key, spelled for display in the active keyboard layout’s legends.

pub fn system(self) -> Shortcut

Held with the desktop’s own modifier (Super).

pub fn has_system(&self) -> bool

pub fn shift(self) -> Shortcut

pub fn alt(self) -> Shortcut

pub fn key_name(&self) -> &str

The key this shortcut is pressed with, as a keycap legend.

pub fn has_command(&self) -> bool

pub fn has_shift(&self) -> bool

pub fn has_alt(&self) -> bool

pub fn label(&self, conventions: PlatformConventions) -> String

pub fn keycap_labels(&self, conventions: PlatformConventions) -> Vec<String>

Labels to paint as individual physical-looking caps, in the legends of the active keyboard layout (crate::keycaps::active).

pub fn matches( &self, key: &Key, modifiers: ModifiersState, conventions: PlatformConventions, ) -> bool

Whether the press of key with modifiers asks for this shortcut: the same key, with exactly the modifiers it names. A command modifier is the platform’s own (PlatformConventions::command_modifier), so a declared Ctrl+Enter is Command+Enter on a Mac and Ctrl+Enter elsewhere, and no other modifier held along with it matches.

pub fn pressed( key: &Key, modifiers: ModifiersState, conventions: PlatformConventions, ) -> Option<Shortcut>

The shortcut a live press asks for, in conventions’ spelling, or None for a key no shortcut can name.

pub fn same_press(&self, other: &Shortcut) -> bool

Whether both ask for one press: one key, in one spelling, with the same modifiers.

Trait Implementations

impl Clone for Shortcut

fn clone(&self) -> Shortcut

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Shortcut

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

Formats the value using the given formatter.

impl From<&str> for Shortcut

A chord as an app, a menu or the person’s table writes it (Ctrl+Enter, Super+W, F2, e): one table for the modifiers and the key names it parses with ([tilo_ui_graph::keys::Chord]), the same one the compiler checks an app’s declared shortcut against.

fn from(label: &str) -> Shortcut

Converts to this type from the input type.

impl From<String> for Shortcut

fn from(label: String) -> Shortcut

Converts to this type from the input type.

impl PartialEq for Shortcut

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

impl StructuralPartialEq for Shortcut