FTextFormatPatternDefinition Class Reference

#include <TextFormatter.h>

Inheritance diagram for FTextFormatPatternDefinition:

Public Member Functions
CORE_API	FTextFormatPatternDefinition ()
CORE_API const FTokenDefinitions &	GetTextFormatDefinitions () const
bool	IsValidEscapeChar (const TCHAR InChar) const
bool	IsLiteralBreakChar (const TCHAR InChar) const
FTextFormatPatternDefinition &	SetEscapeChar (const TCHAR InChar)
FTextFormatPatternDefinition &	SetArgStartChar (const TCHAR InChar)
FTextFormatPatternDefinition &	SetArgEndChar (const TCHAR InChar)
FTextFormatPatternDefinition &	SetArgModChar (const TCHAR InChar)
Public Member Functions inherited from TSharedFromThis< FTextFormatPatternDefinition, ESPMode::ThreadSafe >
TSharedRef< FTextFormatPatternDefinition, Mode >	AsShared ()
TSharedRef< FTextFormatPatternDefinition const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< FTextFormatPatternDefinition, Mode >	AsWeak ()
TWeakPtr< FTextFormatPatternDefinition 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 FTextFormatPatternDefinitionConstRef	GetDefault ()

Public Attributes
TCHAR	EscapeChar = TEXT('`')
TCHAR	ArgStartChar = TEXT('{')
TCHAR	ArgEndChar = TEXT('}')
TCHAR	ArgModChar = TEXT('|')

Additional Inherited Members
Protected Member Functions inherited from TSharedFromThis< FTextFormatPatternDefinition, ESPMode::ThreadSafe >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()
Static Protected Member Functions inherited from TSharedFromThis< FTextFormatPatternDefinition, ESPMode::ThreadSafe >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

Definition of the pattern used during a text format.

Constructor & Destructor Documentation

FTextFormatPatternDefinition()

FTextFormatPatternDefinition::FTextFormatPatternDefinition

(

)

Constructor

Member Function Documentation

GetDefault()

FTextFormatPatternDefinitionConstRef FTextFormatPatternDefinition::GetDefault ( )

static

Singleton access to the default instance

GetTextFormatDefinitions()

const FTokenDefinitions & FTextFormatPatternDefinition::GetTextFormatDefinitions

(

)

const

Get the text format definitions used when formatting text

IsLiteralBreakChar()

bool FTextFormatPatternDefinition::IsLiteralBreakChar ( const TCHAR  InChar ) const

inline

Is the given character one that should cause a literal string token to break parsing?

IsValidEscapeChar()

bool FTextFormatPatternDefinition::IsValidEscapeChar ( const TCHAR  InChar ) const

inline

Is the given character one that an escape token may escape?

SetArgEndChar()

FTextFormatPatternDefinition & FTextFormatPatternDefinition::SetArgEndChar ( const TCHAR  InChar )

inline

SetArgModChar()

FTextFormatPatternDefinition & FTextFormatPatternDefinition::SetArgModChar ( const TCHAR  InChar )

inline

SetArgStartChar()

FTextFormatPatternDefinition & FTextFormatPatternDefinition::SetArgStartChar ( const TCHAR  InChar )

inline

SetEscapeChar()

FTextFormatPatternDefinition & FTextFormatPatternDefinition::SetEscapeChar ( const TCHAR  InChar )

inline

Member Data Documentation

ArgEndChar

TCHAR FTextFormatPatternDefinition::ArgEndChar = TEXT('}')

Character representing the end of a format argument token

ArgModChar

TCHAR FTextFormatPatternDefinition::ArgModChar = TEXT('|')

Character representing the start of a format argument modifier token

ArgStartChar

TCHAR FTextFormatPatternDefinition::ArgStartChar = TEXT('{')

Character representing the start of a format argument token

EscapeChar

TCHAR FTextFormatPatternDefinition::EscapeChar = TEXT('`')

Character representing the start of an escape token

---

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

• Engine/Source/Runtime/Core/Public/Internationalization/TextFormatter.h
• Engine/Source/Runtime/Core/Private/Internationalization/TextFormatter.cpp