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 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
//! Height adjustment options. //! //! This module defines various options to set the height of a [`StyledTextBox`]. Although it is //! necessary to specify the size of a [`TextBox`], sometimes we may want the text to stretch or //! shrink the text box. Height modes help us achieve this. //! //! [`TextBox`]: ../../struct.TextBox.html use crate::{ alignment::{HorizontalTextAlignment, VerticalTextAlignment}, rendering::cursor::Cursor, style::vertical_overdraw::VerticalOverdraw, StyledTextBox, }; use core::ops::Range; use embedded_graphics::prelude::*; /// Specifies how the [`TextBox`]'s height is adjusted when it is turned into a [`StyledTextBox`]. /// /// [`TextBox`]: ../../struct.TextBox.html pub trait HeightMode: Copy { /// Apply the height mode to the textbox /// /// *Note:* This function is used by [`TextBox::into_styled`] and normally does not need to be /// called manually. /// /// [`TextBox::into_styled`]: ../../struct.TextBox.html#method.into_styled fn apply<C, F, A, V, H>(text_box: &mut StyledTextBox<'_, C, F, A, V, H>) where C: PixelColor, F: Font + Copy, A: HorizontalTextAlignment, V: VerticalTextAlignment, H: HeightMode; /// Calculate the range of rows of the current line that can be drawn. /// /// If a line does not fully fit in the bounding box, some `HeightMode` options allow drawing /// partial lines. For a partial line, this function calculates, which rows of each character /// should be displayed. fn calculate_displayed_row_range<F: Font>(cursor: &Cursor<F>) -> Range<i32>; } /// Keep the original [`TextBox`] height. /// /// # Example: /// /// ```rust /// use embedded_text::prelude::*; /// use embedded_graphics::{fonts::Font6x8, pixelcolor::BinaryColor, prelude::*}; /// /// // This TextBox contains two lines of text, but is 60px high /// let text_box = TextBox::new( /// "Two lines\nof text", /// Rectangle::new(Point::zero(), Point::new(59, 59)), /// ); /// /// // Set style, use 6x8 font so the 2 lines are 16px high. /// let style = TextBoxStyleBuilder::new(Font6x8) /// .text_color(BinaryColor::On) /// .build(); /// /// // Exact does not change the size of the TextBox /// let orig_size = text_box.size(); /// let size = text_box.into_styled(style).size(); /// assert_eq!(size, orig_size); /// ``` /// /// [`TextBox`]: ../../struct.TextBox.html #[derive(Copy, Clone, Debug)] pub struct Exact<OV: VerticalOverdraw>(pub OV); impl<OV> HeightMode for Exact<OV> where OV: VerticalOverdraw, { #[inline] fn apply<C, F, A, V, H>(_text_box: &mut StyledTextBox<'_, C, F, A, V, H>) where C: PixelColor, F: Font + Copy, A: HorizontalTextAlignment, V: VerticalTextAlignment, H: HeightMode, { } #[inline] fn calculate_displayed_row_range<F: Font>(cursor: &Cursor<F>) -> Range<i32> { OV::calculate_displayed_row_range(cursor) } } /// Sets the height of the [`StyledTextBox`] to exactly fit the text. /// /// Note: in this mode, vertical alignment is meaningless. Make sure to use [`TopAligned`] for /// efficiency. /// /// # Example: `FitToText` grows the [`TextBox`]. /// /// ```rust /// use embedded_text::prelude::*; /// use embedded_graphics::{fonts::Font6x8, pixelcolor::BinaryColor, prelude::*}; /// /// // This TextBox contains two lines of text, but is 1px high /// let text_box = TextBox::new( /// "Two lines\nof text", /// Rectangle::new(Point::zero(), Point::new(59, 0)), /// ); /// /// // Set style, use 6x8 font so the 2 lines are 16px high. /// let style = TextBoxStyleBuilder::new(Font6x8) /// .height_mode(FitToText) /// .text_color(BinaryColor::On) /// .build(); /// /// // FitToText grows the TextBox to the height of the text /// let size = text_box.into_styled(style).size(); /// assert_eq!(size, Size::new(60, 16)); /// ``` /// /// # Example: `FitToText` also shrinks the [`TextBox`]. /// /// ```rust /// use embedded_text::prelude::*; /// use embedded_graphics::{fonts::Font6x8, pixelcolor::BinaryColor, prelude::*}; /// /// // This TextBox contains two lines of text, but is 1px high /// let text_box = TextBox::new( /// "Two lines\nof text", /// Rectangle::new(Point::zero(), Point::new(59, 59)), /// ); /// /// // Set style, use 6x8 font so the 2 lines are 16px high. /// let style = TextBoxStyleBuilder::new(Font6x8) /// .height_mode(FitToText) /// .text_color(BinaryColor::On) /// .build(); /// /// // FitToText shrinks the TextBox to the height of the text /// let size = text_box.into_styled(style).size(); /// assert_eq!(size, Size::new(60, 16)); /// ``` /// /// [`TopAligned`]: ../../alignment/top/struct.TopAligned.html /// [`TextBox`]: ../../struct.TextBox.html #[derive(Copy, Clone, Debug)] pub struct FitToText; impl HeightMode for FitToText { #[inline] fn apply<C, F, A, V, H>(text_box: &mut StyledTextBox<'_, C, F, A, V, H>) where C: PixelColor, F: Font + Copy, A: HorizontalTextAlignment, V: VerticalTextAlignment, H: HeightMode, { text_box.fit_height(); } #[inline] fn calculate_displayed_row_range<F: Font>(_: &Cursor<F>) -> Range<i32> { // FitToText always sets the bounding box to the exact size of the text, so every row is // always fully displayed 0..F::CHARACTER_SIZE.height as i32 } } /// If the text does not fill the bounding box, shrink the [`StyledTextBox`] to be as tall as the /// text. /// /// # Example: `ShrinkToText` does not grow the [`TextBox`]. /// /// ```rust /// use embedded_text::{prelude::*, style::vertical_overdraw::FullRowsOnly}; /// use embedded_graphics::{fonts::Font6x8, pixelcolor::BinaryColor, prelude::*}; /// /// // This TextBox contains two lines of text, but is 1px high /// let text_box = TextBox::new( /// "Two lines\nof text", /// Rectangle::new(Point::zero(), Point::new(59, 0)), /// ); /// /// // Set style, use 6x8 font so the 2 lines are 16px high. /// let style = TextBoxStyleBuilder::new(Font6x8) /// .height_mode(ShrinkToText(FullRowsOnly)) /// .text_color(BinaryColor::On) /// .build(); /// /// let size = text_box.into_styled(style).size(); /// assert_eq!(size, Size::new(60, 1)); /// ``` /// /// # Example: `ShrinkToText` shrinks the [`TextBox`]. /// /// ```rust /// use embedded_text::{prelude::*, style::vertical_overdraw::FullRowsOnly}; /// use embedded_graphics::{fonts::Font6x8, pixelcolor::BinaryColor, prelude::*}; /// /// // This TextBox contains two lines of text, but is 60px high /// let text_box = TextBox::new( /// "Two lines\nof text", /// Rectangle::new(Point::zero(), Point::new(59, 59)), /// ); /// /// // Set style, use 6x8 font so the 2 lines are 16px high. /// let style = TextBoxStyleBuilder::new(Font6x8) /// .height_mode(ShrinkToText(FullRowsOnly)) /// .text_color(BinaryColor::On) /// .build(); /// /// let size = text_box.into_styled(style).size(); /// assert_eq!(size, Size::new(60, 16)); /// ``` /// /// [`TextBox`]: ../../struct.TextBox.html #[derive(Copy, Clone, Debug)] pub struct ShrinkToText<OV: VerticalOverdraw>(pub OV); impl<OV> HeightMode for ShrinkToText<OV> where OV: VerticalOverdraw, { #[inline] fn apply<C, F, A, V, H>(text_box: &mut StyledTextBox<'_, C, F, A, V, H>) where C: PixelColor, F: Font + Copy, A: HorizontalTextAlignment, V: VerticalTextAlignment, H: HeightMode, { text_box.fit_height_limited(text_box.size().height); } #[inline] fn calculate_displayed_row_range<F: Font>(cursor: &Cursor<F>) -> Range<i32> { OV::calculate_displayed_row_range(cursor) } }