UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FTextHistory_ArgumentDataFormat Class Reference

#include <TextHistory.h>

+ Inheritance diagram for FTextHistory_ArgumentDataFormat:

Public Member Functions

 FTextHistory_ArgumentDataFormat ()=default
 
 FTextHistory_ArgumentDataFormat (FString &&InDisplayString, FTextFormat &&InSourceFmt, TArray< FFormatArgumentData > &&InArguments)
 
virtual ETextHistoryType GetType () const override
 
virtual bool IdenticalTo (const FTextHistory &Other, const ETextIdenticalModeFlags CompareModeFlags) const override
 
virtual FString BuildLocalizedDisplayString () const override
 
virtual FString BuildInvariantDisplayString () const override
 
virtual void Serialize (FStructuredArchive::FRecord Record) override
 
virtual void GetHistoricFormatData (const FText &InText, TArray< FHistoricTextFormatData > &OutHistoricFormatData) const 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
 
FTextHistoryoperator= (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 FTextHistoryGetTextHistory () const override final
 
virtual FTextHistoryGetMutableTextHistory () override final
 
virtual bool ShouldReadFromBuffer (const TCHAR *Buffer) const
 
virtual const TCHARReadFromBuffer (const TCHAR *Buffer, const TCHAR *TextNamespace, const TCHAR *PackageNamespace)
 
virtual bool WriteToBuffer (FString &Buffer, const bool bStripPackageNamespace) 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 ()
 

Public Attributes

 OVERRIDE_TEXT_HISTORY_STRINGIFICATION
 

Additional Inherited Members

- Static Public Member Functions inherited from FTextHistory
static bool StaticShouldReadFromBuffer (const TCHAR *Buffer)
 
- Protected Member Functions inherited from FTextHistory
virtual bool CanUpdateDisplayString ()
 
void MarkDisplayStringOutOfDate ()
 
void MarkDisplayStringUpToDate ()
 
- Protected Attributes inherited from FTextHistory_Generated
FString DisplayString
 

Detailed Description

Handles history for FText::Format when passing raw argument data

Constructor & Destructor Documentation

◆ FTextHistory_ArgumentDataFormat() [1/2]

FTextHistory_ArgumentDataFormat::FTextHistory_ArgumentDataFormat ( )
default

◆ FTextHistory_ArgumentDataFormat() [2/2]

FTextHistory_ArgumentDataFormat::FTextHistory_ArgumentDataFormat ( FString &&  InDisplayString,
FTextFormat &&  InSourceFmt,
TArray< FFormatArgumentData > &&  InArguments 
)

Member Function Documentation

◆ BuildInvariantDisplayString()

FString FTextHistory_ArgumentDataFormat::BuildInvariantDisplayString ( ) const
overridevirtual

Build the display string for the invariant culture

Implements FTextHistory.

◆ BuildLocalizedDisplayString()

FString FTextHistory_ArgumentDataFormat::BuildLocalizedDisplayString ( ) const
overridevirtual

Build the display string for the current culture

Implements FTextHistory_Generated.

◆ GetHistoricFormatData()

void FTextHistory_ArgumentDataFormat::GetHistoricFormatData ( const FText InText,
TArray< FHistoricTextFormatData > &  OutHistoricFormatData 
) const
overridevirtual

Get any historic text format data from this history

Reimplemented from FTextHistory.

◆ GetType()

virtual ETextHistoryType FTextHistory_ArgumentDataFormat::GetType ( ) const
inlineoverridevirtual

Get the type of this history

Implements FTextHistory.

◆ IdenticalTo()

bool FTextHistory_ArgumentDataFormat::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_ArgumentDataFormat::Serialize ( FStructuredArchive::FRecord  Record)
overridevirtual

Serializes the history to/from a structured archive slot

Reimplemented from FTextHistory_Generated.

Member Data Documentation

◆ OVERRIDE_TEXT_HISTORY_STRINGIFICATION

FTextHistory_ArgumentDataFormat::OVERRIDE_TEXT_HISTORY_STRINGIFICATION

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