package oxbow

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

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (1)

Authors

  1. 3
    3L0C

Maintainers

  1. 3
    3L0C

Sources

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

doc/oxbow.river/River/Obj/Xkb/Bindings/C/River_xkb_binding_v1/index.html

Module C.River_xkb_binding_v1Source

Configure a xkb key binding, receive trigger events.

This object allows the window manager to configure a xkbcommon key binding and receive events when the key binding is triggered.

The new key binding is not enabled until the enable request is made during a manage sequence.

Normally, all key events are sent to the surface with keyboard focus by the compositor. Key events that trigger a key binding are not sent to the surface with keyboard focus.

If multiple key bindings would be triggered by a single physical key event on the compositor side, it is compositor policy which key binding(s) will receive press/release events or if all of the matched key bindings receive press/release events.

Key bindings might be matched by the same physical key event due to shared keysym and modifiers. The layout override feature may also cause the same physical key event to trigger two key bindings with different keysyms and different layout overrides configured.

Sourcetype 'v t = ([ `River_xkb_binding_v1 ], 'v, [ `Client ]) Wayland.Proxy.t

Version 1

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

Disable the key binding.

This request may be used to temporarily disable the key binding. It may be later re-enabled with the enable request.

This request modifies window management state and may only be made as part of a manage sequence, see the river_window_manager_v1 description.

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

Enable the key binding.

This request should be made after all initial configuration has been completed and the window manager wishes the key binding to be able to be triggered.

This request modifies window management state and may only be made as part of a manage sequence, see the river_window_manager_v1 description.

Sourceval set_layout_override : [< `V1 | `V2 | `V3 ] t -> layout:int32 -> unit

Override currently active xkb layout.

Specify an xkb layout that should be used to translate key events for the purpose of triggering this key binding irrespective of the currently active xkb layout.

The layout argument is a 0-indexed xkbcommon layout number for the keyboard that generated the key event.

If this request is never made, the currently active xkb layout of the keyboard that generated the key event will be used.

This request modifies window management state and may only be made as part of a manage sequence, see the river_window_manager_v1 description.

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

Destroy the xkb binding object.

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

Version 2, 3

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.

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

Handler for a proxy with version >= 3.