Struct TextLayout 

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

The Layout for TextElement. This can be used to map indices to pixels and vice versa.

Implementations

impl TextLayout

pub fn paint_background(&self, window: &mut Window, cx: &mut App) -> Result<()>

Paints the backgrounds of the text runs without the glyphs, so that callers can paint content, such as highlights, between the backgrounds and the text. Follow it with Self::paint_foreground to paint the glyphs.

pub fn paint_foreground(&self, window: &mut Window, cx: &mut App) -> Result<()>

Paints the glyphs and decorations of the text without the run backgrounds.

pub fn index_for_position( &self, position: Point<Pixels>, ) -> Result<usize, usize>

Get the byte index into the input of the pixel position.

pub fn position_for_index(&self, index: usize) -> Option<Point<Pixels>>

Get the pixel position for the given byte index.

pub fn line_layout_for_index( &self, index: usize, ) -> Option<Arc<WrappedLineLayout>>

Retrieve the layout for the line containing the given byte index.

pub fn line_layouts(&self) -> SmallVec<[Arc<WrappedLineLayout>; 1]>

Retrieve all line layouts in source order.

pub fn bounds(&self) -> Bounds<Pixels>

The bounds of this layout.

pub fn line_height(&self) -> Pixels

The line height for this layout.

pub fn len(&self) -> usize

The UTF-8 length of the underlying text.

pub fn text(&self) -> String

The text for this layout.

pub fn wrapped_text(&self) -> String

The text for this layout (with soft-wraps as newlines)

Trait Implementations

impl Clone for TextLayout

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for TextLayout

fn default() -> Self

Returns the “default value” for a type.