#include <TextLayout.h>

Inheritance diagram for FTextLayout:

Classes
struct	ELineModelDirtyState

struct	ETextLayoutDirtyState

struct	FBlockDefinition

struct	FBreakCandidate

struct	FLineModel

struct	FLineView

struct	FLineViewHighlight

struct	FNewLineData

class	FRunModel

struct	FTextLayoutSize

struct	FTextOffsetLocations

Public Member Functions
virtual SLATE_API	~FTextLayout ()

const TArray< FTextLayout::FLineView > &	GetLineViews () const

const TArray< FTextLayout::FLineModel > &	GetLineModels () const

SLATE_API FVector2D	GetSize () const

SLATE_API FVector2D	GetViewSize () const

SLATE_API FVector2D	GetDrawSize () const

SLATE_API FVector2D	GetWrappedSize () const

SLATE_API FVector2D	GetWrappedDrawSize () const

float	GetWrappingWidth () const

SLATE_API void	SetWrappingWidth (float Value)

ETextWrappingPolicy	GetWrappingPolicy () const

SLATE_API void	SetWrappingPolicy (ETextWrappingPolicy Value)

float	GetLineHeightPercentage () const

SLATE_API void	SetLineHeightPercentage (float Value)

bool	GetApplyLineHeightToBottomLine () const

SLATE_API void	SetApplyLineHeightToBottomLine (bool Value)

ETextJustify::Type	GetJustification () const

SLATE_API void	SetJustification (ETextJustify::Type Value)

SLATE_API ETextJustify::Type	GetVisualJustification () const

ETextTransformPolicy	GetTransformPolicy () const

SLATE_API void	SetTransformPolicy (ETextTransformPolicy Value)

float	GetScale () const

SLATE_API void	SetScale (float Value)

ETextShapingMethod	GetTextShapingMethod () const

SLATE_API void	SetTextShapingMethod (const ETextShapingMethod InTextShapingMethod)

ETextFlowDirection	GetTextFlowDirection () const

SLATE_API void	SetTextFlowDirection (const ETextFlowDirection InTextFlowDirection)

SLATE_API void	SetTextOverflowPolicy (const TOptional< ETextOverflowPolicy > InTextOverflowPolicy)

FMargin	GetMargin () const

SLATE_API void	SetMargin (const FMargin &InMargin)

SLATE_API void	SetVisibleRegion (const FVector2D &InViewSize, const FVector2D &InScrollOffset)

SLATE_API void	SetLineBreakIterator (TSharedPtr< IBreakIterator > InLineBreakIterator)

SLATE_API void	SetDebugSourceInfo (const TAttribute< FString > &InDebugSourceInfo)

SLATE_API void	ClearLines ()

SLATE_API void	AddLine (const FNewLineData &NewLine)

SLATE_API void	AddLines (const TArray< FNewLineData > &NewLines)

SLATE_API void	ClearRunRenderers ()

SLATE_API void	SetRunRenderers (const TArray< FTextRunRenderer > &Renderers)

SLATE_API void	AddRunRenderer (const FTextRunRenderer &Renderer)

SLATE_API void	RemoveRunRenderer (const FTextRunRenderer &Renderer)

SLATE_API void	ClearLineHighlights ()

SLATE_API void	SetLineHighlights (const TArray< FTextLineHighlight > &Highlights)

SLATE_API void	AddLineHighlight (const FTextLineHighlight &Highlight)

SLATE_API void	RemoveLineHighlight (const FTextLineHighlight &Highlight)

virtual SLATE_API void	UpdateIfNeeded ()

virtual SLATE_API void	UpdateLayout ()

virtual SLATE_API void	UpdateHighlights ()

SLATE_API void	DirtyRunLayout (const TSharedRef< const IRun > &Run)

SLATE_API void	DirtyLayout ()

SLATE_API bool	IsLayoutDirty () const

SLATE_API int32	GetLineViewIndexForTextLocation (const TArray< FTextLayout::FLineView > &LineViews, const FTextLocation &Location, const bool bPerformInclusiveBoundsCheck) const

