Struct ScrollWheelEvent 

pub struct ScrollWheelEvent {
    pub position: Point<Pixels>,
    pub delta: ScrollDelta,
    pub modifiers: Modifiers,
    pub touch_phase: TouchPhase,
}

A scroll from a mouse wheel, a trackpad, or a touch pan.

Sent to InteractiveElement::on_scroll_wheel listeners at the pointer position. Scroll containers use the delta to move their content.

Dereferences to Modifiers, so event.shift reads the Shift state.

Fields

position: Point<Pixels>

The pointer position in window coordinates, in logical pixels. For a touch pan, the position where the pan started.

delta: ScrollDelta

How far the content should scroll for this event.

modifiers: Modifiers

The modifier keys held during the scroll.

touch_phase: TouchPhase

Where this event falls in its scroll gesture. Trackpad and touch scrolls report Started, Moved and Ended. Wheels that don’t report phases leave it at Moved.

Methods from Deref<Target = Modifiers>

pub fn modified(&self) -> bool

Returns whether any modifier key is held.

pub fn secondary(&self) -> bool

Returns whether the platform’s shortcut modifier is held.

This is platform (command) on macOS and control on Linux and Windows. Use it for shortcuts such as save and copy, so that they follow each platform’s convention.

Examples

assert!(Modifiers::secondary_key().secondary());
assert!(!Modifiers::shift().secondary());

pub fn number_of_modifiers(&self) -> u8

Returns how many modifier keys are held.

pub fn is_subset_of(&self, other: &Modifiers) -> bool

Returns whether every modifier held in self is also held in other.

Modifiers::none() is a subset of every value, and no value is a subset of none() unless it is none() itself.

Examples

let ctrl_shift = Modifiers::control_shift();
assert!(Modifiers::shift().is_subset_of(&ctrl_shift));
assert!(!Modifiers::alt().is_subset_of(&ctrl_shift));

Trait Implementations

impl Clone for ScrollWheelEvent

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScrollWheelEvent

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

Formats the value using the given formatter.

impl Default for ScrollWheelEvent

fn default() -> Self

Returns the “default value” for a type.

impl Deref for ScrollWheelEvent

type Target = Modifiers

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl InputEvent for ScrollWheelEvent

fn to_platform_input(self) -> PlatformInput

Converts this event into the PlatformInput variant that wraps it.

impl MouseEvent for ScrollWheelEvent