URichTextBlock

The rich text block * Fancy Text * No Children

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

UMG

Header

/Engine/Source/Runtime/UMG/Public/Components/RichTextBlock.h

Include

#include "Components/RichTextBlock.h"

Syntax

class URichTextBlock : public UTextLayoutWidget

Remarks

The rich text block

  • Fancy Text

  • No Children

Variables

Name Description

Protected variable

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

TArray< TSubcla...

 

DecoratorClasses

Protected variable

FTextBlockStyle

 

DefaultTextStyle

Protected variable

FTextBlockStyle

 

DefaultTextStyleOverride

Text style to apply by default to text in this block

Protected variable

TArray< URichTe...

 

InstanceDecorators

Protected variable

float

 

MinDesiredWidth

The minimum desired size for the text

Protected variable

TSharedPtr< SRi...

 

MyRichTextBlock

Protected variable

TSharedPtr< cla...

 

StyleInstance

Protected variable

FText

 

Text

The text to display

Protected variable

UDataTable *...

 

TextStyleSet

Constructors

Name Description

Public function

URichTextBlock

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Protected function

void

 

ApplyUpdatedDefaultTextStyle()

Protected function

void

 

BeginDefaultStyleOverride()

Public function

void

 

ClearAllDefaultStyleOverrides()

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 ITextDeco...
)

Protected function Virtual

TSharedPtr< ...

 

CreateMarkupParser()

Protected function Virtual

TSharedPtr< ...

 

CreateMarkupWriter()

Public function Const

const FTextB...

 

GetCurrentDefaultTextStyle()

Public function

URichTextBlo...

 

GetDecoratorByClass

Public function Const

const FTextB...

 

GetDefaultTextStyle()

Public function Const

FText

 

GetText()

Returns widgets text.

Protected function

void

 

RebuildStyleInstance()

Public function

void

 

SetAutoWrapText

(
    bool InAutoTextWrap
)

Set the auto wrap for this rich text block

Public function

void

 

SetDefaultColorAndOpacity

(
    FSlateColor InColorAndOpacity
)

Sets the color and opacity of the default text in this rich text block

Public function

void

 

SetDefaultFont

(
    FSlateFontInfo InFontInfo
)

Dynamically set the default font info for this rich text block

Public function

void

 

SetDefaultShadowColorAndOpacity

(
    FLinearColor InShadowColorAndOpacit...
)

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

Public function

void

 

SetDefaultShadowOffset

(
    FVector2D InShadowOffset
)

Sets the offset that the default text drop shadow should be drawn at

Public function

void

 

SetDefaultStrikeBrush

(
    FSlateBrush& InStrikeBrush
)

Dynamically set the default strike brush for this rich text block

Public function

void

 

SetDefaultTextStyle

(
    const FTextBlockStyle& InDefaultTe...
)

Wholesale override of the currently established default text style

Public function

void

 

SetJustification

(
    ETextJustify::Type InJustification
)

Set the text justification for this rich text block

Public function

void

 

SetMinDesiredWidth

(
    float InMinDesiredWidth
)

Set the minimum desired width for this rich text block

Public function Virtual

void

 

SetText

(
    const FText& InText
)

Directly sets the widget text.

Public function

void

 

SetTextStyleSet

(
    UDataTable* NewTextStyleSet
)

Protected function Virtual

void

 

UpdateStyleData()

Overridden from UWidget

Name Description

Public function Virtual

const FText

 

GetPaletteCategory()

Gets the palette category of the widget

Public function Virtual

void

 

OnCreationFromPalette()

Called by the palette after constructing a new widget, allows the widget to perform interesting default setup that we don't want to be UObject Defaults.

Protected function Virtual

TSharedRef< ...

 

RebuildWidget()

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

Public function Virtual

void

 

SynchronizeProperties()

Applies all properties to the native widget if possible.

Public function Virtual Const

void

 

ValidateCompiledDefaults

(
    IWidgetCompilerLog& CompileLog
)

Called at the end of Widget Blueprint compilation.

Overridden from UVisual

Name Description

Public function Virtual

void

 

ReleaseSlateResources

(
    bool bReleaseChildren
)

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback