X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ea14492351395f1dcea060e8db0860f865b92658..92c0fc34c104c8d7c12d6a3b78ea232690fc23f4:/interface/wx/intl.h diff --git a/interface/wx/intl.h b/interface/wx/intl.h index 359a5dfcdc..e34f200bac 100644 --- a/interface/wx/intl.h +++ b/interface/wx/intl.h @@ -2,8 +2,7 @@ // Name: intl.h // Purpose: interface of wxLocale // Author: wxWidgets team -// RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -19,7 +18,7 @@ enum wxLayoutDirection }; /** - Encapsulates a ::wxLanguage indentifier together with OS-specific information + Encapsulates a ::wxLanguage identifier together with OS-specific information related to that language. @beginWxPerlOnly @@ -27,7 +26,7 @@ enum wxLayoutDirection - 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 @@ -235,7 +234,7 @@ public: 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); @@ -361,10 +360,10 @@ public: 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; /** @@ -391,10 +390,17 @@ public: 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(); @@ -448,7 +454,7 @@ public: @param name The name of the locale. Only used in diagnostic messages. - @param short + @param shortName The standard 2 letter locale abbreviation; it is used as the directory prefix when looking for the message catalog files. @param locale @@ -459,7 +465,7 @@ public: 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); /**