SLATE_API FTextLocation	GetTextLocationAt (const FVector2D &Relative, ETextHitPoint *const OutHitPoint=nullptr) const

SLATE_API FTextLocation	GetTextLocationAt (const FLineView &LineView, const FVector2D &Relative, ETextHitPoint *const OutHitPoint=nullptr) const

SLATE_API FVector2D	GetLocationAt (const FTextLocation &Location, const bool bPerformInclusiveBoundsCheck) const

SLATE_API bool	SplitLineAt (const FTextLocation &Location)

SLATE_API bool	JoinLineWithNextLine (int32 LineIndex)

SLATE_API bool	InsertAt (const FTextLocation &Location, TCHAR Character)

SLATE_API bool	InsertAt (const FTextLocation &Location, const FString &Text)

SLATE_API bool	InsertAt (const FTextLocation &Location, TSharedRef< IRun > InRun, const bool bAlwaysKeepRightRun=false)

SLATE_API bool	RemoveAt (const FTextLocation &Location, int32 Count=1)

SLATE_API bool	RemoveLine (int32 LineIndex)

SLATE_API bool	IsEmpty () const

SLATE_API int32	GetLineCount () const

SLATE_API void	GetAsText (FString &DisplayText, FTextOffsetLocations *const OutTextOffsetLocations=nullptr) const

SLATE_API void	GetAsText (FText &DisplayText, FTextOffsetLocations *const OutTextOffsetLocations=nullptr) const

SLATE_API void	GetTextOffsetLocations (FTextOffsetLocations &OutTextOffsetLocations) const

SLATE_API void	GetSelectionAsText (FString &DisplayText, const FTextSelection &Selection) const

SLATE_API FTextSelection	GetGraphemeAt (const FTextLocation &Location) const

SLATE_API FTextSelection	GetWordAt (const FTextLocation &Location) const

Public Member Functions inherited from TSharedFromThis< FTextLayout >
TSharedRef< FTextLayout, Mode >	AsShared ()

TSharedRef< FTextLayout const, Mode >	AsShared () const

TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const

TWeakPtr< FTextLayout, Mode >	AsWeak ()

TWeakPtr< FTextLayout const, Mode >	AsWeak () const

TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const

void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const InSharedPtr, OtherType InObject) const

void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const InSharedRef, OtherType InObject) const

UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Protected Member Functions
SLATE_API	FTextLayout ()

SLATE_API void	CalculateTextDirection ()

SLATE_API void	CalculateLineTextDirection (FLineModel &LineModel) const

SLATE_API ETextJustify::Type	CalculateLineViewVisualJustification (const FLineView &LineView) const

SLATE_API void	CreateWrappingCache ()

SLATE_API void	CreateLineWrappingCache (FLineModel &LineModel)

SLATE_API void	FlushTextShapingCache ()

SLATE_API void	FlushLineTextShapingCache (FLineModel &LineModel)

SLATE_API void	DirtyAllLineModels (const ELineModelDirtyState::Flags InDirtyFlags)

SLATE_API void	ClearView ()

SLATE_API void	TransformLineText (FLineModel &LineModel) const

virtual SLATE_API void	BeginLayout ()

SLATE_API void	BeginLineLayout (FLineModel &LineModel)

virtual SLATE_API void	EndLayout ()

SLATE_API void	EndLineLayout (FLineModel &LineModel)

virtual TSharedRef< IRun >	CreateDefaultTextRun (const TSharedRef< FString > &NewText, const FTextRange &NewRange) const =0

Protected Member Functions inherited from TSharedFromThis< FTextLayout >
	TSharedFromThis ()

	TSharedFromThis (TSharedFromThis const &)

UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)

	~TSharedFromThis ()

Protected Attributes
int32	CachedLayoutGeneration = 0

TArray< FLineModel >	LineModels

TArray< FLineView >	LineViews

TSet< int32 >	LineViewsToJustify

ETextLayoutDirtyState::Flags	DirtyFlags

ETextShapingMethod	TextShapingMethod

ETextFlowDirection	TextFlowDirection

float	Scale

float	WrappingWidth

ETextWrappingPolicy	WrappingPolicy

ETextTransformPolicy	TransformPolicy

