FPortableObjectFormatDOM

Contains all the info we need to represent files in the Portable Object format.

Windows
MacOS
Linux

References

Module

Localization

Header

/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h

Include

#include "PortableObjectFormatDOM.h"

Syntax

class FPortableObjectFormatDOM

Remarks

Contains all the info we need to represent files in the Portable Object format.

Constructors

Name Description

Public function

FPortableObjectFormatDOM()

Public function

FPortableObjectFormatDOM

(
    const FString& LanguageCode
)

Public function

FPortableObjectFormatDOM

(
    const FPortableObjectFormatDOM&
)

Copying is not supported

Functions

Name Description

Public function

bool

 

AddEntry

(
    const TSharedRef< FPortableObjectEn...
)

Adds a translation entry to the Portable Object.

Public function

void

 

CreateNewHeader()

Creates a header entry based on the project and language info.

Public function Const

TSharedPtr< ...

 

FindEntry

(
    const TSharedRef< const FPortableOb...
)

Returns the Portable Object entry that matches the passed in entry or NULL if not found

Public function Const

TSharedPtr< ...

 

FindEntry

(
    const FString& MsgId,
    const FString& MsgIdPlural,
    const FString& MsgCtxt
)

Returns the Portable Object file entry that matches the passed in parameters or NULL if not found

Public function

bool

 

FromString

(
    const FString& InStr,
    FText* OutErrorMsg
)

Parses Portable Object elements from a string.

Public function Const

FPortableObj...

 

GetEntriesIterator()

Public function Const

FString

 

GetProjectName()

Sets the project name from the Project-Id-Version header entry

Public function

bool

 

SetLanguage

(
    const FString& LanguageCode,
    const FString& LangPluralForms
)

Sets the language.

Public function

void

 

SetProjectName

(
    const FString& ProjName
)

Sets the project name that will appear in the Project-Id-Version header entry

Public function

void

 

SortEntries()

Public function

FString

 

ToString()

Creates a string representation of the Portable Object.

Operators

Name Description

Public function

FPortableObj...

 

operator=

(
    const FPortableObjectFormatDOM&
)

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss