Struct zng::font::ShapedLine

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

Represents a line selection of a ShapedText.

Implementations

impl<'a> ShapedLine<'a>

pub fn height(&self) -> Px

Height of the line.

pub fn rect(&self) -> Rect<Px, Px>

Bounds of the line.

pub fn original_size(&self) -> Size2D<Px, Px>

Initial size of the line, before any line reshaping.

This can be different then the current rect size if the parent inline changed the size, usually to inject blank spaces to justify the text or to visually insert a bidirectional fragment of another widget.

pub fn overline(&self) -> (Point2D<Px, Px>, Px)

Full overline, start point + width.

pub fn strikethrough(&self) -> (Point2D<Px, Px>, Px)

Full strikethrough line, start point + width.

pub fn underline(&self) -> (Point2D<Px, Px>, Px)

Full underline, not skipping.

The y is defined by the font metrics.

Returns start point + width.

pub fn underline_descent(&self) -> (Point2D<Px, Px>, Px)

Full underline, not skipping.

The y is the baseline + descent + 1px.

Returns start point + width.

pub fn underline_skip_spaces( &self, ) -> impl Iterator<Item = (Point2D<Px, Px>, Px)> + 'a

Underline, skipping spaces.

The y is defined by the font metrics.

Returns and iterator of start point + width for each word.

pub fn underline_descent_skip_spaces( &self, ) -> impl Iterator<Item = (Point2D<Px, Px>, Px)> + 'a

Underline, skipping spaces.

The y is the baseline + descent + 1px.

Returns and iterator of start point + width for each word.

pub fn underline_skip_glyphs( &self, thickness: Px, ) -> impl Iterator<Item = (Point2D<Px, Px>, Px)> + 'a

Underline, skipping glyph descends that intersect the underline.

The y is defined by the font metrics.

Returns an iterator of start point + width for continuous underline.

pub fn underline_skip_glyphs_and_spaces( &self, thickness: Px, ) -> impl Iterator<Item = (Point2D<Px, Px>, Px)> + 'a

Underline, skipping spaces and glyph descends that intersect the underline

The y is defined by font metrics.

Returns an iterator of start point + width for continuous underline.

pub fn glyphs( &self, ) -> impl Iterator<Item = (&'a Font, &'a [GlyphInstance])> + 'a

Glyphs in the line.

The glyphs are in text order by segments and in visual order (LTR) within segments, so the RTL text “لما “ will have the space glyph first, then “’álif”, “miim”, “láam”.

All glyph points are set as offsets to the top-left of the text full text.

pub fn glyphs_with_x_advance( &self, ) -> impl Iterator<Item = (&'a Font, impl Iterator<Item = (GlyphInstance, f32)> + 'a)> + 'a

Glyphs in the line paired with the x-advance.

pub fn segs(&self) -> impl DoubleEndedIterator + ExactSizeIterator

Iterate over word and space segments in this line.

pub fn segs_len(&self) -> usize

Number of segments in this line.

pub fn seg(&self, seg_idx: usize) -> Option<ShapedSegment<'_>>

Get the segment by index.

The first segment of the line is 0.

pub fn started_by_wrap(&self) -> bool

Returns true if this line was started by the wrap algorithm.

If this is false then the line is the first or the previous line ends in a LineBreak.

pub fn ended_by_wrap(&self) -> bool

Returns true if this line was ended by the wrap algorithm.

If this is false then the line is the last or ends in a LineBreak.

pub fn actual_line_start(&self) -> ShapedLine<'a>

Returns the line or first previous line that is not started_by_wrap.

pub fn actual_line_end(&self) -> ShapedLine<'a>

Returns the line or first next line that is not ended_by_wrap.

pub fn text_range(&self) -> Range<usize>

Get the text bytes range of this line in the original text.

pub fn text_caret_range(&self) -> Range<usize>

Get the text bytes range of this line in the original text, excluding the line break to keep end in the same line.

pub fn actual_text_range(&self) -> Range<usize>

Gets the text range of the actual line, joining shaped lines that are started by wrap.

pub fn actual_text_caret_range(&self) -> Range<usize>

Gets the text range of the actual line, excluding the line break at the end.

pub fn text<'s>(&self, full_text: &'s str) -> &'s str

Select the string represented by this line.

The full_text must be equal to the original text that was used to generate the parent ShapedText.

pub fn nearest_seg(&self, x: Px) -> Option<ShapedSegment<'a>>

Gets the segment that contains x or is nearest to it.

pub fn index(&self) -> usize

Gets the line index.

pub fn directions(&self) -> LayoutDirections

Layout directions of segments in this line.

Trait Implementations

impl<'a> Clone for ShapedLine<'a>

fn clone(&self) -> ShapedLine<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ShapedLine<'a>

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

Formats the value using the given formatter.

impl<'a> Copy for ShapedLine<'a>