Struct embedded_text::StyledTextBox

pub struct StyledTextBox<'a, C, F, A, V, H> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment,
    H: HeightMode,  {
    pub text_box: TextBox<'a>,
    pub style: TextBoxStyle<C, F, A, V, H>,
}

A styled TextBox struct.

This structure is constructed by calling the into_styled method of a TextBox object. Use the draw method to draw the textbox on a display.

Fields

text_box: TextBox<'a>

A TextBox that has an associated TextBoxStyle.

style: TextBoxStyle<C, F, A, V, H>

The style of the TextBox.

Implementations

impl<C, F, A, V, H, '_> StyledTextBox<'_, C, F, A, V, H> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment,
    H: HeightMode, 

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

Sets the height of the StyledTextBox to the height of the text.

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

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

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

Trait Implementations

impl<C, F, A, V, H, '_> Dimensions for StyledTextBox<'_, C, F, A, V, H> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment,
    H: HeightMode, 

#[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, C, F, A, V, H> Drawable<C> for &'a StyledTextBox<'a, C, F, A, V, H> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment,
    StyledTextBoxIterator<'a, C, F, A, V, H>: Iterator<Item = Pixel<C>>,
    StyledTextBox<'a, C, F, A, V, H>: StateFactory<'a, F>,
    H: HeightMode, 

fn draw<D: DrawTarget<C>>(self, display: &mut D) -> Result<(), D::Error>

Draw the graphics object using the supplied DrawTarget.

impl<'a, C, F, V, H> StateFactory<'a, F> for StyledTextBox<'a, C, F, CenterAligned, V, H> where
    C: PixelColor,
    F: Font + Copy,
    V: VerticalTextAlignment,
    H: HeightMode, 

type PixelIteratorState = State<'a, C, F>

The type of the state variable used for rendering.

#[must_use]fn create_state(
    &self,
    cursor: Cursor<F>,
    parser: Parser<'a>
) -> Self::PixelIteratorState

Creates a new state variable.

impl<'a, C, F, V, H> StateFactory<'a, F> for StyledTextBox<'a, C, F, Justified, V, H> where
    C: PixelColor,
    F: Font + Copy,
    V: VerticalTextAlignment,
    H: HeightMode, 

type PixelIteratorState = State<'a, C, F>

The type of the state variable used for rendering.

#[must_use]fn create_state(
    &self,
    cursor: Cursor<F>,
    parser: Parser<'a>
) -> Self::PixelIteratorState

Creates a new state variable.

impl<'a, C, F, V, H> StateFactory<'a, F> for StyledTextBox<'a, C, F, LeftAligned, V, H> where
    C: PixelColor,
    F: Font + Copy,
    V: VerticalTextAlignment,
    H: HeightMode, 

type PixelIteratorState = State<'a, C, F>

The type of the state variable used for rendering.

#[must_use]fn create_state(
    &self,
    cursor: Cursor<F>,
    parser: Parser<'a>
) -> Self::PixelIteratorState

Creates a new state variable.

impl<'a, C, F, V, H> StateFactory<'a, F> for StyledTextBox<'a, C, F, RightAligned, V, H> where
    C: PixelColor,
    F: Font + Copy,
    V: VerticalTextAlignment,
    H: HeightMode, 

type PixelIteratorState = State<'a, C, F>

The type of the state variable used for rendering.

#[must_use]fn create_state(
    &self,
    cursor: Cursor<F>,
    parser: Parser<'a>
) -> Self::PixelIteratorState

Creates a new state variable.

impl<C, F, A, V, H, '_> Transform for StyledTextBox<'_, C, F, A, V, H> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment,
    H: HeightMode, 

#[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