Enum Event

pub enum Event {
    Keymap {
        format: Enum<KeymapFormat>,
        fd: Handle,
        size: u32,
    },
    Enter {
        serial: u32,
        surface: ObjectId,
        keys: Array,
    },
    Leave {
        serial: u32,
        surface: ObjectId,
    },
    Key {
        serial: u32,
        time: u32,
        key: u32,
        state: Enum<KeyState>,
    },
    Modifiers {
        serial: u32,
        mods_depressed: u32,
        mods_latched: u32,
        mods_locked: u32,
        group: u32,
    },
    RepeatInfo {
        rate: i32,
        delay: i32,
    },
}

Variants

Keymap

keyboard mapping

This event provides a file descriptor to the client which can be memory-mapped to provide a keyboard mapping description.

From version 7 onwards, the fd must be mapped with MAP_PRIVATE by the recipient, as MAP_SHARED may fail.

Fields

format: Enum<KeymapFormat>

keymap format

fd: Handle

keymap file descriptor

size: u32

keymap size, in bytes

Enter

enter event

Notification that this seat’s keyboard focus is on a certain surface.

The compositor must send the wl_keyboard.modifiers event after this event.

Fields

serial: u32

serial number of the enter event

surface: ObjectId

surface gaining keyboard focus

keys: Array

the currently pressed keys

Leave

leave event

Notification that this seat’s keyboard focus is no longer on a certain surface.

The leave notification is sent before the enter notification for the new focus.

After this event client must assume that all keys, including modifiers, are lifted and also it must stop key repeating if there’s some going on.

Fields

serial: u32

serial number of the leave event

surface: ObjectId

surface that lost keyboard focus

Key

key event

A key was pressed or released. The time argument is a timestamp with millisecond granularity, with an undefined base.

The key is a platform-specific key code that can be interpreted by feeding it to the keyboard mapping (see the keymap event).

If this event produces a change in modifiers, then the resulting wl_keyboard.modifiers event must be sent after this event.

Fields

serial: u32

serial number of the key event

time: u32

timestamp with millisecond granularity

key: u32

key that produced the event

state: Enum<KeyState>

physical state of the key

Modifiers

modifier and group state

Notifies clients that the modifier and/or group state has changed, and it should update its local state.

Fields

serial: u32

serial number of the modifiers event

mods_depressed: u32

depressed modifiers

mods_latched: u32

latched modifiers

mods_locked: u32

locked modifiers

group: u32

keyboard layout

RepeatInfo

repeat rate and delay

Informs the client about the keyboard’s repeat rate and delay.

This event is sent as soon as the wl_keyboard object has been created, and is guaranteed to be received by the client before any key press event.

Negative values for either rate or delay are illegal. A rate of zero will disable any repeating (regardless of the value of delay).

This event can be sent later on as well with a new value if necessary, so clients should continue listening for the event past the creation of wl_keyboard.

Fields

rate: i32

the rate of repeating keys in characters per second

delay: i32

delay in milliseconds since key down until repeating starts

Trait Implementations

impl Debug for Event

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

Formats the value using the given formatter.

impl FromArgs for Event

fn from_args(op: u16, args: Vec<Arg>) -> Result<Self, Error>

Consumes |args| creates an instance of self.

impl MessageType for Event

fn log(&self, this: ObjectId) -> String

Generates a string suitable for protocol logging this message.

fn message_name(&self) -> &'static CStr

Returns a static CStr reference that describes the interface/method of this message.