1. Epic GamesDeveloper
  3. FSlateTextBlockLayout

FSlateTextBlockLayout

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

API > API/Runtime > API/Runtime/Slate

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

   
Name FSlateTextBlockLayout
Type class
Header File /Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateTextBlockLayout.h
Include Path #include "Widgets/Text/SlateTextBlockLayout.h"

Syntax

class FSlateTextBlockLayout

Constructors

Name Remarks Include Path Unreal Specifiers

FSlateTextBlockLayout ( SWidget* InOwner,
FTextBlockStyle InDefaultTextStyle,
const TOptional< ETextShapingMethod > InTextShapingMethod,
const TOptional< ETextFlowDirection > InTextFlowDirection,
const FCreateSlateTextLayout& InCreateSlateTextLayout,
TSharedRef< ITextLayoutMarshaller > InMarshaller,
TSharedPtr< IBreakIterator > InLineBreakPolicy
)

 Constructor Widgets/Text/SlateTextBlockLayout.h  

Structs

Name Remarks
FWidgetArgs  
FWidgetDesiredSizeArgs  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bCachedAutoWrapText bool Cache the auto wrap text value Widgets/Text/SlateTextBlockLayout.h  
CachedSize FVector2f The last known size of the layout from the previous OnPaint, used to guess at an auto-wrapping width in ComputeDesiredSize Widgets/Text/SlateTextBlockLayout.h  
CachedWrapTextAt float Cache where to wrap text at? Widgets/Text/SlateTextBlockLayout.h  
HighlightTextLastUpdate FTextSnapshot The state of the highlight text the last time it was updated (used to allow updates when the text is changed) Widgets/Text/SlateTextBlockLayout.h  
Marshaller TSharedPtr< ITextLayoutMarshaller > The marshaller used to get/set the text to/from the text layout. Widgets/Text/SlateTextBlockLayout.h  
TextHighlighter TSharedPtr< ISlateRunRenderer > Used to render the current highlights in the text layout Widgets/Text/SlateTextBlockLayout.h  
TextLastUpdate FTextSnapshot The state of the text the last time it was updated (used to allow updates when the text is changed) Widgets/Text/SlateTextBlockLayout.h  
TextLayout TSharedPtr< FSlateTextLayout > In control of the layout and wrapping of the text Widgets/Text/SlateTextBlockLayout.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Arrange any child widgets in this layout Widgets/Text/SlateTextBlockLayout.h  

FVector2D ComputeDesiredSize ( const FWidgetDesiredSizeArgs& InWidgetArgs,
const float InScale,
const FTextBlockStyle& InTextStyle
)

 Get the computed desired size for this layout, updating the internal cache as required Widgets/Text/SlateTextBlockLayout.h  

FVector2D ComputeDesiredSize ( const FWidgetDesiredSizeArgs& InWidgetArgs,
const float InScale
)

 Get the computed desired size for this layout, updating the internal cache as required Widgets/Text/SlateTextBlockLayout.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGSFVector2D ComputeDesiredSize ( const FWidgetArgs& InWidgetArgs,
const float InScale,
const FTextBlockStyle& InTextStyle
)

 Get the computed desired size for this layout, updating the internal cache as required Widgets/Text/SlateTextBlockLayout.h  
Conditionally update the text style if needed Widgets/Text/SlateTextBlockLayout.h  

void ConditionallyUpdateTextStyle ( const FTextBlockStyle& InTextStyle
)

 Conditionally update the text style if needed Widgets/Text/SlateTextBlockLayout.h  

void DirtyContent ()

 Force dirty the content due to an external change that can't be picked up automatically by this cache. Widgets/Text/SlateTextBlockLayout.h  

void DirtyLayout()

 Force dirty the layout due to an external change that can't be picked up automatically by this cache Widgets/Text/SlateTextBlockLayout.h  

FChildren * GetChildren()

 Get the child widgets of this layout Widgets/Text/SlateTextBlockLayout.h  

FVector2D GetDesiredSize()

 Gets the last computed desired size. Widgets/Text/SlateTextBlockLayout.h  

float GetLayoutScale()

 Get the TextLayout scale. Widgets/Text/SlateTextBlockLayout.h  

int32 OnPaint ( const FPaintArgs& InPaintArgs,
const FGeometry& InAllottedGeometry,
const FSlateRect& InClippingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FWidgetStyle& InWidgetStyle,
bool bParentEnabled
)

 Paint this layout, updating the internal cache as required Widgets/Text/SlateTextBlockLayout.h  

void OverrideTextStyle ( const FTextBlockStyle& InTextStyle
)

 Override the text style used and immediately update the text layout (if required). Widgets/Text/SlateTextBlockLayout.h  

void SetDebugSourceInfo ( const TAttribute< FString >& InDebugSourceInfo
)

 Set the information used to help identify who owns this text layout in the case of an error Widgets/Text/SlateTextBlockLayout.h  

void SetTextFlowDirection ( const TOptional< ETextFlowDirection >& InTextFlowDirection
)

 Set the text flow direction that the internal text layout should use Widgets/Text/SlateTextBlockLayout.h  

void SetTextOverflowPolicy ( const TOptional< ETextOverflowPolicy > InTextOverflowPolicy
)

 Set the text overflow policy that the internal text layout should use Widgets/Text/SlateTextBlockLayout.h  

void SetTextShapingMethod ( const TOptional< ETextShapingMethod >& InTextShapingMethod
)

 Set the text shaping method that the internal text layout should use Widgets/Text/SlateTextBlockLayout.h  

void UpdateTextStyle ( const FTextBlockStyle& InTextStyle
)

 Update the text style. Widgets/Text/SlateTextBlockLayout.h  

void UpdateTextStyle ( const FTextBlockStyle::CompareParams& InNewStyleParams
)

 Update the text style. Widgets/Text/SlateTextBlockLayout.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page