1. Epic GamesDeveloper
  3. FText

FText

API > API/Runtime > API/Runtime/Core

   
Name FText
Type class
Header File /Engine/Source/Runtime/Core/Public/Internationalization/Text.h
Include Path #include "Internationalization/Text.h"

Syntax

class FText

Constructors

Name Remarks Include Path Unreal Specifiers

FText ()

   Internationalization/Text.h  
  Internationalization/Text.h  

FText ( TRefCountPtr< HistoryType >&& InTextData
)

 End - intrusive TOptional state //. Internationalization/Text.h  

FText ( FString&& InSourceString
)

   Internationalization/Text.h  

FText ( FString&& InSourceString,
const FTextKey& InNamespace,
const FTextKey& InKey,
uint32 InFlags
)

   Internationalization/Text.h  

FText ( FName InTableId,
const FTextKey& InKey,
const EStringTableLoadingPolicy InLoadingPolicy
)

   Internationalization/Text.h  

FText ( const FText&
)

   Internationalization/Text.h  

FText ( FText&& Other
)

   Internationalization/Text.h  

Classes

Name Remarks
FSortPredicate  

Typedefs

Name Type Remarks Include Path
FCreateTextGeneratorDelegate TBaseDelegate_OneParam< TSharedRef< ITextGenerator >, FStructuredArchive::FRecord >   Internationalization/Text.h
IntrusiveUnsetOptionalStateType FText   Internationalization/Text.h

Constants

Name Type Remarks Include Path
bHasIntrusiveUnsetOptionalState bool Start - intrusive TOptional state //. Internationalization/Text.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Flags uint32 Flags with various information on what sort of FText this is Internationalization/Text.h  
TextData TRefCountPtr< ITextData > The internal shared data for this FText Internationalization/Text.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FString BuildSourceString()

 Deep build of the source string for this FText, climbing the history hierarchy Internationalization/Text.h  

int32 CompareTo ( const FText& Other,
const ETextComparisonLevel::Type ComparisonLevel
) const

   Internationalization/Text.h  

int32 CompareToCaseIgnored ( const FText& Other
) const

   Internationalization/Text.h  

bool EqualTo ( const FText& Other,
const ETextComparisonLevel::Type ComparisonLevel
) const

   Internationalization/Text.h  

bool EqualToCaseIgnored ( const FText& Other
) const

   Internationalization/Text.h  

bool IdenticalTo ( const FText& Other,
const ETextIdenticalModeFlags CompareModeFlags
) const

 Check to see if this FText is identical to the other FText Internationalization/Text.h  

bool IsCultureInvariant()

   Internationalization/Text.h  

bool IsEmpty()

   Internationalization/Text.h  

bool IsEmptyOrWhitespace()

   Internationalization/Text.h  

bool IsFromStringTable()

   Internationalization/Text.h  

bool IsInitializedFromString()

   Internationalization/Text.h  

bool IsNumeric()

   Internationalization/Text.h  

bool IsTransient()

   Internationalization/Text.h  

bool ShouldGatherForLocalization()

   Internationalization/Text.h  
Transforms the text to lowercase in a culture correct way. Internationalization/Text.h  

const FString & ToString()

   Internationalization/Text.h  
Transforms the text to uppercase in a culture correct way. Internationalization/Text.h  

Static

Name Remarks Include Path Unreal Specifiers

static FText AsCultureInvariant ( const ANSICHAR* String
)

 Generate a culture invariant FText representing the passed in string Internationalization/Text.h  

static FText AsCultureInvariant ( const WIDECHAR* String
)

   Internationalization/Text.h  

static FText AsCultureInvariant ( FAnsiStringView String
)

   Internationalization/Text.h  

static FText AsCultureInvariant ( FUtf8StringView String
)

   Internationalization/Text.h  

static FText AsCultureInvariant ( FWideStringView String
)

   Internationalization/Text.h  

static FText AsCultureInvariant ( FString&& String
)

   Internationalization/Text.h  

static FText AsCultureInvariant ( FText Text
)

 Generate a culture invariant FText representing the passed in FText Internationalization/Text.h  

static FText AsCultureInvariant ( const UTF8CHAR* String
)

   Internationalization/Text.h  

