Struct Keysym

Source

pub struct Keysym(/* private fields */);

Available on crate feature xkbcommon only.

Expand description

The keyboard symbol, often corresponding to a character.

Implementations§

Source §

pub const fn new(raw: u32) -> Keysym

Create a new Keysym from a raw keyboard symbol.

Source

pub const fn raw(self) -> u32

Get the raw keyboard symbol.

Source

pub const fn name(self) -> Option<&'static str>

Get a string corresponding to the name of this keyboard symbol.

The output of this function is not stable and is intended for debugging purposes.

Source

pub const fn is_keypad_key(self) -> bool

Tell whether a keysym is a keypad key.

Source

pub const fn is_private_keypad_key(self) -> bool

Tell whether a keysym is a private keypad key.

Source

pub const fn is_cursor_key(self) -> bool

Tell whether a keysym is a cursor key.

Source

pub const fn is_pf_key(self) -> bool

Tell whether a keysym is a PF key.

Source

pub const fn is_function_key(self) -> bool

Tell whether a keysym is a function key.

Source

pub const fn is_misc_function_key(self) -> bool

Tell whether a key is a miscellaneous function key.

Source

pub const fn is_modifier_key(self) -> bool

Tell whether a key is a modifier key.

Source

pub fn key_char(self) -> Option<char>

Translate a keyboard symbol to its approximate character.

The translation follows the xkb_keysym_to_utf32 function.

Source

pub fn from_char(ch: char) -> Keysym

Create a Keysym from the given char.

This function replecates the xkb_utf32_to_keysym behavior.

Trait Implementations§

Source §

impl Clone for Keysym

Source §

fn clone(&self) -> Keysym

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for Keysym

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for Keysym

Source §

fn default() -> Keysym

Returns the “default value” for a type. Read more

Source §

impl From<u32> for Keysym

Source §

fn from(raw: u32) -> Keysym

Converts to this type from the input type.

Source §

impl Hash for Keysym

Source §

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more

Source §

impl Ord for Keysym

Source §

fn cmp(&self, other: &Keysym) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more

1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more

Source §

impl PartialEq for Keysym

Source §

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

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

Source §

impl PartialOrd for Keysym

Source §

fn partial_cmp(&self, other: &Keysym) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Source §

impl Zeroable for Keysym

Source §

fn zeroed() -> Self

Calls zeroed. Read more

Source §

impl Copy for Keysym

Source §

impl Eq for Keysym

Source §

impl Pod for Keysym

Source §

impl StructuralPartialEq for Keysym

Auto Trait Implementations§

§

impl Freeze for Keysym

§

impl RefUnwindSafe for Keysym

§

impl Send for Keysym

§

impl Sync for Keysym

§

impl Unpin for Keysym

§

impl UnwindSafe for Keysym

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CheckedBitPattern for T
where T: AnyBitPattern,

Source §

type Bits = T

Self must have the same layout as the specified Bits except for the possible invalid bit patterns being checked during is_valid_bit_pattern.

Source §

fn is_valid_bit_pattern(_bits: &T) -> bool

If this function returns true, then it must be valid to reinterpret bits as &Self.

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

Source §

impl<T> Downcast for T
where T: Any,

Source §

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

Source §

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

Source §

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

Source §

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

Source §

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source §

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

Source §