#include <StringTableCore.h>

Inheritance diagram for FStringTable:

Public Member Functions
CORE_API	FStringTable ()

CORE_API	~FStringTable ()

CORE_API UStringTable *	GetOwnerAsset () const

CORE_API void	SetOwnerAsset (UStringTable *InOwnerAsset)

CORE_API bool	IsLoaded () const

CORE_API void	IsLoaded (const bool bInIsLoaded)

CORE_API bool	IsInternal () const

CORE_API void	IsInternal (const bool bInIsInternal)

CORE_API FString	GetNamespace () const

CORE_API void	SetNamespace (const FTextKey &InNamespace)

CORE_API bool	GetSourceString (const FTextKey &InKey, FString &OutSourceString) const

CORE_API void	SetSourceString (const FTextKey &InKey, const FString &InSourceString)

CORE_API void	RemoveSourceString (const FTextKey &InKey)

CORE_API void	EnumerateSourceStrings (const TFunctionRef< bool(const FString &, const FString &)> &InEnumerator) const

CORE_API void	EnumerateKeysAndSourceStrings (const TFunctionRef< bool(const FTextKey &, const FString &)> &InEnumerator) const

CORE_API void	ClearSourceStrings (const int32 InSlack=0)

CORE_API FStringTableEntryConstPtr	FindEntry (const FTextKey &InKey) const

CORE_API bool	FindKey (const FStringTableEntryConstRef &InEntry, FString &OutKey) const

CORE_API bool	FindKey (const FStringTableEntryConstRef &InEntry, FTextKey &OutKey) const

CORE_API FString	GetMetaData (const FTextKey &InKey, const FName InMetaDataId) const

CORE_API void	SetMetaData (const FTextKey &InKey, const FName InMetaDataId, const FString &InMetaDataValue)

CORE_API void	RemoveMetaData (const FTextKey &InKey, const FName InMetaDataId)

CORE_API void	EnumerateMetaData (const FTextKey &InKey, const TFunctionRef< bool(FName, const FString &)> &InEnumerator) const

CORE_API void	ClearMetaData (const FTextKey &InKey)

CORE_API void	ClearMetaData (const int32 InSlack=0)

CORE_API void	Serialize (FArchive &Ar)

CORE_API bool	ExportStrings (const FString &InFilename) const

CORE_API bool	ImportStrings (const FString &InFilename)

Public Member Functions inherited from TSharedFromThis< FStringTable, ESPMode::ThreadSafe >
TSharedRef< FStringTable, Mode >	AsShared ()

TSharedRef< FStringTable const, Mode >	AsShared () const

TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const

TWeakPtr< FStringTable, Mode >	AsWeak ()

TWeakPtr< FStringTable const, Mode >	AsWeak () const

TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const

void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const InSharedPtr, OtherType InObject) const

void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const InSharedRef, OtherType InObject) const

UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Static Public Member Functions
static FStringTableRef	NewStringTable ()

Additional Inherited Members
Protected Member Functions inherited from TSharedFromThis< FStringTable, ESPMode::ThreadSafe >
	TSharedFromThis ()

	TSharedFromThis (TSharedFromThis const &)

UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)

	~TSharedFromThis ()

Static Protected Member Functions inherited from TSharedFromThis< FStringTable, ESPMode::ThreadSafe >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)

static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

String table implementation. Holds Key->SourceString pairs of text.

Constructor & Destructor Documentation

◆ FStringTable()

FStringTable::FStringTable ( )

Default constructor

◆ ~FStringTable()

FStringTable::~FStringTable ( )

Destructor

Member Function Documentation

◆ ClearMetaData() [1/2]

void FStringTable::ClearMetaData ( const FTextKey & InKey )

Remove all meta-data associated with the given entry

◆ ClearMetaData() [2/2]

void FStringTable::ClearMetaData ( const int32 InSlack = 0 )

Clear all meta-data from the table

◆ ClearSourceStrings()

void FStringTable::ClearSourceStrings ( const int32 InSlack = 0 )

Clear all entries from the table (including their meta-data)

◆ EnumerateKeysAndSourceStrings()

void FStringTable::EnumerateKeysAndSourceStrings ( const TFunctionRef< bool(const FTextKey &, const FString &)> & InEnumerator ) const

