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/Xkb/Bindings/River_xkb_bindings_seat_v1/index.html

Module Bindings.River_xkb_bindings_seat_v1Source

Xkb bindings seat.

This object manages xkb bindings state associated with a specific seat.

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

Version 2

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

Cancel an ensure_next_key_eaten request.

This requests cancels the effect of the latest ensure_next_key_eaten request if no key has been eaten due to the request yet. This request has no effect if a key has already been eaten or no ensure_next_key_eaten was made.

Rationale: the window manager may wish cancel an uncompleted "chorded" keybinding after a timeout of a few seconds. Note that since this timeout use-case requires the window manager to trigger a manage sequence with the river_window_manager_v1.manage_dirty request it is possible that the ate_unbound_key key event may be sent before the window manager has a chance to make the cancel_ensure_next_key_eaten 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 ensure_next_key_eaten : [< `V2 | `V3 ] t -> unit

Ensure the next key press event is eaten.

Ensure that the next non-modifier key press and corresponding release events for this seat are not sent to the currently focused surface.

If the next non-modifier key press triggers a binding, the pressed/released events are sent to the river_xkb_binding_v1 object as usual.

If the next non-modifier key press does not trigger a binding, the ate_unbound_key event is sent instead.

Rationale: the window manager may wish to implement "chorded" keybindings where triggering a binding activates a "submap" with a different set of keybindings. Without a way to eat the next key press event, there is no good way for the window manager to know that it should error out and exit the submap when a key not bound in the submap is pressed.

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 : [< `V2 | `V3 ] t -> unit

Destroy the object.

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

Version 3

Sourceval modifiers_watch : [< `V3 ] t -> modifiers:int32 -> unit

Watch for change in active modifiers.

Request that the server send the modifiers_update event whenever a state change occurs for at least one of the modifiers specified by the modifiers argument.

The window manager should make this request with the modifiers argument set to 0 when it no longer wishes to take action based on a change in modifiers.

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

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.