package oxbow

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Version 1
Version 2
Handlers

Dynamic window manager for the river Wayland compositor

Install

dune-project

Dependency

github.com Readme Edit opam file Versions (1)

Authors

3

3L0C

Maintainers

3

3L0C

Sources

md5=a637acaa0e19046cd65fff733874eb97

sha512=76230cbecd7510de7a05b5d1f335915ef7b6c4aa557d8dbfd23591606618d2cfa25082d17b93f2f4b53a118d1cbf6a80e4ad51cf0f099b4921fb83d6df0c9801

doc/oxbow.river/River/Input/Config/River_libinput_device_v1/index.html

Module `Config.River_libinput_device_v1`Source

A libinput device.

In general, *_support events will be sent exactly once directly after the river_libinput_device_v1 is created. *_default events will be sent after *_support events if the config option is supported, and *_current events willl be sent after the *_default events and again whenever the config option is changed.

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

Sourcemodule Error : sig ... end

Sourcemodule Send_events_modes : sig ... end

Sourcemodule Tap_state : sig ... end

Sourcemodule Tap_button_map : sig ... end

Sourcemodule Drag_state : sig ... end

Sourcemodule Drag_lock_state : sig ... end

Sourcemodule Three_finger_drag_state : sig ... end

Sourcemodule Accel_profile : sig ... end

Sourcemodule Accel_profiles : sig ... end

Sourcemodule Natural_scroll_state : sig ... end

Sourcemodule Left_handed_state : sig ... end

Sourcemodule Click_method : sig ... end

Sourcemodule Click_methods : sig ... end

Sourcemodule Clickfinger_button_map : sig ... end

Sourcemodule Middle_emulation_state : sig ... end

Sourcemodule Scroll_method : sig ... end

Sourcemodule Scroll_methods : sig ... end

Sourcemodule Scroll_button_lock_state : sig ... end

Sourcemodule Dwt_state : sig ... end

Sourcemodule Dwtp_state : sig ... end

Version 1

val set_rotation : 
  ([< `V1 | `V2 ] as 'a) t ->
  [[ `River_libinput_result_v1 ], 'a, [ `Client ]] Wayland.Proxy.Handler.t ->
  angle:int32 ->
  ([ `River_libinput_result_v1 ], 'a, [ `Client ]) Wayland.Proxy.t

Set rotation angle.

Set rotation angle in degrees clockwise off the logical neutral position. Angle must be in the range 0-360).

