1. Epic GamesDeveloper
  3. URichTextBlock

URichTextBlock

The rich text block * Fancy Text * No Children

API > API/Runtime > API/Runtime/UMG

The rich text block

  • Fancy Text
  • No Children
   
Name URichTextBlock
Type class
Header File /Engine/Source/Runtime/UMG/Public/Components/RichTextBlock.h
Include Path #include "Components/RichTextBlock.h"

Syntax

UCLASS (MinimalAPI)  
class URichTextBlock : public UTextLayoutWidget

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

URichTextBlock ( const FObjectInitializer& ObjectInitializer
)

   Components/RichTextBlock.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearAllDefaultStyleOverrides()

 Remove all overrides made to the default text style and return to the style specified in the style set data table Components/RichTextBlock.h
  • BlueprintCallable
  • Category=Appearance

const FTextBlockStyle & GetCurrentDefaultTextStyle()

   Components/RichTextBlock.h  

URichTextBlockDecorator * GetDecoratorByClass ( TSubclassOf< URichTextBlockDecorator > DecoratorClass
)

   Components/RichTextBlock.h
  • BlueprintCallable
  • Category="Widget"

UMaterialInstanceDynamic * GetDefaultDynamicMaterial()

 Creates a dynamic material for the default font or returns it if it already exists Components/RichTextBlock.h
  • BlueprintCallable
  • Category="Appearance"

const FTextBlockStyle & GetDefaultTextStyle()

   Components/RichTextBlock.h  

FText GetText()

 Returns widgets text. Components/RichTextBlock.h
  • BlueprintCallable
  • Category="Widget"

UDataTable * GetTextStyleSet()

   Components/RichTextBlock.h
  • BlueprintCallable
  • Category="Widget"

void RefreshTextLayout()

 Causes the text to reflow it's layout and re-evaluate any decorators Components/RichTextBlock.h
  • BlueprintCallable
  • Category="Widget"

void SetAutoWrapText ( bool InAutoTextWrap
)

 Set the auto wrap for this rich text block Components/RichTextBlock.h
  • BlueprintCallable
  • Category="Appearance"

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

 Replaces the existing decorators with the list provided Components/RichTextBlock.h
  • BlueprintCallable
  • Category="Appearance"

void SetDefaultColorAndOpacity ( FSlateColor InColorAndOpacity
)

 Sets the color and opacity of the default text in this rich text block Components/RichTextBlock.h
  • BlueprintCallable
  • Category="Appearance"

void SetDefaultFont ( FSlateFontInfo InFontInfo
)

 Dynamically set the default font info for this rich text block Components/RichTextBlock.h
  • BlueprintCallable
  • Category="Appearance"

void SetDefaultMaterial ( UMaterialInterface* InMaterial
)

   Components/RichTextBlock.h
  • BlueprintCallable
  • Category=Appearance

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 Components/RichTextBlock.h
  • BlueprintCallable
  • Category="Appearance"

void SetDefaultShadowOffset ( FVector2D InShadowOffset
)

 Sets the offset that the default text drop shadow should be drawn at Components/RichTextBlock.h
  • BlueprintCallable
  • Category="Appearance"

void SetDefaultStrikeBrush ( const FSlateBrush& InStrikeBrush
)

 Dynamically set the default strike brush for this rich text block Components/RichTextBlock.h
  • BlueprintCallable
  • Category="Appearance"

void SetDefaultTextStyle ( const FTextBlockStyle& InDefaultTextStyle
)

 Wholesale override of the currently established default text style Components/RichTextBlock.h
  • BlueprintCallable
  • Category=Appearance

void SetMinDesiredWidth ( float InMinDesiredWidth
)

 Set the minimum desired width for this rich text block Components/RichTextBlock.h
  • BlueprintCallable
  • Category="Appearance"

virtual void SetText ( const FText& InText
)

 Directly sets the widget text. Components/RichTextBlock.h
  • BlueprintCallable
  • Category="Widget"
  • Meta=(AutoCreateRefTerm="InText")

void SetTextOverflowPolicy ( ETextOverflowPolicy InOverflowPolicy
)

 Set the text overflow policy for this text block. Components/RichTextBlock.h
  • BlueprintCallable
  • Category="Appearance"

void SetTextStyleSet ( UDataTable* NewTextStyleSet
)

   Components/RichTextBlock.h
  • BlueprintCallable
  • Category="Widget"

void SetTextTransformPolicy ( ETextTransformPolicy InTransformPolicy
)

 Set the text transformation policy for this text block. Components/RichTextBlock.h
  • BlueprintCallable
  • Category="Appearance"

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

 Gets the palette category of the widget Components/RichTextBlock.h  

virtual void OnCreationFromPalette ()

 Called after constructing a new widget from the palette. Components/RichTextBlock.h  

virtual void SynchronizeProperties ()

 Applies all properties to the native widget if possible. Components/RichTextBlock.h  

virtual void ValidateCompiledDefaults ( IWidgetCompilerLog& CompileLog
) const

 Called at the end of Widget Blueprint compilation. Components/RichTextBlock.h  

Overridden from UVisual

Name Remarks Include Path Unreal Specifiers

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

   Components/RichTextBlock.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void ApplyUpdatedDefaultTextStyle()

   Components/RichTextBlock.h  

void BeginDefaultStyleOverride()

   Components/RichTextBlock.h  

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

   Components/RichTextBlock.h  

virtual TSharedPtr< class IRichTextMarkupParser > CreateMarkupParser()

   Components/RichTextBlock.h  

virtual TSharedPtr< class IRichTextMarkupWriter > CreateMarkupWriter()

   Components/RichTextBlock.h  

const FTextBlockStyle & GetDefaultTextStyleOverride()

   Components/RichTextBlock.h  

float GetMinDesiredWidth()

   Components/RichTextBlock.h  

ETextOverflowPolicy GetOverflowPolicy()

   Components/RichTextBlock.h  

ETextTransformPolicy GetTransformPolicy()

   Components/RichTextBlock.h  

void RebuildStyleInstance()

   Components/RichTextBlock.h  

virtual void UpdateStyleData()

   Components/RichTextBlock.h  

Overridden from UTextLayoutWidget

Name Remarks Include Path Unreal Specifiers

virtual void OnApplyLineHeightToBottomLineChanged ( bool InApplyLineHeightToBottomLine
)

   Components/RichTextBlock.h  

virtual void OnAutoWrapTextChanged ( bool InAutoWrapText
)

   Components/RichTextBlock.h  

virtual void OnJustificationChanged ( ETextJustify::Type InJustification
)

   Components/RichTextBlock.h  

virtual void OnLineHeightPercentageChanged ( float InLineHeightPercentage
)

   Components/RichTextBlock.h  

virtual void OnMarginChanged ( const FMargin& InMargin
)

   Components/RichTextBlock.h  

virtual void OnShapedTextOptionsChanged ( FShapedTextOptions InShapedTextOptions
)

   Components/RichTextBlock.h  

virtual void OnWrappingPolicyChanged ( ETextWrappingPolicy InWrappingPolicy
)

   Components/RichTextBlock.h  

virtual void OnWrapTextAtChanged ( float InWrapTextAt
)

   Components/RichTextBlock.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< SWidget > RebuildWidget()

 Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed. Components/RichTextBlock.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page