Mirrors_UI_SDK/wxWidgets
1
0
Fork 0
mirror of https://github.com/wxWidgets/wxWidgets.git synced 2026-09-25 00:43:39 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Recommend using wxUILocale::GetSystemLanguage() in wxLocale docs

Browse Source 
The wxUILocale function really returns the default language unlike the
one in wxLocale which must kepe using the default locale for
compatibility, making its name confusing.

(cherry picked from commit ce04dbc024)
This commit is contained in:
Vadim Zeitlin
2023-02-08 20:51:45 +01:00
parent 86cf1bba04
commit dc1710bbf3
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
interface/wx/intl.h
+8 -6
View File
@@ -526,13 +526,15 @@ public:
/**
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 is somewhat misleading, as it uses the default
system locale to determine its return value, and not just the system
language. It is preserved for backwards compatibility, but to actually
get the language, and not locale, used by the system by default, call
wxUILocale::GetSystemLanguage() instead.
@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.
Returns the ::wxLanguage value or @c wxLANGUAGE_UNKNOWN if the locale
is not recognized, as can notably happen when combining any language
with a region where this language is not typically spoken.
@see wxTranslations::GetBestTranslation().
*/