Module Pointer_constraints_unstable_v1_server.Zwp_confined_pointer_v1

Confined pointer object.

The wp_confined_pointer interface represents a confined pointer state.

This object will send the event 'confined' when the confinement is activated. Whenever the confinement is activated, it is guaranteed that the surface the pointer is confined to will already have received pointer focus and that the pointer will be within the region passed to the request creating this object. It is up to the compositor to decide whether this requires some user interaction and if the pointer will warp to within the passed region if outside.

To unconfine the pointer, send the destroy request. This will also destroy the wp_confined_pointer object.

If the compositor decides to unconfine the pointer the unconfined event is sent. The wp_confined_pointer object is at this point defunct and should be destroyed.

type 'v t = ([ `Zwp_confined_pointer_v1 ], 'v, [ `Server ]) Wayland.Proxy.t

Version 1

val unconfined : [< `V1 ] t -> unit

Pointer unconfined.

Notification that the pointer confinement of the seat's pointer is no longer active. If this is a oneshot pointer confinement (see wp_pointer_constraints.lifetime) this object is now defunct and should be destroyed. If this is a persistent pointer confinement (see wp_pointer_constraints.lifetime) this pointer confinement may again reactivate in the future.

val confined : [< `V1 ] t -> unit

Pointer confined.

Notification that the pointer confinement of the seat's pointer is activated.

Handlers

Note: Servers will always want to use v1.

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

Handler for a proxy with version >= 1.