UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Protected Member Functions | List of all members
ITextFormatArgumentModifier Class Referenceabstract

#include <ITextFormatArgumentModifier.h>

+ Inheritance diagram for ITextFormatArgumentModifier:

Public Member Functions

virtual ~ITextFormatArgumentModifier ()
 
virtual bool Validate (const FCultureRef &InCulture, TArray< FString > &OutValidationErrors) const =0
 
virtual void Evaluate (const FFormatArgumentValue &InValue, const FPrivateTextFormatArguments &InFormatArgs, FString &OutResult) const =0
 
virtual void GetFormatArgumentNames (TArray< FString > &OutArgumentNames) const =0
 
virtual void EstimateLength (int32 &OutLength, bool &OutUsesFormatArgs) const =0
 

Static Protected Member Functions

static CORE_API bool ParseKeyValueArgs (const FTextFormatString &InArgsString, TSortedMap< FTextFormatString, FTextFormatString > &OutArgKeyValues, const TCHAR InValueSeparator=TEXT('='), const TCHAR InArgSeparator=TEXT(','))
 
static CORE_API bool ParseValueArgs (const FTextFormatString &InArgsString, TArray< FTextFormatString > &OutArgValues, const TCHAR InArgSeparator=TEXT(','))
 

Detailed Description

Interface for a format argument modifier.

Constructor & Destructor Documentation

◆ ~ITextFormatArgumentModifier()

virtual ITextFormatArgumentModifier::~ITextFormatArgumentModifier ( )
inlinevirtual

Virtual destructor

Member Function Documentation

◆ EstimateLength()

virtual void ITextFormatArgumentModifier::EstimateLength ( int32 &  OutLength,
bool &  OutUsesFormatArgs 
) const
pure virtual

Quickly estimate the length of text that this argument modifier will likely inject into the string when evaluated

Implemented in FTextFormatArgumentModifier_PluralForm, FTextFormatArgumentModifier_GenderForm, and FTextFormatArgumentModifier_HangulPostPositions.

◆ Evaluate()

virtual void ITextFormatArgumentModifier::Evaluate ( const FFormatArgumentValue &  InValue,
const FPrivateTextFormatArguments &  InFormatArgs,
FString &  OutResult 
) const
pure virtual

Given the argument, evaluate the result and append it to OutResult

Implemented in FTextFormatArgumentModifier_PluralForm, FTextFormatArgumentModifier_GenderForm, and FTextFormatArgumentModifier_HangulPostPositions.

◆ GetFormatArgumentNames()

virtual void ITextFormatArgumentModifier::GetFormatArgumentNames ( TArray< FString > &  OutArgumentNames) const
pure virtual

Get any argument names that are used by this argument modifier (for cases where the modifier itself uses format strings)

Implemented in FTextFormatArgumentModifier_PluralForm, FTextFormatArgumentModifier_GenderForm, and FTextFormatArgumentModifier_HangulPostPositions.

◆ ParseKeyValueArgs()

bool ITextFormatArgumentModifier::ParseKeyValueArgs ( const FTextFormatString &  InArgsString,
TSortedMap< FTextFormatString, FTextFormatString > &  OutArgKeyValues,
const TCHAR  InValueSeparator = TEXT('='),
const TCHAR  InArgSeparator = TEXT(',') 
)
staticprotected

Utility helper to parse out a list of key->value pair arguments. The keys are assumed to only contain valid identifier characters, and the values may be optionally quoted (parsed strings are sub-string references to within the source args string)

◆ ParseValueArgs()

bool ITextFormatArgumentModifier::ParseValueArgs ( const FTextFormatString &  InArgsString,
TArray< FTextFormatString > &  OutArgValues,
const TCHAR  InArgSeparator = TEXT(',') 
)
staticprotected

Utility helper to parse out a list of value arguments. The values may be optionally quoted (parsed strings are sub-string references to within the source args string)

◆ Validate()

virtual bool ITextFormatArgumentModifier::Validate ( const FCultureRef &  InCulture,
TArray< FString > &  OutValidationErrors 
) const
pure virtual

Validate the argument modifier is valid based on the rules of the given culture

Implemented in FTextFormatArgumentModifier_PluralForm, FTextFormatArgumentModifier_GenderForm, and FTextFormatArgumentModifier_HangulPostPositions.

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