From 20b02d6169fed3ae68caa6a12aa1003a205672f2 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Sun, 18 Nov 2018 01:43:11 +0100 Subject: [PATCH] Rename new wxTranslations method to GetAcceptableTranslations() This name seems to be more precise than a very generic "all good" one used previously. --- include/wx/translation.h | 7 +++--- interface/wx/translation.h | 45 +++++++++++++------------------------- src/common/translation.cpp | 14 ++++++------ 3 files changed, 26 insertions(+), 40 deletions(-) diff --git a/include/wx/translation.h b/include/wx/translation.h index 266166019c..9b931a088a 100644 --- a/include/wx/translation.h +++ b/include/wx/translation.h @@ -146,9 +146,10 @@ public: const wxString& msgIdLanguage = "en"); // find best and all other suitable translation languages for given domain - wxArrayString GetAllGoodTranslations(const wxString& domain, wxLanguage msgIdLanguage); - wxArrayString GetAllGoodTranslations(const wxString& domain, - const wxString& msgIdLanguage = "en"); + wxArrayString GetAcceptableTranslations(const wxString& domain, + wxLanguage msgIdLanguage); + wxArrayString GetAcceptableTranslations(const wxString& domain, + const wxString& msgIdLanguage = "en"); // add standard wxWidgets catalog ("wxstd") bool AddStdCatalog(); diff --git a/interface/wx/translation.h b/interface/wx/translation.h index fd39fd6b18..23ca5128c7 100644 --- a/interface/wx/translation.h +++ b/interface/wx/translation.h @@ -137,47 +137,32 @@ public: const wxString& msgIdLanguage = "en"); /** - Returns the best and all other suitable UI languages for the @a domain. + Returns the languages of all translations that can be used for the @a + domain. - This is nearly the same as GetBestTranslation(), but returns the - whole list of preferred UI languages for which a translation for the - @a domain was found. + This is a more general version of GetBestTranslation(), which returns + the whole list of preferred UI languages for which a translation for + the @a domain was found instead of just the first, i.e. the most + preferred, element of this list. @param domain The catalog domain to look for. @param msgIdLanguage - Specifies the language of "msgid" strings in source code - (i.e. arguments to GetString(), wxGetTranslation() and the _() macro). + Specifies the language of "msgid" strings in source code (i.e. + arguments to GetString(), wxGetTranslation() and the _() macro). - @return An array of language codes if any suitable matches were found, empty array - otherwise. + @return An array of language codes if any suitable matches were found, + empty array otherwise. @since 3.1.2 */ - wxArrayString GetAllGoodTranslations(const wxString& domain, wxLanguage msgIdLanguage); + wxArrayString GetAcceptableTranslations(const wxString& domain, + wxLanguage msgIdLanguage); - /** - Returns the best and all other suitable UI languages for the @a domain. - - This is nearly the same as GetBestTranslation(), but returns the - whole list of preferred UI languages for which a translation for the - @a domain was found. - - @param domain - The catalog domain to look for. - - @param msgIdLanguage - Specifies the language of "msgid" strings in source code - (i.e. arguments to GetString(), wxGetTranslation() and the _() macro). - - @return An array of language codes if any suitable matches were found, empty array - otherwise. - - @since 3.1.2 - */ - wxArrayString GetAllGoodTranslations(const wxString& domain, - const wxString& msgIdLanguage = "en"); + /// @overload + wxArrayString GetAcceptableTranslations(const wxString& domain, + const wxString& msgIdLanguage = "en"); /** Add standard wxWidgets catalogs ("wxstd" and possible port-specific diff --git a/src/common/translation.cpp b/src/common/translation.cpp index 377dc533f1..7d9937cd18 100644 --- a/src/common/translation.cpp +++ b/src/common/translation.cpp @@ -1555,7 +1555,7 @@ bool wxTranslations::AddCatalog(const wxString& domain, wxLanguage msgIdLanguage) { const wxString msgIdLang = wxLocale::GetLanguageCanonicalName(msgIdLanguage); - const wxArrayString domain_langs = GetAllGoodTranslations(domain, msgIdLanguage); + const wxArrayString domain_langs = GetAcceptableTranslations(domain, msgIdLanguage); if ( domain_langs.empty() ) { @@ -1675,21 +1675,21 @@ wxString wxTranslations::GetBestTranslation(const wxString& domain, wxString wxTranslations::GetBestTranslation(const wxString& domain, const wxString& msgIdLanguage) { - const wxArrayString allGoodOnes = GetAllGoodTranslations(domain, msgIdLanguage); + const wxArrayString allGoodOnes = GetAcceptableTranslations(domain, msgIdLanguage); wxLogTrace(TRACE_I18N, " => using language '%s'", allGoodOnes[0]); return allGoodOnes[0]; } -wxArrayString wxTranslations::GetAllGoodTranslations(const wxString& domain, - wxLanguage msgIdLanguage) +wxArrayString wxTranslations::GetAcceptableTranslations(const wxString& domain, + wxLanguage msgIdLanguage) { const wxString lang = wxLocale::GetLanguageCanonicalName(msgIdLanguage); - return GetAllGoodTranslations(domain, lang); + return GetAcceptableTranslations(domain, lang); } -wxArrayString wxTranslations::GetAllGoodTranslations(const wxString& domain, - const wxString& msgIdLanguage) +wxArrayString wxTranslations::GetAcceptableTranslations(const wxString& domain, + const wxString& msgIdLanguage) { wxArrayString available(GetAvailableTranslations(domain)); // it's OK to have duplicates, so just add msgid language