Struct OverlayBehavior

pub struct OverlayBehavior { /* private fields */ }

An overlay behavior.

Example

xkb_symbols {
    key <a> {
        overlay1 = <b>,
        [ a, A ],
    };
};

Implementations

impl OverlayBehavior

pub fn overlay(&self) -> KeyOverlay

Returns the overlay that controls this behavior.

Example

xkb_symbols {
    key <a> {
        overlay2 = <b>,
    };
};

The function returns KeyOverlay::Overlay2.

pub fn key_name(&self) -> &str

Returns the name of the key that this behavior redirects to if the overlay is active.

Example

xkb_symbols {
    key <a> {
        overlay1 = <b>,
    };
};

The function returns "b".

pub fn keycode(&self) -> Keycode

Returns the keycode of the key that this action redirects to if the overlay is active.

Example

xkb_symbols {
    key <a> {
        overlay1 = <b>,
    };
};

The function returns the keycode of <b>.

Trait Implementations

impl Clone for OverlayBehavior

fn clone(&self) -> OverlayBehavior

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OverlayBehavior

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

Formats the value using the given formatter.

impl PartialEq for OverlayBehavior

fn eq(&self, other: &OverlayBehavior) -> 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 OverlayBehavior