FText

Syntax

class FText

Constructors

Name Description

Public function

FText()

Public function

FText

(
    const FText &
)

Public function

FText

(
    FText &&
)

Functions

Name Description

Public function Static

FText

 

AsCultureInvariant

(
    FText Text
)

Generate a culture invariant FText representing the passed in FText

Public function Static

FText

 

AsCultureInvariant

(
    FString && String
)

Generate a culture invariant FText representing the passed in string

Public function Static

FText

 

AsCultureInvariant

(
    const FString & String
)

Generate a culture invariant FText representing the passed in string

Public function Static

FText

 

AsCurrency

(
    double Val,
    const FString & CurrencyCode,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

A dynamically sizeable string.

Public function Static

FText

 

AsCurrency

(
    long Val,
    const FString & CurrencyCode,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

A dynamically sizeable string.

Public function Static

FText

 

AsCurrency

(
    uint64 Val,
    const FString & CurrencyCode,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

A dynamically sizeable string.

Public function Static

FText

 

AsCurrency

(
    uint32 Val,
    const FString & CurrencyCode,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

A dynamically sizeable string.

Public function Static

FText

 

AsCurrency

(
    uint16 Val,
    const FString & CurrencyCode,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

A dynamically sizeable string.

Public function Static

FText

 

AsCurrency

(
    uint8 Val,
    const FString & CurrencyCode,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

A dynamically sizeable string.

Public function Static

FText

 

AsCurrency

(
    int64 Val,
    const FString & CurrencyCode,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

A dynamically sizeable string.

Public function Static

FText

 

AsCurrency

(
    int32 Val,
    const FString & CurrencyCode,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

A dynamically sizeable string.

Public function Static

FText

 

AsCurrency

(
    int16 Val,
    const FString & CurrencyCode,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

A dynamically sizeable string.

Public function Static

FText

 

AsCurrency

(
    int8 Val,
    const FString & CurrencyCode,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

A dynamically sizeable string.

Public function Static

FText

 

AsCurrency

(
    float Val,
    const FString & CurrencyCode,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

Public function Static

FText

 

AsCurrencyBase

(
    int64 BaseVal,
    const FString & CurrencyCode,
    const FCulturePtr & TargetCulture
)

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

Public function Static

FText

 

AsDate

(
    const FDateTime & DateTime,
    const EDateTimeStyle::Type DateStyl...,
    const FString & TimeZone,
    const FCulturePtr & TargetCulture
)

Generate an FText that represents the passed number as a date and/or time in the current culture

Public function Static

FText

 

AsDateTime

(
    const FDateTime & DateTime,
    const EDateTimeStyle::Type DateStyl...,
    const EDateTimeStyle::Type TimeStyl...,
    const FString & TimeZone,
    const FCulturePtr & TargetCulture
)

Public function Static

FText

 

AsMemory

(
    uint64 NumBytes,
    EMemoryUnitStandard UnitStandard
)

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

Public function Static

FText

 

AsMemory

(
    uint64 NumBytes,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture,
    EMemoryUnitStandard UnitStandard
)

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

Public function Static

FText

 

AsNumber

(
    int8 Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

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

Public function Static

FText

 

AsNumber

(
    int32 Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

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

Public function Static

FText

 

AsNumber

(
    int64 Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

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

Public function Static

FText

 

AsNumber

(
    uint8 Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

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

Public function Static

FText

 

AsNumber

(
    uint16 Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

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

Public function Static

FText

 

AsNumber

(
    uint32 Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

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

Public function Static

FText

 

AsNumber

(
    long Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

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

Public function Static

FText

 

AsNumber

(
    int16 Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

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

Public function Static

FText

 

AsNumber

(
    float Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

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

Public function Static

FText

 

AsNumber

(
    uint64 Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

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

Public function Static

FText

 

AsNumber

(
    double Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

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

Public function Static

FText

 

AsPercent

(
    float Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

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

Public function Static

FText

 

AsPercent

(
    double Val,
    const FNumberFormattingOptions *...,
    const FCulturePtr & TargetCulture
)

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

Public function Static

FText

 

AsTime

(
    const FDateTime & DateTime,
    const EDateTimeStyle::Type TimeStyl...,
    const FString & TimeZone,
    const FCulturePtr & TargetCulture
)

Public function Static

FText

 

AsTimespan

(
    const FTimespan & Timespan,
    const FCulturePtr & TargetCulture
)

Public function Const

FString

 

BuildSourceString()

Deep build of the source string for this FText , climbing the history hierarchy

Public function 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

Public function Const

int32

 

CompareTo

(
    const FText & Other,
    const ETextComparisonLevel::Type Co...
)

Public function Const

int32

 

CompareToCaseIgnored

(
    const FText & Other
)

Public function Const

bool

 

EqualTo

(
    const FText & Other,
    const ETextComparisonLevel::Type Co...
)

Public function Const

bool

 

EqualToCaseIgnored

(
    const FText & Other
)

Public function Static

FCreateTextG ...

 

FindRegisteredTextGenerator

(
    FName TypeID
)

Returns the text generator factory function registered under the specified name, if any.

Public function Static

bool

 

FindText

(
    const FTextKey & Namespace,
    const FTextKey & Key,
    FText & OutText,
    const FString *const SourceStri...
)

Attempts to find an existing FText using the representation found in the loc tables for the specified namespace and key

Public function Static

FText

 

Format

(
    FTextFormat Fmt,
    const FFormatNamedArguments & InArg...
)

Public function Static

FText

 

Format

(
    FTextFormat Fmt,
    FFormatNamedArguments && InArgument...
)

Public function Static

FText

 

Format

(
    FTextFormat Fmt,
    const FFormatOrderedArguments & InA...
)

Public function Static

FText

 

Format

(
    FTextFormat Fmt,
    FFormatOrderedArguments && InArgume...
)

Public function Static

FText

 

Format

(
    FTextFormat Fmt,
    ArgTypes... Args
)

Public function Static

FText

 

FormatNamed

(
    FTextFormat Fmt,
    TArguments&&... Args
)

FormatNamed allows you to pass name <-> value pairs to the function to format automatically

Public function Static

FText

 

FormatOrdered

(
    FTextFormat Fmt,
    TArguments&&... Args
)

FormatOrdered allows you to pass a variadic list of types to use for formatting in order desired

Public function Static

FText

 

FromName

(
    const FName & Val
)

Generate an FText representing the pass name

Public function Static

FText

 

FromString

(
    FString && String
)

Generate an FText representing the passed in string

Public function Static

FText

 

FromString

(
    const FString & String
)

Generate an FText representing the passed in string

Public function Static

FText

 

FromStringTable

(
    const FName InTableId,
    const FString & InKey,
    const EStringTableLoadingPolicy InL...
)

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).

Public function Static

FText

 

FromTextGenerator

(
    const TSharedRef < ITextGenerator > ...
)

Produces a custom-generated FText .

Public function Static

const FText ...

 

GetEmpty()

Public function Static

void

 

GetFormatPatternParameters

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

Public function Static

FString

 

GetInvariantTimeZone()

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

Public function Const

bool

 

IdenticalTo

(
    const FText & Other
)

Check to see if this FText is identical to the other FText

Public function Const

bool

 

IsCultureInvariant()

Public function Const

bool

 

IsEmpty()

Public function Const

bool

 

IsEmptyOrWhitespace()

Public function Const

bool

 

IsFromStringTable()

Public function Const

bool

 

IsInitializedFromString()

Public function Const

bool

 

IsNumeric()

Public function Const

bool

 

IsTransient()

Public function Static

bool

 

IsWhitespace

(
    const TCHAR Char
)

Check to see if the given character is considered whitespace by the current culture

Public function Static

void

 

RegisterTextGenerator

(
    FName TypeID
)

Registers a standard text generator factory function.

Public function Static

void

 

RegisterTextGenerator

(
    FName TypeID,
    FCreateTextGeneratorDelegate Factor...
)

Registers a factory function to be used with serialization of text generators within FText .

Public function Static

void

 

RegisterTextGenerator()

Registers a standard text generator factory function.

Public function Const

bool

 

ShouldGatherForLocalization()

Public function Const

FText

 

ToLower()

Transforms the text to lowercase in a culture correct way.

Public function Const

const FStrin ...

 

ToString()

Public function Const

FText

 

ToUpper()

Transforms the text to uppercase in a culture correct way.

Public function Static

FText

 

TrimPreceding

(
    const FText &
)

Removes whitespace characters from the front of the string.

Public function Static

FText

 

TrimPrecedingAndTrailing

(
    const FText &
)

Does both of the above without needing to create an additional FText in the interim.

Public function Static

FText

 

TrimTrailing

(
    const FText &
)

Removes trailing whitespace characters

Public function Static

void

 

UnregisterTextGenerator()

Unregisters a standard text generator factory function.

Public function Static

void

 

UnregisterTextGenerator

(
    FName TypeID
)

Unregisters a factory function to be used with serialization of text generators within FText .

Operators

Name Description

Public function

FText &

 

operator=

(
    FText &&
)

Public function

FText &

 

operator=

(
    const FText &
)

Classes

Name

Description

Public class

FSortPredicate

Enums

Name

Description

Private enum

EInitToEmptyString

Special constructor used to create StaticEmptyText without also allocating a history object

Typedefs

Name

Description

FCreateTextGeneratorDelegate

References

Module

Core

Header

Runtime/Core/Public/Internationalization/Text.h