Struct MouseWheelArgs

pub struct MouseWheelArgs {
    pub timestamp: DInstant,
    pub window_id: WindowId,
    pub device_id: DeviceId,
    pub position: Point2D<Dip, Dip>,
    pub modifiers: ModifiersState,
    pub delta: MouseScrollDelta,
    pub phase: TouchPhase,
    pub hits: HitTestInfo,
    pub target: InteractionPath,
    /* private fields */
}

MOUSE_WHEEL_EVENT arguments.

Fields

timestamp: DInstant

Instant the event happened.

window_id: WindowId

Id of window that received the event.

device_id: DeviceId

Id of device that generated the event.

position: Point2D<Dip, Dip>

Position of the mouse in the coordinates of target.

modifiers: ModifiersState

What modifier keys where pressed when this event happened.

delta: MouseScrollDelta

Wheel motion delta, value is in pixels if the wheel is a touchpad.

phase: TouchPhase

Touch state if the device that generated the event is a touchpad.

hits: HitTestInfo

Hit-test result for the mouse point in the window, at the moment the wheel event was generated.

target: InteractionPath

Full path to the widget that got scrolled.

Implementations

impl MouseWheelArgs

pub fn new( timestamp: impl Into<DInstant>, propagation_handle: EventPropagationHandle, window_id: impl Into<WindowId>, device_id: impl Into<DeviceId>, position: impl Into<Point2D<Dip, Dip>>, modifiers: impl Into<ModifiersState>, delta: impl Into<MouseScrollDelta>, phase: impl Into<TouchPhase>, hits: impl Into<HitTestInfo>, target: impl Into<InteractionPath>, ) -> MouseWheelArgs

New args from values that convert into the argument types.

pub fn now( window_id: impl Into<WindowId>, device_id: impl Into<DeviceId>, position: impl Into<Point2D<Dip, Dip>>, modifiers: impl Into<ModifiersState>, delta: impl Into<MouseScrollDelta>, phase: impl Into<TouchPhase>, hits: impl Into<HitTestInfo>, target: impl Into<InteractionPath>, ) -> MouseWheelArgs

Arguments for event that happened now (INSTANT.now).

impl MouseWheelArgs

pub fn shifted_delta(&self) -> MouseScrollDelta

Swaps the delta axis if modifiers contains SHIFT.

pub fn is_scroll(&self) -> bool

If the modifiers allow the event to be used for scrolling.

Is true if only SHIFT, ALT or none modifiers are pressed. If true the scroll_delta method returns a value.

pub fn scroll_delta( &self, alt_factor: impl Into<Factor>, ) -> Option<MouseScrollDelta>

Returns the delta for a scrolling operation, depending on the modifiers.

If ALT is pressed scales the delta by alt_factor, then, if no more modifiers are pressed returns the scaled delta, if only SHIFT is pressed returns the swapped delta, otherwise returns None.

pub fn is_zoom(&self) -> bool

If the modifiers allow the event to be used for zooming.

Is true if only CTRL is pressed. If true the zoom_delta method returns a value.

pub fn zoom_delta(&self) -> Option<MouseScrollDelta>

Returns the delta for a zoom-in/out operation, depending on the modifiers.

If only CTRL is pressed returns the delta, otherwise returns None.

pub fn is_enabled(&self, widget_id: WidgetId) -> bool

Returns true if the widget is enabled in target.

pub fn is_disabled(&self, widget_id: WidgetId) -> bool

Returns true if the widget is disabled in target.

pub fn position_wgt(&self) -> Option<Point2D<Px, Px>>

Gets position in the widget inner bounds.

Trait Implementations

impl AnyEventArgs for MouseWheelArgs

fn delivery_list(&self, list: &mut UpdateDeliveryList)

The target.

fn clone_any(&self) -> Box<dyn AnyEventArgs>

Clone the event into a type erased box.

fn as_any(&self) -> &(dyn Any + 'static)

Access to dyn Any methods.

fn timestamp(&self) -> DInstant

Gets the instant this event happened.

fn propagation(&self) -> &EventPropagationHandle

Propagation handle associated with this event instance.

impl Clone for MouseWheelArgs

fn clone(&self) -> MouseWheelArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MouseWheelArgs

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

Formats the value using the given formatter.

impl EventArgs for MouseWheelArgs

fn handle<F, R>(&self, handler: F) -> Option<R>

where F: FnOnce(&Self) -> R,

Calls handler and stops propagation if propagation is still allowed.