struct CCL::ILocaleManager

Overview

#include <ilocalemanager.h>

struct ILocaleManager: public CCL::IUnknown
{
    // fields

    UrlRef path;
    UrlRef StringID tableID;
    UrlRef StringID IAttributeList* variables = nullptr) = 0;

    // methods

    virtual void CCL_API setLanguage (StringID language) = 0;
    virtual StringID CCL_API getLanguage () const = 0;
    virtual const ILocaleInfo&CCL_API getCurrentLocale () const = 0;
    virtual const ILocaleInfo*CCL_API getLocale (StringID language) const = 0;
    DECLARE_STRINGID_MEMBER (kMainTableID);

    virtual tresult CCL_API loadModuleStrings (
        ITranslationTable*& table,
        ModuleRef module,
        StringID tableID,
        IAttributeList* variables = nullptr
    ) = 0;

    virtual ITranslationTable*CCL_API getStrings (StringID tableID) const = 0;
    virtual tresult CCL_API unloadStrings (ITranslationTable* table) = 0;
    virtual int CCL_API scanLanguagePacks (UrlRef url) = 0;
    virtual IUnknownIterator*CCL_API createLanguagePackIterator () const = 0;
    virtual const ILanguagePack*CCL_API getActiveLanguagePack () const = 0;
    virtual tresult CCL_API setActiveLanguagePack (const ILanguagePack* languagePack) = 0;
    virtual const FileType&CCL_API getLanguagePackFileType () const = 0;
    virtual void CCL_API getLanguagesFolder (IUrl& url) const = 0;
    virtual StringID CCL_API getSystemLanguage () const = 0;
    virtual StringID CCL_API getInputLanguage () const = 0;
    virtual IUnknownIterator*CCL_API createGeographicRegionIterator () const = 0;
    virtual StringID CCL_API getSystemRegion () const = 0;

    virtual uchar CCL_API getCharacterOnKey (
        uchar characterUS,
        tbool withCapsLock = false
    ) const = 0;

    virtual StringID CCL_API getMeasureSystem () const = 0;
};

Inherited Members

public:
    // methods

    virtual tresult CCL_API queryInterface (UIDRef iid, void** ptr) = 0;
    virtual unsigned int CCL_API retain () = 0;
    virtual unsigned int CCL_API release () = 0;

Detailed Documentation

Methods

virtual void CCL_API setLanguage (StringID language) = 0

Set current application language (e.g.

“en”).

virtual StringID CCL_API getLanguage () const = 0

Get current application language (e.g.

“en”).

virtual const ILocaleInfo&CCL_API getCurrentLocale () const = 0

Get information for current locale.

virtual const ILocaleInfo*CCL_API getLocale (StringID language) const = 0

Get locale information by language identifier.

DECLARE_STRINGID_MEMBER (kMainTableID)

Load translation table.

virtual tresult CCL_API loadModuleStrings (
    ITranslationTable*& table,
    ModuleRef module,
    StringID tableID,
    IAttributeList* variables = nullptr
) = 0

Load translation table of given module.

virtual ITranslationTable*CCL_API getStrings (StringID tableID) const = 0

Get translation table.

virtual tresult CCL_API unloadStrings (ITranslationTable* table) = 0

Unload translation table.

virtual int CCL_API scanLanguagePacks (UrlRef url) = 0

Scan for language packs at given location.

virtual IUnknownIterator*CCL_API createLanguagePackIterator () const = 0

Create iterator for registered language packs (ILanguagePack).

virtual const ILanguagePack*CCL_API getActiveLanguagePack () const = 0

Get currently active language pack (can be null).

virtual tresult CCL_API setActiveLanguagePack (const ILanguagePack* languagePack) = 0

Set active language pack (can be null to reset, requires application restart).

virtual const FileType&CCL_API getLanguagePackFileType () const = 0

Get language pack file type.

virtual void CCL_API getLanguagesFolder (IUrl& url) const = 0

Get application languages folder.

virtual StringID CCL_API getSystemLanguage () const = 0

Get system UI language.

virtual StringID CCL_API getInputLanguage () const = 0

Get input language (keyboard layout) of calling thread.

virtual IUnknownIterator*CCL_API createGeographicRegionIterator () const = 0

Create iterator for geographic regions (IGeographicRegion) provided by the system.

virtual StringID CCL_API getSystemRegion () const = 0

Get system region ISO 3166-1 alpha-2 code.