UArticyRichTextDecorator Class Reference

#include <ArticyRichTextDecorator.h>

Inheritance diagram for UArticyRichTextDecorator:

Public Member Functions
	UArticyRichTextDecorator (const FObjectInitializer &ObjectInitializer)
virtual TSharedPtr< ITextDecorator >	CreateDecorator (URichTextBlock *InOwner) override
void	OnArticyLinkNavigated (URichTextBlock *Parent, const FString Link)
UObject *	GetHyperlinkHandler (URichTextBlock *RichTextBlock)
UArticyObject *	GetLinkDestination (URichTextBlock *Owner, const FString &Link)

Public Attributes
FHyperlinkStyle	HyperlinkStyle

Detailed Description

Decorator for rich text blocks that handles Articy-specific text decoration and hyperlink functionality.

Constructor & Destructor Documentation

UArticyRichTextDecorator()

UArticyRichTextDecorator::UArticyRichTextDecorator

(

const FObjectInitializer &

ObjectInitializer

)

Constructor for the Articy rich text decorator.

Parameters

ObjectInitializer

Object initializer for setting up the decorator.

Member Function Documentation

CreateDecorator()

TSharedPtr< ITextDecorator > UArticyRichTextDecorator::CreateDecorator ( URichTextBlock * InOwner )

overridevirtual

Creates a new text decorator instance for a rich text block.

Parameters

InOwner

The rich text block to decorate.

Returns

A shared pointer to the newly created text decorator.

Creates a new instance of the text decorator for the specified rich text block.

Parameters

InOwner

The rich text block to decorate.

Returns

A shared pointer to the newly created text decorator.

GetHyperlinkHandler()

UObject * UArticyRichTextDecorator::GetHyperlinkHandler

(

URichTextBlock *

RichTextBlock

)

Finds the parent widget that implements the Articy hyperlink handler interface.

Parameters

RichTextBlock

The rich text block to search from.

Returns

The widget implementing the hyperlink handler interface, or nullptr if not found.

GetLinkDestination()

UArticyObject * UArticyRichTextDecorator::GetLinkDestination	(	URichTextBlock *	Owner,
		const FString &	Link )

Resolves a hyperlink URL into an Articy object.

Parameters

Owner	The owning rich text block.
Link	The URL to resolve.

Returns

The Articy object referenced by the URL, or nullptr if not found.

Resolves the link text into an Articy object based on the provided URL.

Parameters

Owner	The owning rich text block.
Link	The URL to resolve.

Returns

The Articy object referenced by the URL, or nullptr if not found.

OnArticyLinkNavigated()

void UArticyRichTextDecorator::OnArticyLinkNavigated	(	URichTextBlock *	Parent,
		const FString	Link )

Callback when a link is navigated.

Parameters

Parent	The parent rich text block.
Link	The link that was navigated to.

Handles the navigation of an Articy link by resolving the link and notifying the hyperlink handler.

Parameters

Parent	The parent rich text block.
Link	The link that was navigated to.

Member Data Documentation

HyperlinkStyle

FHyperlinkStyle UArticyRichTextDecorator::HyperlinkStyle

Hyperlink style

---

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

• Source/ArticyRuntime/Public/ArticyRichTextDecorator.h
• Source/ArticyRuntime/Private/ArticyRichTextDecorator.cpp