Skip to main content

Paragraph

Struct Paragraph 

Source
pub struct Paragraph { /* private fields */ }
Expand description

Text wrapped to a width and laid out once, to measure and then paint.

Lay a paragraph out in measure and keep it on the widget. paint draws the layout that was measured, so the painted lines always fit the size the widget reported.

ⓘ
fn measure(&mut self, ctx: &mut MeasureCtx, constraints: Constraints) -> Size {
    self.paragraph = Paragraph::new(
        ctx,
        &self.text,
        &self.style,
        TextAlign::Start,
        constraints.max.width,
    );
    constraints.clamp(self.paragraph.size())
}

fn paint(&self, ctx: &mut PaintCtx) {
    self.paragraph.paint(ctx, ctx.bounds(), VerticalAlign::Top);
}

Implementations§

Source§

impl Paragraph

Source

pub fn new( shaper: &(impl TextShaper + ?Sized), text: impl Into<String>, style: &TextStyle, align: TextAlign, max_width: f32, ) -> Self

Lay out text wrapped to max_width, or unwrapped when it is infinite, with each line aligned by align.

Source

pub fn text(&self) -> &str

Source

pub fn size(&self) -> Size

The size the text takes: its widest line by the height of its lines.

Source

pub fn line_count(&self) -> usize

Source

pub fn paint(&self, ctx: &mut PaintCtx, rect: Rect, vertical: VerticalAlign)

Paint into rect, placed vertically by vertical and horizontally by the alignment the paragraph was laid out with.

Source

pub fn paint_with_color( &self, ctx: &mut PaintCtx, rect: Rect, vertical: VerticalAlign, color: Color, )

Paint like paint, in color instead of the style’s, for a color that can change without laying the text out again.

Trait Implementations§

Source§

impl Clone for Paragraph

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Paragraph

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Paragraph

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.