Struct nannou::text::Builder

pub struct Builder<'a> { /* fields omitted */ }

A context for building some Text.

Methods

impl<'a> Builder<'a>

pub fn font_size(self, size: FontSize) -> Self

The font size to use for the text.

pub fn line_wrap(self, line_wrap: Option<Wrap>) -> Self

Specify whether or not text should be wrapped around some width and how to do so.

The default value is DEFAULT_LINE_WRAP.

pub fn no_line_wrap(self) -> Self

Specify that the Text should not wrap lines around the width.

Shorthand for builder.line_wrap(None).

pub fn wrap_by_word(self) -> Self

Line wrap the Text at the beginning of the first word that exceeds the width.

Shorthand for builder.line_wrap(Some(Wrap::Whitespace)).

pub fn wrap_by_character(self) -> Self

Line wrap the Text at the beginning of the first character that exceeds the width.

Shorthand for builder.line_wrap(Some(Wrap::Character)).

pub fn font(self, font: Font) -> Self

A method for specifying the Font used for displaying the Text.

pub fn justify(self, justify: Justify) -> Self

Describe the end along the x axis to which the text should be aligned.

pub fn left_justify(self) -> Self

Align the text to the left of its bounding Rect's x axis range.

pub fn center_justify(self) -> Self

Align the text to the middle of its bounding Rect's x axis range.

pub fn right_justify(self) -> Self

Align the text to the right of its bounding Rect's x axis range.

pub fn line_spacing(self, spacing: Scalar) -> Self

Specify how much vertical space should separate each line of text.

pub fn y_align(self, align: Align) -> Self

Specify how the whole text should be aligned along the y axis of its bounding rectangle

pub fn align_top(self) -> Self

Align the top edge of the text with the top edge of its bounding rectangle.

pub fn align_middle_y(self) -> Self

Align the middle of the text with the middle of the bounding rect along the y axis..

This is the default behaviour.

pub fn align_bottom(self) -> Self

Align the bottom edge of the text with the bottom edge of its bounding rectangle.

pub fn layout(self, layout: &Layout) -> Self

Set all the parameters via an existing Layout

pub fn build(self, rect: Rect) -> Text<'a>

Build the text.

This iterates over the text in order to pre-calculates the text's multi-line information using the line::infos function.

The given rect will be used for applying the layout including text alignment, positioning of text, multi-line wrapping, etc,

Trait Implementations

impl<'a> From<&'a str> for Builder<'a>

fn from(s: &'a str) -> Self

Performs the conversion.

impl<'a> From<Cow<'a, str>> for Builder<'a>

fn from(text: Cow<'a, str>) -> Self

Performs the conversion.

impl From<String> for Builder<'static>

fn from(s: String) -> Self

Performs the conversion.