Struct Paragraph 

pub struct Paragraph<'a> { /* private fields */ }

Word-wrapped text in a single Style.

Paragraph::new(text) wraps text to whatever width it is rendered at (via Widget::render), or reports the height it would need at a given width without rendering (via Measure::height_for) so a caller can size its pane to fit instead of guessing a fixed height. style defaults to Style::new(); set it with Paragraph::style.

Without the egc feature, wrapping is char-boundary-safe and breaks on ASCII whitespace only: no grapheme-cluster segmentation, so a combining mark or wide CJK run can land on either side of a wrap point. Enabling egc upgrades wrapping to retroglyph_core::layout::TextLayout, which is grapheme-cluster-aware; every other text-bearing widget in this crate (List, Table, Log) already has this same gap regardless of egc.

Unlike super::BoxBorder, super::Gauge, super::StatBar, super::Table, and super::Button, Paragraph has no theme()/ theme_on() pair: word-wrapped text has no single semantic Theme role to map onto, so callers set style directly.

Examples

use retroglyph_core::grid::{Grid, Rect};
use retroglyph_ui::widget::{Measure, Paragraph, Widget};
use retroglyph_ui::Surface;

let p = Paragraph::new("the quick brown fox jumps");
let height = p.height_for(10); // rows needed to wrap at 10 columns

let area = Rect::new(0, 0, 10, height);
let mut grid = Grid::new(10, height);
p.render(&mut Surface::new(&mut grid, area, 0));

Implementations

impl<'a> Paragraph<'a>

pub fn new(text: &'a str) -> Self

Text to be word-wrapped, in the default style.

pub const fn style(self, style: Style) -> Self

Set the text’s style.

Trait Implementations

impl<'a> Clone for Paragraph<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Paragraph<'a>

impl<'a> Debug for Paragraph<'a>

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

Formats the value using the given formatter.

impl Measure for Paragraph<'_>

Available on crate feature egc only.

fn height_for(&self, width: u16) -> u16

The number of rows this widget would need to render at width columns.

impl Widget for Paragraph<'_>

Available on crate feature egc only.

fn render(&self, surface: &mut Surface<'_>)

Draw this widget into surface, filling surface.area().