txt::ParagraphBuilderSkia Class Reference

ParagraphBuilder implementation using Skia's text layout module. More...

#include <paragraph_builder_skia.h>

Inheritance diagram for txt::ParagraphBuilderSkia:

Public Member Functions
	ParagraphBuilderSkia (const ParagraphStyle &style, std::shared_ptr< FontCollection > font_collection, const bool impeller_enabled)
virtual	~ParagraphBuilderSkia ()
virtual void	PushStyle (const TextStyle &style) override
virtual void	Pop () override
virtual const TextStyle &	PeekStyle () override
virtual void	AddText (const std::u16string &text) override
virtual void	AddPlaceholder (PlaceholderRun &span) override
virtual std::unique_ptr< Paragraph >	Build () override
Public Member Functions inherited from flutter::ParagraphBuilder
	~ParagraphBuilder () override
void	pushStyle (const tonic::Int32List &encoded, const std::vector< std::string > &fontFamilies, double fontSize, double letterSpacing, double wordSpacing, double height, double decorationThickness, const std::string &locale, Dart_Handle background_objects, Dart_Handle background_data, Dart_Handle foreground_objects, Dart_Handle foreground_data, Dart_Handle shadows_data, Dart_Handle font_features_data, Dart_Handle font_variations_data)
void	pop ()
Dart_Handle	addText (const std::u16string &text)
void	addPlaceholder (double width, double height, unsigned alignment, double baseline_offset, unsigned baseline)
void	build (Dart_Handle paragraph_handle)
Public Member Functions inherited from flutter::RefCountedDartWrappable< ParagraphBuilder >
virtual void	RetainDartWrappableReference () const override
virtual void	ReleaseDartWrappableReference () const override
Public Member Functions inherited from fml::RefCountedThreadSafe< ParagraphBuilder >
void	Release () const
Public Member Functions inherited from fml::internal::RefCountedThreadSafeBase
void	AddRef () const
bool	HasOneRef () const
void	AssertHasOneRef () const
Public Member Functions inherited from tonic::DartWrappable
	DartWrappable ()
virtual const DartWrapperInfo &	GetDartWrapperInfo () const =0
virtual void	RetainDartWrappableReference () const =0
virtual void	ReleaseDartWrappableReference () const =0
Dart_Handle	CreateDartWrapper (DartState *dart_state)
void	AssociateWithDartWrapper (Dart_Handle wrappable)
void	ClearDartWrapper ()
Dart_WeakPersistentHandle	dart_wrapper () const

Friends
class	SkiaParagraphBuilderTests_ParagraphStrutStyle_Test

Additional Inherited Members
Public Types inherited from tonic::DartWrappable
enum	DartNativeFields { kPeerIndex , kNumberOfNativeFields }
Static Public Member Functions inherited from flutter::ParagraphBuilder
static void	Create (Dart_Handle wrapper, Dart_Handle encoded_handle, Dart_Handle strutData, const std::string &fontFamily, const std::vector< std::string > &strutFontFamilies, double fontSize, double height, const std::u16string &ellipsis, const std::string &locale)
Protected Member Functions inherited from fml::RefCountedThreadSafe< ParagraphBuilder >
	RefCountedThreadSafe ()
	~RefCountedThreadSafe ()
Protected Member Functions inherited from fml::internal::RefCountedThreadSafeBase
	RefCountedThreadSafeBase ()
	~RefCountedThreadSafeBase ()
bool	Release () const
void	Adopt ()
Protected Member Functions inherited from tonic::DartWrappable
virtual	~DartWrappable ()
Static Protected Member Functions inherited from tonic::DartWrappable
static Dart_PersistentHandle	GetTypeForWrapper (tonic::DartState *dart_state, const tonic::DartWrapperInfo &wrapper_info)

Detailed Description

ParagraphBuilder implementation using Skia's text layout module.

Note

Despite the suffix "Skia", this class is not specific to Skia and is also used with the Impeller backend.

Definition at line 32 of file paragraph_builder_skia.h.

Constructor & Destructor Documentation

ParagraphBuilderSkia()

txt::ParagraphBuilderSkia::ParagraphBuilderSkia	(	const ParagraphStyle &	style,
		std::shared_ptr< FontCollection >	font_collection,
		const bool	impeller_enabled
	)

Definition at line 48 of file paragraph_builder_skia.cc.

    : base_style_(style.GetTextStyle()), impeller_enabled_(impeller_enabled) {
  builder_ = skt::ParagraphBuilder::make(
      TxtToSkia(style),
      font_collection->CreateSktFontCollection(),
      SkUnicodes::ICU::Make());
}

~ParagraphBuilderSkia()

txt::ParagraphBuilderSkia::~ParagraphBuilderSkia ( )

virtualdefault

Member Function Documentation

AddPlaceholder()

void txt::ParagraphBuilderSkia::AddPlaceholder ( PlaceholderRun &  span )

overridevirtual

Definition at line 79 of file paragraph_builder_skia.cc.

                                                              {
  skt::PlaceholderStyle placeholder_style;
  placeholder_style.fHeight = span.height;
  placeholder_style.fWidth = span.width;
  placeholder_style.fBaseline = static_cast<skt::TextBaseline>(span.baseline);
  placeholder_style.fBaselineOffset = span.baseline_offset;
  placeholder_style.fAlignment =
      static_cast<skt::PlaceholderAlignment>(span.alignment);
 
  builder_->addPlaceholder(placeholder_style);
}

AddText()

void txt::ParagraphBuilderSkia::AddText ( const std::u16string &  text )

overridevirtual

Definition at line 75 of file paragraph_builder_skia.cc.

                                                           {
  builder_->addText(text);
}

Build()

std::unique_ptr< Paragraph > txt::ParagraphBuilderSkia::Build ( )

overridevirtual

Definition at line 91 of file paragraph_builder_skia.cc.

                                                     {
  return std::make_unique<ParagraphSkia>(
      builder_->Build(), std::move(dl_paints_), impeller_enabled_);
}

PeekStyle()

const TextStyle & txt::ParagraphBuilderSkia::PeekStyle ( )

overridevirtual

Definition at line 71 of file paragraph_builder_skia.cc.

                                                 {
  return txt_style_stack_.empty() ? base_style_ : txt_style_stack_.top();
}

Pop()

void txt::ParagraphBuilderSkia::Pop ( )

overridevirtual

Definition at line 66 of file paragraph_builder_skia.cc.

                               {
  builder_->pop();
  txt_style_stack_.pop();
}

PushStyle()

void txt::ParagraphBuilderSkia::PushStyle ( const TextStyle &  style )

overridevirtual

Definition at line 61 of file paragraph_builder_skia.cc.

                                                           {
  builder_->pushStyle(TxtToSkia(style));
  txt_style_stack_.push(style);
}

Friends And Related Function Documentation

SkiaParagraphBuilderTests_ParagraphStrutStyle_Test

friend class SkiaParagraphBuilderTests_ParagraphStrutStyle_Test

friend

Definition at line 48 of file paragraph_builder_skia.h.

---

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

• third_party/txt/src/skia/paragraph_builder_skia.h
• third_party/txt/src/skia/paragraph_builder_skia.cc