Struct embedded_text::TextBox

#[must_use]
pub struct TextBox<'a, S> {
    pub text: &'a str,
    pub bounds: Rectangle,
    pub character_style: S,
    pub style: TextBoxStyle,
    pub vertical_offset: i32,
}

A text box object.

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

Use the draw method to draw the textbox on a display.

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

character_style: S

The character style of the TextBox.

style: TextBoxStyle

The style of the TextBox.

vertical_offset: i32

Vertical offset applied to the text just before rendering.

Implementations

impl<'a, S> TextBox<'a, S> where
    S: TextRenderer + CharacterStyle, 

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

Creates a new TextBox instance with a given bounding Rectangle.

impl<'a, S> TextBox<'a, S> where
    S: TextRenderer + CharacterStyle, 

pub fn with_textbox_style(
    text: &'a str,
    bounds: Rectangle,
    character_style: S,
    textbox_style: TextBoxStyle
) -> Self

Creates a new TextBox instance with a given bounding Rectangle and a given TextBoxStyle.

pub fn with_alignment(
    text: &'a str,
    bounds: Rectangle,
    character_style: S,
    alignment: HorizontalAlignment
) -> TextBox<'a, S>

Creates a new TextBox instance with a given bounding Rectangle and a given TextBoxStyle.

pub fn with_vertical_alignment(
    text: &'a str,
    bounds: Rectangle,
    character_style: S,
    vertical_alignment: VerticalAlignment
) -> TextBox<'a, S>

Creates a new TextBox instance with a given bounding Rectangle and a given TextBoxStyle.

pub fn set_vertical_offset(&mut self, offset: i32) -> &mut Self

Sets the vertical text offset.

impl<S> TextBox<'_, S> where
    S: TextRenderer, 

pub fn fit_height(&mut self) -> &mut Self

Sets the height of the TextBox to the height of the text.

pub fn fit_height_limited(&mut self, max_height: u32) -> &mut Self

Sets the height of the TextBox to the height of the text, limited to max_height.

This method allows you to set a maximum height. The TextBox will take up at most max_height pixel vertical space.

Trait Implementations

impl<'a, S: Clone> Clone for TextBox<'a, S>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, S: Debug> Debug for TextBox<'a, S>

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

Formats the value using the given formatter.

impl<S> Dimensions for TextBox<'_, S>

fn bounding_box(&self) -> Rectangle

Returns the bounding box.

impl<'a, F> Drawable for TextBox<'a, F> where
    F: TextRenderer<Color = <F as CharacterStyle>::Color> + CharacterStyle,
    <F as CharacterStyle>::Color: From<Rgb888>, 

type Color = <F as CharacterStyle>::Color

The pixel color type.

type Output = &'a str

The return type of the draw method.

fn draw<D: DrawTarget<Color = Self::Color>>(
    &self,
    display: &mut D
) -> Result<&'a str, D::Error>

Draw the graphics object using the supplied DrawTarget.

impl<'a, S: Hash> Hash for TextBox<'a, S>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<'a, S: PartialEq> PartialEq<TextBox<'a, S>> for TextBox<'a, S>

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

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

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

This method tests for !=.

impl<S> Transform for TextBox<'_, S> where
    Self: Clone, 

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

impl<'a, S: Eq> Eq for TextBox<'a, S>

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

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