Struct floem_cosmic_text::TextLayout

pub struct TextLayout {
    pub lines: Vec<TextLayoutLine>,
    /* private fields */
}

A buffer of text that is shaped and laid out

Fields

lines: Vec<TextLayoutLine>

[BufferLine]s (or paragraphs) of text in the buffer

Implementations

impl TextLayout

pub fn new() -> Self

Create a new [Buffer] with the provided [FontSystem] and Metrics

Panics

Will panic if metrics.line_height is zero.

pub fn shape_until(&mut self, lines: i32) -> i32

Pre-shape lines in the buffer, up to lines, return actual number of layout lines

pub fn shape_until_cursor(&mut self, cursor: Cursor)

Shape lines until cursor, also scrolling to include cursor in view

pub fn shape_until_scroll(&mut self)

Shape lines until scroll

pub fn layout_cursor(&self, cursor: &Cursor) -> LayoutCursor

pub fn line_shape(&mut self, line_i: usize) -> Option<&ShapeLine>

Shape the provided line index and return the result

pub fn line_layout(&mut self, line_i: usize) -> Option<&[LayoutLine]>

Lay out the provided line index and return the result

pub fn wrap(&self) -> Wrap

Get the current Wrap

pub fn set_wrap(&mut self, wrap: Wrap)

Set the current Wrap

pub fn size(&self) -> Size

pub fn set_size(&mut self, width: f32, height: f32)

Set the current buffer dimensions

pub fn scroll(&self) -> i32

Get the current scroll location

pub fn set_scroll(&mut self, scroll: i32)

Set the current scroll location

pub fn set_text(&mut self, text: &str, attrs: AttrsList)

Set text of buffer, using provided attributes for each line by default

pub fn set_tab_width(&mut self, tab_width: usize)

pub fn redraw(&self) -> bool

True if a redraw is needed

pub fn set_redraw(&mut self, redraw: bool)

Set redraw needed flag

pub fn layout_runs(&self) -> LayoutRunIter<'_>

Get the visible layout runs for rendering and other tasks

pub fn hit_point(&self, point: Point) -> HitPoint

pub fn line_col_position(&self, line: usize, col: usize) -> HitPosition

pub fn hit_position(&self, idx: usize) -> HitPosition

pub fn hit(&self, x: f32, y: f32) -> Option<Cursor>

Convert x, y position to Cursor (hit detection)

pub fn draw<F>(&self, cache: &mut SwashCache, color: Color, f: F)

where F: FnMut(i32, i32, u32, u32, Color),

Draw the buffer

Trait Implementations

impl Clone for TextLayout

fn clone(&self) -> TextLayout

Returns a copy of the value.

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

Performs copy-assignment from source.