Struct MouseInputArgs 

pub struct MouseInputArgs {
    pub timestamp: DInstant,
    pub window_id: WindowId,
    pub device_id: Option<InputDeviceId>,
    pub button: MouseButton,
    pub position: DipPoint,
    pub modifiers: ModifiersState,
    pub state: ButtonState,
    pub hits: HitTestInfo,
    pub target: InteractionPath,
    pub capture: Option<CaptureInfo>,
    pub is_click: bool,
    pub propagation: EventPropagationHandle,
}

MOUSE_INPUT_EVENT arguments.

Fields

timestamp: DInstant

Instant the event happened.

window_id: WindowId

Id of window that received the event.

device_id: Option<InputDeviceId>

Id of device that generated the event.

button: MouseButton

Which mouse button generated the event.

position: DipPoint

Position of the mouse in the window’s content area.

modifiers: ModifiersState

What modifier keys where pressed when this event happened.

state: ButtonState

The state the button was changed to.

hits: HitTestInfo

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

target: InteractionPath

Full path to the top-most hit in hits.

capture: Option<CaptureInfo>

Current pointer capture.

is_click: bool

If MOUSE_CLICK_EVENT will notify because of this input.

The click event shares the same propagation handle as this event.

propagation: EventPropagationHandle

Propagation handle associated with this event instance.

Cloned arguments share the same handle, some arguments may also share the handle of another event if they share the same cause.

Implementations

impl MouseInputArgs

pub fn new( timestamp: impl Into<DInstant>, propagation: EventPropagationHandle, window_id: impl Into<WindowId>, device_id: impl Into<Option<InputDeviceId>>, button: impl Into<MouseButton>, position: impl Into<DipPoint>, modifiers: impl Into<ModifiersState>, state: impl Into<ButtonState>, hits: impl Into<HitTestInfo>, target: impl Into<InteractionPath>, capture: impl Into<Option<CaptureInfo>>, is_click: impl Into<bool>, ) -> Self

New args from values that convert into the argument types.

pub fn now( window_id: impl Into<WindowId>, device_id: impl Into<Option<InputDeviceId>>, button: impl Into<MouseButton>, position: impl Into<DipPoint>, modifiers: impl Into<ModifiersState>, state: impl Into<ButtonState>, hits: impl Into<HitTestInfo>, target: impl Into<InteractionPath>, capture: impl Into<Option<CaptureInfo>>, is_click: impl Into<bool>, ) -> Self

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

impl MouseInputArgs

pub fn capture_allows(&self, wgt: (WindowId, WidgetId)) -> bool

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

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

If the widget_id is in the target.

pub fn is_primary(&self) -> bool

If the button is the primary.

pub fn is_context(&self) -> bool

If the button is the context (right).

pub fn is_mouse_down(&self) -> bool

If the state is pressed.

pub fn is_mouse_up(&self) -> bool

If the state is released.

pub fn position_wgt(&self, wgt: (WindowId, WidgetId)) -> Option<PxPoint>

Gets position in the widget inner bounds.

Trait Implementations

impl AnyEventArgs for MouseInputArgs

fn is_in_target(&self, id: WidgetId) -> bool

If is in target or capture.

fn timestamp(&self) -> DInstant

Instant this event update happened.

fn propagation(&self) -> &EventPropagationHandle

Propagation handle associated with this event instance.

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

Clone the args to a new box.

impl Clone for MouseInputArgs

fn clone(&self) -> MouseInputArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MouseInputArgs

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

Formats the value using the given formatter.

impl PartialEq for MouseInputArgs

fn eq(&self, other: &MouseInputArgs) -> 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 EventArgs for MouseInputArgs

impl StructuralPartialEq for MouseInputArgs