FMargin	Margin

ETextJustify::Type	Justification

float	LineHeightPercentage

bool	ApplyLineHeightToBottomLine

FTextLayoutSize	TextLayoutSize

float	OverHeight

FVector2D	ViewSize

FVector2D	ScrollOffset

TSharedPtr< IBreakIterator >	LineBreakIterator

TSharedRef< IBreakIterator >	GraphemeBreakIterator

TSharedRef< IBreakIterator >	WordBreakIterator

TUniquePtr< TextBiDi::ITextBiDi >	TextBiDiDetection

TAttribute< FString >	DebugSourceInfo

TOptional< ETextOverflowPolicy >	TextOverflowPolicyOverride

Additional Inherited Members
Static Protected Member Functions inherited from TSharedFromThis< FTextLayout >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)

static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Constructor & Destructor Documentation

◆ ~FTextLayout()

FTextLayout::~FTextLayout ( )

virtual

◆ FTextLayout()

FTextLayout::FTextLayout ( )

protected

Member Function Documentation

◆ AddLine()

void FTextLayout::AddLine ( const FNewLineData & NewLine )

◆ AddLineHighlight()

void FTextLayout::AddLineHighlight ( const FTextLineHighlight & Highlight )

Adds a single line highlight to the existing set of highlights.

◆ AddLines()

void FTextLayout::AddLines ( const TArray< FNewLineData > & NewLines )

◆ AddRunRenderer()

void FTextLayout::AddRunRenderer ( const FTextRunRenderer & Renderer )

Adds a single run renderer to the existing set of renderers.

◆ BeginLayout()

void FTextLayout::BeginLayout ( )

protectedvirtual

Notifies all Runs that we are beginning to generate a new layout.

◆ BeginLineLayout()

void FTextLayout::BeginLineLayout ( FLineModel & LineModel )

protected

Notifies all Runs on the given line is beginning to have a new layout generated.

◆ CalculateLineTextDirection()

void FTextLayout::CalculateLineTextDirection ( FLineModel & LineModel ) const

protected

Calculates the text direction for the given line based upon the current shaping method and document flow direction

◆ CalculateLineViewVisualJustification()

ETextJustify::Type FTextLayout::CalculateLineViewVisualJustification ( const FLineView & LineView ) const

protected

Calculates the visual justification for the given line view

◆ CalculateTextDirection()

void FTextLayout::CalculateTextDirection ( )

protected

Calculates the text direction for each line based upon the current shaping method and document flow direction When changing the shaping method, or document flow direction, all the lines need to be dirtied (see DirtyAllLineModels(ELineModelDirtyState::TextBaseDirection))

◆ ClearLineHighlights()

void FTextLayout::ClearLineHighlights ( )

Clears all line highlights

◆ ClearLines()

void FTextLayout::ClearLines ( )

◆ ClearRunRenderers()

void FTextLayout::ClearRunRenderers ( )

Clears all run renderers

◆ ClearView()

void FTextLayout::ClearView ( )

protected

Clears the current layouts view information.

◆ CreateDefaultTextRun()

virtual TSharedRef< IRun > FTextLayout::CreateDefaultTextRun	(	const TSharedRef< FString > &	NewText,
		const FTextRange &	NewRange
	)		const

protectedpure virtual

Called to generate a new empty text run for this text layout

Implemented in FSlateTextLayout.

◆ CreateLineWrappingCache()

void FTextLayout::CreateLineWrappingCache ( FLineModel & LineModel )

protected

Create the wrapping cache for the given line based upon the current scale

◆ CreateWrappingCache()

void FTextLayout::CreateWrappingCache ( )

protected

Create the wrapping cache for the current text based upon the current scale Each line keeps its own cached state, so needs to be cleared when changing the text within a line When changing the scale, all the lines need to be cleared (see DirtyAllLineModels(ELineModelDirtyState::WrappingInformation))

◆ DirtyAllLineModels()

void FTextLayout::DirtyAllLineModels ( const ELineModelDirtyState::Flags InDirtyFlags )

protected

Set the given dirty flags on all line models in this layout

◆ DirtyLayout()

