1. Epic GamesDeveloper
  3. URichTextBlock

URichTextBlock

The rich text block * Fancy Text * No Children

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (MinimalAPI)  
class URichTextBlock : public UTextLayoutWidget

Remarks

The rich text block

  • Fancy Text
  • No Children

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere bool bOverrideDefaultStyle True to specify the default text style for this rich text inline, overriding any default provided in the style set table
Protected variable UProperty Category, EditAnywhere TArray< TSubclassOf< URichTextBlockDecorator > > DecoratorClasses  
Protected variable UProperty Transient FTextBlockStyle DefaultTextStyle  
Protected variable UProperty Category, EditAnywhere, Meta blueprintsetter, getter, setter FTextBlockStyle DefaultTextStyleOverride Text style to apply by default to text in this block
Protected variable UProperty Transient TArray< TObjectPtr< URichTextBlockDecorator > > InstanceDecorators  
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter float MinDesiredWidth The minimum desired size for the text
Protected variable TSharedPtr< SRichTextBlock > MyRichTextBlock  
Protected variable UProperty Transient TSharedPtr< class FSlateStyleSet > StyleInstance  
Protected variable UProperty Category, EditAnywhere, Meta blueprintgetter, blueprintsetter, getter, setter FText Text The text to display
Protected 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
Protected variable UProperty Category, EditAnywhere, Meta blueprintgetter, blueprintsetter, getter, setter TObjectPtr< UDataTable > TextStyleSet  
Protected 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  

URichTextBlock ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function Virtual void  
Protected function void  
Public function UFunction BlueprintCallable, Category void Remove all overrides made to the default text style and return to the style specified in the style set data table
Protected function Virtual void

CreateDecorators ( TArray< TSharedRef< class ITextDecorator > >& OutDecorators
)

  
Protected function Virtual TSharedPtr< class IRichTextMarkupParser >  
Protected function Virtual TSharedPtr< class IRichTextMarkupWriter >  
Public function Const const FTextBlockStyle &  
Public function UFunction BlueprintCallable, Category URichTextBlockDecorator *

GetDecoratorByClass ( TSubclassOf< URichTextBlockDecorator > DecoratorClass
)

  
Public function UFunction BlueprintCallable, Category UMaterialInstanceDynamic * Creates a dynamic material for the default font or returns it if it already exists
Public function Const const FTextBlockStyle &  
Protected function Const const FTextBlockStyle &  
Protected function Const float  
Protected function Const ETextOverflowPolicy  
Public function Const UFunction BlueprintCallable, Category FText

GetText ()

 Returns widgets text.
Public function Const UFunction BlueprintCallable, Category UDataTable *  
Protected function Const ETextTransformPolicy  
Protected function void  
Public function UFunction BlueprintCallable, Category void Causes the text to reflow it's layout and re-evaluate any decorators
Public function UFunction BlueprintCallable, Category void

SetAutoWrapText ( bool InAutoTextWrap
)

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

SetDecorators ( const TArray< TSubclassOf< URichTextBlockDecorator > >& InDecoratorClasses
)

 Replaces the existing decorators with the list provided
Public function UFunction BlueprintCallable, Category void

SetDefaultColorAndOpacity ( FSlateColor InColorAndOpacity
)

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

SetDefaultFont ( FSlateFontInfo InFontInfo
)

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

SetDefaultMaterial ( UMaterialInterface* InMaterial
)

  
Public function UFunction BlueprintCallable, Category void

SetDefaultShadowColorAndOpacity ( FLinearColor InShadowColorAndOpacity
)

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

SetDefaultShadowOffset ( FVector2D InShadowOffset
)

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

SetDefaultStrikeBrush ( const FSlateBrush& InStrikeBrush
)

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

SetDefaultTextStyle ( const FTextBlockStyle& InDefaultTextStyle
)

 Wholesale override of the currently established default text style
Public function UFunction BlueprintCallable, Category void

SetMinDesiredWidth ( float InMinDesiredWidth
)

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

SetText ( const 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

SetTextStyleSet ( UDataTable* NewTextStyleSet
)

  
Public function UFunction BlueprintCallable, Category void

SetTextTransformPolicy ( ETextTransformPolicy InTransformPolicy
)

 Set the text transformation policy for this text block.
Protected function Virtual void  

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 FText Gets the palette category of the widget
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.
Public function Virtual Const void Called at the end of Widget Blueprint compilation.

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