Struct embedded_text::style::height_mode::ShrinkToText

pub struct ShrinkToText<OV: VerticalOverdraw>(pub OV);

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.

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.

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));

Trait Implementations

impl<OV: Clone + VerticalOverdraw> Clone for ShrinkToText<OV>

pub fn clone(&self) -> ShrinkToText<OV>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<OV: Copy + VerticalOverdraw> Copy for ShrinkToText<OV>

impl<OV: Debug + VerticalOverdraw> Debug for ShrinkToText<OV>

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<OV> HeightMode for ShrinkToText<OV> where
    OV: VerticalOverdraw, 

pub 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, 

Apply the height mode to the textbox

pub fn calculate_displayed_row_range<F: Font>(cursor: &Cursor<F>) -> Range<i32>

Calculate the range of rows of the current line that can be drawn.