ferroui-base 0.3.0

The base library of FerroUI: the property system, layout, input, styling, media, text, animation, data binding and the compositor
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

use super::InputElement;
use crate::interactivity::RoutedEventArgs;
use crate::{ferro_routed_event_args, Vector};
use std::cell::Cell;
use std::rc::Rc;
use std::sync::atomic::{AtomicI32, Ordering};

static NEXT_ID: AtomicI32 = AtomicI32::new(1);

/// Provides data for the scroll gesture event.
#[derive(Clone)]
pub struct ScrollGestureEventArgs {
    base: RoutedEventArgs,
    id: i32,
    delta: Vector,
    should_end_scroll_gesture: Rc<Cell<bool>>,
}

ferro_routed_event_args!(ScrollGestureEventArgs: RoutedEventArgs);

impl ScrollGestureEventArgs {
    /// Creates scroll gesture event args.
    pub fn new(id: i32, delta: Vector) -> Self {
        Self {
            base: RoutedEventArgs::with_event(InputElement::scroll_gesture_event()),
            id,
            delta,
            should_end_scroll_gesture: Rc::new(Cell::new(false)),
        }
    }

    /// Returns a new gesture identifier.
    pub fn get_next_free_id() -> i32 {
        NEXT_ID.fetch_add(1, Ordering::Relaxed)
    }

    /// The identifier of the gesture.
    #[inline]
    pub fn id(&self) -> i32 {
        self.id
    }

    /// The distance scrolled since the previous event.
    #[inline]
    pub fn delta(&self) -> Vector {
        self.delta
    }

    /// When set, the scroll gesture recognizer should stop its current
    /// active scroll gesture.
    #[inline]
    pub fn should_end_scroll_gesture(&self) -> bool {
        self.should_end_scroll_gesture.get()
    }

    #[inline]
    pub fn set_should_end_scroll_gesture(&self, value: bool) {
        self.should_end_scroll_gesture.set(value)
    }
}

/// Provides data for the scroll gesture ended event.
#[derive(Clone)]
pub struct ScrollGestureEndedEventArgs {
    base: RoutedEventArgs,
    id: i32,
}

ferro_routed_event_args!(ScrollGestureEndedEventArgs: RoutedEventArgs);

impl ScrollGestureEndedEventArgs {
    /// Creates scroll gesture ended event args.
    pub fn new(id: i32) -> Self {
        Self { base: RoutedEventArgs::with_event(InputElement::scroll_gesture_ended_event()), id }
    }

    /// The identifier of the gesture.
    #[inline]
    pub fn id(&self) -> i32 {
        self.id
    }
}

/// Provides data for the scroll gesture inertia starting event.
#[derive(Clone)]
pub struct ScrollGestureInertiaStartingEventArgs {
    base: RoutedEventArgs,
    id: i32,
    inertia: Vector,
}

ferro_routed_event_args!(ScrollGestureInertiaStartingEventArgs: RoutedEventArgs);

impl ScrollGestureInertiaStartingEventArgs {
    #[allow(dead_code)]
    pub(crate) fn new(id: i32, inertia: Vector) -> Self {
        Self {
            base: RoutedEventArgs::with_event(InputElement::scroll_gesture_inertia_starting_event()),
            id,
            inertia,
        }
    }

    /// The identifier of the gesture.
    #[inline]
    pub fn id(&self) -> i32 {
        self.id
    }

    /// The velocity the inertia starts with.
    #[inline]
    pub fn inertia(&self) -> Vector {
        self.inertia
    }
}