1. Epic GamesDeveloper
  3. FPortableObjectFormatDOM

FPortableObjectFormatDOM

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

API > API/Developer > API/Developer/Localization

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

  Type Name Description
Public function    
Public function  

FPortableObjectFormatDOM ( const FString& LanguageCode
)

  
Public function   Copying is not supported

Functions

  Type Name Description
Public function bool

AddEntry ( const TSharedRef< FPortableObjectEntry > LocEntry
)

 Adds a translation entry to the Portable Object.
Public function void

CreateNewHeader ( const FString& InCopyrightNotice
)

 Creates a header entry based on the project and language info.
Public function Const TSharedPtr< FPortableObjectEntry >

FindEntry ( const TSharedRef< const FPortableObjectEntry > LocEntry
)

 Returns the Portable Object entry that matches the passed in entry or NULL if not found
Public function Const TSharedPtr< FPortableObjectEntry >

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 FPortableObjectEntries::TConstIterator  
Public function Const FString Sets the project name from the Project-Id-Version header entry
Public function void

SetHeaderValue ( const FString& EntryKey,
const FString& EntryValue
)

 Sets a header entry value. Must be called after CreateNewHeader.
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  
Public function FString Creates a string representation of the Portable Object.

Operators

  Type Name Description
Public function FPortableObjectFormatDOM &  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page