Virtual keyboard

virtual-keyboard-unstable-v1
Virtual keyboard

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.

keymap(format: uint, fd: fd, size: uint)
Argument
Type
Description
formatuint
keymap format
fdfd
keymap file descriptor
sizeuint
keymap size, in bytes
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.

key(time: uint, key: uint, state: uint)
Argument
Type
Description
timeuint
timestamp with millisecond granularity
keyuint
key that produced the event
stateuint
physical state of the 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.

modifiers(mods_depressed: uint, mods_latched: uint, mods_locked: uint, group: uint)
Argument
Type
Description
mods_depresseduint
depressed modifiers
mods_latcheduint
latched modifiers
mods_lockeduint
locked modifiers
groupuint
keyboard layout
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.

destroy
Type: destructorsince 1
destroy()
Destroy the virtual keyboard keyboard object
error { no_keymap } 
Argument
Value
Description
no_keymap0
No keymap was set

Virtual keyboard manager

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

create_virtual_keyboard(seat: object<wl_seat>, id: new_id<zwp_virtual_keyboard_v1>)
Argument
Type
Description
seatobject<wl_seat>
idnew_id<zwp_virtual_keyboard_v1>
Create a new virtual keyboard

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.

error { unauthorized } 
Argument
Value
Description
unauthorized0
client not authorized to use the interface

Compositor Support

Mutter
Mutter
46
KWin
KWin
6.0
Sway
Sway
1.9
Hyprland
Hyprland
0.35
Weston
Weston
13
Mir
Mir
2.17
GameScope
GameScope
3.14.3
zwp_virtual_keyboard_manager_v1
x
x
1
1
x
1
x

Copyright © 2008-2011 Kristian Høgsberg Copyright © 2010-2013 Intel Corporation Copyright © 2012-2013 Collabora, Ltd. Copyright © 2018 Purism SPC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.