Package org.freedesktop.wayland.client

Interface WlPointerEvents

All Known Subinterfaces:

WlPointerEventsV2, WlPointerEventsV3, WlPointerEventsV4, WlPointerEventsV5, WlPointerEventsV6, WlPointerEventsV7, WlPointerEventsV8, WlPointerEventsV9

All Known Implementing Classes:

Window

public interface 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	Description
static final int	VERSION

Method Summary

Modifier and Type	Method	Description
void	axis(WlPointerProxy emitter, int time, int axis, Fixed value)	axis event
void	button(WlPointerProxy emitter, int serial, int time, int button, int state)	pointer button event
void	enter(WlPointerProxy emitter, int serial, WlSurfaceProxy surface, Fixed surfaceX, Fixed surfaceY)	enter event
void	leave(WlPointerProxy emitter, int serial, WlSurfaceProxy surface)	leave event
void	motion(WlPointerProxy emitter, int time, Fixed surfaceX, Fixed surfaceY)	pointer motion event

Field Details

VERSION

static final int VERSION

See Also:

• Constant Field Values

Method Details

enter

void enter(WlPointerProxy emitter,
 int serial,
 @Nonnull
 WlSurfaceProxy surface,
 @Nonnull
 Fixed surfaceX,
 @Nonnull
 Fixed surfaceY)

enter event

Notification that this seat's pointer is focused on a certain surface.

When a seat's focus enters a surface, the pointer image is undefined and a client should respond to this event by setting an appropriate pointer image with the set_cursor request.

Parameters:

emitter - The protocol object that emitted the event.

serial - serial number of the enter event

surface - surface entered by the pointer

surfaceX - surface-local x coordinate

surfaceY - surface-local y coordinate

leave

void leave(WlPointerProxy emitter,
 int serial,
 @Nonnull
 WlSurfaceProxy surface)

leave event

Notification that this seat's pointer is no longer focused on a certain surface.

The leave notification is sent before the enter notification for the new focus.

Parameters:

emitter - The protocol object that emitted the event.

serial - serial number of the leave event

surface - surface left by the pointer

motion

void motion(WlPointerProxy emitter,
 int time,
 @Nonnull
 Fixed surfaceX,
 @Nonnull
 Fixed surfaceY)

pointer motion event

Notification of pointer location change. The arguments surface_x and surface_y are the location relative to the focused surface.

Parameters:

emitter - The protocol object that emitted the event.

time - timestamp with millisecond granularity

surfaceX - surface-local x coordinate

surfaceY - surface-local y coordinate

button

void button(WlPointerProxy emitter,
 int serial,
 int time,
 int button,
 int state)

pointer button event

Mouse button click and release notifications.

The location of the click is given by the last motion or enter event. The time argument is a timestamp with millisecond granularity, with an undefined base.

The button is a button code as defined in the Linux kernel's linux/input-event-codes.h header file, e.g. BTN_LEFT.

Any 16-bit button code value is reserved for future additions to the kernel's event code list. All other button codes above 0xFFFF are currently undefined but may be used in future versions of this protocol.

Parameters:

emitter - The protocol object that emitted the event.

serial - serial number of the button event

time - timestamp with millisecond granularity

button - button that produced the event

state - physical state of the button

axis

void axis(WlPointerProxy emitter,
 int time,
 int axis,
 @Nonnull
 Fixed value)

axis event

Scroll and other axis notifications.

For scroll events (vertical and horizontal scroll axes), the value parameter is the length of a vector along the specified axis in a coordinate space identical to those of motion events, representing a relative movement along the specified axis.

For devices that support movements non-parallel to axes multiple axis events will be emitted.

When applicable, for example for touch pads, the server can choose to emit scroll events where the motion vector is equivalent to a motion event vector.

When applicable, a client can transform its content relative to the scroll distance.

Parameters:

emitter - The protocol object that emitted the event.

time - timestamp with millisecond granularity

axis - axis type

value - length of vector in surface-local coordinate space