Struct RoutedEventArgs 

pub struct RoutedEventArgs { /* private fields */ }

Provides state information and data specific to a routed event.

The routing state (handled, route, source) is mutated while the event travels along its route, so it is interiorly mutable: handlers receive the args by shared reference.

The args are a reference object: a copy shares the routing state with the args it was made from (marking a copy as handled marks the event as handled), and copies compare by identity. The same holds for the args types derived from this one, whose own mutable state is shared too.

Implementations

impl RoutedEventArgs

pub fn new() -> Self

Creates args with no routed event.

pub fn with_event<T: ?Sized>(routed_event: &RoutedEvent<T>) -> Self

Creates args for a routed event.

pub fn with_event_and_source<T: ?Sized>( routed_event: &RoutedEvent<T>, source: impl Into<Nullable<FerroObject>>, ) -> Self

Creates args for a routed event with a source.

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 RoutedEventArgs

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for RoutedEventArgs

fn default() -> Self

Returns the “default value” for a type.

impl IRoutedEventArgs for RoutedEventArgs

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 PartialEq for RoutedEventArgs

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.