Enum wayland_protocols::wp::tablet::zv2::client::zwp_tablet_pad_v2::Event

#[non_exhaustive]
pub enum Event {
    Group {
        pad_group: ZwpTabletPadGroupV2,
    },
    Path {
        path: String,
    },
    Buttons {
        buttons: u32,
    },
    Done,
    Button {
        time: u32,
        button: u32,
        state: WEnum<ButtonState>,
    },
    Enter {
        serial: u32,
        tablet: ZwpTabletV2,
        surface: WlSurface,
    },
    Leave {
        serial: u32,
        surface: WlSurface,
    },
    Removed,
}

Available on crate features unstable and client only.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Group

Fields

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.

Path

Fields

path: String

path to local device

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.

Buttons

Fields

buttons: u32

the number of buttons

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.

Done

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.

Button

Fields

time: u32

the time of the event with millisecond granularity

button: u32

the index of the button that changed state

state: WEnum<ButtonState>

physical button state

Sent whenever the physical state of a button changes.

Enter

Fields

serial: u32

serial number of the enter event

tablet: ZwpTabletV2

the tablet the pad is attached to

surface: WlSurface

surface the pad is focused on

enter event

Notification that this pad is focused on the specified surface.

Leave

Fields

serial: u32

serial number of the leave event

surface: WlSurface

surface the pad is no longer focused on

leave event

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

Removed

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.

Implementations

impl Event

pub fn opcode(&self) -> u16

Get the opcode number of this message

Trait Implementations

impl Debug for Event

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

Formats the value using the given formatter.