void FTextLayout::DirtyLayout ( )

◆ DirtyRunLayout()

void FTextLayout::DirtyRunLayout ( const TSharedRef< const IRun > & Run )

◆ EndLayout()

void FTextLayout::EndLayout ( )

protectedvirtual

Notifies all Runs that the layout has finished generating.

Reimplemented in FSlateTextLayout.

◆ EndLineLayout()

void FTextLayout::EndLineLayout ( FLineModel & LineModel )

protected

Notifies all Runs on the given line has finished having a new layout generated.

◆ FlushLineTextShapingCache()

void FTextLayout::FlushLineTextShapingCache ( FLineModel & LineModel )

protected

Flushes the text shaping cache for the given line

◆ FlushTextShapingCache()

void FTextLayout::FlushTextShapingCache ( )

protected

Flushes the text shaping cache for each line

◆ GetApplyLineHeightToBottomLine()

bool FTextLayout::GetApplyLineHeightToBottomLine ( ) const

inline

◆ GetAsText() [1/2]

void FTextLayout::GetAsText	(	FString &	DisplayText,
		FTextOffsetLocations *const	OutTextOffsetLocations = `nullptr`
	)		const

◆ GetAsText() [2/2]

void FTextLayout::GetAsText	(	FText &	DisplayText,
		FTextOffsetLocations *const	OutTextOffsetLocations = `nullptr`
	)		const

◆ GetDrawSize()

FVector2D FTextLayout::GetDrawSize ( ) const

Get the size of the text layout, including any lines which extend beyond the wrapping boundaries (eg, lines with lots of trailing whitespace, or lines with no break candidates)

Note: This value is scaled

◆ GetGraphemeAt()

FTextSelection FTextLayout::GetGraphemeAt ( const FTextLocation & Location ) const

◆ GetJustification()

ETextJustify::Type FTextLayout::GetJustification ( ) const

inline

◆ GetLineCount()

int32 FTextLayout::GetLineCount ( ) const

◆ GetLineHeightPercentage()

float FTextLayout::GetLineHeightPercentage ( ) const

inline

◆ GetLineModels()

const TArray< FTextLayout::FLineModel > & FTextLayout::GetLineModels ( ) const

inline

◆ GetLineViewIndexForTextLocation()

int32 FTextLayout::GetLineViewIndexForTextLocation	(	const TArray< FTextLayout::FLineView > &	LineViews,
		const FTextLocation &	Location,
		const bool	bPerformInclusiveBoundsCheck
	)		const

◆ GetLineViews()

const TArray< FTextLayout::FLineView > & FTextLayout::GetLineViews ( ) const

inline

◆ GetLocationAt()

FVector2D FTextLayout::GetLocationAt	(	const FTextLocation &	Location,
		const bool	bPerformInclusiveBoundsCheck
	)		const

◆ GetMargin()

FMargin FTextLayout::GetMargin ( ) const

inline

◆ GetScale()

float FTextLayout::GetScale ( ) const

inline

◆ GetSelectionAsText()

void FTextLayout::GetSelectionAsText	(	FString &	DisplayText,
		const FTextSelection &	Selection
	)		const

◆ GetSize()

FVector2D FTextLayout::GetSize ( ) const

Get the size of the text layout, including any lines which extend beyond the wrapping boundaries (eg, lines with lots of trailing whitespace, or lines with no break candidates)

Note: This value is unscaled

◆ GetTextFlowDirection()

ETextFlowDirection FTextLayout::GetTextFlowDirection ( ) const

inline

◆ GetTextLocationAt() [1/2]

FTextLocation FTextLayout::GetTextLocationAt	(	const FLineView &	LineView,
		const FVector2D &	Relative,
		ETextHitPoint *const	OutHitPoint = `nullptr`
	)		const

◆ GetTextLocationAt() [2/2]

FTextLocation FTextLayout::GetTextLocationAt	(	const FVector2D &	Relative,
		ETextHitPoint *const	OutHitPoint = `nullptr`
	)		const

◆ GetTextOffsetLocations()

void FTextLayout::GetTextOffsetLocations ( FTextOffsetLocations & OutTextOffsetLocations ) const

