virtual_keyboard_unstable_v1

• # zwp_virtual_keyboard_v1

  The virtual keyboard provides an application with requests which emulate the behaviour of a physical keyboard. This interface can be used by clients on its own to provide raw input events, or it can accompany the input method protocol.

  Requests

  • #

    keymap

    keyboard mapping
    void zwp_virtual_keyboard_v1_keymap(

    struct zwp_virtual_keyboard_v1* zwp_virtual_keyboard_v1,

    uint32_t format, /* keymap format */

    int32_t fd, /* keymap file descriptor */

    uint32_t size /* keymap size, in bytes */

    )
    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.
  • #

    key

    key event
    void zwp_virtual_keyboard_v1_key(

    struct zwp_virtual_keyboard_v1* zwp_virtual_keyboard_v1,

    uint32_t time, /* timestamp with millisecond granularity */

    uint32_t key, /* key that produced the event */

    uint32_t state /* physical state of the key */

    )
    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.
  • #

    modifiers

    modifier and group state
    void zwp_virtual_keyboard_v1_modifiers(

    struct zwp_virtual_keyboard_v1* zwp_virtual_keyboard_v1,

    uint32_t mods_depressed, /* depressed modifiers */

    uint32_t mods_latched, /* latched modifiers */

    uint32_t mods_locked, /* locked modifiers */

    uint32_t group /* keyboard layout */

    )
    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.
  • #

    destroy

    destroy the virtual keyboard keyboard object
    void zwp_virtual_keyboard_v1_destroy(

    struct zwp_virtual_keyboard_v1* zwp_virtual_keyboard_v1

    )

  Enums

  • #

    error
    ZWP_VIRTUAL_KEYBOARD_V1_ERROR_NO_KEYMAP /* No keymap was set */

• # zwp_virtual_keyboard_manager_v1

  A virtual keyboard manager allows an application to provide keyboard input events as if they came from a physical keyboard.

  Requests

  • #

    create_virtual_keyboard

    Create a new virtual keyboard
    struct zwp_virtual_keyboard_v1* zwp_virtual_keyboard_manager_v1_create_virtual_keyboard(

    struct zwp_virtual_keyboard_manager_v1* zwp_virtual_keyboard_manager_v1,

    struct wl_seat* seat

    )
    Creates a new virtual keyboard associated to a seat. If the compositor enables a keyboard to perform arbitrary actions, it should present an error when an untrusted client requests a new keyboard.

  Enums

  • #

    error
    ZWP_VIRTUAL_KEYBOARD_MANAGER_V1_ERROR_UNAUTHORIZED /* client not authorized to use the interface */

Copyright Info