Crate ferroui_xaml_interactivity 

ferroui-xaml-interactivity

The object model of the behaviors of FerroUI, ported from the Xaml.Behaviors.Interactivity project of Xaml.Behaviors (see NOTICE.md):

• the attached property Interaction::behaviors_property and its BehaviorCollection, which attaches its behaviors to the host and replays the lifecycle of the host to them (initialized, attached to the logical tree, attached to the visual tree, loaded), phase by phase across the behaviors, including the behaviors added while it does so;
• the contracts IBehavior, ITrigger, IAction, IReversibleAction and IBehaviorEventsHandler;
• the behaviors, triggers and actions that are plain objects (Behavior, Trigger, Action) and the ones that are styled elements and join the logical tree of their host (StyledElementBehavior, StyledElementTrigger, StyledElementAction), with their typed forms (BehaviorOfT, StyledElementBehaviorOfT, ..);
• the base classes of event triggers, command behaviors and actions, and disposing behaviors;
• the templates that let a style set behaviors and actions (BehaviorCollectionTemplate, ActionCollectionTemplate) or other objects (ObjectTemplate, NotificationTemplate);
• the helpers the other behavior crates use: properties and methods by name, conversions and comparisons of untyped values, command state, reversible property changes.

The namespace of the crate is FerroUI.Xaml.Interactivity, mapped into the default XML namespace of the framework: documents name its types without a prefix once register_types ran.

Re-exports

pub use crate::helpers::CommandCanExecuteObserver;

pub use crate::helpers::ReversiblePropertyChange;

pub use crate::styled_element::StyledElementAction;

pub use crate::styled_element::StyledElementActionImpl;

pub use crate::styled_element::StyledElementActionImplExt;

pub use crate::styled_element::StyledElementActionVTable;

pub use crate::styled_element::StyledElementBehavior;

pub use crate::styled_element::StyledElementBehaviorImpl;

pub use crate::styled_element::StyledElementBehaviorImplExt;

pub use crate::styled_element::StyledElementBehaviorOfT;

pub use crate::styled_element::StyledElementBehaviorVTable;

pub use crate::styled_element::StyledElementTrigger;

pub use crate::styled_element::StyledElementTriggerOfT;

Modules

helpers

The helpers of the object model (Helpers/): command state, property and method lookup by name, conversions and comparisons of untyped values, and reversible property changes.

Structs

Action

A base class for action that calls a method on a specified object when invoked.

ActionCollection

Represents a collection of IActions.

ActionCollectionTemplate

A template for creating a collection of IAction objects.

ActionVTable

The virtual table of the class.

AddEventHandlerRegistry

A registry for adding event handlers to various controls: the events an event trigger subscribes by name before it looks for the event in the metadata of the source.

Behavior

A base class for behaviors, implementing the basic plumbing of IBehavior.

BehaviorCollection

Represents a collection of IBehaviors with a shared associated_object.

BehaviorCollectionTemplate

A template for creating a collection of IBehavior objects.

BehaviorOfT

A base class for behaviors making them code compatible with older frameworks, and allow for typed associated objects (Behavior<T>).

BehaviorVTable

The virtual table of the class.

Condition

Represents a reusable comparison that can be used by triggers and behaviors.

ConditionCollection

Represents a collection of Condition objects.

DisposableAction

Represents an IDisposable that executes a specified action when disposed.

DisposingBehavior

A base class for behaviors with disposable resources: the resource on_attached_override creates is disposed when the behavior is detached.

DisposingBehaviorVTable

The virtual table of the class.

DisposingTrigger

A base class for triggers that require a disposable resource: the resource on_attached_override creates is disposed when the trigger is detached.

DisposingTriggerVTable

The virtual table of the class.

EventTriggerBase

A behavior that listens for a specified event on its source and executes its actions when that event is fired.

EventTriggerBaseVTable

The virtual table of the class.

FuncAddEventHandler

An IAddEventHandler for the event name of sources of type TTarget, from a function that subscribes a handler and a function that removes it.

Interaction

Defines a BehaviorCollection attached property and provides a method for executing an ActionCollection.

