zng_ext_input::mouse

Struct MouseHoverArgs

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

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: DipPoint

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§

source§

impl MouseHoverArgs

source

pub fn new( timestamp: impl Into<DInstant>, propagation_handle: EventPropagationHandle, window_id: impl Into<WindowId>, device_id: impl Into<Option<DeviceId>>, position: impl Into<DipPoint>, 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>>, ) -> Self

New args from values that convert into the argument types.

source

pub fn now( window_id: impl Into<WindowId>, device_id: impl Into<Option<DeviceId>>, position: impl Into<DipPoint>, 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>>, ) -> Self

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

source§

impl MouseHoverArgs

source

pub fn capture_allows(&self) -> bool

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

source

pub fn is_mouse_move(&self) -> bool

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

source

pub fn is_widget_move(&self) -> bool

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

source

pub fn is_capture_change(&self) -> bool

Event caused by a pointer capture change.

source

pub fn is_mouse_enter(&self) -> bool

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

source

pub fn is_mouse_leave(&self) -> bool

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

source

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.

source

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.

source

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.

source

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.

source

pub fn was_over(&self) -> bool

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

source

pub fn is_over(&self) -> bool

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

source

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

Returns true if the widget was enabled in prev_target.

source

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

Returns true if the widget was disabled in prev_target.

source

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

Returns true if the widget is enabled in target.

source

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

Returns true if the widget is disabled in target.

source

pub fn position_wgt(&self) -> Option<PxPoint>

Gets position in the widget inner bounds.

Trait Implementations§

source§

impl AnyEventArgs for MouseHoverArgs

source§

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

source§

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

Clone the event into a type erased box.
source§

fn as_any(&self) -> &dyn Any

Access to dyn Any methods.
source§

fn timestamp(&self) -> DInstant

Gets the instant this event happened.
source§

fn propagation(&self) -> &EventPropagationHandle

Propagation handle associated with this event instance. Read more
source§

impl Clone for MouseHoverArgs

source§

fn clone(&self) -> MouseHoverArgs

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for MouseHoverArgs

source§

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

Formats the value using the given formatter. Read more
source§

impl EventArgs for MouseHoverArgs

source§

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

Calls handler and stops propagation if propagation is still allowed. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> StateValue for T
where T: Any + Send + Sync,