Skip to content

zwp_tablet_pad_strip_v2¤

wayland.zwp_tablet_pad_strip_v2 ¤

Pad strip

A linear interaction area, such as the strips found in Wacom Cintiq models.

Events on a strip are logically grouped by the wl_tablet_pad_strip.frame event.

Methods:

source ¤

Strip axis source

Describes the source types for strip events. This indicates to the client how a strip event was physically generated; a client may adjust the user interface accordingly. For example, events from a "finger" source may trigger kinetic scrolling.

events

source ¤

source(source: source) -> None

Strip event source

Source information for strip events.

This event does not occur on its own. It is sent before a wp_tablet_pad_strip.frame event and carries the source information for all events within that frame.

The source specifies how this event was generated. If the source is wp_tablet_pad_strip.source.finger, a wp_tablet_pad_strip.stop event will be sent when the user lifts their finger off the device.

This event is optional. If the source is unknown for an interaction, no event is sent.

Parameters:

  • source ¤

    (source) –

    The event source

position ¤

position(position: int) -> None

Position changed

Sent whenever the position on a strip changes.

The position is normalized to a range of [0, 65535], the 0-value represents the top-most and/or left-most position of the strip in the pad's current rotation.

Parameters:

  • position ¤

    (int) –

    The current position

stop ¤

stop() -> None

Interaction stopped

Stop notification for strip events.

For some wp_tablet_pad_strip.source types, a wp_tablet_pad_strip.stop event is sent to notify a client that the interaction with the strip has terminated. This enables the client to implement kinetic scrolling. See the wp_tablet_pad_strip.source documentation for information on when this event may be generated.

Any wp_tablet_pad_strip.position events with the same source after this event should be considered as the start of a new interaction.

frame ¤

frame(time: int) -> None

End of a strip event sequence

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

All wp_tablet_pad_strip events before a wp_tablet_pad_strip.frame event belong logically together. For example, on termination of a finger interaction on a strip the compositor will send a wp_tablet_pad_strip.source event, a wp_tablet_pad_strip.stop event and a wp_tablet_pad_strip.frame event.

A wp_tablet_pad_strip.frame event is sent for every logical event group, even if the group only contains a single wp_tablet_pad_strip event. Specifically, a client may get a sequence: position, frame, position, 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 strip. This request should be issued immediately after a wp_tablet_pad_group.mode_switch event from the corresponding group is received, or whenever the strip 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 strip, 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 strip. Requests providing other serials than the most recent one will be ignored.

Parameters:

  • description ¤

    (str) –

    Strip description

  • serial ¤

    (int) –

    Serial of the mode switch event

destroy ¤

destroy() -> None

Destroy the strip object

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

on_source ¤

on_source(source: source) -> None

Strip event source.

Override to handle wayland.zwp_tablet_pad_strip_v2.events.source.

on_position ¤

on_position(position: int) -> None

Position changed.

Override to handle wayland.zwp_tablet_pad_strip_v2.events.position.

on_stop ¤

on_stop() -> None

Interaction stopped.

Override to handle wayland.zwp_tablet_pad_strip_v2.events.stop.

on_frame ¤

on_frame(time: int) -> None

End of a strip event sequence.

Override to handle wayland.zwp_tablet_pad_strip_v2.events.frame.