wx.Locale¶

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

In wxWidgets this class manages current locale. It also initializes and activates wx.Translations object that manages message catalogs.

For a list of the supported languages, please see wx.Language enum values. These constants may be used to specify the language in wx.Locale.Init and are returned by wx.Locale.GetSystemLanguage .

Class Hierarchy¶

Inheritance diagram for class Locale:

Methods Summary¶

`__init__`	This is the default constructor and it does nothing to initialize the object: `Init` must be used to do that.
`AddCatalog`	Calls Translations.AddCatalog(const String&).
`AddCatalogLookupPathPrefix`	Calls `wx.FileTranslationsLoader.AddCatalogLookupPathPrefix` .
`AddLanguage`	Adds custom, user-defined language to the database of known languages.
`FindLanguageInfo`	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”).
`GetCanonicalName`	Returns the canonical form of current locale name.
`GetHeaderValue`	Calls `wx.Translations.GetHeaderValue` .
`GetInfo`	Get the values of the given locale-dependent datum.
`GetLanguage`	Returns the wx.Language constant of current language.
`GetLanguageCanonicalName`	Returns canonical name (see `GetCanonicalName` ) of the given language or empty string if this language is unknown.
`GetLanguageInfo`	Returns a pointer to wx.LanguageInfo structure containing information about the given language or `None` if this language is unknown.
`GetLanguageName`	Returns English name of the given language or empty string if this language is unknown.
`GetLocale`	Returns the locale name as passed to the constructor or `Init` .
`GetName`	Returns the current short name for the locale (as given to the constructor or the `Init` function).
`GetOSInfo`	Get the values of a locale datum in the OS locale.
`GetString`	Calls GetTranslation(const String&, String&).
`GetSysName`	Returns current platform-specific locale name as passed to setlocale().
`GetSystemEncoding`	Tries to detect the user’s default font encoding.
`GetSystemEncodingName`	Tries to detect the name of the user’s default font encoding.
`GetSystemLanguage`	Tries to detect the user’s default locale setting.
`Init`	Initializes the wx.Locale instance.
`IsAvailable`	Check whether the operating system and/or C run time environment supports this locale.
`IsLoaded`	Calls `wx.Translations.IsLoaded` .
`IsOk`	Returns `True` if the locale could be set successfully.
`__bool__`
`__nonzero__`

Properties Summary¶

`CanonicalName`	See `GetCanonicalName`
`Language`	See `GetLanguage`
`Locale`	See `GetLocale`
`Name`	See `GetName`
`SysName`	See `GetSysName`

Class API¶

class wx.Locale(object)¶

Possible constructors:

Locale()

Locale(language, flags=LOCALE_LOAD_DEFAULT)

Locale(name, shortName="", locale="",
       bLoadDefault=True)

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

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

__init__ (self)

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

__init__ (self, language, flags=LOCALE_LOAD_DEFAULT)

See Init for parameters description.

Parameters

language (int) –
flags (int) –

__init__ (self, name, shortName=””, locale=””, bLoadDefault=True)

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 wx.Locale object becomes the new current global locale for the application and so all subsequent calls to wx.GetTranslation will try to translate the messages using the message catalogs for this locale.

Parameters

name (string) –
shortName (string) –
locale (string) –
bLoadDefault (bool) –

AddCatalog(self, *args, **kw)¶

Overloaded Implementations:

AddCatalog (self, domain)

Calls Translations.AddCatalog(const String&).

Parameters: domain (string) –
Return type: bool

AddCatalog (self, domain, msgIdLanguage)

Calls wx.Translations.AddCatalog .

Parameters

domain (string) –
msgIdLanguage (Language) –

Return type

bool

AddCatalog (self, domain, msgIdLanguage, msgIdCharset)

Calls wx.Translations.AddCatalog .

Parameters

domain (string) –
msgIdLanguage (Language) –
msgIdCharset (string) –

Return type

bool

static AddCatalogLookupPathPrefix(prefix)¶

Calls wx.FileTranslationsLoader.AddCatalogLookupPathPrefix .

Parameters: prefix (string) –

static AddLanguage(info)¶

Adds custom, user-defined language to the database of known languages.

This database is used in conjunction with the first form of Init .

Parameters: info (wx.LanguageInfo) –

static FindLanguageInfo(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 None if this language is unknown. Note that even if the returned pointer is valid, the caller should not delete it.

Parameters: locale (string) –
Return type: wx.LanguageInfo

Properties¶

CanonicalName¶: See GetCanonicalName

Language¶: See GetLanguage

Locale¶: See GetLocale

Name¶: See GetName

SysName¶: See GetSysName

Navigation

wx.Locale¶

Class Hierarchy¶

Methods Summary¶

Properties Summary¶

Class API¶

Methods¶

Properties¶