Struct zng::mouse::MouseInputArgs

pub struct MouseInputArgs {
    pub timestamp: DInstant,
    pub window_id: WindowId,
    pub device_id: Option<DeviceId>,
    pub button: MouseButton,
    pub position: Point2D<Dip, Dip>,
    pub modifiers: ModifiersState,
    pub state: ButtonState,
    pub hits: HitTestInfo,
    pub target: InteractionPath,
    pub capture: Option<CaptureInfo>,
    pub is_click: bool,
    /* private fields */
}

MOUSE_INPUT_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.

button: MouseButton

Which mouse button generated the event.

position: Point2D<Dip, Dip>

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.

Implementations

impl MouseInputArgs

pub fn new( timestamp: impl Into<DInstant>, propagation_handle: EventPropagationHandle, window_id: impl Into<WindowId>, device_id: impl Into<Option<DeviceId>>, button: impl Into<MouseButton>, position: impl Into<Point2D<Dip, Dip>>, 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>, ) -> MouseInputArgs

New args from values that convert into the argument types.

pub fn now( window_id: impl Into<WindowId>, device_id: impl Into<Option<DeviceId>>, button: impl Into<MouseButton>, position: impl Into<Point2D<Dip, Dip>>, 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>, ) -> MouseInputArgs

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

impl MouseInputArgs

pub fn capture_allows(&self) -> bool

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

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

If the widget_id is in the target.

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

If the widget_id is in the target is enabled.

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

If the widget_id is in the target is disabled.

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) -> Option<Point2D<Px, Px>>

Gets position in the widget inner bounds.

Trait Implementations

impl AnyEventArgs for MouseInputArgs

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

The 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 MouseInputArgs

fn clone(&self) -> MouseInputArgs

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl EventArgs for MouseInputArgs

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

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

Calls handler and stops propagation if propagation is still allowed.