1. Epic GamesDeveloper
  3. UTextBlock

UTextBlock

A simple static text widget. * No Children * Text

Unreal Engine C++ API Reference > Runtime > UMG > Components

Inheritance Hierarchy

References

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

Syntax

class UTextBlock : public UTextLayoutWidget

Remarks

A simple static text widget.

  • No Children
  • Text

Variables

  Type Name Description
Protected variable bool bSimpleTextMode If this is enabled, text shaping, wrapping, justification are disabled in favor of much faster text layout and measurement.
Public variable bool bWrapWithInvalidationPanel If true, it will automatically wrap this text widget with an invalidation panel
Public variable FGetSlateColor ColorAndOpacityDelegate A bindable delegate for the ColorAndOpacity.
Protected variable FSlateColor K2_Cache_ColorAndOpacity  
Protected variable FLinearColor K2_Cache_ShadowColorAndOpacity  
Protected variable FText K2_Cache_Text  
Protected variable TSharedPtr< STextBlock > MyTextBlock  
Public variable FGetLinearColor ShadowColorAndOpacityDelegate A bindable delegate for the ShadowColorAndOpacity.
Public variable FGetText TextDelegate A bindable delegate to allow logic to drive the text of the widget

Constructors

  Type Name Description
Public function  

UTextBlock ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const FSlateColor  
Protected function Virtual TAttribute< FText > Get the text that should be displayed in the internal Slate widget (allows flags to mutate the display text without modifying the persistent designer property data)
Public function UMaterialInstanceDynamic *  
Public function UMaterialInstanceDynamic *  
Public function Const const FSlateFontInfo &

GetFont ()

  
Public function Const float  
Public function Const FLinearColor  
Public function Const FVector2D  
Public function Const const FSlateBrush &  
Public function Const FText

GetText ()

 Gets the widget text
Public function Const ETextOverflowPolicy  
Public function Const ETextTransformPolicy  
Protected function Const EVisibility  
Public function void

HandleTextCommitted ( const FText& InText,
ETextCommit::Type CommitteType
)

  
Protected function FSlateColor  
Protected function FLinearColor  
Protected function FText  
Protected function Virtual void  
Protected function Virtual void  
Public function void

SetAutoWrapText ( bool InAutoTextWrap
)

 Set the auto wrap for this text block.
Public function void

SetColorAndOpacity ( FSlateColor InColorAndOpacity
)

 Sets the color and opacity of the text in this text block
Public function void

SetFont ( FSlateFontInfo InFontInfo
)

 Dynamically set the font info for this text block
Public function void  
Public function void  
Public function void

SetMinDesiredWidth ( float InMinDesiredWidth
)

 Set the minimum desired width for this text block
Public function void

SetOpacity ( float InOpacity
)

 Sets the opacity of the text in this text block
Public function void

SetShadowColorAndOpacity ( FLinearColor InShadowColorAndOpacity
)

 Sets the color and opacity of the text drop shadow Note: if opacity is zero no shadow will be drawn
Public function void

SetShadowOffset ( FVector2D InShadowOffset
)

 Sets the offset that the text drop shadow should be drawn at
Public function void

SetStrikeBrush ( FSlateBrush InStrikeBrush
)

 Dynamically set the strike brush for this text block
Public function Virtual void

SetText ( FText InText
)

 Directly sets the widget text.
Public function void

SetTextOverflowPolicy ( ETextOverflowPolicy InOverflowPolicy
)

 Set the text overflow policy for this text block.
Public function void

SetTextTransformPolicy ( ETextTransformPolicy InTransformPolicy
)

 Set the text transformation policy for this text block.

Overridden from UTextLayoutWidget

  Type Name Description
Public function Virtual void

SetJustification ( ETextJustify::Type InJustification
)

  

Overridden from UWidget

  Type Name Description
Protected function Virtual Const TSharedPtr< SWidget > Gets the widget that accessibility properties should synchronize to.
Public function Virtual Const FString Get Label Metadata, which may be as simple as a bit of string data to help identify an anonymous text block.
Public function Virtual const FText Gets the palette category of the widget
Protected function Virtual void

OnBindingChanged ( const FName& Property
)

  
Public function Virtual void Called after constructing a new widget from the palette.
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Overridden from UObject

  Type Name Description
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.

Deprecated Variables

  Type Name Description
Public variable FSlateColor ColorAndOpacity Direct access to ColorAndOpacity is deprecated. Please use the getter or setter.
Public variable FSlateFontInfo Font Direct access to Font is deprecated. Please use the getter or setter.
Public variable float MinDesiredWidth Direct access to MinDesiredWidth is deprecated. Please use the getter or setter.
Public variable FLinearColor ShadowColorAndOpacity Direct access to ShadowColorAndOpacity is deprecated. Please use the getter or setter.
Public variable FVector2D ShadowOffset Direct access to ShadowOffset is deprecated. Please use the getter or setter.
Public variable FSlateBrush StrikeBrush Direct access to StrikeBrush is deprecated. Please use the getter or setter.
Public variable FText Text Direct access to Text is deprecated. Please use the getter or setter.
Public variable ETextOverflowPolicy TextOverflowPolicy Direct access to TextOverflowPolicy is deprecated. Please use the getter or setter.
Public variable ETextTransformPolicy TextTransformPolicy Direct access to TextTransformPolicy is deprecated. Please use the getter or setter.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page