Struct ZwpTabletV2

pub struct ZwpTabletV2 { /* private fields */ }

Available on crate feature wayland and Linux only.

graphics tablet device

The zwp_tablet_v2 interface represents one graphics tablet device. The tablet interface itself does not generate events; all events are generated by zwp_tablet_tool_v2 objects when in proximity above a tablet.

A tablet has a number of static characteristics, e.g. device name and pid/vid. These capabilities are sent in an event sequence after the zwp_tablet_seat_v2.tablet_added event. This initial event sequence is terminated by a zwp_tablet_v2.done event.

See also the Request enum for this interface.

Implementations

impl ZwpTabletV2

pub fn name(&self, name: String)

tablet device name

A descriptive name for the tablet device.

If the device has no descriptive name, this event is not sent.

This event is sent in the initial burst of events before the zwp_tablet_v2.done event.

pub fn id(&self, vid: u32, pid: u32)

tablet device vendor/product id

The vendor and product IDs for the tablet device.

The interpretation of the id depends on the zwp_tablet_v2.bustype. Prior to version v2 of this protocol, the id was implied to be a USB vendor and product ID. If no zwp_tablet_v2.bustype is sent, the ID is to be interpreted as USB vendor and product ID.

If the device has no vendor/product ID, this event is not sent. This can happen for virtual devices or non-USB devices, for instance.

This event is sent in the initial burst of events before the zwp_tablet_v2.done event.

pub fn path(&self, path: String)

path to the device

A system-specific device path that indicates which device is behind this zwp_tablet_v2. This information may be used to gather additional information about the device, e.g. through libwacom.

A device may have more than one device path. If so, multiple zwp_tablet_v2.path events are sent. A device may be emulated and not have a device path, and in that case this event will not be sent.

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 zwp_tablet_v2.done event.

pub fn done(&self)

tablet description events sequence complete

This event is sent immediately to signal the end of the initial burst of descriptive events. A client may consider the static description of the tablet to be complete and finalize initialization of the tablet.

pub fn removed(&self)

tablet removed event

Sent when the tablet has been removed from the system. When a tablet is removed, some tools may be removed.

When this event is received, the client must zwp_tablet_v2.destroy the object.

pub fn bustype(&self, bustype: Bustype)

tablet device bus type

The bustype argument is one of the BUS_ defines in the Linux kernel’s linux/input.h

If the device has no known bustype or the bustype cannot be queried, this event is not sent.

This event is sent in the initial burst of events before the zwp_tablet_v2.done event.

Trait Implementations

impl Borrow<ObjectId> for ZwpTabletV2

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ZwpTabletV2

fn clone(&self) -> ZwpTabletV2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZwpTabletV2

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

Formats the value using the given formatter.

impl Hash for ZwpTabletV2

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Weak<ZwpTabletV2>> for ZwpTabletV2

fn eq(&self, other: &Weak<ZwpTabletV2>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for ZwpTabletV2

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Resource for ZwpTabletV2

type Request = Request

The request enum for this interface

type Event<'event> = 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>(&self) -> Option<&U>

where U: 'static,

Access the user-data associated with this object

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

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<ZwpTabletV2, InvalidId>

Create an object resource from its ID

fn send_event( &self, evt: <ZwpTabletV2 as Resource>::Event<'_>, ) -> Result<(), InvalidId>

Send an event to this object

fn parse_request( conn: &DisplayHandle, msg: Message<ObjectId, OwnedFd>, ) -> Result<(ZwpTabletV2, <ZwpTabletV2 as Resource>::Request), DispatchError>

Parse a event for this object

fn write_event<'a>( &self, conn: &DisplayHandle, msg: <ZwpTabletV2 as Resource>::Event<'a>, ) -> Result<Message<ObjectId, BorrowedFd<'a>>, InvalidId>

Serialize an event for this object

fn client(&self) -> Option<Client>

The client owning this object

fn is_alive(&self) -> bool

Checks if the Wayland object associated with this proxy is still alive

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

Trigger a protocol error on this object

fn downgrade(&self) -> Weak<Self>

Creates a weak handle to this object

impl Eq for ZwpTabletV2