1. Epic GamesDeveloper
  3. ITextFormatArgumentModifier

ITextFormatArgumentModifier

Interface for a format argument modifier.

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Internationalization

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Internationalization/ITextFormatArgumentModifier.h
Include #include "Internationalization/ITextFormatArgumentModifier.h"

Syntax

class ITextFormatArgumentModifier

Remarks

Interface for a format argument modifier.

Destructors

  Type Name Description
Public function Virtual   Virtual destructor

Functions

  Type Name Description
Public function Const void

EstimateLength ( int32& OutLength,
bool& OutUsesFormatArgs
)

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

Evaluate ( const FFormatArgumentValue& InValue,
const FPrivateTextFormatArguments& InFormatArgs,
FString& OutResult
)

 Given the argument, evaluate the result and append it to OutResult
Public function Const void

GetFormatArgumentNames ( TArray< FString >& OutArgumentNames
)

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

ParseKeyValueArgs ( const FTextFormatString& InArgsString,
TSortedMap< FTextFormatString, FTextFormatString >& OutArgKeyValues,
const TCHAR InValueSeparator,
const TCHAR InArgSeparator
)

 Utility helper to parse out a list of key->value pair arguments.
Protected function Static bool

ParseValueArgs ( const FTextFormatString& InArgsString,
TArray< FTextFormatString >& OutArgValues,
const TCHAR InArgSeparator
)

 Utility helper to parse out a list of value arguments.
Public function Const bool

Validate ( const FCultureRef& InCulture,
TArray< FString >& OutValidationErrors
)

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page