Struct ZwpTabletPadGroupV2

pub struct ZwpTabletPadGroupV2 { /* private fields */ }

Available on crate feature wayland and Linux only.

a set of buttons, rings and strips

A pad group describes a distinct (sub)set of buttons, rings and strips present in the tablet. The criteria of this grouping is usually positional, eg. if a tablet has buttons on the left and right side, 2 groups will be presented. The physical arrangement of groups is undisclosed and may change on the fly.

Pad groups will announce their features during pad initialization. Between the corresponding zwp_tablet_pad_v2.group event and zwp_tablet_pad_group_v2.done, the pad group will announce the buttons, rings and strips contained in it, plus the number of supported modes.

Modes are a mechanism to allow multiple groups of actions for every element in the pad group. The number of groups and available modes in each is persistent across device plugs. The current mode is user-switchable, it will be announced through the zwp_tablet_pad_group_v2.mode_switch event both whenever it is switched, and after zwp_tablet_pad_v2.enter.

The current mode logically applies to all elements in the pad group, although it is at clients’ discretion whether to actually perform different actions, and/or issue the respective .set_feedback requests to notify the compositor. See the zwp_tablet_pad_group_v2.mode_switch event for more details.

See also the Request enum for this interface.

Implementations

impl ZwpTabletPadGroupV2

pub fn buttons(&self, buttons: Vec<u8>)

buttons announced

Sent on zwp_tablet_pad_group_v2 initialization to announce the available buttons in the group. Button indices start at 0, a button may only be in one group at a time.

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

Some buttons are reserved by the compositor. These buttons may not be assigned to any zwp_tablet_pad_group_v2. Compositors may broadcast this event in the case of changes to the mapping of these reserved buttons. If the compositor happens to reserve all buttons in a group, this event will be sent with an empty array.

pub fn ring(&self, ring: &ZwpTabletPadRingV2)

ring announced

Sent on zwp_tablet_pad_group_v2 initialization to announce available rings. One event is sent for each ring available on this pad group.

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

pub fn strip(&self, strip: &ZwpTabletPadStripV2)

strip announced

Sent on zwp_tablet_pad_v2 initialization to announce available strips. One event is sent for each strip available on this pad group.

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

pub fn modes(&self, modes: u32)

mode-switch ability announced

Sent on zwp_tablet_pad_group_v2 initialization to announce that the pad group may switch between modes. A client may use a mode to store a specific configuration for buttons, rings and strips and use the zwp_tablet_pad_group_v2.mode_switch event to toggle between these configurations. Mode indices start at 0.

Switching modes is compositor-dependent. See the zwp_tablet_pad_group_v2.mode_switch event for more details.

This event is sent in the initial burst of events before the zwp_tablet_pad_group_v2.done event. This event is only sent when more than more than one mode is available.

pub fn done(&self)

tablet group 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 group.

pub fn mode_switch(&self, time: u32, serial: u32, mode: u32)

mode switch event

Notification that the mode was switched.

A mode applies to all buttons, rings, strips and dials in a group simultaneously, but a client is not required to assign different actions for each mode. For example, a client may have mode-specific button mappings but map the ring to vertical scrolling in all modes. Mode indices start at 0.

Switching modes is compositor-dependent. The compositor may provide visual cues to the user about the mode, e.g. by toggling LEDs on the tablet device. Mode-switching may be software-controlled or controlled by one or more physical buttons. For example, on a Wacom Intuos Pro, the button inside the ring may be assigned to switch between modes.

The compositor will also send this event after zwp_tablet_pad_v2.enter on each group in order to notify of the current mode. Groups that only feature one mode will use mode=0 when emitting this event.

If a button action in the new mode differs from the action in the previous mode, the client should immediately issue a zwp_tablet_pad_v2.set_feedback request for each changed button.

If a ring, strip or dial action in the new mode differs from the action in the previous mode, the client should immediately issue a zwp_tablet_ring_v2.set_feedback, zwp_tablet_strip_v2.set_feedback or zwp_tablet_dial_v2.set_feedback request for each changed ring, strip or dial.

pub fn dial(&self, dial: &ZwpTabletPadDialV2)

dial announced

Sent on zwp_tablet_pad_v2 initialization to announce available dials. One event is sent for each dial available on this pad group.

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

Trait Implementations

impl Borrow<ObjectId> for ZwpTabletPadGroupV2

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ZwpTabletPadGroupV2

fn clone(&self) -> ZwpTabletPadGroupV2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZwpTabletPadGroupV2

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

Formats the value using the given formatter.

impl Hash for ZwpTabletPadGroupV2

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<ZwpTabletPadGroupV2>> for ZwpTabletPadGroupV2

fn eq(&self, other: &Weak<ZwpTabletPadGroupV2>) -> 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 ZwpTabletPadGroupV2

fn eq(&self, other: &ZwpTabletPadGroupV2) -> 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 ZwpTabletPadGroupV2

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

Create an object resource from its ID

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

Send an event to this object

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

Parse a event for this object

fn write_event<'a>( &self, conn: &DisplayHandle, msg: <ZwpTabletPadGroupV2 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 ZwpTabletPadGroupV2