Struct TabletPadModeGroup

pub struct TabletPadModeGroup { /* private fields */ }

A mode on a tablet pad is a virtual grouping of functionality, usually based on some visual feedback like LEDs on the pad.

The set of buttons, rings and strips that share the same mode are a “mode group”. Whenever the mode changes, all buttons, rings and strips within this mode group are affected. See Tablet pad modes for detail.

Most tablets only have a single mode group, some tablets provide multiple mode groups through independent banks of LEDs (e.g. the Wacom Cintiq 24HD). libinput guarantees that at least one mode group is always available.

Implementations

impl TabletPadModeGroup

pub fn button_is_toggle(&self, button: u32) -> bool

The toggle button in a mode group is the button assigned to cycle to or directly assign a new mode when pressed.

Not all devices have a toggle button and some devices may have more than one toggle button. For example, the Wacom Cintiq 24HD has six toggle buttons in two groups, each directly selecting one of the three modes per group.

Devices without mode switching capabilities return false for every button.

pub fn index(&self) -> u32

The returned number is the same index as passed to Device::tablet_pad_mode_group.

For tablets with only one mode this number is always 0.

pub fn mode(&self) -> u32

Return the current mode this mode group is in.

Note that the returned mode is the mode valid as of completing the last Libinput::dispatch. The returned mode may thus be different than the mode returned by TabletPadEvent::mode.

For example, if the mode was toggled three times between the call to Libinput::dispatch, this function returns the third mode but the events in the event queue will return the modes 1, 2 and 3, respectively.

pub fn number_of_modes(&self) -> u32

Query the mode group for the number of available modes.

The number of modes is usually decided by the number of physical LEDs available on the device. Different mode groups may have a different number of modes. Use TabletPadModeGroup::mode to get the currently active mode.

libinput guarantees that at least one mode is available. A device without mode switching capability has a single mode group and a single mode.

pub fn has_button(&self, button: u32) -> bool

Devices without mode switching capabilities return true for every button.

pub fn has_ring(&self, ring: u32) -> bool

Devices without mode switching capabilities return true for every ring.

pub fn has_strip(&self, strip: u32) -> bool

Devices without mode switching capabilities return true for every strip.

Trait Implementations

impl AsRaw<libinput_tablet_pad_mode_group> for TabletPadModeGroup

fn as_raw(&self) -> *const libinput_tablet_pad_mode_group

Receive a raw pointer representing this type.

impl Clone for TabletPadModeGroup

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Context for TabletPadModeGroup

fn context(&self) -> &Libinput

Returns the underlying libinput context

impl Debug for TabletPadModeGroup

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

Formats the value using the given formatter.

impl Drop for TabletPadModeGroup

fn drop(&mut self)

Executes the destructor for this type.

impl FromRaw<libinput_tablet_pad_mode_group> for TabletPadModeGroup

unsafe fn from_raw( ffi: *mut libinput_tablet_pad_mode_group, context: &Libinput, ) -> Self

Create a new instance of this type from a raw pointer and it’s context. If the type of the struct is a valid libinput type, but is unknown to this library, it panics instead.

impl Hash for TabletPadModeGroup

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

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

fn eq(&self, other: &Self) -> 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 Eq for TabletPadModeGroup