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_Generated Class Referenceabstract

#include <TextHistory.h>

+ Inheritance diagram for FTextHistory_Generated:

Public Member Functions

 FTextHistory_Generated ()=default
 
 FTextHistory_Generated (FString &&InDisplayString)
 
virtual FTextId GetTextId () const override final
 
virtual const FString & GetDisplayString () const override
 
virtual void Serialize (FStructuredArchive::FRecord Record) 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 IdenticalTo (const FTextHistory &Other, const ETextIdenticalModeFlags CompareModeFlags) 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

virtual FString BuildLocalizedDisplayString () const =0
 
- Protected Member Functions inherited from FTextHistory
virtual bool CanUpdateDisplayString ()
 
void MarkDisplayStringOutOfDate ()
 
void MarkDisplayStringUpToDate ()
 

Protected Attributes

FString DisplayString
 

Additional Inherited Members

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

Detailed Description

Base class for text histories that hold a generated display string.

Constructor & Destructor Documentation

◆ FTextHistory_Generated() [1/2]

FTextHistory_Generated::FTextHistory_Generated ( )
default

◆ FTextHistory_Generated() [2/2]

FTextHistory_Generated::FTextHistory_Generated ( FString &&  InDisplayString)
explicit

Member Function Documentation

◆ BuildLocalizedDisplayString()

virtual FString FTextHistory_Generated::BuildLocalizedDisplayString ( ) const
protectedpure virtual

Build the display string for the current culture

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

◆ GetDisplayString()

const FString & FTextHistory_Generated::GetDisplayString ( ) const
overridevirtual

Get the string to use for display purposes. This may be a shared display string from the localization manager, or may been generated at runtime.

Implements ITextData.

◆ GetTextId()

virtual FTextId FTextHistory_Generated::GetTextId ( ) const
inlinefinaloverridevirtual

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

Reimplemented from FTextHistory.

◆ Serialize()

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

Serializes the history to/from a structured archive slot

Implements FTextHistory.

Reimplemented in FTextHistory_NamedFormat, FTextHistory_OrderedFormat, FTextHistory_ArgumentDataFormat, FTextHistory_FormatNumber, FTextHistory_AsNumber, FTextHistory_AsPercent, FTextHistory_AsCurrency, FTextHistory_AsDate, FTextHistory_AsTime, FTextHistory_AsDateTime, FTextHistory_Transform, and FTextHistory_TextGenerator.

◆ UpdateDisplayString()

void FTextHistory_Generated::UpdateDisplayString ( )
overridevirtual

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

Implements FTextHistory.

Member Data Documentation

◆ DisplayString

FString FTextHistory_Generated::DisplayString
protected

The generated display string

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