rlvgl-ui 0.2.6

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

// SPDX-License-Identifier: MIT
//! Linear progress component for rlvgl-ui.
//!
//! [`Progress`] wraps [`rlvgl_widgets::progress::ProgressBar`] with a concise
//! app-facing name and fluent value/color setters.

use rlvgl_core::{
    event::Event,
    renderer::Renderer,
    widget::{Color, Rect, Widget},
};
use rlvgl_widgets::progress::ProgressBar;

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

/// Linear progress indicator.
pub struct Progress {
    inner: ProgressBar,
}

impl Progress {
    /// Create a progress indicator with an inclusive value range.
    pub fn new(bounds: Rect, min: i32, max: i32) -> Self {
        Self {
            inner: ProgressBar::new(bounds, min, max),
        }
    }

    /// Set the current value and return the widget.
    pub fn with_value(mut self, value: i32) -> Self {
        self.inner.set_value(value);
        self
    }

    /// Return the current progress value.
    pub fn value(&self) -> i32 {
        self.inner.value()
    }

    /// Set the current progress value.
    pub fn set_value(&mut self, value: i32) {
        self.inner.set_value(value);
    }

    /// Set the filled-track color and return the widget.
    pub fn fill_color(mut self, color: Color) -> Self {
        self.inner.bar_color = color;
        self
    }

    /// Return the filled-track color.
    pub fn fill_color_value(&self) -> Color {
        self.inner.bar_color
    }

    /// Set the filled-track color.
    pub fn set_fill_color(&mut self, color: Color) {
        self.inner.bar_color = color;
    }

    /// Apply a themed style and fill 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.bar_color = resolved.accent_color;
        self
    }

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

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

impl Widget for Progress {
    fn bounds(&self) -> Rect {
        self.inner.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 progress_sets_value_and_fill_color() {
        let mut progress = Progress::new(rect(0, 0, 100, 8), 0, 100)
            .with_value(40)
            .fill_color(Color(1, 2, 3, 255));

        assert_eq!(progress.value(), 40);
        assert_eq!(progress.fill_color_value(), Color(1, 2, 3, 255));
        progress.set_value(150);
        assert_eq!(progress.value(), 100);
    }

    #[test]
    fn progress_themed_sets_style_and_fill() {
        let theme = Theme::material_light();
        let progress = Progress::new(rect(0, 0, 100, 8), 0, 100).themed(
            &theme,
            ColorScheme::Success,
            Variant::Subtle,
            ComponentSize::Sm,
        );

        assert_eq!(
            progress.fill_color_value(),
            theme.scheme(ColorScheme::Success).solid
        );
        assert_eq!(progress.style().radius, theme.tokens.radii.sm);
    }

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