◆ EnumerateMetaData()

void FStringTable::EnumerateMetaData	(	const FTextKey &	InKey,
		const TFunctionRef< bool(FName, const FString &)> &	InEnumerator
	)		const

Enumerate all meta-data associated with the given entry. Return true from the enumerator to continue, or false to stop

◆ EnumerateSourceStrings()

void FStringTable::EnumerateSourceStrings ( const TFunctionRef< bool(const FString &, const FString &)> & InEnumerator ) const

Enumerate all source strings in the table. Return true from the enumerator to continue, or false to stop

◆ ExportStrings()

bool FStringTable::ExportStrings ( const FString & InFilename ) const

Export the key, string, and meta-data information in this string table to a CSV file (does not export the namespace)

◆ FindEntry()

FStringTableEntryConstPtr FStringTable::FindEntry ( const FTextKey & InKey ) const

Find the entry with the given key (if any)

◆ FindKey() [1/2]

bool FStringTable::FindKey	(	const FStringTableEntryConstRef &	InEntry,
		FString &	OutKey
	)		const

Given an entry, check to see if it exists in this table, and if so, get its key

◆ FindKey() [2/2]

bool FStringTable::FindKey	(	const FStringTableEntryConstRef &	InEntry,
		FTextKey &	OutKey
	)		const

◆ GetMetaData()

FString FStringTable::GetMetaData	(	const FTextKey &	InKey,
		const FName	InMetaDataId
	)		const

Get the meta-data with the given ID associated with the given entry, or an empty string if not found

◆ GetNamespace()

FString FStringTable::GetNamespace ( ) const

Returns: The namespace used by all entries in this string table

◆ GetOwnerAsset()

UStringTable * FStringTable::GetOwnerAsset ( ) const

Returns: The asset that owns this string table instance (if any)

◆ GetSourceString()

bool FStringTable::GetSourceString	(	const FTextKey &	InKey,
		FString &	OutSourceString
	)		const

Get the source string used by the given entry (if any)

◆ ImportStrings()

bool FStringTable::ImportStrings ( const FString & InFilename )

Import key, string, and meta-data information from a CSV file to this string table (does not import the namespace)

◆ IsInternal() [1/2]

bool FStringTable::IsInternal ( ) const

Is this string table considered internal (ie, shouldn't appear in pickers)

◆ IsInternal() [2/2]

void FStringTable::IsInternal ( const bool bInIsInternal )

Set whether this string table is considered internal

◆ IsLoaded() [1/2]

bool FStringTable::IsLoaded ( ) const

Has this string table been fully loaded yet? (used during asset loading)

◆ IsLoaded() [2/2]

void FStringTable::IsLoaded ( const bool bInIsLoaded )

Set whether this string table has been fully loaded

◆ NewStringTable()

static FStringTableRef FStringTable::NewStringTable ( )

inlinestatic

Create a new string table

◆ RemoveMetaData()

void FStringTable::RemoveMetaData	(	const FTextKey &	InKey,
		const FName	InMetaDataId
	)

Remove the meta-data with the given ID associated with the given entry

◆ RemoveSourceString()

void FStringTable::RemoveSourceString ( const FTextKey & InKey )

Remove the given entry (including its meta-data)

◆ Serialize()

void FStringTable::Serialize ( FArchive & Ar )

Serialize this string table to/from an archive

◆ SetMetaData()

void FStringTable::SetMetaData	(	const FTextKey &	InKey,
		const FName	InMetaDataId,
		const FString &	InMetaDataValue
	)

Set the meta-data with the given ID associated with the given entry

◆ SetNamespace()

void FStringTable::SetNamespace ( const FTextKey & InNamespace )

Set the namespace used by all entries in this string table

◆ SetOwnerAsset()

void FStringTable::SetOwnerAsset ( UStringTable * InOwnerAsset )

Set the asset that owns this string table instance (if any)

◆ SetSourceString()

void FStringTable::SetSourceString	(	const FTextKey &	InKey,
		const FString &	InSourceString
	)

Set the source string used by the given entry (will replace any existing data for that entry)

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

Engine/Source/Runtime/Core/Public/Internationalization/StringTableCore.h
Engine/Source/Runtime/Core/Private/Internationalization/StringTableCore.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members