UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Text.cpp File Reference

Macros

#define LOCTEXT_NAMESPACE   "Core.Text"
 
#define DEF_ASNUMBER_CAST(T1, T2)   FText FText::AsNumber(T1 Val, const FNumberFormattingOptions* const Options, const FCulturePtr& TargetCulture) { return FText::AsNumberTemplate<T1, T2>(Val, Options, TargetCulture); }
 
#define DEF_ASNUMBER(T)   DEF_ASNUMBER_CAST(T, T)
 
#define DEF_ASCURRENCY_CAST(T1, T2)   FText FText::AsCurrency(T1 Val, const FString& CurrencyCode, const FNumberFormattingOptions* const Options, const FCulturePtr& TargetCulture) { return FText::AsCurrencyTemplate<T1, T2>(Val, CurrencyCode, Options, TargetCulture); }
 
#define DEF_ASCURRENCY(T)   DEF_ASCURRENCY_CAST(T, T)
 
#define DEF_ASPERCENT_CAST(T1, T2)   FText FText::AsPercent(T1 Val, const FNumberFormattingOptions* const Options, const FCulturePtr& TargetCulture) { return FText::AsPercentTemplate<T1, T2>(Val, Options, TargetCulture); }
 
#define DEF_ASPERCENT(T)   DEF_ASPERCENT_CAST(T, T)
 
#define LOC_DEFINE_REGION
 
#define CONDITIONAL_CREATE_TEXT_HISTORY(HistoryClass)
 
#define LOC_DEFINE_REGION
 
#define LOC_DEFINE_REGION
 
#define ENUM_CASE_FROM_STRING(Enum)   if (FCString::Stricmp(Buffer, TEXT(#Enum)) == 0) { OutValue = ETextGender::Enum; return true; }
 
#define ENUM_CASE_TO_STRING(Enum)   case ETextGender::Enum: return TEXT(#Enum)
 
#define ENUM_CASE_FROM_STRING(Enum)   if (FCString::Stricmp(Buffer, TEXT(#Enum)) == 0) { OutValue = EDateTimeStyle::Enum; return true; }
 
#define ENUM_CASE_TO_STRING(Enum)   case EDateTimeStyle::Enum: return TEXT(#Enum)
 
#define ENUM_CASE_FROM_STRING(Enum)   if (FCString::Stricmp(Buffer, TEXT(#Enum)) == 0) { OutValue = ERoundingMode::Enum; return true; }
 
#define ENUM_CASE_TO_STRING(Enum)   case ERoundingMode::Enum: return TEXT(#Enum)
 

Functions

 DECLARE_LOG_CATEGORY_EXTERN (LogText, Log, All)
 
 DEFINE_LOG_CATEGORY (LogText)
 
void operator<< (FStructuredArchive::FSlot Slot, FNumberFormattingOptions &Value)
 
uint32 GetTypeHash (const FNumberFormattingOptions &Key)
 
FArchiveoperator<< (FArchive &Ar, FNumberParsingOptions &Value)
 
uint32 GetTypeHash (const FNumberParsingOptions &Key)
 
template<typename T >
FText TextJoinImpl (const FText &Delimiter, const TArray< T > &Args)
 
void operator<< (FStructuredArchive::FSlot Slot, FFormatArgumentValue &Value)
 
void operator<< (FStructuredArchive::FSlot Slot, FFormatArgumentData &Value)
 
bool LexTryParseString (ETextGender &OutValue, const TCHAR *Buffer)
 
void LexFromString (ETextGender &OutValue, const TCHAR *Buffer)
 
const TCHARLexToString (ETextGender InValue)
 
bool LexTryParseString (EDateTimeStyle::Type &OutValue, const TCHAR *Buffer)
 
void LexFromString (EDateTimeStyle::Type &OutValue, const TCHAR *Buffer)
 
const TCHARLexToString (EDateTimeStyle::Type InValue)
 
bool LexTryParseString (ERoundingMode &OutValue, const TCHAR *Buffer)
 
void LexFromString (ERoundingMode &OutValue, const TCHAR *Buffer)
 
const TCHARLexToString (ERoundingMode InValue)
 

Macro Definition Documentation

◆ CONDITIONAL_CREATE_TEXT_HISTORY

#define CONDITIONAL_CREATE_TEXT_HISTORY (   HistoryClass)
Value:
if (HistoryClass::StaticShouldReadFromBuffer(Buffer)) \
{ \
return true; \
}
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127

◆ DEF_ASCURRENCY

#define DEF_ASCURRENCY (   T)    DEF_ASCURRENCY_CAST(T, T)

◆ DEF_ASCURRENCY_CAST

#define DEF_ASCURRENCY_CAST (   T1,
  T2 
)    FText FText::AsCurrency(T1 Val, const FString& CurrencyCode, const FNumberFormattingOptions* const Options, const FCulturePtr& TargetCulture) { return FText::AsCurrencyTemplate<T1, T2>(Val, CurrencyCode, Options, TargetCulture); }

Generate an FText that represents the passed number as currency in the current culture

◆ DEF_ASNUMBER

#define DEF_ASNUMBER (   T)    DEF_ASNUMBER_CAST(T, T)

