Struct pane::TextFormat

pub struct TextFormat<S> where
    S: Scalar,  {
    pub font_size: u32,
    pub just: Justification,
    pub line_spacing: S,
    pub first_line_indent: usize,
    pub lines_indent: usize,
    pub color: Color,
    pub resize: Resize,
}

A format for some text

Fields

font_size: u32

The font size

just: Justification

The horizantal justification

line_spacing: S

The spacing between lines. This should usually be somewhere between 1.0 and 2.0, but any scalar is valid

first_line_indent: usize

The number of spaces to indent the first line of a paragraph

lines_indent: usize

The number of spaces to indent all lines of a paragraph after the first

color: Color

The color of the text

resize: Resize

The resize strategy

Methods

impl<S> TextFormat<S> where
    S: Scalar, 

pub fn new(font_size: u32) -> TextFormat<S>

Create a default TextFormat with the given font size

pub fn left(self) -> Self

Align the TextFormat to the left

pub fn centered(self) -> Self

Center-align the TextFormat

pub fn right(self) -> Self

Align the TextFormat to the right

pub fn font_size(self, font_size: u32) -> Self

Set the font size

pub fn line_spacing(self, line_spacing: S) -> Self

Set the line spacing

pub fn map_line_spacing<U>(&self) -> TextFormat<U> where
    U: Scalar + From<S>, 

Changes the type of the line spacing and thus the TextFormat itself

pub fn first_line_indent(self, first_line_indent: usize) -> Self

Set the indentation of the first line

pub fn lines_indent(self, lines_indent: usize) -> Self

Set the indentation of all lines after the first

pub fn color(self, color: Color) -> Self

Set the color

pub fn resize(self, resize: Resize) -> Self

Set the resize strategy

pub fn resize_font(self, max_size: u32) -> Self

Change the font size depending on the the resize strategy

The given max size is not used if the strategy is Resize::None

Trait Implementations

impl<S: Clone> Clone for TextFormat<S> where
    S: Scalar, 

fn clone(&self) -> TextFormat<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> From<u32> for TextFormat<S> where
    S: Scalar, 

fn from(font_size: u32) -> Self

Performs the conversion.

impl<S: PartialOrd> PartialOrd<TextFormat<S>> for TextFormat<S> where
    S: Scalar, 

fn partial_cmp(&self, other: &TextFormat<S>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &TextFormat<S>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &TextFormat<S>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &TextFormat<S>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &TextFormat<S>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<S: PartialEq> PartialEq<TextFormat<S>> for TextFormat<S> where
    S: Scalar, 

fn eq(&self, other: &TextFormat<S>) -> bool

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

fn ne(&self, other: &TextFormat<S>) -> bool

This method tests for !=.

impl<S: Copy> Copy for TextFormat<S> where
    S: Scalar, 

impl<S: Debug> Debug for TextFormat<S> where
    S: Scalar, 

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

Formats the value using the given formatter.