1. Epic GamesDeveloper
  3. UTextBlock

UTextBlock

A simple static text widget. * No Children * Text

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (Meta=(DisplayName="Text"), MinimalAPI)  
class UTextBlock : public UTextLayoutWidget

Remarks

A simple static text widget.

  • No Children
  • Text

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly bool bSimpleTextMode If this is enabled, text shaping, wrapping, justification are disabled in favor of much faster text layout and measurement.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly bool bWrapWithInvalidationPanel If true, it will automatically wrap this text widget with an invalidation panel
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter FSlateColor ColorAndOpacity The color of the text
Public variable UProperty FGetSlateColor ColorAndOpacityDelegate A bindable delegate for the ColorAndOpacity.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter FSlateFontInfo Font The font to render the text with
Protected variable FSlateColor K2_Cache_ColorAndOpacity  
Protected variable FLinearColor K2_Cache_ShadowColorAndOpacity  
Protected variable FText K2_Cache_Text  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter float MinDesiredWidth The minimum desired size for the text
Protected variable TSharedPtr< STextBlock > MyTextBlock  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter, getter, setter FLinearColor ShadowColorAndOpacity The color of the shadow
Public variable UProperty FGetLinearColor ShadowColorAndOpacityDelegate A bindable delegate for the ShadowColorAndOpacity.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter FVector2D ShadowOffset The direction the shadow is cast
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter FSlateBrush StrikeBrush The brush to strike through text with
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintgetter, blueprintsetter, getter, setter FText Text The text to display
Public variable UProperty FGetText TextDelegate A bindable delegate to allow logic to drive the text of the widget
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite blueprintsetter, getter, setter ETextOverflowPolicy TextOverflowPolicy Sets what happens to text that is clipped and doesn't fit within the clip rect for this widget
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter, getter, setter ETextTransformPolicy TextTransformPolicy The text transformation policy to apply to this text block.

Constructors

  Type Name Description
Public function  

UTextBlock ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

  
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 UFunction BlueprintCallable, Category UMaterialInstanceDynamic *  
Public function UFunction BlueprintCallable, Category 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 UFunction BlueprintCallable, Category, Meta 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 UFunction BlueprintCallable, Category void

SetAutoWrapText ( bool InAutoTextWrap
)

 Set the auto wrap for this text block.
Public function UFunction BlueprintCallable, Category void

SetColorAndOpacity ( FSlateColor InColorAndOpacity
)

 Sets the color and opacity of the text in this text block
Public function UFunction BlueprintCallable, Category void

SetFont ( FSlateFontInfo InFontInfo
)

 Dynamically set the font info for this text block
Public function UFunction BlueprintCallable, Category void

SetFontMaterial ( UMaterialInterface* InMaterial
)

  
Public function UFunction BlueprintCallable, Category void

SetFontOutlineMaterial ( UMaterialInterface* InMaterial
)

  
Public function UFunction BlueprintCallable, Category void

SetMinDesiredWidth ( float InMinDesiredWidth
)

 Set the minimum desired width for this text block
Public function UFunction BlueprintCallable, Category void

SetOpacity ( float InOpacity
)

 Sets the opacity of the text in this text block
Public function UFunction BlueprintCallable, Category 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 UFunction BlueprintCallable, Category void

SetShadowOffset ( FVector2D InShadowOffset
)

 Sets the offset that the text drop shadow should be drawn at
Public function UFunction BlueprintCallable, Category void

SetStrikeBrush ( FSlateBrush InStrikeBrush
)

 Dynamically set the strike brush for this text block
Public function Virtual UFunction BlueprintCallable, Category, Meta void

SetText ( FText InText
)

 Directly sets the widget text.
Public function UFunction BlueprintCallable, Category void

SetTextOverflowPolicy ( ETextOverflowPolicy InOverflowPolicy
)

 Set the text overflow policy for this text block.
Public function UFunction BlueprintCallable, Category void

SetTextTransformPolicy ( ETextTransformPolicy InTransformPolicy
)

 Set the text transformation policy for this text block.

Overridden from UTextLayoutWidget

  Type Name Description
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
)

  

Overridden from UWidget

  Type Name Description
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
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page