inset-gestures 0.10.0

Gesture arena and recognizers for Inset
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

//! Flutter counterpart: `gestures/drag.dart`.

use inset_foundation::{App, Handle};

use crate::drag_details::{DragEndDetails, DragUpdateDetails};

/// Interface for objects that receive updates about drags.
///
/// This interface is used in various ways. For example,
/// `MultiDragGestureRecognizer` uses it to update its clients when it recognizes
/// a gesture. Similarly, the scrolling infrastructure in the widgets library
/// uses it to notify the `DragScrollActivity` when the user drags the
/// scrollable.
///
/// What a field or parameter Dart types as `Drag` becomes an `Rc<dyn Drag>`; an arena object
/// implements [`DragObject`], and `Rc::new(handle)` is its erased form.
pub trait Drag {
    /// The pointer has moved.
    fn update(&self, app: &mut App, details: DragUpdateDetails);

    /// The pointer is no longer in contact with the screen.
    ///
    /// The velocity at which the pointer was moving when it stopped contacting
    /// the screen is available in the `details`.
    fn end(&self, app: &mut App, details: DragEndDetails);

    /// The input from the pointer is no longer directed towards this receiver.
    ///
    /// For example, the user might have been interrupted by a system-modal dialog
    /// in the middle of the drag.
    fn cancel(&self, app: &mut App);
}

/// The object side of [`Drag`]: an arena object that receives drag updates. Implementing it
/// makes `Handle<Self>` a [`Drag`]; Dart's empty default bodies are the defaults here.
pub trait DragObject: Sized + 'static {
    /// See [`Drag::update`].
    fn update(self: Handle<Self>, _app: &mut App, _details: DragUpdateDetails) {}

    /// See [`Drag::end`].
    fn end(self: Handle<Self>, _app: &mut App, _details: DragEndDetails) {}

    /// See [`Drag::cancel`].
    fn cancel(self: Handle<Self>, _app: &mut App) {}
}

impl<T: DragObject> Drag for Handle<T> {
    fn update(&self, app: &mut App, details: DragUpdateDetails) {
        T::update(*self, app, details);
    }

    fn end(&self, app: &mut App, details: DragEndDetails) {
        T::end(*self, app, details);
    }

    fn cancel(&self, app: &mut App) {
        T::cancel(*self, app);
    }
}