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 style 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>(
    self,
    style: TextBoxStyle<C, F, A, V>
) -> StyledTextBox<'a, C, F, A, V> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment, 

Attaches a TextBoxStyle to the textbox object.

Trait Implementations

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<'_> 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