FTextFormatArgumentModifier_PluralForm Class Reference

#include <TextFormatArgumentModifier.h>

Inheritance diagram for FTextFormatArgumentModifier_PluralForm:

Public Member Functions
virtual bool	Validate (const FCultureRef &InCulture, TArray< FString > &OutValidationErrors) const override
virtual void	Evaluate (const FFormatArgumentValue &InValue, const FPrivateTextFormatArguments &InFormatArgs, FString &OutResult) const override
virtual void	GetFormatArgumentNames (TArray< FString > &OutArgumentNames) const override
virtual void	EstimateLength (int32 &OutLength, bool &OutUsesFormatArgs) const override
Public Member Functions inherited from ITextFormatArgumentModifier
virtual	~ITextFormatArgumentModifier ()

Static Public Member Functions
static TSharedPtr< ITextFormatArgumentModifier >	Create (const ETextPluralType InPluralType, const FTextFormatString &InArgsString, const FTextFormatPatternDefinitionConstRef &InPatternDef)

Additional Inherited Members
Static Protected Member Functions inherited from ITextFormatArgumentModifier
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

Plural form argument modifier. Takes a set of key->value arguments, where the key is a valid plural form identifier, and the value is an optionally quoted string that may contain format markers. eg) |plural(one=is,other=are) eg) |ordinal(one=st,two=nd,few=rd,other=th)

Member Function Documentation

Create()

TSharedPtr< ITextFormatArgumentModifier > FTextFormatArgumentModifier_PluralForm::Create ( const ETextPluralType  InPluralType, const FTextFormatString &  InArgsString, const FTextFormatPatternDefinitionConstRef &  InPatternDef  )

static

EstimateLength()

void FTextFormatArgumentModifier_PluralForm::EstimateLength ( int32 &  OutLength, bool &  OutUsesFormatArgs  ) const

overridevirtual

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

Implements ITextFormatArgumentModifier.

Evaluate()

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

overridevirtual

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

Implements ITextFormatArgumentModifier.

GetFormatArgumentNames()

void FTextFormatArgumentModifier_PluralForm::GetFormatArgumentNames ( TArray< FString > &  OutArgumentNames ) const

overridevirtual

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

Implements ITextFormatArgumentModifier.

Validate()

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

overridevirtual

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

Implements ITextFormatArgumentModifier.

---

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

• Engine/Source/Runtime/Core/Private/Internationalization/TextFormatArgumentModifier.h
• Engine/Source/Runtime/Core/Private/Internationalization/TextFormatArgumentModifier.cpp