FLocMetadataObject Class Reference

#include <InternationalizationMetadata.h>

Public Member Functions
	FLocMetadataObject ()
CORE_API	FLocMetadataObject (const FLocMetadataObject &Other)
template<ELocMetadataType LocMetadataType>
TSharedPtr< FLocMetadataValue >	GetField (const FString &FieldName)
bool	HasField (const FString &FieldName)
template<ELocMetadataType LocMetadataType>
bool	HasTypedField (const FString &FieldName)
CORE_API void	SetField (const FString &FieldName, const TSharedPtr< FLocMetadataValue > &Value)
CORE_API void	RemoveField (const FString &FieldName)
CORE_API FString	GetStringField (const FString &FieldName)
CORE_API void	SetStringField (const FString &FieldName, const FString &StringValue)
CORE_API bool	GetBoolField (const FString &FieldName)
CORE_API void	SetBoolField (const FString &FieldName, bool InValue)
CORE_API TArray< TSharedPtr< FLocMetadataValue > >	GetArrayField (const FString &FieldName)
CORE_API void	SetArrayField (const FString &FieldName, const TArray< TSharedPtr< FLocMetadataValue > > &Array)
CORE_API TSharedPtr< FLocMetadataObject >	GetObjectField (const FString &FieldName)
CORE_API void	SetObjectField (const FString &FieldName, const TSharedPtr< FLocMetadataObject > &LocMetadataObject)
CORE_API FLocMetadataObject &	operator= (const FLocMetadataObject &Other)
CORE_API bool	operator== (const FLocMetadataObject &Other) const
CORE_API bool	operator< (const FLocMetadataObject &Other) const
CORE_API bool	IsExactMatch (const FLocMetadataObject &Other) const
CORE_API FString	ToString () const

Static Public Member Functions
static CORE_API bool	IsMetadataExactMatch (const FLocMetadataObject *const MetadataA, const FLocMetadataObject *const MetadataB)

Public Attributes
TMap< FString, TSharedPtr< FLocMetadataValue > >	Values

Static Public Attributes
static CORE_API const TCHAR *	COMPARISON_MODIFIER_PREFIX = TEXT("*")

Friends
CORE_API friend FArchive &	operator<< (FArchive &Archive, FLocMetadataObject &Object)
CORE_API friend void	operator<< (FStructuredArchive::FSlot Slot, FLocMetadataObject &Object)

Detailed Description

A LocMetadata Object is a structure holding an unordered set of name/value pairs.

Constructor & Destructor Documentation

FLocMetadataObject() [1/2]

FLocMetadataObject::FLocMetadataObject ( )

inline

FLocMetadataObject() [2/2]

FLocMetadataObject::FLocMetadataObject

(

const FLocMetadataObject &

Other

)

Copy ctor

Member Function Documentation

GetArrayField()

TArray< TSharedPtr< FLocMetadataValue > > FLocMetadataObject::GetArrayField

(

const FString &

FieldName

)

Get the field named FieldName as an array. Ensures that the field is present and is of type LocMetadata Array.

GetBoolField()

bool FLocMetadataObject::GetBoolField

(

const FString &

FieldName

)

Get the field named FieldName as a boolean. Ensures that the field is present and is of type LocMetadata boolean.

GetField()

template<ELocMetadataType LocMetadataType>

TSharedPtr< FLocMetadataValue > FLocMetadataObject::GetField ( const FString &  FieldName )

inline

GetObjectField()

TSharedPtr< FLocMetadataObject > FLocMetadataObject::GetObjectField

(

const FString &

FieldName

)

Get the field named FieldName as a LocMetadata object. Ensures that the field is present and is a LocMetadata object

GetStringField()

FString FLocMetadataObject::GetStringField

(

const FString &

FieldName

)

Get the field named FieldName as a string. Ensures that the field is present and is of type LocMetadata string.

HasField()

bool FLocMetadataObject::HasField ( const FString &  FieldName )

inline

Checks to see if the FieldName exists in the object.

HasTypedField()

template<ELocMetadataType LocMetadataType>

bool FLocMetadataObject::HasTypedField ( const FString &  FieldName )

inline

Checks to see if the FieldName exists in the object, and has the specified type.

IsExactMatch()

bool FLocMetadataObject::IsExactMatch

(

const FLocMetadataObject &

Other

)

const

Similar functionality to == operator but ensures everything matches(ignores COMPARISON_MODIFIER_PREFIX).

IsMetadataExactMatch()

bool FLocMetadataObject::IsMetadataExactMatch ( const FLocMetadataObject *const  MetadataA, const FLocMetadataObject *const  MetadataB  )

static

operator<()

bool FLocMetadataObject::operator<

(

const FLocMetadataObject &

Other

)

const

operator=()

FLocMetadataObject & FLocMetadataObject::operator=

(

const FLocMetadataObject &

Other

)

operator==()

bool FLocMetadataObject::operator==

(

const FLocMetadataObject &

Other

)

const

RemoveField()

void FLocMetadataObject::RemoveField

(

const FString &

FieldName

)

SetArrayField()

void FLocMetadataObject::SetArrayField	(	const FString &	FieldName,
		const TArray< TSharedPtr< FLocMetadataValue > > &	Array
	)

Set an array field named FieldName and value of Array

SetBoolField()

void FLocMetadataObject::SetBoolField	(	const FString &	FieldName,
		bool	InValue
	)

Set a boolean field named FieldName and value of InValue

SetField()

void FLocMetadataObject::SetField	(	const FString &	FieldName,
		const TSharedPtr< FLocMetadataValue > &	Value
	)

SetObjectField()

void FLocMetadataObject::SetObjectField	(	const FString &	FieldName,
		const TSharedPtr< FLocMetadataObject > &	LocMetadataObject
	)

Set an ObjectField named FieldName and value of LocMetadataObject

SetStringField()

void FLocMetadataObject::SetStringField	(	const FString &	FieldName,
		const FString &	StringValue
	)

Add a field named FieldName with value of StringValue

ToString()

FString FLocMetadataObject::ToString

(

)

const

Friends And Related Symbol Documentation

operator<< [1/2]

CORE_API friend FArchive & operator<< ( FArchive &  Archive, FLocMetadataObject &  Object  )

friend

operator<< [2/2]

CORE_API friend void operator<< ( FStructuredArchive::FSlot  Slot, FLocMetadataObject &  Object  )

friend

Member Data Documentation

COMPARISON_MODIFIER_PREFIX

const TCHAR * FLocMetadataObject::COMPARISON_MODIFIER_PREFIX = TEXT("*")

static

Special reserved character. When encountered as a prefix metadata name(the key in the Values map), it will adjust the way comparisons are done.

Values

TMap< FString, TSharedPtr<FLocMetadataValue> > FLocMetadataObject::Values

Stores the name/value pairs for the metadata object

---

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

• Engine/Source/Runtime/Core/Public/Internationalization/InternationalizationMetadata.h
• Engine/Source/Runtime/Core/Private/Internationalization/InternationalizationMetadata.cpp