UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FRichTextDecorator Class Reference

#include <RichTextBlockDecorator.h>

+ Inheritance diagram for FRichTextDecorator:

Public Member Functions

UMG_API FRichTextDecorator (URichTextBlock *InOwner)
 
virtual ~FRichTextDecorator ()
 
virtual bool Supports (const FTextRunParseResults &RunParseResult, const FString &Text) const override
 
virtual UMG_API TSharedRef< ISlateRun > Create (const TSharedRef< class FTextLayout > &TextLayout, const FTextRunParseResults &RunParseResult, const FString &OriginalText, const TSharedRef< FString > &InOutModelText, const ISlateStyle *Style) override final
 

Protected Member Functions

virtual UMG_API TSharedPtr< SWidget > CreateDecoratorWidget (const FTextRunInfo &RunInfo, const FTextBlockStyle &DefaultTextStyle) const
 
virtual UMG_API void CreateDecoratorText (const FTextRunInfo &RunInfo, FTextBlockStyle &InOutTextStyle, FString &InOutString) const
 

Protected Attributes

URichTextBlock * Owner
 

Constructor & Destructor Documentation

◆ FRichTextDecorator()

FRichTextDecorator::FRichTextDecorator ( URichTextBlock *  InOwner)

◆ ~FRichTextDecorator()

virtual FRichTextDecorator::~FRichTextDecorator ( )
inlinevirtual

Member Function Documentation

◆ Create()

TSharedRef< ISlateRun > FRichTextDecorator::Create ( const TSharedRef< class FTextLayout > &  TextLayout,
const FTextRunParseResults &  RunParseResult,
const FString &  OriginalText,
const TSharedRef< FString > &  InOutModelText,
const ISlateStyle *  Style 
)
finaloverridevirtual

◆ CreateDecoratorText()

void FRichTextDecorator::CreateDecoratorText ( const FTextRunInfo &  RunInfo,
FTextBlockStyle &  InOutTextStyle,
FString &  InOutString 
) const
protectedvirtual

Override this function if you want to dynamically generate text, optionally changing the style. InOutString will start as the content between tags

◆ CreateDecoratorWidget()

TSharedPtr< SWidget > FRichTextDecorator::CreateDecoratorWidget ( const FTextRunInfo &  RunInfo,
const FTextBlockStyle &  DefaultTextStyle 
) const
protectedvirtual

Override this function if you want to create a unique widget like an image

Reimplemented in FRichInlineImage.

◆ Supports()

virtual bool FRichTextDecorator::Supports ( const FTextRunParseResults &  RunParseResult,
const FString &  Text 
) const
inlineoverridevirtual

Override this function to specify which types of tags are handled by this decorator

Reimplemented in FRichInlineImage.

Member Data Documentation

◆ Owner

URichTextBlock* FRichTextDecorator::Owner
protected
The documentation for this class was generated from the following files: