Struct PointerScrollWheelEvent

pub struct PointerScrollWheelEvent { /* private fields */ }

An event related to moving a scroll whell on a pointer device

Implementations

impl PointerScrollWheelEvent

pub fn scroll_value_v120(&self, axis: Axis) -> f64

Return the axis value as a v120-normalized value, that represents the movement in logical mouse wheel clicks, normalized to the -120..+120 range.

A value that is a fraction of ±120 indicates a wheel movement less than one logical click, a caller should either scroll by the respective fraction of the normal scroll distance or accumulate that value until a multiple of 120 is reached.

For most callers, this is the preferred way of handling high-resolution scroll events.

The normalized v120 value does not take device-specific physical angles or distances into account, i.e. a wheel with a click angle of 20 degrees produces only 18 logical clicks per 360 degree rotation, a wheel with a click angle of 15 degrees produces 24 logical clicks per 360 degree rotation. Where the physical angle matters, use PointerScrollEvent::scroll_value instead.

The magic number 120 originates from the Windows Vista Mouse Wheel design document.

Trait Implementations

impl AsRaw<libinput_event_pointer> for PointerScrollWheelEvent

fn as_raw(&self) -> *const libinput_event_pointer

Receive a raw pointer representing this type.

impl Context for PointerScrollWheelEvent

fn context(&self) -> &Libinput

Returns the underlying libinput context

impl Debug for PointerScrollWheelEvent

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

Formats the value using the given formatter.

impl Drop for PointerScrollWheelEvent

fn drop(&mut self)

Executes the destructor for this type.

impl EventTrait for PointerScrollWheelEvent

fn into_event(self) -> Event

where Self: Sized,

Convert into a general Event again

fn device(&self) -> Device

Return the device associated with this event.

impl FromRaw<libinput_event_pointer> for PointerScrollWheelEvent

unsafe fn from_raw(ffi: *mut libinput_event_pointer, 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 PointerScrollWheelEvent

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 PointerScrollWheelEvent

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 PointerScrollEvent for PointerScrollWheelEvent

fn has_axis(&self, axis: Axis) -> bool

Check if the event has a valid value for the given axis.

fn scroll_value(&self, axis: Axis) -> f64

Return the axis value of the given axis.

impl Eq for PointerScrollWheelEvent