Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Slate > Framework > Text > FTextLayout

Light Theme

Dark Theme

FTextLayout

Windows

MacOS

Linux

Inheritance Hierarchy

TSharedFromThis

FTextLayout

FSlateTextLayout

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Framework/Text/TextLayout.h
Include	#include "Framework/Text/TextLayout.h"

Syntax

class FTextLayout : public TSharedFromThis< FTextLayout >

Variables

	Name	Description
TAttribute< FSt...	DebugSourceInfo	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
ETextLayoutDirt...	DirtyFlags	Whether parameters on the layout have changed which requires the view be updated.
TSharedRef< IBr...	GraphemeBreakIterator	The iterator to use to detect grapheme cluster boundaries
ETextJustify::T...	Justification	How the text should be aligned with the margin.
TSharedPtr< IBr...	LineBreakIterator	The iterator to use to detect appropriate soft-wrapping points for lines
float	LineHeightPercentage	The percentage to modify a line height by.
TArray< FLineMo...	LineModels	The models for the lines of text. A LineModel represents a single string with no manual breaks.
TArray< FLineVi...	LineViews	The views for the lines of text.
TSet< int32 >	LineViewsToJustify	The indices for all of the line views that require justification.
FMargin	Margin	The size of the margins to put about the text. This is an unscaled value.
float	Scale	The scale to draw the text at
FVector2D	ScrollOffset	The scroll offset of the text layout from the parent widget
TUniquePtr< Tex...	TextBiDiDetection	Unicode BiDi text detection
ETextFlowDirect...	TextFlowDirection	How should the text within this layout be flowed?
FTextLayoutSize	TextLayoutSize	The final size of the text layout on screen.
ETextShapingMet...	TextShapingMethod	The method used to shape the text within this layout
FVector2D	ViewSize	The size of the text layout that can actually be seen from the parent widget
TSharedRef< IBr...	WordBreakIterator	The iterator to use to detect word boundaries
ETextWrappingPo...	WrappingPolicy	The wrapping policy used by this text layout.
float	WrappingWidth	The width that the text should be wrap at. If 0 or negative no wrapping occurs.

Constructors

	Name	Description
	FTextLayout()

Destructors

	Name	Description
	~FTextLayout()

Functions

	Name	Description
