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

#include <TextHistory.h>

+ Inheritance diagram for FTextHistory:

Public Member Functions

 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 FTextId GetTextId () const
 
virtual FString BuildInvariantDisplayString () const =0
 
virtual bool IdenticalTo (const FTextHistory &Other, const ETextIdenticalModeFlags CompareModeFlags) const =0
 
virtual void Serialize (FStructuredArchive::FRecord Record)=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
 
virtual const FString & GetDisplayString () const =0
 
- Public Member Functions inherited from IRefCountedObject
virtual ~IRefCountedObject ()
 

Static Public Member Functions

static bool StaticShouldReadFromBuffer (const TCHAR *Buffer)
 

Protected Member Functions

virtual bool CanUpdateDisplayString ()
 
virtual void UpdateDisplayString ()=0
 
void MarkDisplayStringOutOfDate ()
 
void MarkDisplayStringUpToDate ()
 

Detailed Description

Base interface class for all FText history types

Constructor & Destructor Documentation

◆ FTextHistory() [1/2]

FTextHistory::FTextHistory ( )
default

◆ ~FTextHistory()

virtual FTextHistory::~FTextHistory ( )
virtualdefault

◆ FTextHistory() [2/2]

FTextHistory::FTextHistory ( const FTextHistory &  )
delete

Disallow copying

Member Function Documentation

◆ AddRef()

virtual FReturnedRefCountValue FTextHistory::AddRef ( ) const
inlinefinaloverridevirtual

Implements IRefCountedObject.

◆ BuildInvariantDisplayString()

virtual FString FTextHistory::BuildInvariantDisplayString ( ) const
pure virtual

Build the display string for the invariant culture

Implemented in FTextHistory_Base, FTextHistory_NamedFormat, FTextHistory_OrderedFormat, FTextHistory_ArgumentDataFormat, FTextHistory_AsNumber, FTextHistory_AsPercent, FTextHistory_AsCurrency, FTextHistory_AsDate, FTextHistory_AsTime, FTextHistory_AsDateTime, FTextHistory_Transform, FTextHistory_StringTableEntry, and FTextHistory_TextGenerator.

◆ CanUpdateDisplayString()

virtual bool FTextHistory::CanUpdateDisplayString ( )
inlineprotectedvirtual

True if "UpdateDisplayString" might do something if called, or False if it would be redundant

Reimplemented in FTextHistory_Base.

◆ GetGlobalHistoryRevision()

uint16 FTextHistory::GetGlobalHistoryRevision ( ) const
finaloverridevirtual

Get the global history revision associated with this text instance.

Implements ITextData.

◆ GetHistoricFormatData()

virtual void FTextHistory::GetHistoricFormatData ( const FText &  InText,
TArray< FHistoricTextFormatData > &  OutHistoricFormatData 
) const
inlinevirtual

Get any historic text format data from this history

Reimplemented in FTextHistory_NamedFormat, FTextHistory_OrderedFormat, FTextHistory_ArgumentDataFormat, and FTextHistory_Transform.

◆ GetHistoricNumericData()

virtual bool FTextHistory::GetHistoricNumericData ( const FText &  InText,
FHistoricTextNumericData &  OutHistoricNumericData 
) const
inlinevirtual

Get any historic numeric format data from this history

Reimplemented in FTextHistory_AsNumber, FTextHistory_AsPercent, and FTextHistory_Transform.

◆ GetLocalHistoryRevision()

uint16 FTextHistory::GetLocalHistoryRevision ( ) const
finaloverridevirtual

Get the local history revision associated with this text instance.

Implements ITextData.

◆ GetLocalizedString()

virtual FTextConstDisplayStringPtr FTextHistory::GetLocalizedString ( ) const
inlineoverridevirtual

Get the shared display string (if any).

Implements ITextData.

Reimplemented in FTextHistory_Base, and FTextHistory_StringTableEntry.

◆ GetMutableTextHistory()

virtual FTextHistory & FTextHistory::GetMutableTextHistory ( )
inlinefinaloverridevirtual

Get a mutable reference to the history associated with this text instance (used when loading/saving text).

Implements ITextData.

◆ GetRefCount()

virtual uint32 FTextHistory::GetRefCount ( ) const
inlinefinaloverridevirtual

Implements IRefCountedObject.

◆ GetSourceString()

virtual const FString & FTextHistory::GetSourceString ( ) const
inlineoverridevirtual

Get the source string for this text.

Implements ITextData.

Reimplemented in FTextHistory_Base, and FTextHistory_StringTableEntry.

◆ GetTextHistory()

virtual const FTextHistory & FTextHistory::GetTextHistory ( ) const
inlinefinaloverridevirtual

Get the history associated with this text instance.

Implements ITextData.

◆ GetTextId()

virtual FTextId FTextHistory::GetTextId ( ) const
inlinevirtual

