X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/639f81199f85429d0bc7c043cd9cbdcda423527a..b09857ae000a60704207d63290be937584805fb0:/interface/wx/intl.h diff --git a/interface/wx/intl.h b/interface/wx/intl.h index 4dfa97b8af..ca4587ae8f 100644 --- a/interface/wx/intl.h +++ b/interface/wx/intl.h @@ -19,7 +19,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 @@ -391,10 +391,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();