Enum zwp_virtual_keyboard::virtual_keyboard_unstable_v1::zwp_virtual_keyboard_v1::Request

#[non_exhaustive]pub enum Request {
    Keymap {
        format: u32,
        fd: RawFd,
        size: u32,
    },
    Key {
        time: u32,
        key: u32,
        state: u32,
    },
    Modifiers {
        mods_depressed: u32,
        mods_latched: u32,
        mods_locked: u32,
        group: u32,
    },
    Destroy,
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Keymap

keyboard mapping

Provide a file descriptor to the compositor which can be memory-mapped to provide a keyboard mapping description.

Format carries a value from the keymap_format enumeration.

Fields of Keymap

format: u32fd: RawFdsize: u32

Key

key event

A key was pressed or released. The time argument is a timestamp with millisecond granularity, with an undefined base. All requests regarding a single object must share the same clock.

Keymap must be set before issuing this request.

State carries a value from the key_state enumeration.

Fields of Key

time: u32key: u32state: u32

Modifiers

modifier and group state

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

The client should use wl_keyboard.modifiers event to synchronize its internal state with seat state.

Keymap must be set before issuing this request.

Fields of Modifiers

mods_depressed: u32mods_latched: u32mods_locked: u32group: u32

Destroy

destroy the virtual keyboard keyboard object

This is a destructor, once sent this object cannot be used any longer.

Trait Implementations

impl Debug for Request

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

Formats the value using the given formatter.

impl MessageGroup for Request

const MESSAGES: &'static [MessageDesc]

Wire representation of this MessageGroup

type Map = ProxyMap

The wrapper type for ObjectMap allowing the mapping of Object and NewId arguments to the object map during parsing.

fn is_destructor(&self) -> bool

Whether this message is a destructor

fn opcode(&self) -> u16

The opcode of this message

fn since(&self) -> u32

The minimal object version for which this message exists

fn child<Meta: ObjectMetadata>(
    opcode: u16,
    version: u32,
    meta: &Meta
) -> Option<Object<Meta>>

Retrieve the child Object associated with this message if any

fn from_raw(msg: Message, map: &mut Self::Map) -> Result<Self, ()>

Construct a message from its raw representation

fn into_raw(self, sender_id: u32) -> Message

Turn this message into its raw representation

unsafe fn from_raw_c(
    obj: *mut c_void,
    opcode: u32,
    args: *const wl_argument
) -> Result<Request, ()>

Construct a message of this group from its C representation

fn as_raw_c_in<F, T>(self, f: F) -> T where
    F: FnOnce(u32, &mut [wl_argument]) -> T, 

Build a C representation of this message