ferroui-xaml-interactions 0.4.0

The classic triggers and actions of the FerroUI behaviors: event, data and timer triggers, property, method and command actions, clipboard actions and storage pickers
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

//! Port of `Core/TaskCompletedTrigger.cs`.

use crate::action_task::{ActionTask, CatchUnwind};
use ferroui_base::threading::{Dispatcher, DispatcherPriority};
use ferroui_base::{
    ferro_class, ferro_class_info, ferro_properties, instantiate, BoxedValue, FerroObjectImpl, FerroObjectImplExt,
    FerroProperty, FerroPropertyChangedEventArgs, Ref, StyledElementImpl, StyledProperty,
};
use ferroui_xaml_interactivity::{Interaction, StyledElementBehaviorImpl, StyledElementTrigger};
use std::rc::Rc;

/// A trigger that invokes its actions when the supplied task completes.
///
/// The task is an [`ActionTask`] (the `Task` of the reference); the actions run in a job of the
/// dispatcher after it completed, whether it ran to the end, failed or was canceled.
#[repr(C)]
pub struct TaskCompletedTrigger {
    base: StyledElementTrigger,
}

ferro_class!(TaskCompletedTrigger: StyledElementTrigger);
ferro_class_info!(TaskCompletedTrigger { new: TaskCompletedTrigger::new });
ferroui_base::ferro_impl_classes!(TaskCompletedTrigger: StyledElementImpl, StyledElementBehaviorImpl);

ferro_properties! {
    impl TaskCompletedTrigger {
        /// Identifies the `Task` property.
        pub fn task_property() -> StyledProperty<Option<ActionTask>> {
            FerroProperty::register::<TaskCompletedTrigger, _>("Task", None)
        }
    }
}

ferroui_base::ferro_overrides! {
    impl FerroObjectImpl for TaskCompletedTrigger {
        fn on_property_changed(this: &Self, change: &FerroPropertyChangedEventArgs<'_>) {
            Self::parent_on_property_changed(this, change);

            if change.property() == Self::task_property().as_property() {
                this.on_task_changed(change.get_new_value::<Option<ActionTask>>());
            }
        }
    }
}

impl TaskCompletedTrigger {
    /// Creates the class data; see [`ferroui_base::FerroObject::construct`].
    pub fn construct() -> Self {
        Self { base: StyledElementTrigger::construct() }
    }

    /// Creates a trigger.
    pub fn new() -> Ref<Self> {
        instantiate(Self::construct())
    }

    /// Gets or sets the task monitored by the trigger.
    pub fn task(&self) -> Option<ActionTask> {
        self.get_value(Self::task_property())
    }

    pub fn set_task(&self, value: Option<ActionTask>) {
        self.set_value(Self::task_property(), value)
    }

    fn on_task_changed(&self, task: Option<ActionTask>) {
        let Some(task) = task else {
            return;
        };

        // `task.ContinueWith(..)`: the continuation runs whatever the outcome of the task.
        let trigger: Ref<TaskCompletedTrigger> = self.to_ref();
        drop(ActionTask::spawn(async move {
            let _ = CatchUnwind::new(task).await;
            Dispatcher::ui_thread().post_local(
                move || {
                    let sender = trigger
                        .associated_object()
                        .map(|associated_object| Rc::new(associated_object) as BoxedValue);
                    Interaction::execute_actions(sender.as_ref(), trigger.actions().as_ref(), None);
                },
                DispatcherPriority::DEFAULT,
            );
        }));
    }
}