Struct pugl_sys::Key

pub struct Key {
    pub key: KeyVal,
    pub modifiers: Modifiers,
    pub code: u32,
}

Key with keyboard modifiers

Fields

key: KeyVal

The actual key

modifiers: Modifiers

The modifiers to be used with the Modifiers struct

code: u32

System's code for the key

Implementations

impl Key

pub fn try_char(&self) -> Option<char>

Returns the character if the key is a character key, otherwise None

let char_key = pugl_sys::Key {
    key: pugl_sys::KeyVal::Character('A'),
    modifiers: pugl_sys::Modifiers::SHIFT,
    code: 38
};
let special_key = pugl_sys::Key {
    key: pugl_sys::KeyVal::Special(pugl_sys::SpecialKey::F1),
    modifiers: pugl_sys::Modifiers::NONE,
    code: 67
};

assert_eq!(char_key.try_char(), Some('A'));
assert_eq!(special_key.try_char(), None);

Trait Implementations

impl Clone for Key

pub fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Key

impl Debug for Key

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

Formats the value using the given formatter.

impl PartialEq<Key> for Key

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Key