Struct wayland_protocols::unstable::tablet::v2::server::zwp_tablet_pad_group_v2::ZwpTabletPadGroupV2

pub struct ZwpTabletPadGroupV2(_);

Implementations

impl ZwpTabletPadGroupV2

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

buttons announced

Sent on wp_tablet_pad_group 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 wp_tablet_pad_group.done event.

Some buttons are reserved by the compositor. These buttons may not be assigned to any wp_tablet_pad_group. 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 wp_tablet_pad_group 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 wp_tablet_pad_group.done event.

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

strip announced

Sent on wp_tablet_pad 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 wp_tablet_pad_group.done event.

pub fn modes(&self, modes: u32)

mode-switch ability announced

Sent on wp_tablet_pad_group 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 wl_tablet_pad_group.mode_switch event to toggle between these configurations. Mode indices start at 0.

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

This event is sent in the initial burst of events before the wp_tablet_pad_group.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 and strips 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 client 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 wp_tablet_pad.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 wp_tablet_pad.set_feedback request for each changed button.

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

Trait Implementations

impl AsRef<Resource<ZwpTabletPadGroupV2>> for ZwpTabletPadGroupV2

fn as_ref(&self) -> &Resource<Self>

Performs the conversion.

impl Clone for ZwpTabletPadGroupV2

fn clone(&self) -> ZwpTabletPadGroupV2

Returns a copy 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

Formats the value using the given formatter.

impl From<Resource<ZwpTabletPadGroupV2>> for ZwpTabletPadGroupV2

fn from(value: Resource<Self>) -> Self

Performs the conversion.

impl From<ZwpTabletPadGroupV2> for Resource<ZwpTabletPadGroupV2>

fn from(value: ZwpTabletPadGroupV2) -> Self

Performs the conversion.

impl Interface for ZwpTabletPadGroupV2

type Request = Request

Set of requests associated to this interface

type Event = Event

Set of events associated to this interface

const NAME: &'static str

Name of this interface

const VERSION: u32

Maximum supported version of this interface

fn c_interface() -> *const wl_interface

Pointer to the C representation of this interface

impl PartialEq<ZwpTabletPadGroupV2> for ZwpTabletPadGroupV2

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

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

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

This method tests for !=.

impl Eq for ZwpTabletPadGroupV2

impl StructuralEq for ZwpTabletPadGroupV2

impl StructuralPartialEq for ZwpTabletPadGroupV2