Skip to content

zwp_tablet_pad_dial_v2¤

wayland.zwp_tablet_pad_dial_v2 ¤

Pad dial

A rotary control, e.g. a dial or a wheel.

Events on a dial are logically grouped by the wl_tablet_pad_dial.frame event.

Methods:

events

delta ¤

delta(value120: int) -> None

Delta movement

Sent whenever the position on a dial changes.

This event carries the wheel delta as multiples or fractions of 120 with each multiple of 120 representing one logical wheel detent. For example, an axis_value120 of 30 is one quarter of a logical wheel step in the positive direction, a value120 of -240 are two logical wheel steps in the negative direction within the same hardware event. See the wl_pointer.axis_value120 for more details.

The value120 must not be zero.

Parameters:

  • value120 ¤

    (int) –

    Rotation distance as fraction of 120

frame ¤

frame(time: int) -> None

End of a dial event sequence

Indicates the end of a set of events that represent one logical hardware dial event. A client is expected to accumulate the data in all events within the frame before proceeding.

All wp_tablet_pad_dial events before a wp_tablet_pad_dial.frame event belong logically together.

A wp_tablet_pad_dial.frame event is sent for every logical event group, even if the group only contains a single wp_tablet_pad_dial event. Specifically, a client may get a sequence: delta, frame, delta, frame, etc.

Parameters:

  • time ¤

    (int) –

    Timestamp with millisecond granularity

set_feedback ¤

set_feedback(description: str, serial: int) -> None

Set compositor feedback

Requests the compositor to use the provided feedback string associated with this dial. This request should be issued immediately after a wp_tablet_pad_group.mode_switch event from the corresponding group is received, or whenever the dial 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 dial, and 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 dial. Requests providing other serials than the most recent one will be ignored.

Parameters:

  • description ¤

    (str) –

    Dial description

  • serial ¤

    (int) –

    Serial of the mode switch event

destroy ¤

destroy() -> None

Destroy the dial object

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

on_delta ¤

on_delta(value120: int) -> None

Delta movement.

Override to handle wayland.zwp_tablet_pad_dial_v2.events.delta.

on_frame ¤

on_frame(time: int) -> None

End of a dial event sequence.

Override to handle wayland.zwp_tablet_pad_dial_v2.events.frame.