Struct KeyTypeMapping

pub struct KeyTypeMapping { /* private fields */ }

A key-type mapping.

Example

xkb_types {
    type "X" {
        modifiers = Shift+Mod1;
        map[Shift] = Level2;
        map[Mod1] = Level2;
    };
};

This object might refer to either map[Shift] or map[Mod1].

Implementations

impl KeyTypeMapping

pub fn mask(&self) -> ModifierMask

Returns the modifier mask of this mapping.

After masking with the type mask, the effective modifiers must match this mask exactly for the mapping to be applicable.

Example

xkb_types {
    type "X" {
        modifiers = Shift+Mod1;
        map[Shift] = Level2;
        map[Mod1] = Level2;
    };
};

If this mapping is map[Shift], then this function returns ModifierMask::SHIFT.

pub fn preserved(&self) -> ModifierMask

Returns the preserved modifiers of this mapping.

If this mapping is applicable, then the preserved modifiers are not consumed by the mapping and might be used for keyboard shortcuts or keysym transformations.

Example

xkb_types {
    type "X" {
        modifiers = Control+Shift;
        map[Control+Shift] = Level2;
        preserve[Control+Shift] = Control;
    };
};

If this mapping is map[Control+Shift], then function returns ModifierMask::CONTROL.

pub fn consumed(&self) -> ModifierMask

Returns the consumed modifiers of this mapping.

If this mapping is applicable, then the consumed modifiers should no longer be considered for keyboard shortcuts and keysym transformations.

Example

xkb_types {
    type "X" {
        modifiers = Control+Shift;
        map[Control+Shift] = Level2;
        preserve[Control+Shift] = Control;
    };
};

If this mapping is map[Control+Shift], then function returns ModifierMask::SHIFT.

pub fn level(&self) -> usize

Returns the 0-based level that this mapping maps to.

Example

xkb_types {
    type "X" {
        modifiers = Shift;
        map[Shift] = Level2;
    };
};

If this mapping is map[Shift], then function returns 1.

Trait Implementations

impl Debug for KeyTypeMapping

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

Formats the value using the given formatter.

impl PartialEq for KeyTypeMapping

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

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

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

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

impl StructuralPartialEq for KeyTypeMapping