1. Epic GamesDeveloper
  3. FSlateTextBlockLayout

FSlateTextBlockLayout

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

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Widgets > API/Runtime/Slate/Widgets/Text

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

  Type Name Description
Public function  

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

 Constructor

Functions

  Type Name Description
Public function Const void

ArrangeChildren ( const FGeometry& AllottedGeometry,
FArrangedChildren& ArrangedChildren
)

 Arrange any child widgets in this layout
Public function 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
Public function FVector2D

ComputeDesiredSize ( const FWidgetDesiredSizeArgs& InWidgetArgs,
const float InScale
)

 Get the computed desired size for this layout, updating the internal cache as required
Public function void Conditionally update the text style if needed
Public function void Conditionally update the text style if needed
Public function void Force dirty the content due to an external change that can't be picked up automatically by this cache.
Public function void Force dirty the layout due to an external change that can't be picked up automatically by this cache
Public function FChildren * Get the child widgets of this layout
Public function Const FVector2D Gets the last computed desired size.
Public function Const float Get the TextLayout scale.
Public function 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
Public function void

OverrideTextStyle ( const FTextBlockStyle& InTextStyle
)

 Override the text style used and immediately update the text layout (if required).
Public function void

SetDebugSourceInfo ( const TAttribute< FString >& InDebugSourceInfo
)

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

SetTextFlowDirection ( const TOptional< ETextFlowDirection >& InTextFlowDirection
)

 Set the text flow direction that the internal text layout should use
Public function void

SetTextOverflowPolicy ( const TOptional< ETextOverflowPolicy > InTextOverflowPolicy
)

 Set the text overflow policy that the internal text layout should use
Public function void

SetTextShapingMethod ( const TOptional< ETextShapingMethod >& InTextShapingMethod
)

 Set the text shaping method that the internal text layout should use

Classes

  Type Name Description
Public struct FWidgetArgs    
Public struct FWidgetDesiredSizeArgs    

Deprecated Functions

  Type Name Description
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGSFVector2D

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

 FWidgetArgs is deprecated. Upgrade to FWidgetDesiredSizeArgs instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page