void	AddLine ( const FNewLineData& NewLine )
void	AddLineHighlight ( const FTextLineHighlight& Highligh... )	Adds a single line highlight to the existing set of highlights.
void	AddLines ( const TArray< FNewLineData >& NewL... )
void	AddRunRenderer ( const FTextRunRenderer& Renderer )	Adds a single run renderer to the existing set of renderers.
void	BeginLayout()	Notifies all Runs that we are beginning to generate a new layout.
void	BeginLineLayout ( FLineModel& LineModel )	Notifies all Runs on the given line is beginning to have a new layout generated.
void	CalculateLineTextDirection ( FLineModel& LineModel )	Calculates the text direction for the given line based upon the current shaping method and document flow direction
ETextJustify...	CalculateLineViewVisualJustification ( const FLineView& LineView )	Calculates the visual justification for the given line view
void	CalculateTextDirection()	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))
void	ClearLineHighlights()	Clears all line highlights
void	ClearLines()
void	ClearRunRenderers()	Clears all run renderers
void	ClearView()	Clears the current layouts view information.
TSharedRef< ...	CreateDefaultTextRun ( const TSharedRef< FString >& NewTe..., const FTextRange& NewRange )	Called to generate a new empty text run for this text layout
void	CreateLineWrappingCache ( FLineModel& LineModel )	Create the wrapping cache for the given line based upon the current scale
void	CreateWrappingCache()	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))
void	DirtyAllLineModels ( const ELineModelDirtyState::Flags I... )	Set the given dirty flags on all line models in this layout
void	DirtyLayout()
void	DirtyRunLayout ( const TSharedRef< const IRun >& Ru... )
void	EndLayout()	Notifies all Runs that the layout has finished generating.
void	EndLineLayout ( FLineModel& LineModel )	Notifies all Runs on the given line has finished having a new layout generated.
void	FlushLineTextShapingCache ( FLineModel& LineModel )	Flushes the text shaping cache for the given line
void	FlushTextShapingCache()	Flushes the text shaping cache for each line
void	GetAsText ( FString& DisplayText, FTextOffsetLocations*const Out... )
void	GetAsText ( FText& DisplayText, FTextOffsetLocations*const Out... )
FVector2D	GetDrawSize()	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)
FTextSelecti...	GetGraphemeAt ( const FTextLocation& Location )
ETextJustify...	GetJustification()
int32	GetLineCount()
float	GetLineHeightPercentage()
const TArray...	GetLineModels()
int32	GetLineViewIndexForTextLocation ( const TArray< FTextLayout::FLineVie..., const FTextLocation& Location, const bool bPerformInclusiveBoundsC... )
const TArray...	GetLineViews()
FVector2D	GetLocationAt ( const FTextLocation& Location, const bool bPerformInclusiveBoundsC... )
FMargin	GetMargin()
float	GetScale()
void	GetSelectionAsText ( FString& DisplayText, const FTextSelection& Selection )
FVector2D	GetSize()	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)
ETextFlowDir...	GetTextFlowDirection()
FTextLocatio...	GetTextLocationAt ( const FLineView& LineView, const FVector2D& Relative, ETextHitPoint*const OutHitPoin... )
FTextLocatio...	GetTextLocationAt ( const FVector2D& Relative, ETextHitPoint*const OutHitPoin... )
void	GetTextOffsetLocations ( FTextOffsetLocations& OutTextOffse... )	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
ETextShaping...	GetTextShapingMethod()
ETextJustify...	GetVisualJustification()	Get the visual justification for this document (based on the visual justification used by the first line of text)
FTextSelecti...	GetWordAt ( const FTextLocation& Location )
FVector2D	GetWrappedDrawSize()	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
FVector2D	GetWrappedSize()	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
ETextWrappin...	GetWrappingPolicy()
float	GetWrappingWidth()
bool	InsertAt ( const FTextLocation& Location, TSharedRef< IRun > InRun, const bool bAlwaysKeepRightRun )
bool	InsertAt ( const FTextLocation& Location, TCHAR Character )
bool	InsertAt ( const FTextLocation& Location, const FString& Text )
bool	IsEmpty()
bool	IsLayoutDirty()
bool	JoinLineWithNextLine ( int32 LineIndex )
bool	RemoveAt ( const FTextLocation& Location, int32 Count )
bool	RemoveLine ( int32 LineIndex )
void	RemoveLineHighlight ( const FTextLineHighlight& Highligh... )	Removes a single line highlight to the existing set of highlights.
void	RemoveRunRenderer ( const FTextRunRenderer& Renderer )	Removes a single run renderer to the existing set of renderers.
void	SetDebugSourceInfo ( const TAttribute< FString >& InDeb... )	Set the information used to help identify who owns this text layout in the case of an error
void	SetJustification ( ETextJustify::Type Value )
void	SetLineBreakIterator ( TSharedPtr< IBreakIterator > InLine... )	Set the iterator to use to detect appropriate soft-wrapping points for lines (or null to go back to using the default)
void	SetLineHeightPercentage ( float Value )
void	SetLineHighlights ( const TArray< FTextLineHighlight > ... )	Replaces the current set of line highlights with the provided highlights.
void	SetMargin ( const FMargin& InMargin )
void	SetRunRenderers ( const TArray< FTextRunRenderer >& ... )	Replaces the current set of run renderers with the provided renderers.
void	SetScale ( float Value )
void	SetTextFlowDirection ( const ETextFlowDirection InTextFlow... )
void	SetTextShapingMethod ( const ETextShapingMethod InTextShap... )
void	SetVisibleRegion ( const FVector2D& InViewSize, const FVector2D& InScrollOffset )
void	SetWrappingPolicy ( ETextWrappingPolicy Value )
void	SetWrappingWidth ( float Value )
bool	SplitLineAt ( const FTextLocation& Location )
void	UpdateHighlights()
void	UpdateIfNeeded()	Updates the TextLayout's if any changes have occurred since the last update.
void	UpdateLayout()

Classes

	Name	Description
	ELineModelDirtyState
	ETextLayoutDirtyState
	FBlockDefinition
	FBreakCandidate
	FLineModel
	FLineView
	FLineViewHighlight
	FNewLineData
	FRunModel
	FTextLayoutSize
	FTextOffsetLocations	A mapping between the offsets into the text as a flat string (with line-breaks), and the internal lines used within a text layout

Deprecated Functions

		Name	Description
	void	AddLine ( const TSharedRef< FString >& Text, const TArray< TSharedRef< IRun > > ... )	Please use the version of AddLine that takes an FNewLineData parameter.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss