Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

> Unreal Engine API Reference > Runtime > Slate > Widgets > Text > FSlateTextBlockLayout

Light Theme

Dark Theme

FSlateTextBlockLayout

Class to handle the cached layout of STextBlock/SRichTextBlock by proxying around a [FTextLayout](API\Runtime\Slate\Framework\Text\FTextLayout)

Choose your operating system:

Windows

macOS

Linux

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateTextBlockLayout.h
Include	#include "Widgets/Text/SlateTextBlockLayout.h"

Syntax

class FSlateTextBlockLayout

Remarks

Class to handle the cached layout of STextBlock/SRichTextBlock by proxying around a FTextLayout

Constructors

	Name	Description
	FSlateTextBlockLayout ( SWidget* InOwner, FTextBlockStyle InDefaultTextStyle, const TOptional< ETextShapingMethod..., const TOptional< ETextFlowDirection..., const FCreateSlateTextLayout& InCr..., TSharedRef< ITextLayoutMarshaller >..., TSharedPtr< IBreakIterator > InLine... )	Constructor

Functions

		Name	Description
	void	ArrangeChildren ( const FGeometry& AllottedGeometry, FArrangedChildren& ArrangedChildre... )	Arrange any child widgets in this layout
	FVector2D	ComputeDesiredSize ( const FWidgetDesiredSizeArgs& InWi..., const float InScale, const FTextBlockStyle& InTextStyle )	Get the computed desired size for this layout, updating the internal cache as required
	void	DirtyContent()	Force dirty the content due to an external change that can't be picked up automatically by this cache.
	void	DirtyLayout()	Force dirty the layout due to an external change that can't be picked up automatically by this cache
	FChildren &#...	GetChildren()	Get the child widgets of this layout
	FVector2D	GetDesiredSize()	Gets the last computed desired size.
	float	GetLayoutScale()	Get the TextLayout scale.
	int32	OnPaint ( const FPaintArgs& InPaintArgs, const FGeometry& InAllottedGeometr..., const FSlateRect& InClippingRect, FSlateWindowElementList& OutDrawEl..., int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled )	Paint this layout, updating the internal cache as required
	void	OverrideTextStyle ( const FTextBlockStyle& InTextStyle )	Override the text style used and immediately update the text layout (if required).
	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	SetTextFlowDirection ( const TOptional< ETextFlowDirection... )	Set the text flow direction that the internal text layout should use
	void	SetTextOverflowPolicy ( const TOptional< ETextOverflowPolic... )	Set the text overflow policy that the internal text layout should use
	void	SetTextShapingMethod ( const TOptional< ETextShapingMethod... )	Set the text shaping method that the internal text layout should use

Classes

	Name	Description
	FWidgetArgs
	FWidgetDesiredSizeArgs

Deprecated Functions

		Name	Description
	FVector2D	ComputeDesiredSize ( const FWidgetArgs& InWidgetArgs, const float InScale, const FTextBlockStyle& InTextStyle )	FWidgetArgs is deprecated. Upgrade to FWidgetDesiredSizeArgs instead.