Constructs an array containing the mappings between the text that would be returned by GetAsText, and the internal FTextLocation points used within this text layout

◆ GetTextShapingMethod()

ETextShapingMethod FTextLayout::GetTextShapingMethod ( ) const

inline

◆ GetTransformPolicy()

ETextTransformPolicy FTextLayout::GetTransformPolicy ( ) const

inline

Note: This option is destructive to the model text, so changing it requires refreshing the text layout from its marshaller

◆ GetViewSize()

FVector2D FTextLayout::GetViewSize ( ) const

Get the size of the text layout that can actually be seen from the parent widget

◆ GetVisualJustification()

ETextJustify::Type FTextLayout::GetVisualJustification ( ) const

Get the visual justification for this document (based on the visual justification used by the first line of text)

◆ GetWordAt()

FTextSelection FTextLayout::GetWordAt ( const FTextLocation & Location ) const

◆ GetWrappedDrawSize()

FVector2D FTextLayout::GetWrappedDrawSize ( ) const

Get the size of the text layout after the text has been wrapped, and including the first piece of trailing whitespace for any given soft-wrapped line

Note: This value is scaled

◆ GetWrappedSize()

FVector2D FTextLayout::GetWrappedSize ( ) const

Get the size of the text layout after the text has been wrapped, and including the first piece of trailing whitespace for any given soft-wrapped line

Note: This value is unscaled

◆ GetWrappingPolicy()

ETextWrappingPolicy FTextLayout::GetWrappingPolicy ( ) const

inline

◆ GetWrappingWidth()

float FTextLayout::GetWrappingWidth ( ) const

inline

◆ InsertAt() [1/3]

bool FTextLayout::InsertAt	(	const FTextLocation &	Location,
		const FString &	Text
	)

◆ InsertAt() [2/3]

bool FTextLayout::InsertAt	(	const FTextLocation &	Location,
		TCHAR	Character
	)

◆ InsertAt() [3/3]

bool FTextLayout::InsertAt	(	const FTextLocation &	Location,
		TSharedRef< IRun >	InRun,
		const bool	bAlwaysKeepRightRun = `false`
	)

◆ IsEmpty()

bool FTextLayout::IsEmpty ( ) const

◆ IsLayoutDirty()

bool FTextLayout::IsLayoutDirty ( ) const

◆ JoinLineWithNextLine()

bool FTextLayout::JoinLineWithNextLine ( int32 LineIndex )

◆ RemoveAt()

bool FTextLayout::RemoveAt	(	const FTextLocation &	Location,
		int32	Count = `1`
	)

◆ RemoveLine()

bool FTextLayout::RemoveLine ( int32 LineIndex )

◆ RemoveLineHighlight()

void FTextLayout::RemoveLineHighlight ( const FTextLineHighlight & Highlight )

Removes a single line highlight to the existing set of highlights.

◆ RemoveRunRenderer()

void FTextLayout::RemoveRunRenderer ( const FTextRunRenderer & Renderer )

Removes a single run renderer to the existing set of renderers.

◆ SetApplyLineHeightToBottomLine()

void FTextLayout::SetApplyLineHeightToBottomLine ( bool Value )

◆ SetDebugSourceInfo()

void FTextLayout::SetDebugSourceInfo ( const TAttribute< FString > & InDebugSourceInfo )

Set the information used to help identify who owns this text layout in the case of an error

◆ SetJustification()

void FTextLayout::SetJustification ( ETextJustify::Type Value )

◆ SetLineBreakIterator()

void FTextLayout::SetLineBreakIterator ( TSharedPtr< IBreakIterator > InLineBreakIterator )

Set the iterator to use to detect appropriate soft-wrapping points for lines (or null to go back to using the default)

◆ SetLineHeightPercentage()

void FTextLayout::SetLineHeightPercentage ( float Value )

◆ SetLineHighlights()

void FTextLayout::SetLineHighlights ( const TArray< FTextLineHighlight > & Highlights )

Replaces the current set of line highlights with the provided highlights.

◆ SetMargin()

void FTextLayout::SetMargin ( const FMargin & InMargin )

