river-xkb-config-v1

This protocol allow a client to set the xkbcommon keymap of individual keyboard input devices. It also allows switching between the layouts of a keymap and toggling capslock/numlock state.

The key words "must", "must not", "required", "shall", "shall not", "should", "should not", "recommended", "may", and "optional" in this document are to be interpreted as described in IETF RFC 2119.

Global interface for configuring xkb devices.

This global should only be advertised if river_input_manager_v1 is advertised as well.

This request indicates that the client no longer wishes to receive events on this object.

The Wayland protocol is asynchronous, which means the server may send further events until the stop request is processed. The client must wait for a river_xkb_config_v1.finished event before destroying this object.

This request should be called after the finished event has been received to complete destruction of the object.

It is a protocol error to make this request before the finished event has been received.

If a client wishes to destroy this object it should send a river_xkb_config_v1.stop request and wait for a river_xkb_config_v1.finished event. Once the finished event is received it is safe to destroy this object and any other objects created through this interface.

The server must be able to mmap the fd with MAP_PRIVATE. The server will fstat the fd to obtain the size of the keymap. The client must not modify the contents of the fd after making this request. The client should seal the fd with fcntl.

This event indicates that the server will send no further events on this object. The client should destroy the object. See river_xkb_config_v1.destroy for more information.

A new xkbcommon keyboard has been created. Not every river_input_device_v1 is necessarily an xkbcommon keyboard as well.

This object is the result of attempting to create an xkbcommon keymap.

This request indicates that the client will no longer use the keymap object and that it may be safely destroyed.

The keymap object was successfully created and may be used with the river_xkb_keyboard_v1.set_keymap request.

The compositor failed to create a keymap from the given parameters.

It is a protocol error to use this keymap object with river_xkb_keyboard_v1.set_keymap.

This object represent a physical keyboard which has its configuration and state managed by xkbcommon.

This request indicates that the client will no longer use the keyboard object and that it may be safely destroyed.

Set the keymap for the keyboard.

It is a protocol error to pass a keymap object for which the river_xkb_keymap_v1.success event was not received.

Set the active layout for the keyboard's keymap. Has no effect if the layout index is out of bounds for the current keymap.

Set the active layout for the keyboard's keymap. Has no effect if there is no layout with the give name for the keyboard's keymap.

Enable capslock for the keyboard.

Disable capslock for the keyboard.

Enable numlock for the keyboard.

Disable numlock for the keyboard.

This event indicates that the xkb keyboard has been removed.

The server will send no further events on this object and ignore any request (other than river_xkb_keyboard_v1.destroy) made after this event is sent. The client should destroy this object with the river_xkb_keyboard_v1.destroy request to free up resources.

The river_input_device_v1 corresponding to this xkb keyboard. This event will always be the first event sent on the river_xkb_keyboard_v1 object, and it will be sent exactly once.

The currently active layout index and name. The name arg may be null if the active layout does not have a name.

This event is sent once when the river_xkb_keyboard_v1 is created and again whenever the layout changes.

Capslock is currently enabled for the keyboard.

This event is sent once when the river_xkb_keyboard_v1 is created and again whenever the capslock state changes.

Capslock is currently disabled for the keyboard.

This event is sent once when the river_xkb_keyboard_v1 is created and again whenever the capslock state changes.

Numlock is currently enabled for the keyboard.

This event is sent once when the river_xkb_keyboard_v1 is created and again whenever the numlock state changes.

Numlock is currently disabled for the keyboard.

This event is sent once when the river_xkb_keyboard_v1 is created and again whenever the numlock state changes.