## wxLocale

wxLocale class encapsulates all language-dependent settings and is a generalization of the C locale concept.

In wxWidgets this class manages message catalogs which contain the translations of the strings used to the current language.

wxPerl note: In wxPerl you can't use the '_' function name, so the `Wx::Locale` module can export the `gettext` and `gettext_noop` under any given name.

      # this imports gettext ( equivalent to Wx::GetTranslation
      # and gettext_noop ( a noop )
      # into your module
      use Wx::Locale qw(:default);

      # ....

      # use the functions
      print gettext( ``Panic!'' );

      button = Wx::Button->new( window, -1, gettext( ``Label'' ) );

If you need to translate a lot of strings, then adding gettext( ) around each one is a long task ( that is why _( ) was introduced ), so just choose a shorter name for gettext:

      #
      use Wx::Locale 'gettext' => 't',
                     'gettext_noop' => 'gettext_noop';

      # ...

      # use the functions
      print t( ``Panic!!'' );

      # ...

Derived from

No base class

See also

Internationalization overview,
Internat sample

Include files

<wx/intl.h>

Members

Supported languages
wxLocale::wxLocale
wxLocale::~wxLocale
wxLocale::AddCatalog
wxLocale::AddCatalogLookupPathPrefix
wxLocale::AddLanguage
wxLocale::FindLanguageInfo
wxLocale::GetCanonicalName
wxLocale::GetLanguage
wxLocale::GetLanguageInfo
wxLocale::GetLanguageName
wxLocale::GetLocale
wxLocale::GetName
wxLocale::GetString
wxLocale::GetHeaderValue
wxLocale::GetSysName
wxLocale::GetSystemEncoding
wxLocale::GetSystemEncodingName
wxLocale::GetSystemLanguage
wxLocale::Init
wxLocale::IsAvailable
wxLocale::IsLoaded
wxLocale::IsOk

### Supported languages

See list of recognized language constants. These constants may be used to specify the language in Init and are returned by GetSystemLanguage:

### wxLocale::wxLocale

wxLocale()

This is the default constructor and it does nothing to initialize the object: Init() must be used to do that.

wxLocale(int language, int flags = wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING)

See Init() for parameters description.

wxLocale(const char *szName, const char *szShort = NULL, const char *szLocale = NULL, bool bLoadDefault = true, bool bConvertEncoding = false)

See Init() for parameters description.

The call of this function has several global side effects which you should understand: first of all, the application locale is changed - note that this will affect many of standard C library functions such as printf() or strftime(). Second, this wxLocale object becomes the new current global locale for the application and so all subsequent calls to wxGetTranslation() will try to translate the messages using the message catalogs for this locale.

### wxLocale::~wxLocale

~wxLocale()

The destructor, like the constructor, also has global side effects: the previously set locale is restored and so the changes described in Init documentation are rolled back.

### wxLocale::AddCatalog

bool AddCatalog(const char *szDomain)

bool AddCatalog(const char *szDomain, wxLanguage msgIdLanguage, const char *msgIdCharset)

Add a catalog for use with the current locale: it is searched for in standard places (current directory first, then the system one), but you may also prepend additional directories to the search path with AddCatalogLookupPathPrefix().

All loaded catalogs will be used for message lookup by GetString() for the current locale.

