FTextFormatString Class Reference

#include <ITextFormatArgumentModifier.h>

Public Member Functions
	FTextFormatString ()
	FTextFormatString (FString InStr)
	FTextFormatString (const TCHAR *InStr)
	FTextFormatString (const FTextFormatString &Other)
	FTextFormatString (FTextFormatString &&Other)
FTextFormatString &	operator= (const FTextFormatString &Other)
FTextFormatString &	operator= (FTextFormatString &&Other)

Static Public Member Functions
static FTextFormatString	MakeReference (const TCHAR *InStr)
static FTextFormatString	MakeReference (const TCHAR *InStr, const int32 InLen)

Public Attributes
const TCHAR *	StringPtr
int32	StringLen

Friends
uint32	GetTypeHash (const FTextFormatString &InStr)

Detailed Description

Type used as a string literal by the text formatter. It is a case sensitive string that can hold onto a string either by pointer (in which case the data being pointed to must outlive this object), or by taking a copy (stored as an FString internally).

Note

The buffer is not guaranteed to be null terminated, so always test the length!

Constructor & Destructor Documentation

FTextFormatString() [1/5]

FTextFormatString::FTextFormatString ( )

inline

Construct an empty string

FTextFormatString() [2/5]

FTextFormatString::FTextFormatString ( FString  InStr )

inline

Construct from the given string (steals the value)

FTextFormatString() [3/5]

FTextFormatString::FTextFormatString ( const TCHAR *  InStr )

inline

Construct from the given string (takes a copy, expected to be null terminated)

FTextFormatString() [4/5]

FTextFormatString::FTextFormatString ( const FTextFormatString &  Other )

inline

FTextFormatString() [5/5]

FTextFormatString::FTextFormatString ( FTextFormatString &&  Other )

inline

Member Function Documentation

MakeReference() [1/2]

static FTextFormatString FTextFormatString::MakeReference ( const TCHAR *  InStr )

inlinestatic

Construct from the given string (takes a reference, expected to be null terminated)

MakeReference() [2/2]

static FTextFormatString FTextFormatString::MakeReference ( const TCHAR *  InStr, const int32  InLen  )

inlinestatic

Construct from the given pointer and size (takes a sub-string reference, doesn't have to be null terminated)

operator=() [1/2]

FTextFormatString & FTextFormatString::operator= ( const FTextFormatString &  Other )

inline

operator=() [2/2]

FTextFormatString & FTextFormatString::operator= ( FTextFormatString &&  Other )

inline

Friends And Related Symbol Documentation

GetTypeHash

uint32 GetTypeHash ( const FTextFormatString &  InStr )

friend

Member Data Documentation

StringLen

int32 FTextFormatString::StringLen

The length of the string

StringPtr

const TCHAR* FTextFormatString::StringPtr

The start of the string

---

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

• Engine/Source/Runtime/Core/Public/Internationalization/ITextFormatArgumentModifier.h