Package org.freedesktop.wayland.client

Interface ZwpTabletPadV2Events

public interface ZwpTabletPadV2Events

a set of buttons, rings and strips

A pad device is a set of buttons, rings and strips usually physically present on the tablet device itself. Some exceptions exist where the pad device is physically detached, e.g. the Wacom ExpressKey Remote.

Pad devices have no axes that control the cursor and are generally auxiliary devices to the tool devices used on the tablet surface.

A pad device has a number of static characteristics, e.g. the number of rings. These capabilities are sent in an event sequence after the wp_tablet_seat.pad_added event before any actual events from this pad. This initial event sequence is terminated by a wp_tablet_pad.done event.

All pad features (buttons, rings and strips) are logically divided into groups and all pads have at least one group. The available groups are notified through the wp_tablet_pad.group event; the compositor will emit one event per group before emitting wp_tablet_pad.done.

Groups may have multiple modes. Modes allow clients to map multiple actions to a single pad feature. Only one mode can be active per group, although different groups may have different active modes.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VERSION

Method Summary

Modifier and Type	Method	Description
void	button(ZwpTabletPadV2Proxy emitter, int time, int button, int state)	physical button state
void	buttons(ZwpTabletPadV2Proxy emitter, int buttons)	buttons announced
void	done(ZwpTabletPadV2Proxy emitter)	pad description event sequence complete
void	enter(ZwpTabletPadV2Proxy emitter, int serial, ZwpTabletV2Proxy tablet, WlSurfaceProxy surface)	enter event
void	group(ZwpTabletPadV2Proxy emitter, ZwpTabletPadGroupV2Proxy padGroup)	group announced
void	leave(ZwpTabletPadV2Proxy emitter, int serial, WlSurfaceProxy surface)	leave event
void	path(ZwpTabletPadV2Proxy emitter, String path)	path to the device
void	removed(ZwpTabletPadV2Proxy emitter)	pad removed event

Field Details

VERSION

static final int VERSION

See Also:

• Constant Field Values

Method Details

group

void group(ZwpTabletPadV2Proxy emitter,
 @Nonnull
 ZwpTabletPadGroupV2Proxy padGroup)

group announced

Sent on wp_tablet_pad initialization to announce available groups. One event is sent for each pad group available.

This event is sent in the initial burst of events before the wp_tablet_pad.done event. At least one group will be announced.

Parameters:

emitter - The protocol object that emitted the event.

padGroup -

path

void path(ZwpTabletPadV2Proxy emitter,
 @Nonnull
 String path)

path to the device

A system-specific device path that indicates which device is behind this wp_tablet_pad. This information may be used to gather additional information about the device, e.g. through libwacom.

The format of the path is unspecified, it may be a device node, a sysfs path, or some other identifier. It is up to the client to identify the string provided.

This event is sent in the initial burst of events before the wp_tablet_pad.done event.

Parameters:

emitter - The protocol object that emitted the event.

path - path to local device

buttons

void buttons(ZwpTabletPadV2Proxy emitter,
 int buttons)

buttons announced

Sent on wp_tablet_pad initialization to announce the available buttons.

This event is sent in the initial burst of events before the wp_tablet_pad.done event. This event is only sent when at least one button is available.

Parameters:

emitter - The protocol object that emitted the event.

buttons - the number of buttons

done

void done(ZwpTabletPadV2Proxy emitter)

pad description event sequence complete

This event signals the end of the initial burst of descriptive events. A client may consider the static description of the pad to be complete and finalize initialization of the pad.

Parameters:

emitter - The protocol object that emitted the event.

button

void button(ZwpTabletPadV2Proxy emitter,
 int time,
 int button,
 int state)

physical button state

Sent whenever the physical state of a button changes.

Parameters:

emitter - The protocol object that emitted the event.

time - the time of the event with millisecond granularity

button - the index of the button that changed state

state -

enter

void enter(ZwpTabletPadV2Proxy emitter,
 int serial,
 @Nonnull
 ZwpTabletV2Proxy tablet,
 @Nonnull
 WlSurfaceProxy surface)

enter event

Notification that this pad is focused on the specified surface.

Parameters:

emitter - The protocol object that emitted the event.

serial - serial number of the enter event

tablet - the tablet the pad is attached to

surface - surface the pad is focused on

leave

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

leave event

Notification that this pad is no longer focused on the specified surface.

Parameters:

emitter - The protocol object that emitted the event.

serial - serial number of the leave event

surface - surface the pad is no longer focused on

removed

void removed(ZwpTabletPadV2Proxy emitter)

pad removed event

Sent when the pad has been removed from the system. When a tablet is removed its pad(s) will be removed too.

When this event is received, the client must destroy all rings, strips and groups that were offered by this pad, and issue wp_tablet_pad.destroy the pad itself.

Parameters:

emitter - The protocol object that emitted the event.