1. Epic GamesDeveloper
  3. UTextLayoutWidget

UTextLayoutWidget

Base class for all widgets that use a text layout.

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Components

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Components/TextWidgetTypes.h
Include #include "Components/TextWidgetTypes.h"

Syntax

UCLASS (Abstract, BlueprintType, MinimalAPI)  
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

  Type Name Description
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite setter bool ApplyLineHeightToBottomLine Whether to leave extra space below the last line due to line height.
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite setter uint8: 1 AutoWrapText True if we're wrapping text automatically based on the computed horizontal space for this widget.
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, setter TEnumAsByte< ETextJustify::Type > Justification How the text should be aligned with the margin.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite setter float LineHeightPercentage The amount to scale each lines height by.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite setter FMargin Margin The amount of blank space left around the edges of text area.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite setter FShapedTextOptions ShapedTextOptions Controls how the text within this widget should be shaped.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite setter ETextWrappingPolicy WrappingPolicy The wrapping policy to use.
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite setter 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

  Type Name Description
Public function  

UTextLayoutWidget ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const bool  
Public function Const float  
Protected function Virtual void

OnApplyLineHeightToBottomLineChanged ( bool InApplyLineHeightToBottomLine
)

  
Protected function Virtual void

OnAutoWrapTextChanged ( bool InAutoWrapText
)

  
Protected function Virtual void

OnJustificationChanged ( ETextJustify::Type InJustification
)

  
Protected function Virtual void

OnLineHeightPercentageChanged ( float InLineHeightPercentage
)

  
Protected function Virtual void

OnMarginChanged ( const FMargin& InMargin
)

  
Protected function Virtual void  
Protected function Virtual void

OnWrappingPolicyChanged ( ETextWrappingPolicy InWrappingPolicy
)

  
Protected function Virtual void

OnWrapTextAtChanged ( float InWrapTextAt
)

  
Public function void

SetApplyLineHeightToBottomLine ( bool InApplyLineHeightToBottomLine
)

  
Public function void

SetAutoWrapText ( bool InAutoWrapText
)

  
Public function Virtual UFunction blueprintsetter void

SetJustification ( ETextJustify::Type InJustification
)

  
Public function void

SetLineHeightPercentage ( float InLineHeightPercentage
)

  
Public function void

SetMargin ( const FMargin& InMargin
)

  
Public function void

SetShapedTextOptions ( FShapedTextOptions InShapedTextOptions
)

  
Public function void

SetWrappingPolicy ( ETextWrappingPolicy InWrappingPolicy
)

  
Public function void

SetWrapTextAt ( float InWrapTextAt
)

  
Protected function void

SynchronizeTextLayoutProperties ( TWidgetType& InWidget
)

 Synchronize the properties with the given widget.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page