Struct MouseClickArgs

pub struct MouseClickArgs {
    pub timestamp: DInstant,
    pub window_id: WindowId,
    pub device_id: DeviceId,
    pub button: MouseButton,
    pub position: DipPoint,
    pub modifiers: ModifiersState,
    pub click_count: NonZeroU32,
    pub is_repeat: bool,
    pub hits: HitTestInfo,
    pub target: InteractionPath,
    /* private fields */
}

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

button: MouseButton

Which mouse button generated the event.

position: DipPoint

Position of the mouse in the coordinates of target.

modifiers: ModifiersState

What modifier keys where pressed when this event happened.

click_count: NonZeroU32

Count of clicks within the double-click interval. Number 1 is single click, 2 is double click, etc.

Auto repeated clicks also increment this count.

is_repeat: bool

If the event was generated by holding the button pressed over a widget with ClickMode::repeat.

hits: HitTestInfo

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

target: InteractionPath

Full path to the widget that got clicked.

A widget is clicked if the mouse down and mouse up happen in sequence in the same widget. Subsequent clicks (double, triple) happen on mouse down.

If a mouse down happen in a child widget and the pointer is dragged to a larger parent widget and then let go (mouse up), the click target is the parent widget.

Multi-clicks (click_count > 1) only happen to the same target.

Implementations

impl MouseClickArgs

pub fn new( timestamp: impl Into<DInstant>, propagation_handle: EventPropagationHandle, window_id: impl Into<WindowId>, device_id: impl Into<DeviceId>, button: impl Into<MouseButton>, position: impl Into<DipPoint>, modifiers: impl Into<ModifiersState>, click_count: impl Into<NonZeroU32>, is_repeat: impl Into<bool>, hits: impl Into<HitTestInfo>, target: impl Into<InteractionPath>, ) -> Self

New args from values that convert into the argument types.

pub fn now( window_id: impl Into<WindowId>, device_id: impl Into<DeviceId>, button: impl Into<MouseButton>, position: impl Into<DipPoint>, modifiers: impl Into<ModifiersState>, click_count: impl Into<NonZeroU32>, is_repeat: impl Into<bool>, hits: impl Into<HitTestInfo>, target: impl Into<InteractionPath>, ) -> Self

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

impl MouseClickArgs

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 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_single(&self) -> bool

If the click_count is 1.

pub fn is_double(&self) -> bool

If the click_count is 2.

pub fn is_triple(&self) -> bool

If the click_count is 3.

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

Gets position in the widget inner bounds.

Trait Implementations

impl AnyEventArgs for MouseClickArgs

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

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 MouseClickArgs

fn clone(&self) -> MouseClickArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MouseClickArgs

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

Formats the value using the given formatter.

impl EventArgs for MouseClickArgs

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

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

Calls handler and stops propagation if propagation is still allowed.

impl From<MouseClickArgs> for ClickArgs

fn from(args: MouseClickArgs) -> Self

Converts to this type from the input type.