rlvgl-ui 0.2.5

High-level UI components and theming for rlvgl.
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

// SPDX-License-Identifier: MIT
//! Spinner component for rlvgl-ui.
//!
//! Wraps the deterministic tick-driven [`rlvgl_widgets::spinner::Spinner`].

use rlvgl_core::{
    event::Event,
    renderer::Renderer,
    widget::{Color, Rect, Widget},
};
use rlvgl_widgets::spinner::Spinner as BaseSpinner;

use crate::theme::{ColorScheme, ComponentSize, Theme, Variant};

/// Deterministic tick-driven busy indicator.
pub struct Spinner {
    inner: BaseSpinner,
}

impl Spinner {
    /// Create a spinner.
    pub fn new(bounds: Rect) -> Self {
        Self {
            inner: BaseSpinner::new(bounds),
        }
    }

    /// Set animation period and arc length, then return the widget.
    pub fn animation(mut self, period_ticks: u32, arc_length_deg: i32) -> Self {
        self.inner.set_anim_params(period_ticks, arc_length_deg);
        self
    }

    /// Set animation period and arc length.
    pub fn set_animation(&mut self, period_ticks: u32, arc_length_deg: i32) {
        self.inner.set_anim_params(period_ticks, arc_length_deg);
    }

    /// Return the effective animation period in ticks.
    pub fn period_ticks(&self) -> u32 {
        self.inner.period_ticks()
    }

    /// Return the active indicator arc length in degrees.
    pub fn arc_length_deg(&self) -> i32 {
        self.inner.arc_length_deg()
    }

    /// Set the moving indicator color and return the widget.
    pub fn indicator_color(mut self, color: Color) -> Self {
        self.inner.indicator_color = color;
        self
    }

    /// Return the moving indicator color.
    pub fn indicator_color_value(&self) -> Color {
        self.inner.indicator_color
    }

    /// Set the moving indicator color.
    pub fn set_indicator_color(&mut self, color: Color) {
        self.inner.indicator_color = color;
    }

    /// Apply a themed style and indicator color.
    pub fn themed(
        mut self,
        theme: &Theme,
        scheme: ColorScheme,
        variant: Variant,
        size: ComponentSize,
    ) -> Self {
        let resolved = theme.component_style(scheme, variant, size);
        self.inner.style = resolved.style;
        self.inner.indicator_color = resolved.accent_color;
        self
    }

    /// Immutable access to the spinner style.
    pub fn style(&self) -> &rlvgl_core::style::Style {
        &self.inner.style
    }

    /// Mutable access to the spinner style.
    pub fn style_mut(&mut self) -> &mut rlvgl_core::style::Style {
        &mut self.inner.style
    }
}

impl Widget for Spinner {
    fn bounds(&self) -> Rect {
        self.inner.bounds()
    }

    fn set_bounds(&mut self, bounds: Rect) {
        self.inner.set_bounds(bounds);
    }

    fn draw(&self, renderer: &mut dyn Renderer) {
        self.inner.draw(renderer);
    }

    fn handle_event(&mut self, event: &Event) -> bool {
        self.inner.handle_event(event)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn spinner_builder_sets_animation_and_indicator() {
        let spinner = Spinner::new(rect(0, 0, 40, 40))
            .animation(30, 120)
            .indicator_color(Color(4, 5, 6, 255));

        assert_eq!(spinner.period_ticks(), 30);
        assert_eq!(spinner.arc_length_deg(), 120);
        assert_eq!(spinner.indicator_color_value(), Color(4, 5, 6, 255));
    }

    #[test]
    fn spinner_themed_sets_style_and_indicator() {
        let theme = Theme::material_light();
        let spinner = Spinner::new(rect(0, 0, 40, 40)).themed(
            &theme,
            ColorScheme::Primary,
            Variant::Subtle,
            ComponentSize::Md,
        );

        assert_eq!(
            spinner.indicator_color_value(),
            theme.scheme(ColorScheme::Primary).solid
        );
        assert_eq!(spinner.style().radius, theme.tokens.radii.md);
    }

    fn rect(x: i32, y: i32, width: i32, height: i32) -> Rect {
        Rect {
            x,
            y,
            width,
            height,
        }
    }
}