Struct rckive_genpdf::elements::Paragraph

pub struct Paragraph { /* private fields */ }

A multi-line wrapped paragraph of formatted text.

If the text of this paragraph is longer than the page width, the paragraph is wrapped at word borders (and additionally at string borders if it contains multiple strings). If a word in the paragraph is longer than the page width, the text is truncated.

Use the push, string, push_styled and string_styled methods to add strings to this paragraph. Besides the styling of the text (see Style), you can also set an Alignment for the paragraph.

The line height and spacing are calculated based on the style of each string.

Examples

With setters:

use rckive_genpdf::{elements, style};
let mut p = elements::Paragraph::default();
p.push("This is an ");
p.push_styled("important", style::Color::Rgb(255, 0, 0));
p.push(" message!");
p.set_alignment(rckive_genpdf::Alignment::Center);

Chained:

use rckive_genpdf::{elements, style};
let p = elements::Paragraph::default()
    .string("This is an ")
    .styled_string("important", style::Color::Rgb(255, 0, 0))
    .string(" message!")
    .aligned(rckive_genpdf::Alignment::Center);

Implementations

impl Paragraph

pub fn new(text: impl Into<StyledString>) -> Paragraph

Creates a new paragraph with the given content.

pub fn set_alignment(&mut self, alignment: Alignment)

Sets the alignment of this paragraph.

pub fn aligned(self, alignment: Alignment) -> Self

Sets the alignment of this paragraph and returns the paragraph.

pub fn push(&mut self, s: impl Into<StyledString>)

Adds a string to the end of this paragraph.

pub fn string(self, s: impl Into<StyledString>) -> Self

Adds a string to the end of this paragraph and returns the paragraph.

pub fn push_styled(&mut self, s: impl Into<String>, style: impl Into<Style>)

Adds a string with the given style to the end of this paragraph.

pub fn styled_string(self, s: impl Into<String>, style: impl Into<Style>) -> Self

Adds a string with the given style to the end of this paragraph and returns the paragraph.

Trait Implementations

impl Clone for Paragraph

fn clone(&self) -> Paragraph

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Paragraph

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

Formats the value using the given formatter.

impl Default for Paragraph

fn default() -> Paragraph

Returns the “default value” for a type.

impl Element for Paragraph

fn render(
    &mut self,
    context: &Context,
    area: Area<'_>,
    style: Style
) -> Result<RenderResult, Error>

Renders this element to the given area using the given style and font cache.

fn framed(self, line_style: impl Into<LineStyle>) -> FramedElement<Self>where
    Self: Sized,

Draws a frame around this element using the given line style.

fn padded(self, padding: impl Into<Margins>) -> PaddedElement<Self>where
    Self: Sized,

Adds a padding to this element.

fn styled(self, style: impl Into<Style>) -> StyledElement<Self>where
    Self: Sized,

Sets the default style for this element and its children.

impl<T: Into<StyledString>> Extend<T> for Paragraph

fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<Vec<StyledString, Global>> for Paragraph

fn from(text: Vec<StyledString>) -> Paragraph

Converts to this type from the input type.

impl<T: Into<StyledString>> FromIterator<T> for Paragraph

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.