val set_dwtp : 
  ([< `V1 | `V2 ] as 'a) t ->
  [[ `River_libinput_result_v1 ], 'a, [ `Client ]] Wayland.Proxy.Handler.t ->
  state:Imports.River_libinput_device_v1.Dwtp_state.t ->
  ([ `River_libinput_result_v1 ], 'a, [ `Client ]) Wayland.Proxy.t

Set disable-while-trackpointing state.

Set disable-while-trackpointing state.

val set_dwt : 
  ([< `V1 | `V2 ] as 'a) t ->
  [[ `River_libinput_result_v1 ], 'a, [ `Client ]] Wayland.Proxy.Handler.t ->
  state:Imports.River_libinput_device_v1.Dwt_state.t ->
  ([ `River_libinput_result_v1 ], 'a, [ `Client ]) Wayland.Proxy.t

Set disable-while-typing state.

Set disable-while-typing state.

val set_scroll_button_lock : 
  ([< `V1 | `V2 ] as 'a) t ->
  [[ `River_libinput_result_v1 ], 'a, [ `Client ]] Wayland.Proxy.Handler.t ->
  state:Imports.River_libinput_device_v1.Scroll_button_lock_state.t ->
  ([ `River_libinput_result_v1 ], 'a, [ `Client ]) Wayland.Proxy.t

Set scroll button lock state.

Set scroll button lock state. Supported if scroll_methods.on_button_down is supported.

val set_scroll_button : 
  ([< `V1 | `V2 ] as 'a) t ->
  [[ `River_libinput_result_v1 ], 'a, [ `Client ]] Wayland.Proxy.Handler.t ->
  button:int32 ->
  ([ `River_libinput_result_v1 ], 'a, [ `Client ]) Wayland.Proxy.t

Set scroll button.

Set scroll button. Supported if scroll_methods.on_button_down is supported.

val set_scroll_method : 
  ([< `V1 | `V2 ] as 'a) t ->
  [[ `River_libinput_result_v1 ], 'a, [ `Client ]] Wayland.Proxy.Handler.t ->
  method_:Imports.River_libinput_device_v1.Scroll_method.t ->
  ([ `River_libinput_result_v1 ], 'a, [ `Client ]) Wayland.Proxy.t

Set scroll method.

Set scroll method.

val set_middle_emulation : 
  ([< `V1 | `V2 ] as 'a) t ->
  [[ `River_libinput_result_v1 ], 'a, [ `Client ]] Wayland.Proxy.Handler.t ->
  state:Imports.River_libinput_device_v1.Middle_emulation_state.t ->
  ([ `River_libinput_result_v1 ], 'a, [ `Client ]) Wayland.Proxy.t

Set middle mouse button emulation state.

Set middle mouse button emulation state.

val set_clickfinger_button_map : 
  ([< `V1 | `V2 ] as 'a) t ->
  [[ `River_libinput_result_v1 ], 'a, [ `Client ]] Wayland.Proxy.Handler.t ->
  button_map:Imports.River_libinput_device_v1.Clickfinger_button_map.t ->
  ([ `River_libinput_result_v1 ], 'a, [ `Client ]) Wayland.Proxy.t

Set clickfinger button map.

Set clickfinger button map. Supported if click_methods.clickfinger is supported.

val set_click_method : 
  ([< `V1 | `V2 ] as 'a) t ->
  [[ `River_libinput_result_v1 ], 'a, [ `Client ]] Wayland.Proxy.Handler.t ->
  method_:Imports.River_libinput_device_v1.Click_method.t ->
  ([ `River_libinput_result_v1 ], 'a, [ `Client ]) Wayland.Proxy.t

Set click method.

Set click method.

val set_left_handed : 
  ([< `V1 | `V2 ] as 'a) t ->
  [[ `River_libinput_result_v1 ], 'a, [ `Client ]] Wayland.Proxy.Handler.t ->
  state:Imports.River_libinput_device_v1.Left_handed_state.t ->
  ([ `River_libinput_result_v1 ], 'a, [ `Client ]) Wayland.Proxy.t

Set left-handed mode state.

Set left-handed mode state.

val set_natural_scroll : 
  ([< `V1 | `V2 ] as 'a) t ->
  [[ `River_libinput_result_v1 ], 'a, [ `Client ]] Wayland.Proxy.Handler.t ->
  state:Imports.River_libinput_device_v1.Natural_scroll_state.t ->
  ([ `River_libinput_result_v1 ], 'a, [ `Client ]) Wayland.Proxy.t

Set natural scroll state.

Set natural scroll state.

val apply_accel_config : 
  ([< `V1 | `V2 ] as 'a) t ->
  [[ `River_libinput_result_v1 ], 'a, [ `Client ]] Wayland.Proxy.Handler.t ->
  config:([ `River_libinput_accel_config_v1 ], 'b, [ `Client ]) Wayland.Proxy.t ->
  ([ `River_libinput_result_v1 ], 'a, [ `Client ]) Wayland.Proxy.t

Apply acceleration config.

Apply a pointer accleration config.

val set_accel_speed : 
  ([< `V1 | `V2 ] as 'a) t ->
  [[ `River_libinput_result_v1 ], 'a, [ `Client ]] Wayland.Proxy.Handler.t ->
  speed:string ->
  ([ `River_libinput_result_v1 ], 'a, [ `Client ]) Wayland.Proxy.t

Set acceleration speed.

Set the acceleration speed within a range of -1, 1, where 0 is the default acceleration for this device, -1 is the slowest acceleration and 1 is the maximum acceleration available on this device.

val set_accel_profile : 
  ([< `V1 | `V2 ] as 'a) t ->
  [[ `River_libinput_result_v1 ], 'a, [ `Client ]] Wayland.Proxy.Handler.t ->
  profile:Imports.River_libinput_device_v1.Accel_profile.t ->
  ([ `River_libinput_result_v1 ], 'a, [ `Client ]) Wayland.Proxy.t

Set acceleration profile.

Set the acceleration profile.

val set_calibration_matrix : 
  ([< `V1 | `V2 ] as 'a) t ->
  [[ `River_libinput_result_v1 ], 'a, [ `Client ]] Wayland.Proxy.Handler.t ->
  matrix:string ->
  ([ `River_libinput_result_v1 ], 'a, [ `Client ]) Wayland.Proxy.t

Set calibration matrix.

Set calibration matrix.

val set_three_finger_drag : 
  ([< `V1 | `V2 ] as 'a) t ->
  [[ `River_libinput_result_v1 ], 'a, [ `Client ]] Wayland.Proxy.Handler.t ->
  state:Imports.River_libinput_device_v1.Three_finger_drag_state.t ->
  ([ `River_libinput_result_v1 ], 'a, [ `Client ]) Wayland.Proxy.t

Set three finger drag state.

Configure three finger drag functionality for the device.

val set_drag_lock : 
  ([< `V1 | `V2 ] as 'a) t ->
  [[ `River_libinput_result_v1 ], 'a, [ `Client ]] Wayland.Proxy.Handler.t ->
  state:Imports.River_libinput_device_v1.Drag_lock_state.t ->
  ([ `River_libinput_result_v1 ], 'a, [ `Client ]) Wayland.Proxy.t

Set drag lock state.

Configure drag-lock during tapping on this device. When enabled, a finger may be lifted and put back on the touchpad and the drag process continues. A timeout for lifting the finger is optional. When disabled, lifting the finger during a tap-and-drag will immediately stop the drag. See the libinput documentation for more details.

val set_drag : 
  ([< `V1 | `V2 ] as 'a) t ->
  [[ `River_libinput_result_v1 ], 'a, [ `Client ]] Wayland.Proxy.Handler.t ->
  state:Imports.River_libinput_device_v1.Drag_state.t ->
  ([ `River_libinput_result_v1 ], 'a, [ `Client ]) Wayland.Proxy.t

Set tap-and-drag state.

Configure tap-and-drag functionality on the device.

val set_tap_button_map : 
  ([< `V1 | `V2 ] as 'a) t ->
  [[ `River_libinput_result_v1 ], 'a, [ `Client ]] Wayland.Proxy.Handler.t ->
  button_map:Imports.River_libinput_device_v1.Tap_button_map.t ->
  ([ `River_libinput_result_v1 ], 'a, [ `Client ]) Wayland.Proxy.t

Set tap-to-click button map.

Set the finger number to button number mapping for tap-to-click. The default mapping on most devices is to have a 1, 2 and 3 finger tap to map to the left, right and middle button, respectively.

val set_tap : 
  ([< `V1 | `V2 ] as 'a) t ->
  [[ `River_libinput_result_v1 ], 'a, [ `Client ]] Wayland.Proxy.Handler.t ->
  state:Imports.River_libinput_device_v1.Tap_state.t ->
  ([ `River_libinput_result_v1 ], 'a, [ `Client ]) Wayland.Proxy.t

Enable/disable tap-to-click.

Configure tap-to-click on this device, with a default mapping of 1, 2, 3 finger tap mapping to left, right, middle click, respectively.

val set_send_events : 
  ([< `V1 | `V2 ] as 'a) t ->
  [[ `River_libinput_result_v1 ], 'a, [ `Client ]] Wayland.Proxy.Handler.t ->
  mode:int32 ->
  ([ `River_libinput_result_v1 ], 'a, [ `Client ]) Wayland.Proxy.t

Set send events mode.

Set the send events mode for the device.

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

Destroy the libinput device object.

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

Version 2

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.

On This Page

Version 1
Version 2
Handlers