egui 0.37.0

An easy-to-use immediate mode GUI that runs on both web and native
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

use crate::class::ClassName;

/// Any widgets supporting [`crate::class::Classes`] must implement this trait.
pub trait HasClasses {
    fn classes(&self) -> &crate::class::Classes;

    fn classes_mut(&mut self) -> &mut crate::class::Classes;

    /// True if the class is present.
    #[inline]
    fn has_class(&self, class: &str) -> bool {
        self.classes()
            .iter()
            .any(|existing| existing.as_str() == class)
    }

    /// Add the given class in-place.
    #[inline]
    fn add_class(&mut self, class: impl Into<ClassName>) -> &mut Self
    where
        Self: Sized,
    {
        self.classes_mut().add_if(class.into(), true);
        self
    }

    /// Add the given class in-place if `present`, remove it otherwise.
    ///
    /// Use this for a setter that takes a `bool`, so that the last call wins.
    #[inline]
    fn set_class(&mut self, class: impl Into<ClassName>, present: bool) -> &mut Self
    where
        Self: Sized,
    {
        self.classes_mut().set(class.into(), present);
        self
    }

    /// Remove the given class in-place.
    #[inline]
    fn remove_class(&mut self, class: impl Into<ClassName>) -> &mut Self
    where
        Self: Sized,
    {
        self.classes_mut().set(class.into(), false);
        self
    }

    /// Add the given class by consuming `self`.
    #[inline]
    fn with_class(mut self, class: impl Into<ClassName>) -> Self
    where
        Self: Sized,
    {
        self.classes_mut().add_if(class.into(), true);
        self
    }

    /// Append all the given classes at the end, deduplicating them.
    #[inline]
    fn add_classes(&mut self, classes: crate::class::Classes) -> &mut Self {
        self.classes_mut().extend(classes);
        self
    }

    /// Append all the given classes at the end, deduplicating them. Consuming `self`.
    #[inline]
    fn with_classes(mut self, classes: crate::class::Classes) -> Self
    where
        Self: Sized,
    {
        self.classes_mut().extend(classes);
        self
    }

    /// Add a class to the list if the condition is true.
    ///
    /// A class is never added twice. This never removes a class: use [`Self::set_class`] for that.
    #[inline]
    fn add_class_if(&mut self, class: impl Into<ClassName>, condition: bool) -> &mut Self
    where
        Self: Sized,
    {
        self.classes_mut().add_if(class.into(), condition);
        self
    }

    /// Add the given class by consuming `self` if the condition is true.
    ///
    /// A class is never added twice. This never removes a class: use [`Self::set_class`] for that.
    #[inline]
    fn with_class_if(mut self, class: impl Into<ClassName>, condition: bool) -> Self
    where
        Self: Sized,
    {
        self.classes_mut().add_if(class.into(), condition);
        self
    }

    /// Iterate over the classes, in the order they were added.
    #[inline]
    fn iter_classes(&self) -> core::slice::Iter<'_, ClassName> {
        self.classes().iter()
    }

    /// Return the classes as a slice.
    #[inline]
    fn classes_as_slice(&self) -> &[ClassName] {
        self.classes().as_slice()
    }
}

#[cfg(test)]
mod tests {
    use crate::class::{Classes, HasClasses as _};

    #[test]
    fn setting_a_class_moves_it_to_end() {
        let mut classes = Classes::default();
        classes.add_class("first");
        classes.add_class("updated");
        classes.add_class("second");

        classes.set_class("updated", true);

        assert_eq!(classes.as_slice(), ["first", "second", "updated"]);
    }

    #[test]
    fn adding_a_class_twice_moves_it_to_end() {
        let mut classes = Classes::default();
        classes.add_class("first");
        classes.add_class("updated");
        classes.add_class("second");

        classes.add_class("updated");

        assert_eq!(classes.as_slice(), ["first", "second", "updated"]);
    }
}