Returns true if catalog was successfully loaded, false otherwise (which might mean that the catalog is not found or that it isn't in the correct format).

The second form of this method takes two additional arguments, msgIdLanguage and msgIdCharset.

msgIdLanguage specifies the language of "msgid" strings in source code (i.e. arguments to GetString, wxGetTranslation and the _() macro). It is used if AddCatalog cannot find any catalog for current language: if the language is same as source code language, then strings from source code are used instead.

msgIdCharset lets you specify the charset used for msgids in sources in case they use 8-bit characters (e.g. German or French strings). This argument has no effect in Unicode build, because literals in sources are Unicode strings; you have to use compiler-specific method of setting the right charset when compiling with Unicode.

By default (i.e. when you use the first form), msgid strings are assumed to be in English and written only using 7-bit ASCII characters.

If you have to deal with non-English strings or 8-bit characters in the source code, see the instructions in Writing non-English applications.

### wxLocale::AddCatalogLookupPathPrefix

void AddCatalogLookupPathPrefix(const wxString& prefix)

Add a prefix to the catalog lookup path: the message catalog files will be looked up under prefix/<lang>/LC_MESSAGES, prefix/<lang> and prefix (in this order).

This only applies to subsequent invocations of AddCatalog().

### wxLocale::AddLanguage

static void AddLanguage(const wxLanguageInfo& info)

Adds custom, user-defined language to the database of known languages. This database is used in conjunction with the first form of Init.

wxLanguageInfo is defined as follows:

    struct WXDLLEXPORT wxLanguageInfo
    {
        int Language;                   // wxLanguage id
        wxString CanonicalName;         // Canonical name, e.g. fr_FR
    #ifdef __WIN32__
        wxUint32 WinLang, WinSublang;   // Win32 language identifiers
                                        // (LANG_xxxx, SUBLANG_xxxx)
    #endif
        wxString Description;           // human-readable name of the language
    };

Language should be greater than wxLANGUAGE_USER_DEFINED.

wxPerl note: In wxPerl Wx::LanguageInfo has only one method:

Wx::LanguageInfo->new( language, canonicalName, WinLang, WinSubLang, Description )

### wxLocale::FindLanguageInfo

static wxLanguageInfo * FindLanguageInfo(const wxString& locale)

This function may be used to find the language description structure for the given locale, specified either as a two letter ISO language code (for example, "pt"), a language code followed by the country code ("pt_BR") or a full, human readable, language description ("Portuguese-Brazil").

Returns the information for the given language or `NULL` if this language is unknown. Note that even if the returned pointer is valid, the caller should not delete it.

See also

GetLanguageInfo

### wxLocale::GetCanonicalName

wxString GetCanonicalName() const

Returns the canonical form of current locale name. Canonical form is the one that is used on UNIX systems: it is a two- or five-letter string in xx or xx_YY format, where xx is ISO 639 code of language and YY is ISO 3166 code of the country. Examples are "en", "en_GB", "en_US" or "fr_FR".

This form is internally used when looking up message catalogs.

Compare GetSysName.

### wxLocale::GetLanguage

int GetLanguage() const

Returns wxLanguage constant of current language. Note that you can call this function only if you used the form of Init that takes wxLanguage argument.

### wxLocale::GetLanguageInfo

static wxLanguageInfo * GetLanguageInfo(int lang) const

Returns a pointer to wxLanguageInfo structure containing information about the given language or `NULL` if this language is unknown. Note that even if the returned pointer is valid, the caller should not delete it.

See AddLanguage for the wxLanguageInfo description.

As with Init, `wxLANGUAGE_DEFAULT` has the special meaning if passed as an argument to this function and in this case the result of GetSystemLanguage() is used.

### wxLocale::GetLanguageName

static wxString GetLanguageName(int lang) const

Returns English name of the given language or empty string if this language is unknown.

See GetLanguageInfo for a remark about special meaning of `wxLANGUAGE_DEFAULT`.

### wxLocale::GetLocale

const char* GetLocale() const

Returns the locale name as passed to the constructor or Init(). This is full, human-readable name, e.g. "English" or "French".

### wxLocale::GetName

const wxString& GetName() const

Returns the current short name for the locale (as given to the constructor or the Init() function).

### wxLocale::GetString

const char* GetString(const char *szOrigString, const char *szDomain = NULL) const

const char* GetString(const char *szOrigString, const char *szOrigString2, size_t n, const char *szDomain = NULL) const

Retrieves the translation for a string in all loaded domains unless the szDomain parameter is specified (and then only this catalog/domain is searched).

Returns original string if translation is not available (in this case an error message is generated the first time a string is not found; use wxLogNull to suppress it).

The second form is used when retrieving translation of string that has different singular and plural form in English or different plural forms in some other language. It takes two extra arguments: szOrigString parameter must contain the singular form of the string to be converted. It is also used as the key for the search in the catalog. The szOrigString2 parameter is the plural form (in English). The parameter n is used to determine the plural form. If no message catalog is found szOrigString is returned if 'n == 1', otherwise szOrigString2. See GNU gettext manual for additional information on plural forms handling.

This method is called by the wxGetTranslation function and _() macro.

Remarks

Domains are searched in the last to first order, i.e. catalogs added later override those added before.

### wxLocale::GetHeaderValue

wxString GetHeaderValue(const char *szHeader, const char *szDomain = NULL) const

Returns the header value for header szHeader. The search for szHeader is case sensitive. If an szDomain is passed, this domain is searched. Else all domains will be searched until a header has been found. The return value is the value of the header if found. Else this will be empty.

### wxLocale::GetSysName

wxString GetSysName() const

Returns current platform-specific locale name as passed to setlocale().

Compare GetCanonicalName.

### wxLocale::GetSystemEncoding

static wxFontEncoding GetSystemEncoding() const

Tries to detect the user's default font encoding. Returns wxFontEncoding value or wxFONTENCODING_SYSTEM if it couldn't be determined.

### wxLocale::GetSystemEncodingName

static wxString GetSystemEncodingName() const

Tries to detect the name of the user's default font encoding. This string isn't particularly useful for the application as its form is platform-dependent and so you should probably use GetSystemEncoding instead.

Returns a user-readable string value or an empty string if it couldn't be determined.

### wxLocale::GetSystemLanguage

static int GetSystemLanguage() const

Tries to detect the user's default language setting. Returns wxLanguage value or wxLANGUAGE_UNKNOWN if the language-guessing algorithm failed.

### wxLocale::Init

bool Init(int language = wxLANGUAGE_DEFAULT, int flags = wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING)

bool Init(const char *szName, const char *szShort = NULL, const char *szLocale = NULL, bool bLoadDefault = true, bool bConvertEncoding = false)

The second form is deprecated, use the first one unless you know what you are doing.

Parameters

language

wxLanguage identifier of the locale. wxLANGUAGE_DEFAULT has special meaning -- wxLocale will use system's default language (see GetSystemLanguage).

flags

Combination of the following:

wxLOCALE_LOAD_DEFAULT | Load the message catalog for the given locale containing the translations of standard wxWidgets messages automatically.
wxLOCALE_CONV_ENCODING | Automatically convert message catalogs to platform's default encoding. Note that it will do only basic conversion between well-known pair like iso8859-1 and windows-1252 or iso8859-2 and windows-1250. See Writing non-English applications for detailed description of this behaviour. Note that this flag is meaningless in Unicode build.

szName

The name of the locale. Only used in diagnostic messages.

szShort

The standard 2 letter locale abbreviation; it is used as the directory prefix when looking for the message catalog files.

szLocale

The parameter for the call to setlocale(). Note that it is platform-specific.

bLoadDefault

May be set to false to prevent loading of the message catalog for the given locale containing the translations of standard wxWidgets messages. This parameter would be rarely used in normal circumstances.

bConvertEncoding

May be set to true to do automatic conversion of message catalogs to platform's native encoding. Note that it will do only basic conversion between well-known pair like iso8859-1 and windows-1252 or iso8859-2 and windows-1250. See Writing non-English applications for detailed description of this behaviour.

The call of this function has several global side effects which you should understand: first of all, the application locale is changed - note that this will affect many of standard C library functions such as printf() or strftime(). Second, this wxLocale object becomes the new current global locale for the application and so all subsequent calls to wxGetTranslation() will try to translate the messages using the message catalogs for this locale.

Returns true on success or false if the given locale couldn't be set.

### wxLocale::IsAvailable

static bool IsAvailable(int lang)

Check whether the operating system and/or C run time environment supports this locale. For example in Windows 2000 and Windows XP, support for many locales is not installed by default. Returns `true` if the locale is supported.

The argument lang is the wxLanguage identifier. To obtain this for a given a two letter ISO language code, use FindLanguageInfo to obtain its wxLanguageInfo structure. See AddLanguage for the wxLanguageInfo description.

This function is new since wxWidgets version 2.7.1.

### wxLocale::IsLoaded

bool IsLoaded(const char* domain) const

Check if the given catalog is loaded, and returns true if it is.

According to GNU gettext tradition, each catalog normally corresponds to 'domain' which is more or less the application name.

See also: AddCatalog

### wxLocale::IsOk

bool IsOk() const

Returns true if the locale could be set successfully.