ITextData

Interface to the internal data for an [FText](API\Runtime\Core\Internationalization\FText).

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Internationalization/ITextData.h

Include

#include "Internationalization/ITextData.h"

Syntax

class ITextData

Remarks

Interface to the internal data for an FText. Various derived types are optimized to reduce memory allocation overhead.

Destructors

Name Description

Public function Virtual

~ITextData()

Functions

Name Description

Public function Const

const FStrin...

 

GetDisplayString()

Get the string to use for display purposes.

Public function Const

uint16

 

GetGlobalHistoryRevision()

Get the global history revision associated with this text instance.

Public function Const

uint16

 

GetLocalHistoryRevision()

Get the local history revision associated with this text instance.

Public function Const

FTextDisplay...

 

GetLocalizedString()

Get the string pointer that was retrieved from the text localization manager.

Public function

FTextDisplay...

 

GetMutableLocalizedString()

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

Public function

FTextHistory...

 

GetMutableTextHistory()

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

Public function Const

const FTextH...

 

GetTextHistory()

Get the history associated with this text.

Public function Const

bool

 

OwnsLocalizedString()

True if this text data owns its localized string pointer, and allows you to call GetMutableLocalizedString on it

Public function

void

 

PersistText()

Persist this text so that it can be stored in the localization manager.

Public function

void

 

SetTextHistory

(
    THistoryType&& InHistory
)

Assign a new history object to this instance.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback