Crate ferroui_xaml_interactions

Expand description

ferroui-xaml-interactions

The classic triggers and actions of the behaviors of FerroUI, ported from the Xaml.Behaviors.Interactions project of Xaml.Behaviors (see NOTICE.md):

triggers on events (EventTriggerBehavior), on bound data (DataTriggerBehavior, MultiDataTriggerBehavior), on timers (TimerTrigger), on tasks (TaskCompletedTrigger) and on observables (ObservableStreamBehavior);
actions that change a property (ChangePropertyAction, reversible), call a method (CallMethodAction) or invoke a command (InvokeCommandAction), and the action containers that delay, debounce, throttle or group their actions;
the clipboard actions and the storage pickers (actions and behaviors of buttons and menu items) of the services of the top level;
behind the features file-system and network, the actions and the triggers of the local file system and of the network.

The namespaces of the crate are FerroUI.Xaml.Interactions.Core (with the clipboard and the storage pickers), FerroUI.Xaml.Interactions.FileSystem and FerroUI.Xaml.Interactions.Network, mapped into the default XML namespace of the framework: documents name its types without a prefix once register_types ran.

Structs§

AsyncActionGroup: An action that executes its child actions asynchronously, either in sequence or in parallel.
AsyncDataTransferRef: A data transfer that is read asynchronously (IAsyncDataTransfer).
ButtonOpenFilePickerBehavior: Open file picker behavior for Button: the picker opens when the button is clicked.
ButtonOpenFolderPickerBehavior: Open folder picker behavior for Button: the picker opens when the button is clicked.
ButtonSaveFilePickerBehavior: Save file picker behavior for Button: the picker opens when the button is clicked.
CallMethodAction: An action that calls a method on a specified object when invoked.
ChangePropertyAction: An action that will change a specified property to a specified value when invoked.
ClearClipboardAction: An action that will clear the clipboard.
ClipboardRef: A clipboard (IClipboard).
DataTrigger: A behavior that performs actions when the bound data meets a specified condition (the short name of DataTriggerBehavior).
DataTriggerBehavior: A behavior that performs actions when the bound data meets a specified condition.
DebounceAction: An action that will execute its child actions after a specified delay. If invoked again before the delay elapses, the timer is reset.
Delay: The future of delay.
DelayAction: An action that waits for a specified duration.
EventTrigger: A behavior that listens for a specified event on its source and executes its actions when that event is fired.
EventTriggerBehavior: A behavior that listens for a specified event on its source and executes its actions when that event is fired.
FilePickerEventArgs: Event args raised after a file pick operation completes.
FolderPickerEventArgs: Event args raised after a folder pick operation completes.
GetClipboardDataAction: An action that will get the data of a format from the clipboard and pass it to its command.
GetClipboardFormatsAction: An action that will get the clipboard formats and pass them to its command (a list of the identifiers of the formats, Vec<String>).
GetClipboardTextAction: An action that will get the text from the clipboard and pass it to its command.
InvokeCommandAction: Executes a specified command (ICommand) when invoked.
MenuItemOpenFilePickerBehavior: Open file picker behavior for MenuItem: the picker opens when the menu item is clicked.
MenuItemOpenFolderPickerBehavior: Open folder picker behavior for MenuItem: the picker opens when the menu item is clicked.
MenuItemSaveFilePickerBehavior: Save file picker behavior for MenuItem: the picker opens when the menu item is clicked.
MultiDataTrigger: A behavior that performs actions when all bound data conditions are satisfied (the short name of MultiDataTriggerBehavior).
MultiDataTriggerBehavior: A behavior that performs actions when all bound data conditions are satisfied.
ObservableStreamBehavior: A behavior that subscribes to an observable and executes actions on its values, its error and its completion.
OpenFilePickerAction: An action that will open a file picker dialog.
OpenFilePickerActionVTable: The virtual table of the class.
OpenFilePickerBehaviorBase: Open file picker behavior base: a behavior that opens a file picker dialog when the deriving class calls execute.
OpenFilePickerBehaviorBaseVTable: The virtual table of the class.
OpenFolderPickerAction: An action that will open a folder picker dialog.
OpenFolderPickerActionVTable: The virtual table of the class.
OpenFolderPickerBehaviorBase: Open folder picker behavior base: a behavior that opens a folder picker dialog when the deriving class calls execute.
OpenFolderPickerBehaviorBaseVTable: The virtual table of the class.
PickerActionBase: Base class for picker actions: the storage provider, the title and the suggested start location of the picker, and the tracking of the picker operations that run.
PickerBehaviorBase: Base class for picker behaviors: the storage provider, the title and the suggested start location of the picker.
ReversibleActionExecution: Executes the actions of a collection, the reversible ones reversibly (an internal class of the reference).
SaveFilePickerAction: An action that will open a save file picker dialog.
SaveFilePickerActionVTable: The virtual table of the class.
SaveFilePickerBehaviorBase: Save file picker behavior base: a behavior that opens a save file picker dialog when the deriving class calls execute.
SaveFilePickerBehaviorBaseVTable: The virtual table of the class.
SaveFilePickerEventArgs: Event args raised after a save file pick operation completes.
SetClipboardDataObjectAction: An action that will set the data object to the clipboard.
SetClipboardTextAction: An action that will set the text to the clipboard.
StorageFileRef: A file of a storage provider (IStorageFile).
StorageFileToReadStreamConverter: Converts a storage file to a read stream: the task of opening the stream (TaskHandle<std::io::Result<Box<dyn Read>>>).
StorageFileToWriteStreamConverter: Converts a storage file to a write stream: the task of opening the stream (TaskHandle<std::io::Result<Box<dyn Write>>>).
StorageFolderRef: A folder of a storage provider (IStorageFolder).
StorageItemRef: A file or folder of a storage provider (IStorageItem).
StorageItemToPathConverter: Converts a storage item to its path (a Uri).
StorageProviderRef: A storage provider (IStorageProvider).
TaskCompletedTrigger: A trigger that invokes its actions when the supplied task completes.
TaskHandle: A task of the dispatcher of the user interface, held as an untyped value (Task<T>).
ThrottleAction: An action that will execute its child actions immediately, but ignores subsequent invocations until a specified interval has passed.
TimerTrigger: A trigger that invokes its actions after a specified interval.

