xiiTranslatorFromFiles Class Reference

Loads translations from files. Each translator can have different search paths, but the files to be loaded are the same for all of them. More...

#include <TranslationLookup.h>

Inheritance diagram for xiiTranslatorFromFiles:

Public Member Functions
void	AddTranslationFilesFromFolder (xiiStringView sFolder)
	Loads all files recursively from the specified folder as translation files.
virtual xiiStringView	Translate (xiiStringView sString, xiiUInt64 uiStringHash, xiiTranslationUsage usage) override
	Returns the translated string for uiStringHash, or nullptr, if not available.
virtual void	Reload () override
	Simply executes Reset() on this translator.
Public Member Functions inherited from xiiTranslatorStorage
virtual void	StoreTranslation (xiiStringView sString, xiiUInt64 uiStringHash, xiiTranslationUsage usage)
	Stores sString as the translation for the string with the given hash.
virtual void	Reset () override
	Clears all stored translation strings.

Additional Inherited Members
Static Public Member Functions inherited from xiiTranslator
static void	ReloadAllTranslators ()
	Will call Reload() on all currently active translators.
static void	HighlightUntranslated (bool bHighlight)
static bool	GetHighlightUntranslated ()
Protected Attributes inherited from xiiTranslatorStorage
xiiMap< xiiUInt64, xiiString >	m_Translations [(xiiInt32) xiiTranslationUsage::ENUM_COUNT]

Detailed Description

Loads translations from files. Each translator can have different search paths, but the files to be loaded are the same for all of them.

Member Function Documentation

AddTranslationFilesFromFolder()

void xiiTranslatorFromFiles::AddTranslationFilesFromFolder

(

xiiStringView

sFolder

)

Loads all files recursively from the specified folder as translation files.

The given path must be absolute or resolvable to an absolute path. On failure, the function does nothing. This function depends on xiiFileSystemIterator to be available.

Reload()

void xiiTranslatorFromFiles::Reload ( )

overridevirtual

Simply executes Reset() on this translator.

Reimplemented from xiiTranslatorStorage.

Translate()

xiiStringView xiiTranslatorFromFiles::Translate ( xiiStringView sString, xiiUInt64 uiStringHash, xiiTranslationUsage usage )

overridevirtual

Returns the translated string for uiStringHash, or nullptr, if not available.

Reimplemented from xiiTranslatorStorage.

---

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

• /home/runner/work/XII/XII/Source/Engine/Foundation/Strings/TranslationLookup.h
• /home/runner/work/XII/XII/Source/Engine/Foundation/Strings/Implementation/TranslationLookup.cpp