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/Server/Window_management/River_seat_v1/class-v5/index.html

Class River_seat_v1.v5Source

Handler for a proxy with version >= 5.

constraint 'a = [< `V5 ]
method private virtual on_destroy : [> `V5 ] t -> unit

Destroy the seat object.

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

This request should be made after the river_seat_v1.removed event is received to complete destruction of the seat.

method private virtual on_focus_window : [> `V5 ] t -> window: ([ `River_window_v1 ], [> Imports.River_window_v1.versions ], [ `Server ]) Proxy.t -> unit

Give keyboard focus to a window.

Request that the compositor send keyboard input to the given window.

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

method private virtual on_focus_shell_surface : [> `V5 ] t -> shell_surface: ([ `River_shell_surface_v1 ], [> Imports.River_shell_surface_v1.versions ], [ `Server ]) Proxy.t -> unit

Give keyboard focus to a shell_surface.

Request that the compositor send keyboard input to the given shell surface.

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

method private virtual on_clear_focus : [> `V5 ] t -> unit

Clear keyboard focus.

Request that the compositor not send keyboard input to any client.

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

method private virtual on_op_start_pointer : [> `V5 ] t -> unit

Start an interactive pointer operation.

Start an interactive pointer operation. During the operation, op_delta events will be sent based on pointer input.

When all pointer buttons are released, the op_release event is sent.

The pointer operation continues until the op_end request is made during a manage sequence and that manage sequence is finished.

The window manager may use this operation to implement interactive move/resize of windows by setting the position of windows and proposing dimensions based off of the op_delta events.

This request is ignored if an operation is already in progress.

The compositor must ensure that no client has pointer focus from this seat during the pointer operation. This means that the window manager has control over the pointer's cursor surface/shape during the pointer operation. See the river_seat_v1 description.

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

method private virtual on_op_end : [> `V5 ] t -> unit

End an interactive operation.

End an interactive operation.

This request is ignored if there is no operation in progress.

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

method private virtual on_get_pointer_binding : [> `V5 ] t -> ([ `River_pointer_binding_v1 ], 'a, [ `Server ]) Proxy.t -> button:int32 -> modifiers:Imports.River_seat_v1.Modifiers.t -> unit

Define a new pointer binding.

Define a pointer binding in terms of a pointer button, keyboard modifiers, and other configurable properties.

The button argument is a Linux input event code defined in the linux/input-event-codes.h header file (e.g. BTN_RIGHT).

The new pointer binding is not enabled until initial configuration is completed and the enable request is made during a manage sequence.

method private virtual on_set_xcursor_theme : [> `V5 ] t -> name:string -> size:int32 -> unit

Set the xcursor theme for the seat.

Set the XCursor theme for the seat. This theme is used for cursors rendered by the compositor, but not necessarily for cursors rendered by clients.

Note: The window manager may also wish to set the XCURSOR_THEME and XCURSOR_SIZE environment variable for programs it starts.

method private virtual on_pointer_warp : [> `V5 ] t -> x:int32 -> y:int32 -> unit

Warp the pointer to a given position.

Warp the pointer to the given position in the compositor's logical coordinate space.

If the given position is outside the bounds of all outputs, the pointer will be warped to the closest point inside an output instead.

If an op_start_pointer request is made during the same manage sequence as a pointer_warp request, the warp is applied first by the server regardless of the relative ordering of the two requests.

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

method min_version : int32