org.freedesktop.wayland.client

Class WlPointerProxy

java.lang.Object

org.freedesktop.wayland.client.Proxy<WlPointerEvents>

org.freedesktop.wayland.client.WlPointerProxy

All Implemented Interfaces:

org.freedesktop.wayland.util.WaylandObject

public class WlPointerProxy
extends Proxy<WlPointerEvents>

pointer input device

The wl_pointer interface represents one or more input devices, such as mice, which control the pointer location and pointer_focus of a seat.

The wl_pointer interface generates motion, enter and leave events for the surfaces that the pointer is located over, and button and axis events for button presses, button releases and scrolling.

Field Summary

Fields

Modifier and Type	Field and Description
static String	INTERFACE_NAME

Fields inherited from class org.freedesktop.wayland.client.Proxy

pointer

Constructor Summary

Constructors

Constructor and Description
WlPointerProxy(long pointer)
WlPointerProxy(long pointer, WlPointerEvents implementation, int version)

Method Summary

Modifier and Type	Method and Description
void	release() release the pointer object
void	setCursor(int serial, WlSurfaceProxy surface, int hotspotX, int hotspotY) set the pointer surface

Methods inherited from class org.freedesktop.wayland.client.Proxy

destroy, equals, getId, getImplementation, getPointer, getVersion, hashCode, marshal, marshal, marshalConstructor, setQueue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

INTERFACE_NAME

public static final String INTERFACE_NAME

See Also:

Constant Field Values

Constructor Detail

WlPointerProxy

public WlPointerProxy(long pointer,
                      WlPointerEvents implementation,
                      int version)

WlPointerProxy

public WlPointerProxy(long pointer)

Method Detail

setCursor

public void setCursor(int serial,
                      @Nullable
                      WlSurfaceProxy surface,
                      int hotspotX,
                      int hotspotY)

set the pointer surface

Set the pointer surface, i.e., the surface that contains the pointer image (cursor). This request gives the surface the role of a cursor. If the surface already has another role, it raises a protocol error.

The cursor actually changes only if the pointer focus for this device is one of the requesting client's surfaces or the surface parameter is the current pointer surface. If there was a previous surface set with this request it is replaced. If surface is NULL, the pointer image is hidden.

The parameters hotspot_x and hotspot_y define the position of the pointer surface relative to the pointer location. Its top-left corner is always at (x, y) - (hotspot_x, hotspot_y), where (x, y) are the coordinates of the pointer location, in surface-local coordinates.

On surface.attach requests to the pointer surface, hotspot_x and hotspot_y are decremented by the x and y parameters passed to the request. Attach must be confirmed by wl_surface.commit as usual.

The hotspot can also be updated by passing the currently set pointer surface to this request with new values for hotspot_x and hotspot_y.

The current and pending input regions of the wl_surface are cleared, and wl_surface.set_input_region is ignored until the wl_surface is no longer used as the cursor. When the use as a cursor ends, the current and pending input regions become undefined, and the wl_surface is unmapped.

Parameters:

serial - serial number of the enter event

surface - pointer surface

hotspotX - surface-local x coordinate

hotspotY - surface-local y coordinate

release

public void release()

release the pointer object

Using this request a client can tell the server that it is not going to use the pointer object anymore.

This request destroys the pointer proxy object, so clients must not call wl_pointer_destroy() after using this request.