Enum WheelDelta 

pub enum WheelDelta {
    Pixels(PixelsVector),
    Lines(LinesVector),
    Pages(PagesVector),
}

A vector representing the movement of the mouse wheel

This may be expressed in Pixels, Lines or Pages

Variants

Pixels(PixelsVector)

Movement in Pixels

Lines(LinesVector)

Movement in Lines

Pages(PagesVector)

Movement in Pages

Implementations

impl WheelDelta

pub fn pixels(x: f64, y: f64, z: f64) -> Self

Convenience function for constructing a WheelDelta with pixel units

pub fn lines(x: f64, y: f64, z: f64) -> Self

Convenience function for constructing a WheelDelta with line units

pub fn pages(x: f64, y: f64, z: f64) -> Self

Convenience function for constructing a WheelDelta with page units

pub fn is_zero(&self) -> bool

Returns true iff there is no wheel movement

i.e. the x, y and z delta is zero (disregarding units)

pub fn strip_units(&self) -> Vector3D<f64, UnknownUnit>

A Vector3D proportional to the amount scrolled

Note that this disregards the 3 possible units: this could be expressed in terms of pixels, lines, or pages.

In most cases, to properly handle scrolling, you should handle all 3 possible enum variants instead of stripping units. Otherwise, if you assume that the units will always be pixels, the user may experience some unexpectedly slow scrolling if their mouse/OS sends values expressed in lines or pages.

Trait Implementations

impl Clone for WheelDelta

fn clone(&self) -> WheelDelta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WheelDelta

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

Formats the value using the given formatter.

impl PartialEq for WheelDelta

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

fn zero() -> Self

impl Copy for WheelDelta

impl StructuralPartialEq for WheelDelta