Virtual keyboard
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.
Argument | Type | Description |
|---|---|---|
| format | uint | keymap format |
| fd | fd | keymap file descriptor |
| size | uint | 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.
Argument | Type | Description |
|---|---|---|
| time | uint | timestamp with millisecond granularity |
| key | uint | key that produced the event |
| state | uint | 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(mods_depressed: uint, mods_latched: uint, mods_locked: uint, group: uint)
Argument | Type | Description |
|---|---|---|
| mods_depressed | uint | depressed modifiers |
| mods_latched | uint | latched modifiers |
| mods_locked | uint | locked modifiers |
| group | uint | 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()
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.
create_virtual_keyboard(seat: object<wl_seat>, id: new_id<zwp_virtual_keyboard_v1>)
Argument | Type | Description |
|---|---|---|
| seat | object<wl_seat> | |
| id | new_id<zwp_virtual_keyboard_v1> |
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 |
|---|---|---|
| unauthorized | 0 | client not authorized to use the interface |
Compositor Support
Mutter  46 | KWin  6.2 | Sway  1.9 | COSMIC  1.0.0 | Hyprland  0.42.0 | niri 0.1.8 | Weston  13 | Mir  2.18 | GameScope  3.15.14 | Jay 1.7.0 | |
|---|---|---|---|---|---|---|---|---|---|---|
| zwp_virtual_keyboard_manager_v1 | x | x | 1 | 1 | 1 | 1 | x | 1 | x | 1 |
Copyright
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.