Struct Paragraph

pub struct Paragraph(/* private fields */);

A bunch of text.

Implementations

impl Paragraph

pub fn new() -> Self

Creates a new empty Paragraph.

pub fn buffer(&self) -> &Buffer

Returns the buffer of the Paragraph.

pub fn downgrade(&self) -> Weak

Creates a Weak reference to the Paragraph.

This is useful to avoid cloning the Paragraph when referential guarantees are unnecessary. For instance, when creating a rendering tree.

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() -> Self

Returns the “default value” for a type.

impl Paragraph for Paragraph

type Font = Font

The font of this [Paragraph].

fn with_text(text: Text<&str>) -> Self

Creates a new [Paragraph] laid out with the given [Text].

fn with_spans<Link>(text: Text<&[Span<'_, Link>]>) -> Self

Creates a new [Paragraph] laid out with the given [Text].

fn resize(&mut self, new_bounds: Size)

Lays out the [Paragraph] with some new boundaries.

fn compare(&self, text: Text<()>) -> Difference

Compares the [Paragraph] with some desired [Text] and returns the [Difference].

fn size(&self) -> Pixels

Returns the text size of the [Paragraph] in [Pixels].

fn font(&self) -> Font

Returns the font of the [Paragraph].

fn line_height(&self) -> LineHeight

Returns the [LineHeight] of the [Paragraph].

fn align_x(&self) -> Alignment

Returns the horizontal alignment of the [Paragraph].

fn align_y(&self) -> Vertical

Returns the vertical alignment of the [Paragraph].

fn wrapping(&self) -> Wrapping

Returns the [Wrapping] strategy of the [Paragraph]>

fn shaping(&self) -> Shaping

Returns the [Shaping] strategy of the [Paragraph]>

fn bounds(&self) -> Size

Returns the availalbe bounds used to layout the [Paragraph].

fn min_bounds(&self) -> Size

Returns the minimum boundaries that can fit the contents of the [Paragraph].

fn hit_test(&self, point: Point) -> Option<Hit>

Tests whether the provided point is within the boundaries of the [Paragraph], returning information about the nearest character.

fn hit_span(&self, point: Point) -> Option<usize>

Tests whether the provided point is within the boundaries of a [Span] in the [Paragraph], returning the index of the [Span] that was hit.

fn span_bounds(&self, index: usize) -> Vec<Rectangle>

Returns all bounds for the provided [Span] index of the [Paragraph]. A [Span] can have multiple bounds for each line it’s on.

fn grapheme_position(&self, line: usize, index: usize) -> Option<Point>

Returns the distance to the given grapheme index in the [Paragraph].

fn min_width(&self) -> f32

Returns the minimum width that can fit the contents of the [Paragraph].

fn min_height(&self) -> f32

Returns the minimum height that can fit the contents of the [Paragraph].

impl PartialEq for Paragraph

fn eq(&self, other: &Paragraph) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Paragraph