// Purpose: interface of wxLocale
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
};
/**
- Encapsulates a ::wxLanguage indentifier together with OS-specific information
+ Encapsulates a ::wxLanguage identifier together with OS-specific information
related to that language.
@beginWxPerlOnly
- Wx::LanguageInfo->new(language, canonicalName, WinLang, WinSubLang, Description)
@endWxPerlOnly
*/
-struct WXDLLIMPEXP_BASE wxLanguageInfo
+struct wxLanguageInfo
{
/// ::wxLanguage id.
/// It should be greater than @c wxLANGUAGE_USER_DEFINED when defining your own
translate the messages using the message catalogs for this locale.
*/
wxLocale(const wxString& name,
- const wxString& short = wxEmptyString,
+ const wxString& shortName = wxEmptyString,
const wxString& locale = wxEmptyString,
bool bLoadDefault = true);
const wxString& domain = wxEmptyString) const;
/**
- Calls wxTranslations::GetString(const wxString&, const wxString&, size_t, const wxString&) const.
+ Calls wxTranslations::GetString(const wxString&, const wxString&, unsigned, const wxString&) const.
*/
virtual const wxString& GetString(const wxString& origString,
- const wxString& origString2, size_t n,
+ const wxString& origString2, unsigned n,
const wxString& domain = wxEmptyString) const;
/**
static wxString GetSystemEncodingName();
/**
- Tries to detect the user's default language setting.
+ Tries to detect the user's default locale setting.
Returns the ::wxLanguage value or @c wxLANGUAGE_UNKNOWN if the language-guessing
algorithm failed.
+
+ @note This function works with @em locales and returns the user's default
+ locale. This may be, and usually is, the same as their preferred UI
+ language, but it's not the same thing. Use wxTranslation to obtain
+ @em language information.
+
+ @see wxTranslations::GetBestTranslation().
*/
static int GetSystemLanguage();
given locale containing the translations of standard wxWidgets messages.
This parameter would be rarely used in normal circumstances.
*/
- bool Init(const wxString& name, const wxString& short = wxEmptyString,
+ bool Init(const wxString& name, const wxString& shortName = wxEmptyString,
const wxString& locale = wxEmptyString, bool bLoadDefault = true);
/**