Package org.freedesktop.wayland.server

Interface ZwpTabletPadRingV2Requests

public interface ZwpTabletPadRingV2Requests

pad ring

A circular interaction area, such as the touch ring on the Wacom Intuos Pro series tablets.

Events on a ring are logically grouped by the wl_tablet_pad_ring.frame event.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VERSION

Method Summary

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

Field Details

VERSION

static final int VERSION

See Also:

• Constant Field Values

Method Details

setFeedback

void setFeedback(ZwpTabletPadRingV2Resource requester,
 @Nonnull
 String description,
 int serial)

set compositor feedback

Request that the compositor use the provided feedback string associated with this ring. This request should be issued immediately after a wp_tablet_pad_group.mode_switch event from the corresponding group is received, or whenever the ring 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 the ring; compositors may use this information to offer visual feedback about the button layout (eg. on-screen displays).

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 ring. Requests providing other serials than the most recent one will be ignored.

Parameters:

requester - The protocol object that made the request.

description - ring description

serial - serial of the mode switch event

destroy

void destroy(ZwpTabletPadRingV2Resource requester)

destroy the ring object

This destroys the client's resource for this ring object.

Parameters:

requester - The protocol object that made the request.