◆ SetRunRenderers()

void FTextLayout::SetRunRenderers ( const TArray< FTextRunRenderer > & Renderers )

Replaces the current set of run renderers with the provided renderers.

◆ SetScale()

void FTextLayout::SetScale ( float Value )

◆ SetTextFlowDirection()

void FTextLayout::SetTextFlowDirection ( const ETextFlowDirection InTextFlowDirection )

◆ SetTextOverflowPolicy()

void FTextLayout::SetTextOverflowPolicy ( const TOptional< ETextOverflowPolicy > InTextOverflowPolicy )

◆ SetTextShapingMethod()

void FTextLayout::SetTextShapingMethod ( const ETextShapingMethod InTextShapingMethod )

◆ SetTransformPolicy()

void FTextLayout::SetTransformPolicy ( ETextTransformPolicy Value )

◆ SetVisibleRegion()

void FTextLayout::SetVisibleRegion	(	const FVector2D &	InViewSize,
		const FVector2D &	InScrollOffset
	)

◆ SetWrappingPolicy()

void FTextLayout::SetWrappingPolicy ( ETextWrappingPolicy Value )

◆ SetWrappingWidth()

void FTextLayout::SetWrappingWidth ( float Value )

◆ SplitLineAt()

bool FTextLayout::SplitLineAt ( const FTextLocation & Location )

◆ TransformLineText()

void FTextLayout::TransformLineText ( FLineModel & LineModel ) const

protected

Transform the given line model text based on the active transform policy.

Note: This is destructive to the model text!

◆ UpdateHighlights()

void FTextLayout::UpdateHighlights ( )

virtual

◆ UpdateIfNeeded()

void FTextLayout::UpdateIfNeeded ( )

virtual

Updates the TextLayout's if any changes have occurred since the last update.

◆ UpdateLayout()

void FTextLayout::UpdateLayout ( )

virtual

Member Data Documentation

◆ ApplyLineHeightToBottomLine

bool FTextLayout::ApplyLineHeightToBottomLine

protected

Whether or not line height should be applied to the last line.

◆ CachedLayoutGeneration

int32 FTextLayout::CachedLayoutGeneration = 0

protected

◆ DebugSourceInfo

TAttribute<FString> FTextLayout::DebugSourceInfo

protected

Information given to use by our an external source (typically our owner widget) to help identify who owns this text layout in the case of an error

◆ DirtyFlags

ETextLayoutDirtyState::Flags FTextLayout::DirtyFlags

protected

Whether parameters on the layout have changed which requires the view be updated.

◆ GraphemeBreakIterator

TSharedRef<IBreakIterator> FTextLayout::GraphemeBreakIterator

protected

The iterator to use to detect grapheme cluster boundaries

◆ Justification

ETextJustify::Type FTextLayout::Justification

protected

How the text should be aligned with the margin.

◆ LineBreakIterator

TSharedPtr<IBreakIterator> FTextLayout::LineBreakIterator

protected

The iterator to use to detect appropriate soft-wrapping points for lines

◆ LineHeightPercentage

float FTextLayout::LineHeightPercentage

protected

The percentage to modify a line height by.

◆ LineModels

TArray< FLineModel > FTextLayout::LineModels

protected

The models for the lines of text. A LineModel represents a single string with no manual breaks.

◆ LineViews

TArray< FLineView > FTextLayout::LineViews

protected

The views for the lines of text. A LineView represents a single visual line of text. Multiple LineViews can map to the same LineModel, if for example wrapping occurs.

◆ LineViewsToJustify

TSet< int32 > FTextLayout::LineViewsToJustify

protected

The indices for all of the line views that require justification.

◆ Margin

FMargin FTextLayout::Margin

protected

The size of the margins to put about the text. This is an unscaled value.

◆ OverHeight

float FTextLayout::OverHeight

protected

Extra height of the last line due to line height.

◆ Scale

float FTextLayout::Scale

protected

The scale to draw the text at

◆ ScrollOffset

FVector2D FTextLayout::ScrollOffset

protected

The scroll offset of the text layout from the parent widget

◆ TextBiDiDetection

