Struct input::event::tablet_tool::TabletToolProximityEvent

pub struct TabletToolProximityEvent { /* private fields */ }

Signals that a tool has come in or out of proximity of a device with the DeviceCapability::TabletTool capability.

Proximity events contain each of the current values for each axis, and these values may be extracted from them in the same way they are with TabletToolAxisEvent events.

Some tools may always be in proximity. For these tools, proximity events with ProximityState::In are sent only once after DeviceAddedEvent, and proximity events with ProximityState::Out are sent only once before DeviceRemovedEvent.

If the tool that comes into proximity supports x/y coordinates, libinput guarantees that both x and y are set in the proximity event.

When a tool goes out of proximity, the value of every axis should be assumed to have an undefined state and any buttons that are currently held down on the stylus are marked as released. Button release events for each button that was held down on the stylus are sent before the proximity out event.

Implementations

impl TabletToolProximityEvent

pub fn proximity_state(&self) -> ProximityState

Returns the new proximity state of a tool from a proximity event.

Used to check whether or not a tool came in or out of proximity during an TabletToolProximityEvent.

See Handling of proximity events for recommendations on proximity handling.

Trait Implementations

impl AsRaw<libinput_event_tablet_tool> for TabletToolProximityEvent

fn as_raw(&self) -> *const libinput_event_tablet_tool

Receive a raw pointer representing this type.

impl Context for TabletToolProximityEvent

fn context(&self) -> &Libinput

Returns the underlying libinput context

impl Debug for TabletToolProximityEvent

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

Formats the value using the given formatter.

impl Drop for TabletToolProximityEvent

fn drop(&mut self)

Executes the destructor for this type.

impl EventTrait for TabletToolProximityEvent

fn into_event(self) -> Eventwhere
    Self: Sized,

Convert into a general Event again

fn device(&self) -> Device

Return the device associated with this event.

impl FromRaw<libinput_event_tablet_tool> for TabletToolProximityEvent

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

Create a new instance of this type from a raw pointer and it’s context.

impl Hash for TabletToolProximityEvent

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

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

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

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

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

impl Eq for TabletToolProximityEvent

impl StructuralEq for TabletToolProximityEvent