1. Epic GamesDeveloper
  3. FTextFormatter

FTextFormatter

A text formatter is responsible for formatting text patterns using a set of named or ordered arguments.

API > API/Runtime > API/Runtime/Core

A text formatter is responsible for formatting text patterns using a set of named or ordered arguments.

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

Syntax

class FTextFormatter

Constructors

Name Remarks Include Path Unreal Specifiers

FTextFormatter()

   Internationalization/TextFormatter.h  

Typedefs

Name Type Remarks Include Path
FCompileTextArgumentModifierFuncPtr TFunction< TSharedPtr< ITextFormatArgumentModifier >(const FTextFormatString &, FTextFormatPatternDefinitionConstRef)> Callback function used to compile an argument modifier. Internationalization/TextFormatter.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
TextArgumentModifiers TSortedMap< FTextFormatString, FCompileTextArgumentModifierFuncPtr > Functions for constructing argument modifier data Internationalization/TextFormatter.h  
TextArgumentModifiersRW FTransactionallySafeRWLock RW lock protecting the argument modifiers map from being modified concurrently Internationalization/TextFormatter.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FCompileTextArgumentModifierFuncPtr FindTextArgumentModifier ( const FTextFormatString& InKeyword
) const

   Internationalization/TextFormatter.h  

void RegisterTextArgumentModifier ( const FTextFormatString& InKeyword,
FCompileTextArgumentModifierFuncPtr InCompileFunc
)

   Internationalization/TextFormatter.h  

void UnregisterTextArgumentModifier ( const FTextFormatString& InKeyword
)

   Internationalization/TextFormatter.h  

Static

Name Remarks Include Path Unreal Specifiers

static void ArgumentValueToFormattedString ( const FFormatArgumentValue& InValue,
const FPrivateTextFormatArguments& InFormatArgs,
FString& OutResult
)

 Incredibly low-level version of FFormatArgumentValue::ToFormattedString. Internationalization/TextFormatter.h  

static int32 EstimateArgumentValueLength ( const FFormatArgumentValue& ArgumentValue
)

   Internationalization/TextFormatter.h  

static FString Format ( const FTextFormat& InFmt,
const FPrivateTextFormatArguments& InFormatArgs
)

 Incredibly low-level version of format. Internationalization/TextFormatter.h  

static FText Format ( FTextFormat&& InFmt,
FFormatNamedArguments&& InArguments,
const bool bInRebuildText,
const bool bInRebuildAsSource
)

 Low-level versions of Format. Internationalization/TextFormatter.h  

static FText Format ( FTextFormat&& InFmt,
FFormatOrderedArguments&& InArguments,
const bool bInRebuildText,
const bool bInRebuildAsSource
)

   Internationalization/TextFormatter.h  

static FText Format ( FTextFormat&& InFmt,
TArray< FFormatArgumentData >&& InArguments,
const bool bInRebuildText,
const bool bInRebuildAsSource
)

   Internationalization/TextFormatter.h  

static FString FormatStr ( const FTextFormat& InFmt,
const FFormatNamedArguments& InArguments,
const bool bInRebuildText,
const bool bInRebuildAsSource
)

 Low-level version of Format that returns a string. Internationalization/TextFormatter.h  

static FString FormatStr ( const FTextFormat& InFmt,
const FFormatOrderedArguments& InArguments,
const bool bInRebuildText,
const bool bInRebuildAsSource
)

   Internationalization/TextFormatter.h  

static FString FormatStr ( const FTextFormat& InFmt,
const TArray< FFormatArgumentData >& InArguments,
const bool bInRebuildText,
const bool bInRebuildAsSource
)

   Internationalization/TextFormatter.h  

static FTextFormatter & Get()

 Singleton access Internationalization/TextFormatter.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page