Struct PointerEventArgs 

pub struct PointerEventArgs { /* private fields */ }

Provides data for pointer events.

Implementations

impl PointerEventArgs

pub fn new<T: ?Sized>( routed_event: Option<&RoutedEvent<T>>, source: impl Into<Nullable<FerroObject>>, pointer: Rc<dyn IPointer>, root_visual: Option<&Visual>, root_visual_position: Point, timestamp: u64, properties: PointerPointProperties, modifiers: KeyModifiers, ) -> Self

Creates pointer event args.

root_visual is the root of the tree that observed the event and root_visual_position the position of the pointer in its coordinates. timestamp is the platform time stamp of the input.

pub fn with_previous_points( self, previous_points: Option<IntermediatePoints>, ) -> Self

Adds the intermediate points of the event.

pub fn with_platform_input_event_cookie( self, cookie: Option<Rc<dyn Any>>, ) -> Self

Adds the platform’s cookie for the input event.

pub fn pointer(&self) -> &Rc<dyn IPointer>

The pointer that caused the event.

pub fn timestamp(&self) -> u64

The time when the pointer event occurred, as reported by the platform.

pub fn platform_input_event_cookie(&self) -> Option<&Rc<dyn Any>>

The platform’s opaque cookie for the input event that caused this event, if any.

pub fn key_modifiers(&self) -> KeyModifiers

The key modifiers held down when the event occurred.

pub fn get_position(&self, relative_to: Option<&Visual>) -> Point

Gets the pointer position relative to a control, or relative to the root of the tree that observed the event when relative_to is None.

pub fn get_current_point(&self, relative_to: Option<&Visual>) -> PointerPoint

Returns the pointer point associated with the current event, positioned relative to a control.

pub fn get_intermediate_points( &self, relative_to: Option<&Visual>, ) -> Vec<PointerPoint>

Returns all points since the last relevant pointer event, positioned relative to a control. The last one is the current point.

pub fn prevent_gesture_recognition(&self)

Prevents this event from being handled by other gesture recognizers in the route.

pub fn properties(&self) -> PointerPointProperties

The state of the pointer device at the time of the event.

Methods from Deref<Target = RoutedEventArgs>

pub fn handled(&self) -> bool

Whether the routed event has already been handled.

Once handled, the event keeps travelling along its route but is only delivered to handlers registered for handled events too.

pub fn set_handled(&self, value: bool)

Marks the routed event as handled or unhandled.

pub fn routed_event(&self) -> Option<RoutedEvent>

The routed event associated with these args.

pub fn set_routed_event<T: ?Sized>(&self, value: Option<&RoutedEvent<T>>)

Sets the routed event associated with these args.

pub fn route(&self) -> RoutingStrategies

The routing strategy currently being applied to the event.

pub fn set_route(&self, value: RoutingStrategies)

Sets the routing strategy currently being applied to the event.

pub fn source(&self) -> Option<Ref<FerroObject>>

The object that raised the event.

pub fn set_source(&self, value: impl Into<Nullable<FerroObject>>)

Sets the object that raised the event.

pub fn is_source(&self, object: &FerroObject) -> bool

Whether object is the source of the event (C# e.Source == object).

Trait Implementations

impl Clone for PointerEventArgs

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Deref for PointerEventArgs

type Target = RoutedEventArgs

The resulting type after dereferencing.

fn deref(&self) -> &RoutedEventArgs

Dereferences the value.

impl IKeyModifiersEventArgs for PointerEventArgs

fn key_modifiers(&self) -> KeyModifiers

The key modifiers associated with this event.

impl IRoutedEventArgs for PointerEventArgs

fn as_routed_event_args(&self) -> &RoutedEventArgs

The base routed event args: the routing state of the event.

fn query_args(&self, type_id: TypeId) -> Option<&dyn Any>

Returns the args viewed as the args type identified by type_id, if the args are of that type or of a type derived from it.

fn is_args_type(type_id: TypeId) -> bool

Whether this args type is the args type identified by type_id or is derived from it.

fn share(&self) -> Rc<dyn IRoutedEventArgs>

A shared handle to these args: what untyped code (a handler wired up by markup) is given, since a borrow cannot be held in an untyped value. The handle refers to the live args: the state handlers change (handled, the source, a cancel flag, ..) is shared with them.

impl MarkupTyped for PointerEventArgs

const MARKUP: &'static MarkupType

The markup metadata of the type.