Struct wayland_protocols::wp::tablet::zv2::server::zwp_tablet_pad_v2::ZwpTabletPadV2

pub struct ZwpTabletPadV2 { /* private fields */ }

Available on crate features unstable and server only.

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.

See also the Request enum for this interface.

Implementations

impl ZwpTabletPadV2

pub fn group(&self, pad_group: &ZwpTabletPadGroupV2)

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.

pub fn path(&self, path: String)

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.

pub fn buttons(&self, buttons: u32)

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.

pub fn done(&self)

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.

pub fn button(&self, time: u32, button: u32, state: ButtonState)

physical button state

Sent whenever the physical state of a button changes.

pub fn enter(&self, serial: u32, tablet: &ZwpTabletV2, surface: &WlSurface)

enter event

Notification that this pad is focused on the specified surface.

pub fn leave(&self, serial: u32, surface: &WlSurface)

enter event

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

pub fn removed(&self)

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.

Trait Implementations

impl Clone for ZwpTabletPadV2

fn clone(&self) -> ZwpTabletPadV2

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ZwpTabletPadV2

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<ZwpTabletPadV2> for ZwpTabletPadV2

fn eq(&self, other: &ZwpTabletPadV2) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Resource for ZwpTabletPadV2

type Request = Request

The request enum for this interface

type Event = Event

The event enum for this interface

fn interface() -> &'static Interface

The interface description

fn id(&self) -> ObjectId

The ID of this object

fn version(&self) -> u32

The version of this object

fn data<U: 'static>(&self) -> Option<&U>

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn Any + Send + Sync>>

Access the raw data associated with this object.

fn handle(&self) -> &WeakHandle

Access the backend handle associated with this object

fn from_id(conn: &DisplayHandle, id: ObjectId) -> Result<Self, InvalidId>

Create an object resource from its ID

fn send_event(&self, evt: Self::Event) -> Result<(), InvalidId>

Send an event to this object

fn parse_request(
    conn: &DisplayHandle,
    msg: Message<ObjectId>
) -> Result<(Self, Self::Request), DispatchError>

Parse a event for this object

fn write_event(
    &self,
    conn: &DisplayHandle,
    msg: Self::Event
) -> Result<Message<ObjectId>, InvalidId>

Serialize an event for this object

fn client_id(&self) -> Option<ClientId>

The ID of the client owning this object

fn post_error(&self, code: impl Into<u32>, error: impl Into<String>)

Trigger a protocol error on this object

impl Eq for ZwpTabletPadV2