UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TextLayout.h File Reference
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Misc/Attribute.h"
#include "Layout/Margin.h"
#include "Framework/Text/TextRunRenderer.h"
#include "Framework/Text/TextLineHighlight.h"
#include "Framework/Text/IRun.h"
#include "Styling/SlateTypes.h"
#include "TextLayout.generated.h"

Go to the source code of this file.

Classes

struct  FTextLocation
 
class  FTextSelection
 
class  FTextLayout
 
struct  FTextLayout::FBlockDefinition
 
struct  FTextLayout::FBreakCandidate
 
class  FTextLayout::FRunModel
 
struct  FTextLayout::ELineModelDirtyState
 
struct  FTextLayout::FLineModel
 
struct  FTextLayout::FLineViewHighlight
 
struct  FTextLayout::FLineView
 
struct  FTextLayout::FTextOffsetLocations
 
struct  FTextLayout::FNewLineData
 
struct  FTextLayout::ETextLayoutDirtyState
 
struct  FTextLayout::FTextLayoutSize
 

Namespaces

namespace  ETextJustify
 

Macros

#define TEXT_LAYOUT_DEBUG   0
 

Enumerations

enum  ETextJustify::Type : int {
  ETextJustify::Left , ETextJustify::Center , ETextJustify::Right , ETextJustify::InvariantLeft ,
  ETextJustify::InvariantRight
}
 
enum class  ETextWrappingPolicy : uint8 { DefaultWrapping = 0 , AllowPerCharacterWrapping }
 
enum class  ETextFlowDirection : uint8 { Auto = 0 , LeftToRight , RightToLeft , Culture }
 

Functions

SLATE_API ETextFlowDirection GetDefaultTextFlowDirection ()
 

Macro Definition Documentation

◆ TEXT_LAYOUT_DEBUG

#define TEXT_LAYOUT_DEBUG   0

Enumeration Type Documentation

◆ ETextFlowDirection

enum class ETextFlowDirection : uint8
strong

The different directions that text can flow within a paragraph of text.

Note
If you change this enum, make sure and update CVarDefaultTextFlowDirection and GetDefaultTextFlowDirection.
Enumerator
Auto 

Automatically detect the flow direction for each paragraph from its text

LeftToRight 

Force text to be flowed left-to-right

RightToLeft 

Force text to be flowed right-to-left

Culture 

Uses the set culture to determine if text should flow left-to-right or right-to-left. By comparison, Auto will use the text itself to determine it.

◆ ETextWrappingPolicy

enum class ETextWrappingPolicy : uint8
strong

The different methods that can be used if a word is too long to be broken by the default line-break iterator.

Enumerator
DefaultWrapping 

No fallback, just use the given line-break iterator

AllowPerCharacterWrapping 

Fallback to per-character wrapping if a word is too long

Function Documentation

◆ GetDefaultTextFlowDirection()

SLATE_API ETextFlowDirection GetDefaultTextFlowDirection ( )

Get the default text flow direction (from the "Slate.DefaultTextFlowDirection" CVar)