Returns the ID of the shared display string (if any).

Reimplemented in FTextHistory_Base, FTextHistory_Generated, and FTextHistory_StringTableEntry.

◆ GetType()

virtual ETextHistoryType FTextHistory::GetType ( ) const
pure virtual

Get the type of this history

Implemented in FTextHistory_Base, FTextHistory_NamedFormat, FTextHistory_OrderedFormat, FTextHistory_ArgumentDataFormat, FTextHistory_AsNumber, FTextHistory_AsPercent, FTextHistory_AsCurrency, FTextHistory_AsDate, FTextHistory_AsTime, FTextHistory_AsDateTime, FTextHistory_Transform, FTextHistory_StringTableEntry, and FTextHistory_TextGenerator.

◆ IdenticalTo()

virtual bool FTextHistory::IdenticalTo ( const FTextHistory &  Other,
const ETextIdenticalModeFlags  CompareModeFlags 
) const
pure virtual

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!

Implemented in FTextHistory_Base, FTextHistory_NamedFormat, FTextHistory_OrderedFormat, FTextHistory_ArgumentDataFormat, FTextHistory_FormatNumber, FTextHistory_AsDate, FTextHistory_AsTime, FTextHistory_AsDateTime, FTextHistory_Transform, FTextHistory_StringTableEntry, and FTextHistory_TextGenerator.

◆ MarkDisplayStringOutOfDate()

void FTextHistory::MarkDisplayStringOutOfDate ( )
protected

Mark the history revisions as out-of-date

◆ MarkDisplayStringUpToDate()

void FTextHistory::MarkDisplayStringUpToDate ( )
protected

Mark the history revisions as up-to-date

◆ operator=()

FTextHistory & FTextHistory::operator= ( FTextHistory &  )
delete

◆ ReadFromBuffer()

virtual const TCHAR * FTextHistory::ReadFromBuffer ( const TCHAR *  Buffer,
const TCHAR *  TextNamespace,
const TCHAR *  PackageNamespace 
)
inlinevirtual

Attempt to parse this text history from the given stream of text.

Parameters
BufferThe buffer of text to read from.
TextNamespaceAn optional namespace to use when parsing texts that use LOCTEXT (default is an empty namespace).
PackageNamespaceThe package namespace of the containing object (if loading for a property - see TextNamespaceUtil::GetPackageNamespace).
OutDisplayStringThe display string pointer to potentially fill in (depending on the history type).
Returns
The updated buffer after we parsed this text history, or nullptr on failure

◆ Release()

virtual uint32 FTextHistory::Release ( ) const
inlinefinaloverridevirtual

Implements IRefCountedObject.

◆ Serialize()

virtual void FTextHistory::Serialize ( FStructuredArchive::FRecord  Record)
pure virtual

Serializes the history to/from a structured archive slot

Implemented in FTextHistory_Base, FTextHistory_Generated, FTextHistory_NamedFormat, FTextHistory_OrderedFormat, FTextHistory_ArgumentDataFormat, FTextHistory_FormatNumber, FTextHistory_AsNumber, FTextHistory_AsPercent, FTextHistory_AsCurrency, FTextHistory_AsDate, FTextHistory_AsTime, FTextHistory_AsDateTime, FTextHistory_Transform, FTextHistory_StringTableEntry, and FTextHistory_TextGenerator.

◆ ShouldReadFromBuffer()

virtual bool FTextHistory::ShouldReadFromBuffer ( const TCHAR *  Buffer) const
inlinevirtual

◆ StaticShouldReadFromBuffer()

static bool FTextHistory::StaticShouldReadFromBuffer ( const TCHAR *  Buffer)
inlinestatic

Check the given stream of text to see if it looks like something this class could process in via ReadFromBuffer.

Note
This doesn't guarantee that ReadFromBuffer will be able to process the stream, only that it could attempt to.

◆ UpdateDisplayString()

virtual void FTextHistory::UpdateDisplayString ( )
protectedpure virtual

Update the display string when the history is out-of-date

Implemented in FTextHistory_Base, FTextHistory_Generated, and FTextHistory_StringTableEntry.

◆ UpdateDisplayStringIfOutOfDate()

void FTextHistory::UpdateDisplayStringIfOutOfDate ( )

Update the display string if the history is out-of-date

◆ WriteToBuffer()

virtual bool FTextHistory::WriteToBuffer ( FString &  Buffer,
const bool  bStripPackageNamespace 
) const
inlinevirtual

Write this text history to a stream of text

Parameters
BufferThe buffer of text to write to.
DisplayStringThe display string associated with the text being written
bStripPackageNamespaceTrue to strip the package namespace from the written NSLOCTEXT value (eg, when saving cooked data)
Returns
True if we wrote valid data into Buffer, false otherwise
The documentation for this class was generated from the following files: