txt::Paragraph Class Reference

#include <paragraph.h>

Classes
struct	PositionWithAffinity
struct	Range
struct	TextBox

Public Types
enum	Affinity { UPSTREAM , DOWNSTREAM }
enum class	RectHeightStyle {   kTight , kMax , kIncludeLineSpacingMiddle , kIncludeLineSpacingTop ,   kIncludeLineSpacingBottom , kStrut }
enum class	RectWidthStyle { kTight , kMax }

Public Member Functions
virtual	~Paragraph ()=default
virtual double	GetMaxWidth ()=0
virtual double	GetHeight ()=0
virtual double	GetLongestLine ()=0
virtual double	GetMinIntrinsicWidth ()=0
virtual double	GetMaxIntrinsicWidth ()=0
virtual double	GetAlphabeticBaseline ()=0
virtual double	GetIdeographicBaseline ()=0
virtual bool	DidExceedMaxLines ()=0
virtual void	Layout (double width)=0
virtual bool	Paint (flutter::DisplayListBuilder *builder, double x, double y)=0
virtual std::vector< TextBox >	GetRectsForRange (size_t start, size_t end, RectHeightStyle rect_height_style, RectWidthStyle rect_width_style)=0
virtual std::vector< TextBox >	GetRectsForPlaceholders ()=0
virtual PositionWithAffinity	GetGlyphPositionAtCoordinate (double dx, double dy)=0
virtual bool	GetGlyphInfoAt (unsigned offset, skia::textlayout::Paragraph::GlyphInfo *glyphInfo) const =0
virtual bool	GetClosestGlyphInfoAtCoordinate (double dx, double dy, skia::textlayout::Paragraph::GlyphInfo *glyphInfo) const =0
virtual Range< size_t >	GetWordBoundary (size_t offset)=0
virtual std::vector< LineMetrics > &	GetLineMetrics ()=0
virtual bool	GetLineMetricsAt (int lineNumber, skia::textlayout::LineMetrics *lineMetrics) const =0
virtual size_t	GetNumberOfLines () const =0
virtual int	GetLineNumberAt (size_t utf16Offset) const =0

Detailed Description

Definition at line 35 of file paragraph.h.

Member Enumeration Documentation

Affinity

enum txt::Paragraph::Affinity

Enumerator
UPSTREAM
DOWNSTREAM

Definition at line 37 of file paragraph.h.

{ UPSTREAM, DOWNSTREAM };

RectHeightStyle

enum class txt::Paragraph::RectHeightStyle

strong

Enumerator
kTight
kMax
kIncludeLineSpacingMiddle
kIncludeLineSpacingTop
kIncludeLineSpacingBottom
kStrut

Definition at line 41 of file paragraph.h.

                             {
    // Provide tight bounding boxes that fit heights per run.
    kTight,
 
    // The height of the boxes will be the maximum height of all runs in the
    // line. All rects in the same line will be the same height.
    kMax,
 
    // Extends the top and/or bottom edge of the bounds to fully cover any line
    // spacing. The top edge of each line should be the same as the bottom edge
    // of the line above. There should be no gaps in vertical coverage given any
    // ParagraphStyle line_height.
    //
    // The top and bottom of each rect will cover half of the
    // space above and half of the space below the line.
    kIncludeLineSpacingMiddle,
    // The line spacing will be added to the top of the rect.
    kIncludeLineSpacingTop,
    // The line spacing will be added to the bottom of the rect.
    kIncludeLineSpacingBottom,
 
    // Calculate boxes based on the strut's metrics.
    kStrut
  };

RectWidthStyle

enum class txt::Paragraph::RectWidthStyle

strong

Enumerator
kTight
kMax

Definition at line 66 of file paragraph.h.

                            {
    // Provide tight bounding boxes that fit widths to the runs of each line
    // independently.
    kTight,
 
    // Extends the width of the last rect of each line to match the position of
    // the widest rect over all the lines.
    kMax
  };

Constructor & Destructor Documentation

~Paragraph()

virtual txt::Paragraph::~Paragraph ( )

virtualdefault

Member Function Documentation

DidExceedMaxLines()

virtual bool txt::Paragraph::DidExceedMaxLines ( )

pure virtual

GetAlphabeticBaseline()

virtual double txt::Paragraph::GetAlphabeticBaseline ( )

pure virtual

GetClosestGlyphInfoAtCoordinate()

virtual bool txt::Paragraph::GetClosestGlyphInfoAtCoordinate ( double  dx, double  dy, skia::textlayout::Paragraph::GlyphInfo *  glyphInfo  ) const

pure virtual

GetGlyphInfoAt()

virtual bool txt::Paragraph::GetGlyphInfoAt ( unsigned  offset, skia::textlayout::Paragraph::GlyphInfo *  glyphInfo  ) const

pure virtual

GetGlyphPositionAtCoordinate()

virtual PositionWithAffinity txt::Paragraph::GetGlyphPositionAtCoordinate ( double  dx, double  dy  )

pure virtual

GetHeight()

virtual double txt::Paragraph::GetHeight ( )

pure virtual

GetIdeographicBaseline()

virtual double txt::Paragraph::GetIdeographicBaseline ( )

pure virtual

GetLineMetrics()

virtual std::vector< LineMetrics > & txt::Paragraph::GetLineMetrics ( )

pure virtual

GetLineMetricsAt()

virtual bool txt::Paragraph::GetLineMetricsAt ( int  lineNumber, skia::textlayout::LineMetrics *  lineMetrics  ) const

pure virtual

GetLineNumberAt()

virtual int txt::Paragraph::GetLineNumberAt ( size_t  utf16Offset ) const

pure virtual

GetLongestLine()

virtual double txt::Paragraph::GetLongestLine ( )

pure virtual

GetMaxIntrinsicWidth()

virtual double txt::Paragraph::GetMaxIntrinsicWidth ( )

pure virtual

GetMaxWidth()

virtual double txt::Paragraph::GetMaxWidth ( )

pure virtual

GetMinIntrinsicWidth()

virtual double txt::Paragraph::GetMinIntrinsicWidth ( )

pure virtual

GetNumberOfLines()

virtual size_t txt::Paragraph::GetNumberOfLines ( ) const

pure virtual

GetRectsForPlaceholders()

virtual std::vector< TextBox > txt::Paragraph::GetRectsForPlaceholders ( )

pure virtual

GetRectsForRange()

virtual std::vector< TextBox > txt::Paragraph::GetRectsForRange ( size_t  start, size_t  end, RectHeightStyle  rect_height_style, RectWidthStyle  rect_width_style  )

pure virtual

GetWordBoundary()

virtual Range< size_t > txt::Paragraph::GetWordBoundary ( size_t  offset )

pure virtual

Layout()

virtual void txt::Paragraph::Layout ( double  width )

pure virtual

Paint()

virtual bool txt::Paragraph::Paint ( flutter::DisplayListBuilder *  builder, double  x, double  y  )

pure virtual

---

The documentation for this class was generated from the following file:

• third_party/txt/src/txt/paragraph.h