InteractiveBehaviorBase

Base class for behaviors that listen for routed events (a behavior attached to an Interactive).

InteractiveTriggerBase

Base class for triggers that listen for routed events (a trigger attached to an Interactive).

InvokeCommandActionBase

Command action base class: an action that invokes a command, reports whether the command can execute (can_execute_command) and can make the input element of its trigger follow it (use_command_can_execute_for_is_enabled).

InvokeCommandBehaviorBase

Invoke command behavior base class: a behavior of a Control that invokes a command, reports whether the command can execute (can_execute_command) and can make the control follow it (use_command_can_execute_for_is_enabled).

NotificationTemplate

A template for creating notifications: each build creates a new notification from the content.

ObjectTemplate

A template for creating custom objects: each build creates a new object from the content.

StyledElementAction

A base class for action that calls a method on a specified object when invoked.

StyledElementActionVTable

The virtual table of the class.

StyledElementBehavior

A base class for behaviors, implementing the basic plumbing of IBehavior.

StyledElementBehaviorOfT

A base class for behaviors making them code compatible with older frameworks, and allow for typed associated objects (StyledElementBehavior<T>).

StyledElementBehaviorVTable

The virtual table of the class.

StyledElementTrigger

A base class for behaviors, implementing the basic plumbing of ITrigger.

StyledElementTriggerOfT

A base class for behaviors, implementing the basic plumbing of ITrigger, with a typed associated object (StyledElementTrigger<T>).

Trigger

A base class for behaviors, implementing the basic plumbing of ITrigger.

TriggerOfT

A base class for behaviors, implementing the basic plumbing of ITrigger, with a typed associated object (Trigger<T>).

Enums

ComparisonConditionType

Represents one ternary condition.

Statics

ASSEMBLY

What this crate states about itself for markup: its assembly name and the namespace the XML namespace of the framework maps to.

Traits

ActionImpl

The overridable members introduced by the class.

ActionImplExt

Access to the base implementations of the overridable members.

BehaviorImpl

The overridable members introduced by the class.

BehaviorImplExt

Access to the base implementations of the overridable members.

DisposingBehaviorImpl

The overridable members introduced by the class.

DisposingBehaviorImplExt

Access to the base implementations of the overridable members.

DisposingTriggerImpl

The overridable members introduced by the class.

DisposingTriggerImplExt

Access to the base implementations of the overridable members.

EventArgsValue

The event args of an event as the untyped value an IAddEventHandler passes on (the args are an object in the reference).

EventTriggerBaseImpl

The overridable members introduced by the class.

EventTriggerBaseImplExt

Access to the base implementations of the overridable members.

FerroObjectBehaviorsExtensions

Surfaces Interaction::behaviors_property directly on FerroObject: the static members FerroObject::behaviors_property(), FerroObject::get_behaviors(..) and FerroObject::set_behaviors(..) when this trait is in scope.

IAction

Interface implemented by all custom actions.

IAddEventHandler

A service that provides a way to register event handlers for specific events on various controls.

IBehavior

Interface implemented by all custom behaviors.

IBehaviorEventsHandler

Interface implemented by base behaviors: the lifecycle callbacks of the host that a behavior collection forwards to its behaviors.

IReversibleAction

Interface for actions that can revert the effect of a previous IAction::execute call.

ITrigger

Interface implemented by all custom triggers.

StyledElementActionImpl

The overridable members introduced by the class.

StyledElementActionImplExt

Access to the base implementations of the overridable members.

StyledElementBehaviorImpl

The overridable members introduced by the class.

StyledElementBehaviorImplExt

Access to the base implementations of the overridable members.

Functions

register_types

Registers the namespace, the types, the markup metadata and the assembly of this crate (and of the crates it is built on). Cheap and idempotent.

Type Aliases

AddEventHandlerCallback

The handler an IAddEventHandler subscribes: it receives the sender (if the event has one) and the event args, untyped (Action<object?, object>).

EventHandler

The handler FuncAddEventHandler gives to the subscription function: the sender and the typed event args (EventHandler<TEventArgs>).