#include <SlateTextLayout.h>

Inheritance diagram for FSlateTextLayout:

Public Member Functions
SLATE_API FChildren *	GetChildren ()

virtual SLATE_API void	ArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren) const

virtual SLATE_API int32	OnPaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const

virtual SLATE_API void	EndLayout () override

SLATE_API void	SetDefaultTextStyle (FTextBlockStyle InDefaultTextStyle)

SLATE_API const FTextBlockStyle &	GetDefaultTextStyle () const

SLATE_API void	SetIsPassword (const TAttribute< bool > &InIsPassword)

Public Member Functions inherited from FTextLayout
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

Static Public Member Functions
static SLATE_API TSharedRef< FSlateTextLayout >	Create (SWidget *InOwner, FTextBlockStyle InDefaultTextStyle)

Protected Member Functions
SLATE_API	FSlateTextLayout (SWidget *InOwner, FTextBlockStyle InDefaultTextStyle)

virtual SLATE_API int32	OnPaintHighlights (const FPaintArgs &Args, const FTextLayout::FLineView &LineView, const TArray< FLineViewHighlight > &Highlights, const FTextBlockStyle &DefaultTextStyle, const FGeometry &AllottedGeometry, const FSlateRect &ClippingRect, FSlateWindowElementList &OutDrawElements, const int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const

virtual SLATE_API void	AggregateChildren ()

virtual SLATE_API TSharedRef< IRun >	CreateDefaultTextRun (const TSharedRef< FString > &NewText, const FTextRange &NewRange) const override

Protected Member Functions inherited from FTextLayout
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)

SLATE_API void	EndLineLayout (FLineModel &LineModel)

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

	TSharedFromThis (TSharedFromThis const &)

UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)

	~TSharedFromThis ()

Protected Attributes
FTextBlockStyle	DefaultTextStyle

Protected Attributes inherited from FTextLayout
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

Friends
class	FSlateTextLayoutFactory

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

◆ FSlateTextLayout()

FSlateTextLayout::FSlateTextLayout	(	SWidget *	InOwner,
		FTextBlockStyle	InDefaultTextStyle
	)

protected

Member Function Documentation

◆ AggregateChildren()

void FSlateTextLayout::AggregateChildren ( )

protectedvirtual

◆ ArrangeChildren()

void FSlateTextLayout::ArrangeChildren	(	const FGeometry &	AllottedGeometry,
		FArrangedChildren &	ArrangedChildren
	)		const

virtual

◆ Create()

TSharedRef< FSlateTextLayout > FSlateTextLayout::Create	(	SWidget *	InOwner,
		FTextBlockStyle	InDefaultTextStyle
	)

static

◆ CreateDefaultTextRun()

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

overrideprotectedvirtual

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

Implements FTextLayout.

◆ EndLayout()

void FSlateTextLayout::EndLayout ( )

overridevirtual

Notifies all Runs that the layout has finished generating.

Reimplemented from FTextLayout.

◆ GetChildren()

FChildren * FSlateTextLayout::GetChildren ( )

◆ GetDefaultTextStyle()

const FTextBlockStyle & FSlateTextLayout::GetDefaultTextStyle ( ) const

◆ OnPaint()

int32 FSlateTextLayout::OnPaint	(	const FPaintArgs &	Args,
		const FGeometry &	AllottedGeometry,
		const FSlateRect &	MyCullingRect,
		FSlateWindowElementList &	OutDrawElements,
		int32	LayerId,
		const FWidgetStyle &	InWidgetStyle,
		bool	bParentEnabled
	)		const

virtual

◆ OnPaintHighlights()

int32 FSlateTextLayout::OnPaintHighlights	(	const FPaintArgs &	Args,
		const FTextLayout::FLineView &	LineView,
		const TArray< FLineViewHighlight > &	Highlights,
		const FTextBlockStyle &	DefaultTextStyle,
		const FGeometry &	AllottedGeometry,
		const FSlateRect &	ClippingRect,
		FSlateWindowElementList &	OutDrawElements,
		const int32	LayerId,
		const FWidgetStyle &	InWidgetStyle,
		bool	bParentEnabled
	)		const

protectedvirtual

◆ SetDefaultTextStyle()

void FSlateTextLayout::SetDefaultTextStyle ( FTextBlockStyle InDefaultTextStyle )

◆ SetIsPassword()

void FSlateTextLayout::SetIsPassword ( const TAttribute< bool > & InIsPassword )

Friends And Related Symbol Documentation

◆ FSlateTextLayoutFactory

friend class FSlateTextLayoutFactory

friend

Member Data Documentation

◆ DefaultTextStyle

FTextBlockStyle FSlateTextLayout::DefaultTextStyle