Struct embedded_text::TextBox

pub struct TextBox<'a> {
    pub text: &'a str,
    pub bounds: Rectangle,
}

A textbox object.

The TextBox struct represents a piece of text that can be drawn on a display inside the given bounding box.

The struct only contains the text and the bounding box, no additional information. To draw a TextBox it is necessary to attach a TextBoxStyle to it using the into_styled method to create a StyledTextBox object.

See the module-level documentation for more information.

Fields

text: &'a str

The text to be displayed in this TextBox

bounds: Rectangle

The bounding box of this TextBox

Implementations

impl<'a> TextBox<'a>

#[must_use]

pub fn new(text: &'a str, bounds: Rectangle) -> Self

Creates a new TextBox instance with a given bounding Rectangle.

#[must_use]

pub fn into_styled<C, F, A, V, H>(
    self,
    style: TextBoxStyle<C, F, A, V, H>
) -> StyledTextBox<'a, C, F, A, V, H> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment,
    H: HeightMode, 

Creates a StyledTextBox by attaching a TextBoxStyle to the TextBox object.

By default, the size of the StyledTextBox is equal to the size of the TextBox. Use HeightMode options to change this.

Example:

In this example, we make a TextBox and give it all our available space as size. We create a TextBoxStyle object to set how our TextBox should be drawn.

• Set the 6x8 font
• Set the text color to BinaryColor::On
• Leave the background color transparent
• Leave text alignment top/left
• Set ShrinkToText HeightMode to shrink the TextBox when possible.

use embedded_text::{prelude::*, style::vertical_overdraw::FullRowsOnly};
use embedded_graphics::{fonts::Font6x8, pixelcolor::BinaryColor, prelude::*};

let text_box = TextBox::new(
    "Two lines\nof text",
    Rectangle::new(Point::zero(), Point::new(59, 59)),
);
let style = TextBoxStyleBuilder::new(Font6x8)
    .height_mode(ShrinkToText(FullRowsOnly))
    .text_color(BinaryColor::On)
    .build();

let styled_text_box = text_box.into_styled(style);
assert_eq!(16, styled_text_box.size().height);

Trait Implementations

impl<'a> Clone for TextBox<'a>

fn clone(&self) -> TextBox<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for TextBox<'a>

impl<'a> Debug for TextBox<'a>

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

Formats the value using the given formatter.

impl Dimensions for TextBox<'_>

#[must_use]

fn top_left(&self) -> Point

Get the top left corner of the bounding box for an object

#[must_use]

fn bottom_right(&self) -> Point

Get the bottom right corner of the bounding box for an object

#[must_use]

fn size(&self) -> Size

Get the width and height for an object

impl<'a> Eq for TextBox<'a>

impl<'a> Hash for TextBox<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq<TextBox<'a>> for TextBox<'a>

fn eq(&self, other: &TextBox<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &TextBox<'a>) -> bool

This method tests for !=.

impl<'a> StructuralEq for TextBox<'a>

impl<'a> StructuralPartialEq for TextBox<'a>

impl Transform for TextBox<'_>

#[must_use]

fn translate(&self, by: Point) -> Self

Move the origin of an object by a given number of (x, y) pixels, returning a new object

fn translate_mut(&mut self, by: Point) -> &mut Self

Move the origin of an object by a given number of (x, y) pixels, mutating the object in place