Struct cskk::keyevent::CskkKeyEvent

pub struct CskkKeyEvent { /* private fields */ }

In-lib structure of key event

String representation of key event is paren enclosed LongModifiers and single KeyName, or just one ShortModifier and one KeyName joined, or single KeyName. LongModifier := “control” | “meta” | “alt” | “lshift” | “rshift” | “shift” ShortModifier := “C-” | “A-” | “M-” | “G-” for ctrl, mod1, meta, mod5 respectively KeyName := ↓ https://github.com/xkbcommon/libxkbcommon/blob/master/include/xkbcommon/xkbcommon-keysyms.h https://xkbcommon.org/doc/current/xkbcommon_8h.html#a79e604a22703391bdfe212cfc10ea007

e.g. “(control a)” “C-a” “M-Left” “l” “space”

Implementations

impl CskkKeyEvent

pub fn from_keysym_with_flags( keysym: Keysym, ctrl_mod: bool, shift_mod: bool, alt_mod: bool ) -> Self

Get a keyevent used in cskk.

TODO: Switch to another interface that accepts ModMap of xkb instead of each bool when xkbcommon lib can handle them better.

pub fn from_string_representation(key: &str) -> Result<CskkKeyEvent, CskkError>

string representation to KeyEvent. When parsing fails keysym is likely to be a voidsymbol

Testing purpose and not intended to be used from library users. May delete this interface at any update. Use from_keysym_with_flags for now instead.

pub fn deserialize_seq(from: &str) -> Result<KeyEventSeq, CskkError>

Mostly testing purpose. May delete this interface at any update. Use from_keysym_with_flags for now instead.

Trait Implementations

impl Clone for CskkKeyEvent

fn clone(&self) -> CskkKeyEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CskkKeyEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CskkKeyEvent

where Self: FromStr, <Self as FromStr>::Err: Display,

fn deserialize<__D>(deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CskkKeyEvent

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

Formats the value using the given formatter.

impl FromStr for CskkKeyEvent

type Err = CskkError

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 CskkKeyEvent

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 CskkKeyEvent

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CskkKeyEvent

impl StructuralPartialEq for CskkKeyEvent