Struct KeyGesture 

pub struct KeyGesture { /* private fields */ }

Defines a keyboard input combination.

Implementations

impl KeyGesture

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

Creates a gesture for a key with modifiers.

pub const fn from_key(key: Key) -> Self

Creates a gesture for a key without modifiers.

pub const fn key(&self) -> Key

The key of the gesture.

pub const fn key_modifiers(&self) -> KeyModifiers

The modifier keys of the gesture.

pub fn parse(gesture: &str) -> Result<KeyGesture, ParseKeyModifiersError>

Parses a gesture such as Ctrl+Shift+A.

Parts are separated by +. The last part that names a key decides the key (+, -, . and , name the corresponding OEM keys); every other part must be a modifier: Ctrl/Control, Shift, Alt, Meta/Cmd/Win/⌘.

pub fn matches(&self, key_event: Option<&KeyEventArgs>) -> bool

Whether a key event matches the gesture: same modifiers and the same key, where the numpad operation keys match their regular counterparts.

impl KeyGesture

pub fn to_platform_string( &self, format_provider: Option<Rc<KeyGestureFormatInfo>>, ) -> String

Formats the gesture with the platform’s names for keys and modifiers (the p format): the given format info, or the one registered with the locator, or the invariant one.

pub fn to_string_format( &self, format: Option<&str>, format_provider: Option<Rc<KeyGestureFormatInfo>>, ) -> Result<String, FormatError>

Returns the gesture as a string formatted according to the format string and the format provider.

The format is None, an empty string or "g" for the invariant format, or "p" for the platform specific format: the given format info, or the one registered with the locator, or the invariant one.

Fails with a FormatError if the format string is anything else.

pub fn format_with(&self, format_info: &KeyGestureFormatInfo) -> String

Formats the gesture with the given format info.

Trait Implementations

impl Clone for KeyGesture

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KeyGesture

impl Debug for KeyGesture

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

Formats the value using the given formatter.

impl Display for KeyGesture

Formats the gesture in the invariant format, e.g. Ctrl+Shift+A.

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

Formats the value using the given formatter.

impl Eq for KeyGesture

impl FromStr for KeyGesture

type Err = ParseKeyModifiersError

The associated error which can be returned from parsing.

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

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

impl Hash for KeyGesture

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 MarkupTyped for KeyGesture

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl PartialEq for KeyGesture

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KeyGesture