Struct ClickArgs

pub struct ClickArgs {
    pub timestamp: DInstant,
    pub window_id: WindowId,
    pub device_id: Option<DeviceId>,
    pub source: ClickArgsSource,
    pub click_count: NonZero<u32>,
    pub is_repeat: bool,
    pub modifiers: ModifiersState,
    pub target: InteractionPath,
    /* private fields */
}

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

Is None if the event was generated programmatically.

source: ClickArgsSource

Specific info from the source of this event.

click_count: NonZero<u32>

Sequential click count. Number 1 is single click, 2 is double click, etc.

Mouse clicks are translated directly, keyboard clicks are the key repeat count plus one.

is_repeat: bool

If the event was auto-generated by holding the key or button pressed.

modifiers: ModifiersState

What modifier keys where pressed when this event happened.

target: InteractionPath

The mouse input top-most hit or the focused element at the time of the key input.

Implementations

impl ClickArgs

pub fn new( timestamp: impl Into<DInstant>, propagation_handle: EventPropagationHandle, window_id: impl Into<WindowId>, device_id: impl Into<Option<DeviceId>>, source: impl Into<ClickArgsSource>, click_count: impl Into<NonZero<u32>>, is_repeat: impl Into<bool>, modifiers: impl Into<ModifiersState>, target: impl Into<InteractionPath>, ) -> ClickArgs

New args from values that convert into the argument types.

pub fn now( window_id: impl Into<WindowId>, device_id: impl Into<Option<DeviceId>>, source: impl Into<ClickArgsSource>, click_count: impl Into<NonZero<u32>>, is_repeat: impl Into<bool>, modifiers: impl Into<ModifiersState>, target: impl Into<InteractionPath>, ) -> ClickArgs

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

impl ClickArgs

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 event counts as primary click.

A primary click causes the default widget function interaction.

Returns true if the click source is a left mouse button click or a primary click shortcut or a touch tap.

pub fn is_context(&self) -> bool

If the event counts as a context menu request.

Returns true if the click_count is 1 and the click source is a right mouse button click or a context click shortcut or a touch long press.

pub fn is_mouse_btn(&self, mouse_button: MouseButton) -> bool

If the event was caused by a press of mouse_button.

pub fn shortcut(&self) -> Option<Shortcut>

The shortcut the generated this event.

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

If this event was generated by a mouse device.

pub fn is_from_touch(&self) -> bool

If this event was generated by a touch device.

pub fn is_from_keyboard(&self) -> bool

If this event was generated by a keyboard device.

pub fn is_from_access(&self) -> bool

If this event was generated by accessibility automation event.

Note that accessibility assistants can also simulate mouse click events, these events are not classified as accessibility sourced.

pub fn position(&self) -> Option<Point2D<Dip, Dip>>

Gets the click position, if the click was generated by a device with position.

The position is in the coordinates of target.

Trait Implementations

impl AnyEventArgs for ClickArgs

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 + '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 ClickArgs

fn clone(&self) -> ClickArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClickArgs

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

Formats the value using the given formatter.

impl EventArgs for ClickArgs

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) -> ClickArgs

Converts to this type from the input type.

impl From<TouchLongPressArgs> for ClickArgs

fn from(args: TouchLongPressArgs) -> ClickArgs

Converts to this type from the input type.

impl From<TouchTapArgs> for ClickArgs

fn from(args: TouchTapArgs) -> ClickArgs

Converts to this type from the input type.