Enum WheelDelta

pub enum WheelDelta {
    Pixels(Vector3D<f64, Pixels>),
    Lines(Vector3D<f64, Lines>),
    Pages(Vector3D<f64, Pages>),
}

A vector representing the amount the mouse wheel was moved

This may be expressed in Pixels, Lines or Pages

Variants

Pixels(Vector3D<f64, Pixels>)

Movement in Pixels

Lines(Vector3D<f64, Lines>)

Movement in Lines

Pages(Vector3D<f64, Pages>)

Movement in Pages

Implementations

impl WheelDelta

pub fn from_web_attributes( delta_mode: u32, delta_x: f64, delta_y: f64, delta_z: f64, ) -> WheelDelta

Construct from the attributes of the web wheel event

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

Convenience function for constructing a WheelDelta with pixel units

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

Convenience function for constructing a WheelDelta with line units

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

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 (disregards 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<(), Error>

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 Copy for WheelDelta

impl StructuralPartialEq for WheelDelta