#include <TokenizedMessage.h>

Inheritance diagram for FTokenizedMessage:

Public Member Functions
CORE_API TSharedRef< FTokenizedMessage >	Clone () const

CORE_API FText	ToText () const

CORE_API TSharedRef< FTokenizedMessage >	AddToken (const TSharedRef< IMessageToken > &InToken)

CORE_API TSharedRef< FTokenizedMessage >	AddText (const FText &InText)

template<typename... TArguments>
TSharedRef< FTokenizedMessage >	AddText (FTextFormat InTextFormat, TArguments &&... InArgs)

CORE_API void	SetSeverity (const EMessageSeverity::Type InSeverity)

CORE_API EMessageSeverity::Type	GetSeverity () const

CORE_API const TArray< TSharedRef< IMessageToken > > &	GetMessageTokens () const

CORE_API void	SetMessageLink (const TSharedRef< IMessageToken > &InToken)

CORE_API TSharedPtr< IMessageToken >	GetMessageLink () const

CORE_API FName	GetIdentifier () const

CORE_API void	SetIdentifier (FName InIdentifier)

	FTokenizedMessage (FPrivateToken)

Public Member Functions inherited from TSharedFromThis< FTokenizedMessage >
TSharedRef< FTokenizedMessage, Mode >	AsShared ()

TSharedRef< FTokenizedMessage const, Mode >	AsShared () const

TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const

TWeakPtr< FTokenizedMessage, Mode >	AsWeak ()

TWeakPtr< FTokenizedMessage const, Mode >	AsWeak () const

TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const

void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const InSharedPtr, OtherType InObject) const

void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const InSharedRef, OtherType InObject) const

UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Static Public Member Functions
static CORE_API TSharedRef< FTokenizedMessage >	Create (EMessageSeverity::Type InSeverity, const FText &InMessageText=FText())

static CORE_API FText	GetSeverityText (EMessageSeverity::Type InSeverity)

static CORE_API FName	GetSeverityIconName (EMessageSeverity::Type InSeverity)

Protected Attributes
TArray< TSharedRef< IMessageToken > >	MessageTokens

TSharedPtr< IMessageToken >	MessageLink

Additional Inherited Members
Protected Member Functions inherited from TSharedFromThis< FTokenizedMessage >
	TSharedFromThis ()

	TSharedFromThis (TSharedFromThis const &)

UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)

	~TSharedFromThis ()

Static Protected Member Functions inherited from TSharedFromThis< FTokenizedMessage >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)

static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

This class represents a rich tokenized message, such as would be used for compiler output with 'hyperlinks' to source file locations

Constructor & Destructor Documentation

◆ FTokenizedMessage()

FTokenizedMessage::FTokenizedMessage ( FPrivateToken )

inlineexplicit

Private constructor - we want to only create these structures as shared references via Create()

Member Function Documentation

◆ AddText() [1/2]

TSharedRef< FTokenizedMessage > FTokenizedMessage::AddText ( const FText & InText )

Adds a text token to a message.

Parameters

InMessage	The message to insert a token into
InText	The text to insert as a token

Returns: this message, for chaining calls.

◆ AddText() [2/2]

template<typename... TArguments>

TSharedRef< FTokenizedMessage > FTokenizedMessage::AddText	(	FTextFormat	InTextFormat,
		TArguments &&...	InArgs
	)

inline

Adds a text token to a message as by calling FText::FormatOrdered

Parameters

InMessage	The message to insert a token into
InText	The text to insert as a token

Returns: this message, for chaining calls.

◆ AddToken()

TSharedRef< FTokenizedMessage > FTokenizedMessage::AddToken ( const TSharedRef< IMessageToken > & InToken )

Adds a token to a message.

Parameters

InMessage	The message to insert a token into
InToken	The token to insert

Returns: this message, for chaining calls.

◆ Clone()

TSharedRef< FTokenizedMessage > FTokenizedMessage::Clone ( ) const

Clone this message.

Note: The message tokens are shared between the original and the clone.

◆ Create()

TSharedRef< FTokenizedMessage > FTokenizedMessage::Create	(	EMessageSeverity::Type	InSeverity,
		const FText &	InMessageText = `FText()`
	)

static

Creates a new FTokenizedMessage

Parameters

InSeverity	The severity of the message.
InMessageString	The string to display for this message. If this is not empty, then a string token will be added to this message.

Returns: the generated message for temporary storage or so other tokens can be added to it if required.

◆ GetIdentifier()

FName FTokenizedMessage::GetIdentifier ( ) const

Returns: Identifier for the message, if set, else NAME_None

◆ GetMessageLink()

TSharedPtr< IMessageToken > FTokenizedMessage::GetMessageLink ( ) const

Gets the token action associated with this messages as a whole. Should link to an associated element.

Returns: A token action that was set via SetMessageLink().

◆ GetMessageTokens()

const TArray< TSharedRef< IMessageToken > > & FTokenizedMessage::GetMessageTokens ( ) const

Get the tokens in this message

Returns: an array of tokens

◆ GetSeverity()

EMessageSeverity::Type FTokenizedMessage::GetSeverity ( ) const

Gets the severity of this message

Returns: the severity of this message

◆ GetSeverityIconName()

FName FTokenizedMessage::GetSeverityIconName ( EMessageSeverity::Type InSeverity )

static

Helper function for getting a severity as an icon name

Parameters

InSeverity the severity to use

Returns: the name of the icon for the severity

◆ GetSeverityText()

FText FTokenizedMessage::GetSeverityText ( EMessageSeverity::Type InSeverity )

static

Helper function for getting a severity as text

Parameters

InSeverity the severity to use

Returns: a string representation of the severity

◆ SetIdentifier()

void FTokenizedMessage::SetIdentifier ( FName InIdentifier )

Assigns Identifier for the message to the provided name

◆ SetMessageLink()

void FTokenizedMessage::SetMessageLink ( const TSharedRef< IMessageToken > & InToken )

Sets up a token action for the message as a whole (not to be displayed... intended to be invoked from a double click).

Parameters

InToken A token for the entire message to link to.

◆ SetSeverity()

void FTokenizedMessage::SetSeverity ( const EMessageSeverity::Type InSeverity )

Sets the severity of this message

Parameters

InSeverity The severity to set this message to

◆ ToText()

FText FTokenizedMessage::ToText ( ) const

Get this tokenized message as a string

Returns: a string representation of this message

Member Data Documentation

◆ MessageLink

TSharedPtr<IMessageToken> FTokenizedMessage::MessageLink

protected

A token associated with the entire message (doesn't display)

◆ MessageTokens

TArray< TSharedRef<IMessageToken> > FTokenizedMessage::MessageTokens

protected

the array of message tokens this message contains

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

Engine/Source/Runtime/Core/Public/Logging/TokenizedMessage.h
Engine/Source/Runtime/Core/Private/Logging/TokenizedMessage.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FTokenizedMessage()

Member Function Documentation

◆ AddText() [1/2]

◆ AddText() [2/2]

◆ AddToken()

◆ Clone()

◆ Create()

◆ GetIdentifier()

◆ GetMessageLink()

◆ GetMessageTokens()

◆ GetSeverity()

◆ GetSeverityIconName()

◆ GetSeverityText()

◆ SetIdentifier()

◆ SetMessageLink()

◆ SetSeverity()

◆ ToText()

Member Data Documentation

◆ MessageLink

◆ MessageTokens