Enum wayland_protocols::unstable::tablet::v2::client::zwp_tablet_pad_v2::Event

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

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

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.

Fields of Group

pad_group: Main<ZwpTabletPadGroupV2>

Path

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.

Fields of Path

path: String

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.

Fields of Buttons

buttons: u32

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

physical button state

Sent whenever the physical state of a button changes.

Fields of Button

time: u32button: u32state: ButtonState

Enter

enter event

Notification that this pad is focused on the specified surface.

Fields of Enter

serial: u32tablet: ZwpTabletV2surface: WlSurface

Leave

enter event

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

Fields of Leave

serial: u32surface: WlSurface

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.

Trait Implementations

impl Debug for Event

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

Formats the value using the given formatter.

impl MessageGroup for Event

const MESSAGES: &'static [MessageDesc]

Wire representation of this MessageGroup

type Map = ProxyMap

The wrapper type for ObjectMap allowing the mapping of Object and NewId arguments to the object map during parsing.

fn is_destructor(&self) -> bool

Whether this message is a destructor

fn opcode(&self) -> u16

The opcode of this message

fn since(&self) -> u32

The minimal object version for which this message exists

fn child<Meta: ObjectMetadata>(
    opcode: u16,
    version: u32,
    meta: &Meta
) -> Option<Object<Meta>>

Retrieve the child Object associated with this message if any

fn from_raw(msg: Message, map: &mut Self::Map) -> Result<Self, ()>

Construct a message from its raw representation

fn into_raw(self, sender_id: u32) -> Message

Turn this message into its raw representation

unsafe fn from_raw_c(
    obj: *mut c_void,
    opcode: u32,
    args: *const wl_argument
) -> Result<Event, ()>

Construct a message of this group from its C representation

fn as_raw_c_in<F, T>(self, f: F) -> T where
    F: FnOnce(u32, &mut [wl_argument]) -> T, 

Build a C representation of this message