TUniquePtr<TextBiDi::ITextBiDi> FTextLayout::TextBiDiDetection

protected

Unicode BiDi text detection

◆ TextFlowDirection

ETextFlowDirection FTextLayout::TextFlowDirection

protected

How should the text within this layout be flowed?

◆ TextLayoutSize

FTextLayoutSize FTextLayout::TextLayoutSize

protected

The final size of the text layout on screen.

◆ TextOverflowPolicyOverride

TOptional<ETextOverflowPolicy> FTextLayout::TextOverflowPolicyOverride

protected

Override for the text overflow policy. If unset, the style is used

◆ TextShapingMethod

ETextShapingMethod FTextLayout::TextShapingMethod

protected

The method used to shape the text within this layout

◆ TransformPolicy

ETextTransformPolicy FTextLayout::TransformPolicy

protected

The transform policy used by this text layout.

◆ ViewSize

FVector2D FTextLayout::ViewSize

protected

The size of the text layout that can actually be seen from the parent widget

◆ WordBreakIterator

TSharedRef<IBreakIterator> FTextLayout::WordBreakIterator

protected

The iterator to use to detect word boundaries

◆ WrappingPolicy

ETextWrappingPolicy FTextLayout::WrappingPolicy

protected

The wrapping policy used by this text layout.

◆ WrappingWidth

float FTextLayout::WrappingWidth

protected

The width that the text should be wrap at. If 0 or negative no wrapping occurs.

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

Engine/Source/Runtime/Slate/Public/Framework/Text/TextLayout.h
Engine/Source/Runtime/Slate/Private/Framework/Text/TextLayout.cpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ ~FTextLayout()

◆ FTextLayout()

Member Function Documentation

◆ AddLine()

◆ AddLineHighlight()

◆ AddLines()

◆ AddRunRenderer()

◆ BeginLayout()

◆ BeginLineLayout()

◆ CalculateLineTextDirection()

◆ CalculateLineViewVisualJustification()

◆ CalculateTextDirection()

◆ ClearLineHighlights()

◆ ClearLines()

◆ ClearRunRenderers()

◆ ClearView()

◆ CreateDefaultTextRun()

◆ CreateLineWrappingCache()

◆ CreateWrappingCache()

◆ DirtyAllLineModels()

◆ DirtyLayout()

◆ DirtyRunLayout()

◆ EndLayout()

◆ EndLineLayout()

◆ FlushLineTextShapingCache()

◆ FlushTextShapingCache()

◆ GetApplyLineHeightToBottomLine()

◆ GetAsText() [1/2]

◆ GetAsText() [2/2]

◆ GetDrawSize()

◆ GetGraphemeAt()

◆ GetJustification()

◆ GetLineCount()

◆ GetLineHeightPercentage()

◆ GetLineModels()

◆ GetLineViewIndexForTextLocation()

◆ GetLineViews()

◆ GetLocationAt()

◆ GetMargin()

◆ GetScale()

◆ GetSelectionAsText()

◆ GetSize()

◆ GetTextFlowDirection()

◆ GetTextLocationAt() [1/2]

◆ GetTextLocationAt() [2/2]

◆ GetTextOffsetLocations()

◆ GetTextShapingMethod()

◆ GetTransformPolicy()

◆ GetViewSize()

◆ GetVisualJustification()

◆ GetWordAt()

◆ GetWrappedDrawSize()

◆ GetWrappedSize()

◆ GetWrappingPolicy()

◆ GetWrappingWidth()

◆ InsertAt() [1/3]

◆ InsertAt() [2/3]

◆ InsertAt() [3/3]

◆ IsEmpty()

◆ IsLayoutDirty()

◆ JoinLineWithNextLine()

◆ RemoveAt()

◆ RemoveLine()

◆ RemoveLineHighlight()

◆ RemoveRunRenderer()

◆ SetApplyLineHeightToBottomLine()

◆ SetDebugSourceInfo()

◆ SetJustification()

◆ SetLineBreakIterator()

◆ SetLineHeightPercentage()

◆ SetLineHighlights()

◆ SetMargin()

◆ SetRunRenderers()

◆ SetScale()