Package org.freedesktop.wayland.client

Class ZwpTabletPadV2Proxy

java.lang.Object

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

org.freedesktop.wayland.client.ZwpTabletPadV2Proxy

All Implemented Interfaces:

WaylandObject

public class ZwpTabletPadV2Proxy
extends Proxy<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 String	INTERFACE_NAME

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

pointer

Constructor Summary

Constructors

Constructor	Description
ZwpTabletPadV2Proxy(MemorySegment pointer)
ZwpTabletPadV2Proxy(MemorySegment pointer, ZwpTabletPadV2Events implementation, int version)

Method Summary

Modifier and Type	Method	Description
void	destroy()	destroy the pad object
void	setFeedback(int button, String description, int serial)	set compositor feedback

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

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 Details

INTERFACE_NAME

public static final String INTERFACE_NAME

See Also:

• Constant Field Values

Constructor Details

ZwpTabletPadV2Proxy

public ZwpTabletPadV2Proxy(MemorySegment pointer,
 ZwpTabletPadV2Events implementation,
 int version)

ZwpTabletPadV2Proxy

public ZwpTabletPadV2Proxy(MemorySegment pointer)

Method Details

setFeedback

public void setFeedback(int button,
 @Nonnull
 String description,
 int serial)

set compositor feedback

Requests the compositor to use the provided feedback string associated with this button. This request should be issued immediately after a wp_tablet_pad_group.mode_switch event from the corresponding group is received, or whenever a button is mapped to a different action. See wp_tablet_pad_group.mode_switch for more details.

Clients are encouraged to provide context-aware descriptions for the actions associated with each button, and compositors may use this information to offer visual feedback on the button layout (e.g. on-screen displays).

Button indices start at 0. Setting the feedback string on a button that is reserved by the compositor (i.e. not belonging to any wp_tablet_pad_group) does not generate an error but the compositor is free to ignore the request.

The provided string 'description' is a UTF-8 encoded string to be associated with this ring, and is considered user-visible; general internationalization rules apply.

The serial argument will be that of the last wp_tablet_pad_group.mode_switch event received for the group of this button. Requests providing other serials than the most recent one will be ignored.

Parameters:

button - button index

description - button description

serial - serial of the mode switch event

destroy

public void destroy()

destroy the pad object

Destroy the wp_tablet_pad object. Objects created from this object are unaffected and should be destroyed separately.

Overrides:

destroy in class Proxy<ZwpTabletPadV2Events>