◆ DEF_ASNUMBER_CAST

#define DEF_ASNUMBER_CAST (   T1,
  T2 
)    FText FText::AsNumber(T1 Val, const FNumberFormattingOptions* const Options, const FCulturePtr& TargetCulture) { return FText::AsNumberTemplate<T1, T2>(Val, Options, TargetCulture); }

Generate an FText that represents the passed number in the passed culture

◆ DEF_ASPERCENT

#define DEF_ASPERCENT (   T)    DEF_ASPERCENT_CAST(T, T)

◆ DEF_ASPERCENT_CAST

#define DEF_ASPERCENT_CAST (   T1,
  T2 
)    FText FText::AsPercent(T1 Val, const FNumberFormattingOptions* const Options, const FCulturePtr& TargetCulture) { return FText::AsPercentTemplate<T1, T2>(Val, Options, TargetCulture); }

Generate an FText that represents the passed number as a percentage in the current culture

◆ ENUM_CASE_FROM_STRING [1/3]

#define ENUM_CASE_FROM_STRING (   Enum)    if (FCString::Stricmp(Buffer, TEXT(#Enum)) == 0) { OutValue = ETextGender::Enum; return true; }

◆ ENUM_CASE_FROM_STRING [2/3]

#define ENUM_CASE_FROM_STRING (   Enum)    if (FCString::Stricmp(Buffer, TEXT(#Enum)) == 0) { OutValue = EDateTimeStyle::Enum; return true; }

◆ ENUM_CASE_FROM_STRING [3/3]

#define ENUM_CASE_FROM_STRING (   Enum)    if (FCString::Stricmp(Buffer, TEXT(#Enum)) == 0) { OutValue = ERoundingMode::Enum; return true; }

◆ ENUM_CASE_TO_STRING [1/3]

#define ENUM_CASE_TO_STRING (   Enum)    case ETextGender::Enum: return TEXT(#Enum)

◆ ENUM_CASE_TO_STRING [2/3]

#define ENUM_CASE_TO_STRING (   Enum)    case EDateTimeStyle::Enum: return TEXT(#Enum)

◆ ENUM_CASE_TO_STRING [3/3]

#define ENUM_CASE_TO_STRING (   Enum)    case ERoundingMode::Enum: return TEXT(#Enum)

◆ LOC_DEFINE_REGION [1/3]

#define LOC_DEFINE_REGION

◆ LOC_DEFINE_REGION [2/3]

#define LOC_DEFINE_REGION

◆ LOC_DEFINE_REGION [3/3]

#define LOC_DEFINE_REGION

◆ LOCTEXT_NAMESPACE

#define LOCTEXT_NAMESPACE   "Core.Text"

Function Documentation

◆ DECLARE_LOG_CATEGORY_EXTERN()

DECLARE_LOG_CATEGORY_EXTERN ( LogText  ,
Log  ,
All   
)

◆ DEFINE_LOG_CATEGORY()

DEFINE_LOG_CATEGORY ( LogText  )

◆ GetTypeHash() [1/2]

uint32 GetTypeHash ( const FNumberFormattingOptions Key)

Get the hash code to use for the given formatting options

◆ GetTypeHash() [2/2]

uint32 GetTypeHash ( const FNumberParsingOptions Key)

Get the hash code to use for the given parsing options

◆ LexFromString() [1/3]

void LexFromString ( EDateTimeStyle::Type OutValue,
const TCHAR Buffer 
)

◆ LexFromString() [2/3]

void LexFromString ( ERoundingMode OutValue,
const TCHAR Buffer 
)

◆ LexFromString() [3/3]

void LexFromString ( ETextGender OutValue,
const TCHAR Buffer 
)

◆ LexToString() [1/3]

const TCHAR * LexToString ( EDateTimeStyle::Type  InValue)

◆ LexToString() [2/3]

const TCHAR * LexToString ( ERoundingMode  InValue)

◆ LexToString() [3/3]

const TCHAR * LexToString ( ETextGender  InValue)

◆ LexTryParseString() [1/3]

bool LexTryParseString ( EDateTimeStyle::Type OutValue,
const TCHAR Buffer 
)

◆ LexTryParseString() [2/3]

bool LexTryParseString ( ERoundingMode OutValue,
const TCHAR Buffer 
)

◆ LexTryParseString() [3/3]

bool LexTryParseString ( ETextGender OutValue,
const TCHAR Buffer 
)

◆ operator<<() [1/4]

FArchive & operator<< ( FArchive Ar,
FNumberParsingOptions Value 
)

◆ operator<<() [2/4]

void operator<< ( FStructuredArchive::FSlot  Slot,
FFormatArgumentData Value 
)

◆ operator<<() [3/4]

void operator<< ( FStructuredArchive::FSlot  Slot,
FFormatArgumentValue Value 
)

◆ operator<<() [4/4]

void operator<< ( FStructuredArchive::FSlot  Slot,
FNumberFormattingOptions Value 
)

◆ TextJoinImpl()

template<typename T >
FText TextJoinImpl ( const FText Delimiter,
const TArray< T > &  Args 
)