package oxbow

  1. Overview
  2. Docs
Dynamic window manager for the river Wayland compositor

Install

dune-project
 Dependency

Authors

Maintainers

Sources

v0.1.0.tar.gz
md5=a637acaa0e19046cd65fff733874eb97
sha512=76230cbecd7510de7a05b5d1f335915ef7b6c4aa557d8dbfd23591606618d2cfa25082d17b93f2f4b53a118d1cbf6a80e4ad51cf0f099b4921fb83d6df0c9801

doc/oxbow.river/River/Server/Xkb/Config/River_xkb_keyboard_v1/index.html

Module Config.River_xkb_keyboard_v1Source

Xkbcommon keyboard device.

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

Sourcetype 'v t = ([ `River_xkb_keyboard_v1 ], 'v, [ `Server ]) Wayland.Proxy.t
Sourcemodule Error : sig ... end

Version 1

Sourceval numlock_disabled : [< `V1 | `V2 ] t -> unit

Numlock is currently disabled.

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.

Sourceval numlock_enabled : [< `V1 | `V2 ] t -> unit

Numlock is currently enabled.

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.

Sourceval capslock_disabled : [< `V1 | `V2 ] t -> unit

Capslock is currently disabled.

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.

Sourceval capslock_enabled : [< `V1 | `V2 ] t -> unit

Capslock is currently enabled.

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.

Sourceval layout : [< `V1 | `V2 ] t -> index:int32 -> name:string option -> unit

Currently active layout.

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.

Sourceval input_device : [< `V1 | `V2 ] t -> device:([ `River_input_device_v1 ], 'a, [ `Server ]) Wayland.Proxy.t -> unit

Corresponding river input device.

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.

Sourceval removed : [< `V1 | `V2 ] t -> unit

The xkb keyboard is removed.

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.

Version 2

Sourceval done_ : [< `V2 ] t -> unit

All information has been sent.

This event is sent after all information about the keyboard has been sent.

This allows changes to one or more river_xkb_keyboard_v1 properties to be seen as atomic, even if they happen via multiple events.

Handlers

Note: Servers will always want to use v1.

Sourceclass virtual +'a v1 : object ... end

Handler for a proxy with version >= 1.

Sourceclass virtual +'a v2 : object ... end

Handler for a proxy with version >= 2.