Struct Chord 

pub struct Chord { /* private fields */ }

A key plus the modifiers held with it, such as Ctrl+Shift+Tab.

Parse one from a string: modifiers and the key are joined by +, and case does not matter. Modifiers are Ctrl, Shift, Alt (or Option), Cmd (or Super, Meta) and Mod, which is Cmd on macOS and Ctrl elsewhere. Keys are a single character (K, /, +) or a name: Enter, Tab, Space, Escape, Backspace, Delete, Insert, ArrowUp, ArrowDown, ArrowLeft, ArrowRight, Home, End, PageUp, PageDown, Menu (the context menu key) and F1 to F12.

use iced_cube::keys::Chord;

let chord: Chord = "ctrl+shift+tab".parse().unwrap();
assert_eq!(chord.to_string(), "Ctrl+Shift+Tab");

Implementations

impl Chord

pub fn new(key: Key, modifiers: Modifiers) -> Self

A chord for key. Characters are stored in lower case.

pub fn named(key: Named) -> Self

A named key with no modifiers.

pub fn character(key: char) -> Self

A character key with no modifiers.

pub fn ctrl(self) -> Self

pub fn shift(self) -> Self

pub fn alt(self) -> Self

pub fn logo(self) -> Self

Adds the logo key: Cmd on macOS, Super or the Windows key elsewhere.

pub fn command(self) -> Self

Adds Cmd on macOS and Ctrl elsewhere.

pub fn key(&self) -> &Key

pub fn modifiers(&self) -> Modifiers

pub fn matches(&self, key: &Key, modifiers: Modifiers) -> bool

Whether a key press with exactly these modifiers triggers the chord.

Trait Implementations

impl Clone for Chord

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Chord

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

Formats the value using the given formatter.

impl Display for Chord

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

Formats the value using the given formatter.

impl Eq for Chord

impl FromStr for Chord

type Err = ParseChordError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Chord

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Chord

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Chord

impl TryFrom<&str> for Chord

type Error = ParseChordError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.