FDocumentationToken Class Reference

#include <TokenizedMessage.h>

Inheritance diagram for FDocumentationToken:

Public Member Functions
virtual EMessageToken::Type	GetType () const override
const FString &	GetDocumentationLink () const
const FString &	GetPreviewExcerptLink () const
const FString &	GetPreviewExcerptName () const
	FDocumentationToken (FPrivateToken, const FString &InDocumentationLink, const FString &InPreviewExcerptLink, const FString &InPreviewExcerptName)
Public Member Functions inherited from IMessageToken
virtual	~IMessageToken ()
virtual const FText &	ToText () const
virtual const FOnMessageTokenActivated &	GetOnMessageTokenActivated () const
virtual TSharedRef< IMessageToken >	OnMessageTokenActivated (FOnMessageTokenActivated InMessageTokenActivated)
Public Member Functions inherited from TSharedFromThis< IMessageToken >
TSharedRef< IMessageToken, Mode >	AsShared ()
TSharedRef< IMessageToken const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< IMessageToken, Mode >	AsWeak ()
TWeakPtr< IMessageToken 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< FDocumentationToken >	Create (const FString &InDocumentationLink, const FString &InPreviewExcerptLink=FString(), const FString &InPreviewExcerptName=FString())

Protected Member Functions
	FDocumentationToken (const FString &InDocumentationLink, const FString &InPreviewExcerptLink, const FString &InPreviewExcerptName)
Protected Member Functions inherited from TSharedFromThis< IMessageToken >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()

Additional Inherited Members
Static Protected Member Functions inherited from TSharedFromThis< IMessageToken >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)
Protected Attributes inherited from IMessageToken
FOnMessageTokenActivated	MessageTokenActivated
FText	CachedText

Detailed Description

Basic message token that defaults is activated method to access UDN documentation.

Constructor & Destructor Documentation

FDocumentationToken() [1/2]

FDocumentationToken::FDocumentationToken ( FPrivateToken  , const FString &  InDocumentationLink, const FString &  InPreviewExcerptLink, const FString &  InPreviewExcerptName  )

inline

FDocumentationToken() [2/2]

FDocumentationToken::FDocumentationToken ( const FString &  InDocumentationLink, const FString &  InPreviewExcerptLink, const FString &  InPreviewExcerptName  )

protected

Protected constructor

Member Function Documentation

Create()

TSharedRef< FDocumentationToken > FDocumentationToken::Create ( const FString &  InDocumentationLink, const FString &  InPreviewExcerptLink = FString(), const FString &  InPreviewExcerptName = FString()  )

static

Factory method, tokens can only be constructed as shared refs

GetDocumentationLink()

const FString & FDocumentationToken::GetDocumentationLink ( ) const

inline

End IMessageToken interface Get the documentation link used by this token

GetPreviewExcerptLink()

const FString & FDocumentationToken::GetPreviewExcerptLink ( ) const

inline

Get the documentation excerpt link used by this token

GetPreviewExcerptName()

const FString & FDocumentationToken::GetPreviewExcerptName ( ) const

inline

Get the documentation excerpt name used by this token

GetType()

virtual EMessageToken::Type FDocumentationToken::GetType ( ) const

inlineoverridevirtual

Begin IMessageToken interface

Implements IMessageToken.

---

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