Translations

This class allows to get translations for strings.

In wxWidgets this class manages message catalogs which contain the translations of the strings used to the current language. Unlike Locale, it isn’t bound to locale. It can be used either independently of, or in conjunction with Locale. In the latter case, you should initialize Locale (which creates Translations instance) first; in the former, you need to create a Translations object and Set it manually.

Only one Translations instance is active at a time; it is set with the Set method and obtained using Get.

Unlike Locale, Translations’ primary mean of identifying language is by its “canonical name”, i.e. ISO 639 code, possibly combined with ISO 3166 country code and additional modifiers (examples include “fr”, “en_GB” or “ca@valencia”; see Locale.GetCanonicalName for more information). This allows apps using Translations API to use even languages not recognized by the operating system or not listed in Language enum.

New in version 2.9.1.

See also

Locale

Inheritance Diagram

Inheritance diagram for class Translations

Methods Summary

__init__	Constructor.
AddCatalog	Add a catalog for use with the current locale.
AddStdCatalog	Add standard wxWidgets catalogs (“wxstd” and possible port-specific catalogs).
Get	Returns current translations object, may return None.
GetAvailableTranslations	Returns list of all translations of domain that were found.
GetHeaderValue	Returns the header value for header header.
GetString	Retrieves the translation for a string in all loaded domains unless the domain parameter is specified (and then only this catalog/domain is searched).
IsLoaded	Check if the given catalog is loaded, and returns True if it is.
Set	Sets current translations object.
SetLanguage	Sets translations language to use.
SetLoader	Changes loader use to read catalogs to a non-default one.

Class API

---

class Translations(object)

This class allows to get translations for strings.

Possible constructors:

Translations()

Methods

---

__init__(self)

Constructor.

---

AddCatalog(self, *args, **kw)

Overloaded Implementations:

---

AddCatalog (self, domain)

Add a catalog for use with the current locale.

By default, it is searched for in standard places (see FileTranslationsLoader), but you may also prepend additional directories to the search path with FileTranslationsLoader.AddCatalogLookupPathPrefix .

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

In this overload, 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.

Parameters:domain (string) – Return type:bool 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).

---

AddCatalog (self, domain, msgIdLanguage)

Same as AddCatalog , but takes an additional argument, msgIdLanguage.

Parameters:

• domain (string) – The catalog domain to add.
• msgIdLanguage (Language) – Specifies the language of “msgid” strings in source code (i.e. arguments to GetString , GetTranslation 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.

Return type:

bool

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).

---

---

AddStdCatalog(self)

Add standard wxWidgets catalogs (“wxstd” and possible port-specific catalogs).

Return type:bool Returns:True if a suitable catalog was found, False otherwise

See also

AddCatalog

---

static Get()

Returns current translations object, may return None.

You must either call this early in app initialization code, or let Locale do it for you.

Return type: Translations

---

GetAvailableTranslations(self, domain)

Returns list of all translations of domain that were found.

This method can be used e.g. to populate list of application’s translations offered to the user. To do this, pass the app’s main catalog as domain.

Parameters:domain (string) – Return type:list of strings

---

GetHeaderValue(self, header, domain='')

Returns the header value for header header.

The search for header is case sensitive. If an domain 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.

Parameters:

• header (string) –
• domain (string) –

Return type:

string

---

GetString(self, *args, **kw)

Overloaded Implementations:

---

GetString (self, origString, domain=’‘)

Retrieves the translation for a string in all loaded domains unless the domain 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 LogNull to suppress it).

Parameters:

• origString (string) –
• domain (string) –

Return type:

string

Note

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

---

GetString (self, origString, origString2, n, domain=’‘)

Retrieves the translation for a string in all loaded domains unless the domain 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 LogNull to suppress it).

This 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: origString 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 origString2 parameter is the plural form (in English).

The parameter n is used to determine the plural form. If no message catalog is found origString is returned if ‘n == 1’, otherwise origString2.

See GNU gettext manual for additional information on plural forms handling. This method is called by the GetTranslation function and _ macro.

Parameters:

• origString (string) –
• origString2 (string) –
• n –
• domain (string) –

Return type:

string

Note

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

---

---

IsLoaded(self, domain)

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.

Parameters:domain (string) – Return type:bool

See also

AddCatalog

---

static Set(t)

Sets current translations object.

Deletes previous translation object and takes ownership of t.

Parameters:t (Translations) –

---

SetLanguage(self, *args, **kw)

Overloaded Implementations:

---

SetLanguage (self, lang)

Sets translations language to use.

LANGUAGE_DEFAULT has special meaning: best suitable translation, given user’s preference and available translations, will be used.

Parameters:lang (Language) –

---

SetLanguage (self, lang)

Sets translations language to use.

Empty lang string has the same meaning as LANGUAGE_DEFAULT in SetLanguage : best suitable translation, given user’s preference and available translations, will be used.

Parameters:lang (string) –

---

---

SetLoader(self, loader)

Changes loader use to read catalogs to a non-default one.

Deletes previous loader and takes ownership of loader.

Parameters:loader (TranslationsLoader) –

See also

TranslationsLoader, FileTranslationsLoader, ResourceTranslationsLoader