Struct MouseHoverArgs

pub struct MouseHoverArgs {
    pub timestamp: DInstant,
    pub window_id: WindowId,
    pub device_id: Option<DeviceId>,
    pub position: Point2D<Dip, Dip>,
    pub hits: HitTestInfo,
    pub prev_target: Option<InteractionPath>,
    pub target: Option<InteractionPath>,
    pub prev_capture: Option<CaptureInfo>,
    pub capture: Option<CaptureInfo>,
    /* private fields */
}

MOUSE_HOVERED_EVENT arguments.

Fields

timestamp: DInstant

Instant the event happened.

window_id: WindowId

Id of window that received the event.

device_id: Option<DeviceId>

Id of device that generated the event.

position: Point2D<Dip, Dip>

Position of the mouse in the window.

hits: HitTestInfo

Hit-test result for the mouse point in the window.

prev_target: Option<InteractionPath>

Previous top-most hit before the mouse moved.

target: Option<InteractionPath>

Full path to the top-most hit in hits.

Is None when the mouse moves out of a window or the window closes under the mouse and there was a previous hovered widget.

prev_capture: Option<CaptureInfo>

Previous pointer capture.

capture: Option<CaptureInfo>

Current pointer capture.

Implementations

impl MouseHoverArgs

pub fn new( timestamp: impl Into<DInstant>, propagation_handle: EventPropagationHandle, window_id: impl Into<WindowId>, device_id: impl Into<Option<DeviceId>>, position: impl Into<Point2D<Dip, Dip>>, hits: impl Into<HitTestInfo>, prev_target: impl Into<Option<InteractionPath>>, target: impl Into<Option<InteractionPath>>, prev_capture: impl Into<Option<CaptureInfo>>, capture: impl Into<Option<CaptureInfo>>, ) -> MouseHoverArgs

New args from values that convert into the argument types.

pub fn now( window_id: impl Into<WindowId>, device_id: impl Into<Option<DeviceId>>, position: impl Into<Point2D<Dip, Dip>>, hits: impl Into<HitTestInfo>, prev_target: impl Into<Option<InteractionPath>>, target: impl Into<Option<InteractionPath>>, prev_capture: impl Into<Option<CaptureInfo>>, capture: impl Into<Option<CaptureInfo>>, ) -> MouseHoverArgs

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

impl MouseHoverArgs

pub fn capture_allows(&self) -> bool

If capture is None or allows the WIDGET to receive this event.

pub fn is_mouse_move(&self) -> bool

Event caused by the mouse position moving over/out of the widget bounds.

pub fn is_widget_move(&self) -> bool

Event caused by the widget moving under/out of the mouse position.

pub fn is_capture_change(&self) -> bool

Event caused by a pointer capture change.

pub fn is_mouse_enter(&self) -> bool

Returns true if the WIDGET was not hovered, but now is.

pub fn is_mouse_leave(&self) -> bool

Returns true if the WIDGET was hovered, but now isn’t.

pub fn is_mouse_enter_enabled(&self) -> bool

Returns true if the WIDGET was not hovered or was disabled, but now is hovered and enabled.

pub fn is_mouse_leave_enabled(&self) -> bool

Returns true if the WIDGET was hovered and enabled, but now is not hovered or is disabled.

pub fn is_mouse_enter_disabled(&self) -> bool

Returns true if the WIDGET was not hovered or was enabled, but now is hovered and disabled.

pub fn is_mouse_leave_disabled(&self) -> bool

Returns true if the WIDGET was hovered and disabled, but now is not hovered or is enabled.

pub fn was_over(&self) -> bool

Returns true if the WIDGET is in prev_target and is allowed by the prev_capture.

pub fn is_over(&self) -> bool

Returns true if the WIDGET is in target and is allowed by the current capture.

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

Returns true if the widget was enabled in prev_target.

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

Returns true if the widget was disabled in prev_target.

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 MouseHoverArgs

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

The target, prev_target and capture.

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 MouseHoverArgs

fn clone(&self) -> MouseHoverArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MouseHoverArgs

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

Formats the value using the given formatter.

impl EventArgs for MouseHoverArgs

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

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

Calls handler and stops propagation if propagation is still allowed.