static FText AsCurrency ( float Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsCurrency ( double Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsCurrency ( int32 Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsCurrency ( int64 Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsCurrency ( uint8 Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsCurrency ( uint16 Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsCurrency ( uint32 Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsCurrency ( uint64 Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsCurrency ( long Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsCurrency ( int8 Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsCurrency ( int16 Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsCurrencyBase ( int64 BaseVal,
const FString& CurrencyCode,
const FCulturePtr& TargetCulture,
int32 ForceDecimalPlaces
)

 Generate an FText that represents the passed number as currency in the current culture. Internationalization/Text.h  

static FText AsCurrencyTemplate ( T1 Val,
const FString& CurrencyCode,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsDate ( const FDateTime& DateTime,
const EDateTimeStyle::Type DateStyle,
const FString& TimeZone,
const FCulturePtr& TargetCulture
)

 Generate an FText that represents the given timestamp as a date/time in the current culture using the given timezone (default is the local timezone). Internationalization/Text.h  

static FText AsDateTime ( const FDateTime& DateTime,
const FString& CustomPattern,
const FString& TimeZone,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsDateTime ( const FDateTime& DateTime,
const EDateTimeStyle::Type DateStyle,
const EDateTimeStyle::Type TimeStyle,
const FString& TimeZone,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsLocalizable_Advanced ( const FTextKey& Namespace,
const FTextKey& Key,
const TCHAR* String
)

 === !! This is an ADVANCED function. Internationalization/Text.h  

static FText AsLocalizable_Advanced ( const FTextKey& Namespace,
const FTextKey& Key,
FStringView String
)

   Internationalization/Text.h  

static FText AsLocalizable_Advanced ( const FTextKey& Namespace,
const FTextKey& Key,
FString&& String
)

   Internationalization/Text.h  

static FText AsMemory ( uint64 NumBytes,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture,
EMemoryUnitStandard UnitStandard
)

 Generate an FText that represents the passed number as a memory size in the current culture Internationalization/Text.h  

static FText AsMemory ( uint64 NumBytes,
EMemoryUnitStandard UnitStandard
)

 Generate an FText that represents the passed number as a memory size in the current culture Internationalization/Text.h  

static FText AsNumber ( int16 Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsNumber ( long Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsNumber ( uint64 Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsNumber ( uint32 Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsNumber ( uint16 Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsNumber ( uint8 Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsNumber ( int64 Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsNumber ( int32 Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsNumber ( int8 Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsNumber ( double Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsNumber ( float Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 Generate an FText that represents the passed number in the current culture Internationalization/Text.h  

static FText AsNumberTemplate ( T1 Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsPercent ( float Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

 Generate an FText that represents the passed number as a percentage in the current culture Internationalization/Text.h  

static FText AsPercent ( double Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsPercentTemplate ( T1 Val,
const FNumberFormattingOptions*const Options,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsTime ( const FDateTime& DateTime,
const EDateTimeStyle::Type TimeStyle,
const FString& TimeZone,
const FCulturePtr& TargetCulture
)

   Internationalization/Text.h  

static FText AsTimespan ( const FTimespan& Timespan,
const FCulturePtr& TargetCulture
)

 Generate an FText that represents the given timespan in the current culture, as a delta-time representation (eg, {Hours}:{Minutes}:{Seconds} or {Minutes}:{Seconds}). Internationalization/Text.h  

static void AutoRTFMAssignFromOpenToClosed ( FText& Closed,
const FText& Open
)

 Safely copies an FText from the open to a closed transaction. Internationalization/Text.h  

static FText ChangeKey ( const FTextKey& Namespace,
const FTextKey& Key,
const FText& Text
)

 Constructs a new FText with the SourceString of the specified text but with the specified namespace and key Internationalization/Text.h  

static TSharedRef< ITextGenerator > CreateTextGenerator ( FStructuredArchive::FRecord Record
)

   Internationalization/Text.h  

static FCreateTextGeneratorDelegate FindRegisteredTextGenerator ( FName TypeID
)

 Returns the text generator factory function registered under the specified name, if any. Internationalization/Text.h  

static bool FindText ( const FTextKey& Namespace,
const FTextKey& Key,
FText& OutText,
const FString*const SourceString
)

   Internationalization/Text.h  

static bool FindTextInLiveTable_Advanced ( const FTextKey& Namespace,
const FTextKey& Key,
FText& OutText,
const FString*const SourceString
)

 === !! This is an ADVANCED function. Internationalization/Text.h  

static FText Format ( FTextFormat Fmt,
FFormatOrderedArguments&& InArguments
)

   Internationalization/Text.h  

static FText Format ( FTextFormat Fmt,
const FFormatNamedArguments& InArguments
)

 Format the given map of key->value pairs as named arguments within the given format pattern Internationalization/Text.h  

static FText Format ( FTextFormat Fmt,
ArgTypes... Args
)

 Format the given list of variadic values as ordered arguments within the given format pattern Internationalization/Text.h  

static FText Format ( FTextFormat Fmt,
FFormatNamedArguments&& InArguments
)

   Internationalization/Text.h  

static FText Format ( FTextFormat Fmt,
const FFormatOrderedArguments& InArguments
)

 Format the given list values as ordered arguments within the given format pattern Internationalization/Text.h  

static FText FormatNamed ( FTextFormat Fmt,
TArguments&&... Args
)

 Format the given list of variadic key->value pairs as named arguments within the given format pattern Internationalization/Text.h  

static FText FormatNamedImpl ( FTextFormat&& Fmt,
FFormatNamedArguments&& InArguments
)

   Internationalization/Text.h  

static FText FormatOrdered ( FTextFormat Fmt,
TArguments&&... Args
)

 Format the given list of variadic values as ordered arguments within the given format pattern Internationalization/Text.h  

static FText FormatOrderedImpl ( FTextFormat&& Fmt,
FFormatOrderedArguments&& InArguments
)

   Internationalization/Text.h  

static FText FromName ( const FName& Val
)

 Generate an FText representing the pass name Internationalization/Text.h  

static FText FromString ( const FUtf8String& String
)

   Internationalization/Text.h  

static FText FromString ( FString&& String
)

   Internationalization/Text.h  

static FText FromString ( const FString& String
)

   Internationalization/Text.h  

static FText FromString ( const FAnsiString& String
)

   Internationalization/Text.h  

static FText FromString ( const WIDECHAR* String
)

   Internationalization/Text.h  

static FText FromString ( const UTF8CHAR* String
)

   Internationalization/Text.h  

static FText FromString ( const ANSICHAR* String
)

 Generate an FText representing the passed in string Internationalization/Text.h  

static FText FromStringTable ( const FName InTableId,
const FTextKey& InKey,
const EStringTableLoadingPolicy InLoadingPolicy
)

 Attempts to create an FText instance from a string table ID and key (this is the same as the LOCTABLE macro, except this can also work with non-literal string values). Internationalization/Text.h  

static FText FromStringView ( FWideStringView InString
)

   Internationalization/Text.h  

static FText FromStringView ( FUtf8StringView InString
)

   Internationalization/Text.h  

static FText FromStringView ( FAnsiStringView InString
)

 Generate a FText representing the passed string view Internationalization/Text.h  

static FText FromTextGenerator ( const TSharedRef< ITextGenerator >& TextGenerator
)

 Produces a custom-generated FText. Internationalization/Text.h  

static const FText & GetEmpty()

   Internationalization/Text.h  

static void GetFormatPatternParameters ( const FTextFormat& Fmt,
TArray< FString >& ParameterNames
)

   Internationalization/Text.h  

static FString GetInvariantTimeZone()

 Gets the time zone string that represents a non-specific, zero offset, culture invariant time zone. Internationalization/Text.h  

static bool IsWhitespace ( const TCHAR Char
)

 Check to see if the given character is considered whitespace by the current culture Internationalization/Text.h  

static FText Join ( const FText& Delimiter,
const FFormatOrderedArguments& Args
)

 Join an arbitrary list of formattable values together, separated by the given delimiter Internationalization/Text.h  

static FText Join ( const FText& Delimiter,
ArgTypes... Args
)

 Join an arbitrary list of formattable items together, separated by the given delimiter Internationalization/Text.h  

static FText Join ( const FText& Delimiter,
const TArray< FText >& Args
)

   Internationalization/Text.h  

static void PreloadStringTable ( FName InTableId,
const FTextKey& InKey
)

   Internationalization/Text.h  

static void RegisterTextGenerator ()

 Registers a standard text generator factory function. Internationalization/Text.h  

static void RegisterTextGenerator ( FName TypeID
)

 Registers a standard text generator factory function. Internationalization/Text.h  

static void RegisterTextGenerator ( FName TypeID,
FCreateTextGeneratorDelegate FactoryFunction
)

 Registers a factory function to be used with serialization of text generators within FText. Internationalization/Text.h  

static void SerializeText ( FArchive& Ar,
FText& Value
)

   Internationalization/Text.h  

static void SerializeText ( FStructuredArchive::FSlot Slot,
FText& Value
)

   Internationalization/Text.h  

static FText TrimPreceding ( const FText&
)

 Removes any whitespace characters from the start of the text. Internationalization/Text.h  

static FText TrimPrecedingAndTrailing ( const FText&
)

 Removes any whitespace characters from the start and end of the text. Internationalization/Text.h  

static FText TrimTrailing ( const FText&
)

 Removes any whitespace characters from the end of the text. Internationalization/Text.h  

static void UnregisterTextGenerator ()

 Unregisters a standard text generator factory function. Internationalization/Text.h  

static void UnregisterTextGenerator ( FName TypeID
)

 Unregisters a factory function to be used with serialization of text generators within FText. Internationalization/Text.h  

Operators

Name Remarks Include Path Unreal Specifiers

FText & operator= ( const FText&
)

   Internationalization/Text.h  

FText & operator= ( FText&& Other
)

   Internationalization/Text.h  

bool operator== ( FIntrusiveUnsetOptionalState
) const

   Internationalization/Text.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page