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

#include <TextHistory.h>

+ Inheritance diagram for FTextHistory_FormatNumber:

Public Member Functions

 FTextHistory_FormatNumber ()=default
 
 FTextHistory_FormatNumber (FString &&InDisplayString, FFormatArgumentValue InSourceValue, const FNumberFormattingOptions *const InFormatOptions, FCulturePtr InTargetCulture)
 
virtual bool IdenticalTo (const FTextHistory &Other, const ETextIdenticalModeFlags CompareModeFlags) const override
 
virtual void Serialize (FStructuredArchive::FRecord Record) override
 
- Public Member Functions inherited from FTextHistory_Generated
 FTextHistory_Generated ()=default
 
 FTextHistory_Generated (FString &&InDisplayString)
 
virtual FTextId GetTextId () const override final
 
virtual const FString & GetDisplayString () const override
 
virtual void UpdateDisplayString () override
 
- Public Member Functions inherited from FTextHistory
 FTextHistory ()=default
 
virtual ~FTextHistory ()=default
 
 FTextHistory (const FTextHistory &)=delete
 
FTextHistory & operator= (FTextHistory &)=delete
 
virtual FReturnedRefCountValue AddRef () const override final
 
virtual uint32 Release () const override final
 
virtual uint32 GetRefCount () const override final
 
virtual const FString & GetSourceString () const override
 
virtual FTextConstDisplayStringPtr GetLocalizedString () const override
 
virtual uint16 GetGlobalHistoryRevision () const override final
 
virtual uint16 GetLocalHistoryRevision () const override final
 
virtual const FTextHistory & GetTextHistory () const override final
 
virtual FTextHistory & GetMutableTextHistory () override final
 
virtual ETextHistoryType GetType () const =0
 
virtual FString BuildInvariantDisplayString () const =0
 
virtual bool ShouldReadFromBuffer (const TCHAR *Buffer) const
 
virtual const TCHAR * ReadFromBuffer (const TCHAR *Buffer, const TCHAR *TextNamespace, const TCHAR *PackageNamespace)
 
virtual bool WriteToBuffer (FString &Buffer, const bool bStripPackageNamespace) const
 
virtual void GetHistoricFormatData (const FText &InText, TArray< FHistoricTextFormatData > &OutHistoricFormatData) const
 
virtual bool GetHistoricNumericData (const FText &InText, FHistoricTextNumericData &OutHistoricNumericData) const
 
void UpdateDisplayStringIfOutOfDate ()
 
- Public Member Functions inherited from ITextData
virtual ~ITextData ()=default
 
- Public Member Functions inherited from IRefCountedObject
virtual ~IRefCountedObject ()
 

Protected Member Functions

FString BuildNumericDisplayString (const FDecimalNumberFormattingRules &InFormattingRules, const int32 InValueMultiplier=1) const
 
- Protected Member Functions inherited from FTextHistory_Generated
virtual FString BuildLocalizedDisplayString () const =0
 
- Protected Member Functions inherited from FTextHistory
virtual bool CanUpdateDisplayString ()
 
void MarkDisplayStringOutOfDate ()
 
void MarkDisplayStringUpToDate ()
 

Protected Attributes

FFormatArgumentValue SourceValue
 
TOptional< FNumberFormattingOptions > FormatOptions
 
FCulturePtr TargetCulture
 
- Protected Attributes inherited from FTextHistory_Generated
FString DisplayString
 

Additional Inherited Members

- Static Public Member Functions inherited from FTextHistory
static bool StaticShouldReadFromBuffer (const TCHAR *Buffer)
 

Detailed Description

Base class for managing formatting FText's from: AsNumber, AsPercent, and AsCurrency. Manages data serialization of these history events

Constructor & Destructor Documentation

◆ FTextHistory_FormatNumber() [1/2]

FTextHistory_FormatNumber::FTextHistory_FormatNumber ( )
default

◆ FTextHistory_FormatNumber() [2/2]

FTextHistory_FormatNumber::FTextHistory_FormatNumber ( FString &&  InDisplayString,
FFormatArgumentValue  InSourceValue,
const FNumberFormattingOptions *const  InFormatOptions,
FCulturePtr  InTargetCulture 
)

Member Function Documentation

◆ BuildNumericDisplayString()

FString FTextHistory_FormatNumber::BuildNumericDisplayString ( const FDecimalNumberFormattingRules &  InFormattingRules,
const int32  InValueMultiplier = 1 
) const
protected

Build the numeric display string using the given formatting rules

◆ IdenticalTo()

bool FTextHistory_FormatNumber::IdenticalTo ( const FTextHistory &  Other,
const ETextIdenticalModeFlags  CompareModeFlags 
) const
overridevirtual

Check whether this history is considered identical to the other history, based on the comparison flags provided.

Note
You must ensure that both histories are the same type (via GetType) prior to calling this function!

Implements FTextHistory.

◆ Serialize()

void FTextHistory_FormatNumber::Serialize ( FStructuredArchive::FRecord  Record)
overridevirtual

Serializes the history to/from a structured archive slot

Reimplemented from FTextHistory_Generated.

Reimplemented in FTextHistory_AsNumber, FTextHistory_AsPercent, and FTextHistory_AsCurrency.

Member Data Documentation

◆ FormatOptions

TOptional<FNumberFormattingOptions> FTextHistory_FormatNumber::FormatOptions
protected

All the formatting options available to format using. This can be empty.

◆ SourceValue

FFormatArgumentValue FTextHistory_FormatNumber::SourceValue
protected

The source value to format from

◆ TargetCulture

FCulturePtr FTextHistory_FormatNumber::TargetCulture
protected

The culture to format using

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