Struct RoutedEvent 

pub struct RoutedEvent<TEventArgs: ?Sized = dyn IRoutedEventArgs> { /* private fields */ }

The identity and description of a routed event.

RoutedEvent<TEventArgs> is a routed event whose handlers receive TEventArgs; plain RoutedEvent is the untyped view of any routed event (the base class of the typed ones). Both are cheap copyable handles to the same definition and compare equal when they denote the same event; as_routed_event converts a typed handle to the untyped one.

Like property definitions, routed events are registered once per thread and live for the rest of the program; declare them with ferro_routed_event!.

Implementations

impl RoutedEvent

pub fn new_untyped<TEventArgs: IRoutedEventArgs>( name: &str, routing_strategies: RoutingStrategies, owner_type: &'static TypeInfo, ) -> RoutedEvent

Creates an untyped routed event whose args are of type TEventArgs, without registering it.

pub fn register<TOwner: StaticType, TEventArgs: IRoutedEventArgs>( name: &str, routing_strategy: RoutingStrategies, ) -> &'static RoutedEvent<TEventArgs>

Registers a routed event owned by class TOwner.

pub fn register_with_owner<TEventArgs: IRoutedEventArgs>( name: &str, routing_strategy: RoutingStrategies, owner_type: &'static TypeInfo, ) -> &'static RoutedEvent<TEventArgs>

Registers a routed event owned by the given type.

impl<TEventArgs: ?Sized> RoutedEvent<TEventArgs>

pub fn as_routed_event(&self) -> RoutedEvent

The untyped handle of this routed event.

pub fn event_args_type(&self) -> TypeId

The type of the event’s args.

pub fn event_args_type_name(&self) -> &'static str

The Rust type name of the event’s args.

pub fn event_args_is<T: IRoutedEventArgs>(&self) -> bool

Whether the event’s args type is T or derives from it, i.e. whether a handler taking T can be attached to the event.

pub fn name(&self) -> &'static str

The name of the event.

pub fn owner_type(&self) -> &'static TypeInfo

The class that registered the event.

pub fn routing_strategies(&self) -> RoutingStrategies

How the event travels through the tree.

pub fn has_raised_subscriptions(&self) -> bool

Whether anything is subscribed to raised, i.e. whether the event has class handlers.

pub fn raised(&self) -> &'static RoutedEventObservable

Notifications of the event being raised on any element.

pub fn route_finished(&self) -> &'static RouteFinishedObservable

Notifications of the event having finished one of its routes.

pub fn add_class_handler_untyped( &self, target_type: &'static TypeInfo, handler: impl Fn(&Interactive, &dyn IRoutedEventArgs) + 'static, routes: RoutingStrategies, handled_events_too: bool, ) -> Rc<dyn IDisposable>

Adds a handler that is invoked for every element of type target_type (or derived from it) on the route of the event, before the handlers attached to that element.

The handler is invoked on the direct route, and on the tunnel or bubble routes selected by routes; for events that are already handled only if handled_events_too is set.

impl<TEventArgs: IRoutedEventArgs> RoutedEvent<TEventArgs>

pub fn new( name: &str, routing_strategies: RoutingStrategies, owner_type: &'static TypeInfo, ) -> Self

Creates a routed event without registering it.

pub fn add_class_handler<TTarget: ObjectType>( &self, handler: impl Fn(&TTarget, &TEventArgs) + 'static, ) -> Rc<dyn IDisposable>

Adds a class handler for elements of class TTarget, listening to the direct and bubble routes of unhandled events.

pub fn add_class_handler_with<TTarget: ObjectType>( &self, handler: impl Fn(&TTarget, &TEventArgs) + 'static, routes: RoutingStrategies, handled_events_too: bool, ) -> Rc<dyn IDisposable>

Adds a class handler for elements of class TTarget.

See add_class_handler_untyped.

Trait Implementations

impl<T: ?Sized> Clone for RoutedEvent<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: ?Sized> Copy for RoutedEvent<T>

impl<T: ?Sized> Debug for RoutedEvent<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Display for RoutedEvent<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Eq for RoutedEvent<T>

impl<T: ?Sized> Hash for RoutedEvent<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl MarkupTyped for RoutedEvent<AccessKeyEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<AccessKeyPressedEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<ContextRequestedEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<DragEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<FocusChangedEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<FocusChangingEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<HoldingRoutedEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<KeyEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<PinchEndedEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<PinchEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<PointerCaptureLostEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<PointerDeltaEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<PointerEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<PointerPressedEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<PointerReleasedEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<PointerWheelEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<PullGestureEndedEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<PullGestureEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<RoutedEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<ScrollGestureEndedEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<ScrollGestureEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<ScrollGestureInertiaStartingEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<SwipeGestureEndedEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<SwipeGestureEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<TappedEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<TextInputEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<TextInputMethodClientRequeryRequestedEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent<TextInputMethodClientRequestedEventArgs>

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl MarkupTyped for RoutedEvent

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl<T: ?Sized, U: ?Sized> PartialEq<RoutedEvent<U>> for RoutedEvent<T>

fn eq(&self, other: &RoutedEvent<U>) -> bool

Equality operator ==.

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

Inequality operator !=.