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<'a, C: Clone, F: Clone, A: Clone, V: Clone, H: Clone> Clone for StyledTextBox<'a, C, F, A, V, H> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment,
    H: HeightMode, 

pub fn clone(&self) -> StyledTextBox<'a, C, F, A, V, H>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

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]pub fn top_left(&self) -> Point

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

#[must_use]pub fn bottom_right(&self) -> Point

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

#[must_use]pub 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,
    StyledTextBox<'a, C, F, A, V, H>: RendererFactory<'a, C>,
    H: HeightMode, 

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

Draw the graphics object using the supplied DrawTarget.

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

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

pub 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, C: PartialEq, F: PartialEq, A: PartialEq, V: PartialEq, H: PartialEq> PartialEq<StyledTextBox<'a, C, F, A, V, H>> for StyledTextBox<'a, C, F, A, V, H> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment,
    H: HeightMode, 

pub fn eq(&self, other: &StyledTextBox<'a, C, F, A, V, H>) -> bool

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

pub fn ne(&self, other: &StyledTextBox<'a, C, F, A, V, H>) -> bool

This method tests for !=.

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

type Renderer = StyledTextBoxIterator<'a, C, F, CenterAligned, V, H, UniformSpaceConfig<F>>

The type of the pixel iterator.

#[must_use]pub fn create_renderer(&self) -> Self::Renderer

Creates a new renderer object.

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

type Renderer = StyledTextBoxIterator<'a, C, F, Justified, V, H, JustifiedSpaceConfig<F>>

The type of the pixel iterator.

#[must_use]pub fn create_renderer(&self) -> Self::Renderer

Creates a new renderer object.

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

type Renderer = StyledTextBoxIterator<'a, C, F, LeftAligned, V, H, UniformSpaceConfig<F>>

The type of the pixel iterator.

#[must_use]pub fn create_renderer(&self) -> Self::Renderer

Creates a new renderer object.

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

type Renderer = StyledTextBoxIterator<'a, C, F, RightAligned, V, H, UniformSpaceConfig<F>>

The type of the pixel iterator.

#[must_use]pub fn create_renderer(&self) -> Self::Renderer

Creates a new renderer object.

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

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

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]pub fn translate(&self, by: Point) -> Self

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

pub 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