embedded-text 0.4.1

TextBox for embedded-graphics
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

//! Bottom vertical text alignment.
use crate::{
    alignment::{HorizontalTextAlignment, VerticalTextAlignment},
    rendering::cursor::Cursor,
    style::height_mode::HeightMode,
    StyledTextBox,
};
use embedded_graphics::prelude::*;

/// Align text to the bottom of the TextBox.
#[derive(Copy, Clone, Debug)]
pub struct BottomAligned;

impl VerticalTextAlignment for BottomAligned {
    #[inline]
    fn apply_vertical_alignment<'a, C, F, A, H>(
        cursor: &mut Cursor<F>,
        styled_text_box: &'a StyledTextBox<'a, C, F, A, Self, H>,
    ) where
        C: PixelColor,
        F: Font + Copy,
        A: HorizontalTextAlignment,
        H: HeightMode,
    {
        let text_height = styled_text_box
            .style
            .measure_text_height(styled_text_box.text_box.text, cursor.line_width())
            as i32;

        let box_height = styled_text_box.size().height as i32;
        let offset = box_height - text_height;

        cursor.position.y += offset
    }
}

#[cfg(test)]
mod test {
    use embedded_graphics::{
        fonts::Font6x8, mock_display::MockDisplay, pixelcolor::BinaryColor, prelude::*,
        primitives::Rectangle,
    };

    use crate::{
        alignment::BottomAligned, style::height_mode::Exact, style::vertical_overdraw::Visible,
        style::TextBoxStyleBuilder, TextBox,
    };

    #[test]
    fn test_bottom_alignment() {
        let mut display = MockDisplay::new();
        let style = TextBoxStyleBuilder::new(Font6x8)
            .vertical_alignment(BottomAligned)
            .text_color(BinaryColor::On)
            .background_color(BinaryColor::Off)
            .build();

        TextBox::new("word", Rectangle::new(Point::zero(), Point::new(54, 15)))
            .into_styled(style)
            .draw(&mut display)
            .unwrap();

        assert_eq!(
            display,
            MockDisplay::from_pattern(&[
                "                        ",
                "                        ",
                "                        ",
                "                        ",
                "                        ",
                "                        ",
                "                        ",
                "                        ",
                "......................#.",
                "......................#.",
                "#...#..###..#.##...##.#.",
                "#...#.#...#.##..#.#..##.",
                "#.#.#.#...#.#.....#...#.",
                "#.#.#.#...#.#.....#...#.",
                ".#.#...###..#......####.",
                "........................",
            ])
        );
    }

    #[test]
    fn test_bottom_alignment_tall_text() {
        let mut display = MockDisplay::new();
        let style = TextBoxStyleBuilder::new(Font6x8)
            .vertical_alignment(BottomAligned)
            .text_color(BinaryColor::On)
            .background_color(BinaryColor::Off)
            .build();

        TextBox::new(
            "word1 word2 word3 word4",
            Rectangle::new(Point::zero(), Point::new(30, 15)),
        )
        .into_styled(style)
        .draw(&mut display)
        .unwrap();

        assert_eq!(
            display,
            MockDisplay::from_pattern(&[
                "......................#..###..",
                "......................#.#...#.",
                "#...#..###..#.##...##.#.....#.",
                "#...#.#...#.##..#.#..##...##..",
                "#.#.#.#...#.#.....#...#.....#.",
                "#.#.#.#...#.#.....#...#.#...#.",
                ".#.#...###..#......####..###..",
                "..............................",
                "......................#....#..",
                "......................#...##..",
                "#...#..###..#.##...##.#..#.#..",
                "#...#.#...#.##..#.#..##.#..#..",
                "#.#.#.#...#.#.....#...#.#####.",
                "#.#.#.#...#.#.....#...#....#..",
                ".#.#...###..#......####....#..",
                "..............................",
            ])
        );
    }

    #[test]
    fn test_bottom_alignment_tall_text_with_line_spacing() {
        let mut display = MockDisplay::new();
        let style = TextBoxStyleBuilder::new(Font6x8)
            .vertical_alignment(BottomAligned)
            .text_color(BinaryColor::On)
            .background_color(BinaryColor::Off)
            .height_mode(Exact(Visible))
            .line_spacing(2)
            .build();

        TextBox::new(
            "word1 word2 word3 word4",
            Rectangle::new(Point::zero(), Point::new(30, 15)),
        )
        .into_styled(style)
        .draw(&mut display)
        .unwrap();

        assert_eq!(
            display,
            MockDisplay::from_pattern(&[
                "#...#..###..#.##...##.#.....#.",
                "#...#.#...#.##..#.#..##...##..",
                "#.#.#.#...#.#.....#...#.....#.",
                "#.#.#.#...#.#.....#...#.#...#.",
                ".#.#...###..#......####..###..",
                "..............................",
                "                              ",
                "                              ",
                "......................#....#..",
                "......................#...##..",
                "#...#..###..#.##...##.#..#.#..",
                "#...#.#...#.##..#.#..##.#..#..",
                "#.#.#.#...#.#.....#...#.#####.",
                "#.#.#.#...#.#.....#...#....#..",
                ".#.#...###..#......####....#..",
                "..............................",
            ])
        );
    }
}