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

#include <TextHistory.h>

+ Inheritance diagram for FTextHistory_Base:

Public Member Functions

 FTextHistory_Base ()=default
 
 FTextHistory_Base (const FTextId &InTextId, FString &&InSourceString)
 
 FTextHistory_Base (const FTextId &InTextId, FString &&InSourceString, FTextConstDisplayStringPtr &&InLocalizedString)
 
virtual ETextHistoryType GetType () const override
 
virtual FTextId GetTextId () const override final
 
virtual FTextConstDisplayStringPtr GetLocalizedString () const override
 
virtual const FString & GetSourceString () const override
 
virtual const FString & GetDisplayString () const override
 
virtual FString BuildInvariantDisplayString () const override
 
virtual bool IdenticalTo (const FTextHistory &Other, const ETextIdenticalModeFlags CompareModeFlags) const override
 
virtual void Serialize (FStructuredArchive::FRecord Record) override
 
virtual bool CanUpdateDisplayString () 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 uint16 GetGlobalHistoryRevision () const override final
 
virtual uint16 GetLocalHistoryRevision () const override final
 
virtual const FTextHistory & GetTextHistory () const override final
 
virtual FTextHistory & GetMutableTextHistory () override final
 
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 ()
 

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
void MarkDisplayStringOutOfDate ()
 
void MarkDisplayStringUpToDate ()
 

Detailed Description

A potentially localized piece of source text (may have a TextId).

Constructor & Destructor Documentation

◆ FTextHistory_Base() [1/3]

FTextHistory_Base::FTextHistory_Base ( )
default

◆ FTextHistory_Base() [2/3]

FTextHistory_Base::FTextHistory_Base ( const FTextId &  InTextId,
FString &&  InSourceString 
)

◆ FTextHistory_Base() [3/3]

FTextHistory_Base::FTextHistory_Base ( const FTextId &  InTextId,
FString &&  InSourceString,
FTextConstDisplayStringPtr &&  InLocalizedString 
)

Member Function Documentation

◆ BuildInvariantDisplayString()

FString FTextHistory_Base::BuildInvariantDisplayString ( ) const
overridevirtual

Build the display string for the invariant culture

Implements FTextHistory.

◆ CanUpdateDisplayString()

bool FTextHistory_Base::CanUpdateDisplayString ( )
overridevirtual

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

Reimplemented from FTextHistory.

◆ GetDisplayString()

const FString & FTextHistory_Base::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.

◆ GetLocalizedString()

FTextConstDisplayStringPtr FTextHistory_Base::GetLocalizedString ( ) const
overridevirtual

Get the shared display string (if any).

Reimplemented from FTextHistory.

◆ GetSourceString()

const FString & FTextHistory_Base::GetSourceString ( ) const
overridevirtual

Get the source string for this text.

Reimplemented from FTextHistory.

◆ GetTextId()

FTextId FTextHistory_Base::GetTextId ( ) const
finaloverridevirtual

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

Reimplemented from FTextHistory.

◆ GetType()

virtual ETextHistoryType FTextHistory_Base::GetType ( ) const
inlineoverridevirtual

Get the type of this history

Implements FTextHistory.

◆ IdenticalTo()

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

Serializes the history to/from a structured archive slot

Implements FTextHistory.

◆ UpdateDisplayString()

void FTextHistory_Base::UpdateDisplayString ( )
overridevirtual

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

Implements FTextHistory.

Member Data Documentation

◆ OVERRIDE_TEXT_HISTORY_STRINGIFICATION

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