Enums§

AsyncActionMode: Defines the mode of execution for AsyncActionGroup.

Statics§

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

Traits§

OpenFilePickerActionImpl: The overridable members introduced by the class.
OpenFilePickerActionImplExt: Access to the base implementations of the overridable members.
OpenFilePickerBehaviorBaseImpl: The overridable members introduced by the class.
OpenFilePickerBehaviorBaseImplExt: Access to the base implementations of the overridable members.
OpenFolderPickerActionImpl: The overridable members introduced by the class.
OpenFolderPickerActionImplExt: Access to the base implementations of the overridable members.
OpenFolderPickerBehaviorBaseImpl: The overridable members introduced by the class.
OpenFolderPickerBehaviorBaseImplExt: Access to the base implementations of the overridable members.
SaveFilePickerActionImpl: The overridable members introduced by the class.
SaveFilePickerActionImplExt: Access to the base implementations of the overridable members.
SaveFilePickerBehaviorBaseImpl: The overridable members introduced by the class.
SaveFilePickerBehaviorBaseImplExt: Access to the base implementations of the overridable members.

Functions§

delay: A future that completes after duration (Task.Delay(duration)), measured by a timer of the dispatcher of the thread that first polls it. A zero duration completes at the first poll.
register_types: Registers the namespaces, the types, the markup metadata and the assembly of this crate (and of the crates it is built on). Cheap and idempotent.

Type Aliases§

ActionTask: The task of an action that produces no value (Task).