Struct Paragraph 

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

Available on crate feature egc only.

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.

Examples

use retroglyph_core::{Grid, Rect};
use retroglyph_widgets::{Measure, Paragraph, Surface, Widget};

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(area, &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) -> Paragraph<'a>

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<'_>

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

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

impl Widget for Paragraph<'_>

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

Draw this widget into area, via surface scoped to it.