cohtml::ILocalizationManager
Takes care of translating text between different locales.
#include <LocalizationManager.h>
Public Classes
| Name | |
|---|---|
| struct | TranslationData The struct should be used by the implementer to set the translated text. Use this struct only in the context of a ILocalizationManager::OnTranslate call. |
Public Functions
| Name | |
|---|---|
| ILocalizationManager() | |
| virtual | ~ILocalizationManager() |
| virtual const char * | Translate(const char * key) DEPRECATED. Use the overload with TranslationData instead. Translates the given text in the currently selected language. The returned value must be UTF-8 encoded and outlive the method - it’s safe to delete the string on the next call to this method or after the system has been uninitialized. Return nullptr if there’s no translation for the text. Your application must take care of tracking the current locale and translating the text according to it. |
| virtual void | Translate(const char * key, TranslationData * data) Translates the given text in the currently selected language. The translated text must be UTF-8. The string will be copied internally during the TranslationData::Set call. Your application must take care of tracking the current locale and translating the text according to it. |
Public Functions Documentation
function ILocalizationManager
ILocalizationManager()
function ~ILocalizationManager
virtual ~ILocalizationManager()
function Translate
inline virtual const char * Translate(
const char * key
)
DEPRECATED. Use the overload with TranslationData instead. Translates the given text in the currently selected language. The returned value must be UTF-8 encoded and outlive the method - it’s safe to delete the string on the next call to this method or after the system has been uninitialized. Return nullptr if there’s no translation for the text. Your application must take care of tracking the current locale and translating the text according to it.
Parameters:
- key the key to the text that needs translation
Return: the translation of the given text, encoded in UTF-8
function Translate
inline virtual void Translate(
const char * key,
TranslationData * data
)
Translates the given text in the currently selected language. The translated text must be UTF-8. The string will be copied internally during the TranslationData::Set call. Your application must take care of tracking the current locale and translating the text according to it.
Parameters:
- key the key to the text that needs translation
- data the object that contains the translated text encoded. This object is valid only for the current call. in UTF-8 and its length in bytes