UTextLayoutWidget

Base class for all widgets that use a text layout.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

UMG

Header

/Engine/Source/Runtime/UMG/Public/Components/TextWidgetTypes.h

Include

#include "Components/TextWidgetTypes.h"

Syntax

class UTextLayoutWidget : public UWidget

Remarks

Base class for all widgets that use a text layout. Contains the common options that should be exposed for the underlying Slate widget.

Variables

Name Description

Protected variable

uint8: 1

 

AutoWrapText

True if we're wrapping text automatically based on the computed horizontal space for this widget.

Protected variable

TEnumAsByte< ET...

 

Justification

How the text should be aligned with the margin.

Protected variable

float

 

LineHeightPercentage

The amount to scale each lines height by.

Protected variable

FMargin

 

Margin

The amount of blank space left around the edges of text area.

Protected variable

FShapedTextOpti...

 

ShapedTextOptions

Controls how the text within this widget should be shaped.

Protected variable

ETextWrappingPo...

 

WrappingPolicy

The wrapping policy to use.

Protected variable

float

 

WrapTextAt

Whether text wraps onto a new line when it's length exceeds this width; if this value is zero or negative, no wrapping occurs.

Constructors

Name Description

Public function

UTextLayoutWidget

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

bool

 

GetAutoWrapText()

Public function Const

float

 

GetWrapTextAt()

Public function Virtual

void

 

SetJustification

(
    ETextJustify::Type InJustification
)

Protected function

void

 

SynchronizeTextLayoutProperties

(
    TWidgetType& InWidget
)

Synchronize the properties with the given widget.