UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Member Functions | List of all members
FRichInlineImage Class Reference
+ Inheritance diagram for FRichInlineImage:

Public Member Functions

 FRichInlineImage (URichTextBlock *InOwner, URichTextBlockImageDecorator *InDecorator)
 
virtual bool Supports (const FTextRunParseResults &RunParseResult, const FString &Text) const override
 
- Public Member Functions inherited from FRichTextDecorator
UMG_API FRichTextDecorator (URichTextBlock *InOwner)
 
virtual ~FRichTextDecorator ()
 
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 TSharedPtr< SWidget > CreateDecoratorWidget (const FTextRunInfo &RunInfo, const FTextBlockStyle &TextStyle) const override
 
- Protected Member Functions inherited from FRichTextDecorator
virtual UMG_API void CreateDecoratorText (const FTextRunInfo &RunInfo, FTextBlockStyle &InOutTextStyle, FString &InOutString) const
 

Additional Inherited Members

- Protected Attributes inherited from FRichTextDecorator
URichTextBlock * Owner
 

Detailed Description

Add an image inline with the text. Usage: Before image , after image.

A width and height can be specified. By default the width and the height is the same size as the font height. Use "desired" to use the same size as the image brush. Usage: Before image , after image.

A stretch type can be specified. See EStretch. By default the stretch type is ScaleToFit. Usage: Before image , after image.

Constructor & Destructor Documentation

◆ FRichInlineImage()

FRichInlineImage::FRichInlineImage ( URichTextBlock *  InOwner,
URichTextBlockImageDecorator *  InDecorator 
)
inline

Member Function Documentation

◆ CreateDecoratorWidget()

virtual TSharedPtr< SWidget > FRichInlineImage::CreateDecoratorWidget ( const FTextRunInfo &  RunInfo,
const FTextBlockStyle &  DefaultTextStyle 
) const
inlineoverrideprotectedvirtual

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

Reimplemented from FRichTextDecorator.

◆ Supports()

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

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

Reimplemented from FRichTextDecorator.

The documentation for this class was generated from the following file: