mirui 0.46.0

A lightweight, no_std ECS-driven UI framework for embedded, mobile, desktop, and WebAssembly
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

use crate::types::Fixed;

/// Scroll direction
#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
pub enum ScrollAxis {
    #[default]
    Vertical,
    Horizontal,
    Both,
}

/// Controls whether a pointer drag may be claimed by an ancestor scroller.
///
/// The nearest non-`Auto` value between the hit widget and the scroller wins.
/// Wheel and rotary input are unaffected.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
pub enum TouchAction {
    /// Defer to the nearest ancestor with an explicit policy.
    #[default]
    Auto,
    /// Keep both drag axes available to the widget.
    None,
    /// Allow horizontal scrolling while keeping vertical drags for the widget.
    PanX,
    /// Allow vertical scrolling while keeping horizontal drags for the widget.
    PanY,
}

impl TouchAction {
    pub(crate) const fn allows_scroll(self, axis: ScrollAxis) -> bool {
        matches!(
            (self, axis),
            (Self::Auto, _)
                | (Self::PanX, ScrollAxis::Horizontal)
                | (Self::PanY, ScrollAxis::Vertical)
        )
    }
}

/// Scroll offset component — any widget with this becomes scrollable
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub struct ScrollOffset {
    pub x: Fixed,
    pub y: Fixed,
}

/// Per-frame `ScrollOffset` increment. Input / inertia systems write
/// it; the dirty walker reads it to plan a framebuffer self-blit and
/// subtracts the integer pixels it consumed, leaving any sub-pixel
/// residue for the next frame.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub struct ScrollDelta {
    pub dx: Fixed,
    pub dy: Fixed,
}

/// Scroll configuration.
///
/// A zero content dimension derives that extent from the widget's retained
/// descendants. Virtualized content can provide an explicit dimension.
pub struct ScrollConfig {
    pub direction: ScrollAxis,
    pub elastic: bool,
    pub content_height: Fixed,
    pub content_width: Fixed,
}

impl Default for ScrollConfig {
    fn default() -> Self {
        Self {
            direction: ScrollAxis::Vertical,
            elastic: true,
            content_height: Fixed::ZERO,
            content_width: Fixed::ZERO,
        }
    }
}