git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@28218
c3d73ce0-8a6f-49c7-b76d-
6d57e0e08775
\latexignore{\rtfignore{\wxheading{Members}}}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{Supported languages}\label{wxlanguage}
The following wxLanguage constants may be used to specify the language
\membersection{Supported languages}\label{wxlanguage}
The following wxLanguage constants may be used to specify the language
\membersection{wxLocale::wxLocale}\label{wxlocaledefctor}
\func{}{wxLocale}{\void}
\membersection{wxLocale::wxLocale}\label{wxlocaledefctor}
\func{}{wxLocale}{\void}
translate the messages using the message catalogs for this locale.
translate the messages using the message catalogs for this locale.
\membersection{wxLocale::\destruct{wxLocale}}\label{wxlocaledtor}
\func{}{\destruct{wxLocale}}{\void}
\membersection{wxLocale::\destruct{wxLocale}}\label{wxlocaledtor}
\func{}{\destruct{wxLocale}}{\void}
set locale is restored and so the changes described in
\helpref{Init}{wxlocaleinit} documentation are rolled back.
set locale is restored and so the changes described in
\helpref{Init}{wxlocaleinit} documentation are rolled back.
\membersection{wxLocale::AddCatalog}\label{wxlocaleaddcatalog}
\func{bool}{AddCatalog}{\param{const char }{*szDomain}}
\membersection{wxLocale::AddCatalog}\label{wxlocaleaddcatalog}
\func{bool}{AddCatalog}{\param{const char }{*szDomain}}
code, see the instructions in
\helpref{Writing non-English applications}{nonenglishoverview}.
code, see the instructions in
\helpref{Writing non-English applications}{nonenglishoverview}.
\membersection{wxLocale::AddCatalogLookupPathPrefix}\label{wxlocaleaddcataloglookuppathprefix}
\func{void}{AddCatalogLookupPathPrefix}{\param{const wxString\& }{prefix}}
\membersection{wxLocale::AddCatalogLookupPathPrefix}\label{wxlocaleaddcataloglookuppathprefix}
\func{void}{AddCatalogLookupPathPrefix}{\param{const wxString\& }{prefix}}
This only applies to subsequent invocations of AddCatalog()!
This only applies to subsequent invocations of AddCatalog()!
\membersection{wxLocale::AddLanguage}\label{wxlocaleaddlanguage}
\func{static void}{AddLanguage}{\param{const wxLanguageInfo\& }{info}}
\membersection{wxLocale::AddLanguage}\label{wxlocaleaddlanguage}
\func{static void}{AddLanguage}{\param{const wxLanguageInfo\& }{info}}
\perlnote{In wxPerl Wx::LanguageInfo has only one method:\par
Wx::LanguageInfo->new( language, canonicalName, WinLang, WinSubLang, Description )}
\perlnote{In wxPerl Wx::LanguageInfo has only one method:\par
Wx::LanguageInfo->new( language, canonicalName, WinLang, WinSubLang, Description )}
\membersection{wxLocale::FindLanguageInfo}{wxlocalefindlanguageinfo}
\constfunc{static wxLanguageInfo *}{FindLanguageInfo}{\param{const wxString\& }{locale}}
\membersection{wxLocale::FindLanguageInfo}{wxlocalefindlanguageinfo}
\constfunc{static wxLanguageInfo *}{FindLanguageInfo}{\param{const wxString\& }{locale}}
\helpref{GetLanguageInfo}{wxlocalegetlanguageinfo}
\helpref{GetLanguageInfo}{wxlocalegetlanguageinfo}
\membersection{wxLocale::GetCanonicalName}\label{wxlocalegetcanonicalname}
\constfunc{wxString}{GetSysName}{\void}
\membersection{wxLocale::GetCanonicalName}\label{wxlocalegetcanonicalname}
\constfunc{wxString}{GetSysName}{\void}
\membersection{wxLocale::GetLanguage}\label{wxlocalegetlanguage}
\constfunc{int}{GetLanguage}{\void}
\membersection{wxLocale::GetLanguage}\label{wxlocalegetlanguage}
\constfunc{int}{GetLanguage}{\void}
Note that you can call this function only if you used the form of
\helpref{Init}{wxlocaleinit} that takes wxLanguage argument.
Note that you can call this function only if you used the form of
\helpref{Init}{wxlocaleinit} that takes wxLanguage argument.
\membersection{wxLocale::GetLanguageInfo}\label{wxlocalegetlanguageinfo}
\constfunc{static wxLanguageInfo *}{GetLanguageInfo}{\param{int }{lang}}
\membersection{wxLocale::GetLanguageInfo}\label{wxlocalegetlanguageinfo}
\constfunc{static wxLanguageInfo *}{GetLanguageInfo}{\param{int }{lang}}
See \helpref{AddLanguage}{wxlocaleaddlanguage} for the wxLanguageInfo
description.
See \helpref{AddLanguage}{wxlocaleaddlanguage} for the wxLanguageInfo
description.
+As with \helpref{Init}{wxlocaleinit}, \texttt{wxLANGUAGE\_DEFAULT} has the
+special meaning if passed as an argument to this function and in this case the
+result of \helpref{GetSystemLanguage()}{wxlocalegetsystemlanguage} is used.
+
+
\membersection{wxLocale::GetLanguageName}\label{wxlocalegetlanguagename}
\constfunc{static wxString}{GetLanguageName}{\param{int }{lang}}
\membersection{wxLocale::GetLanguageName}\label{wxlocalegetlanguagename}
\constfunc{static wxString}{GetLanguageName}{\param{int }{lang}}
Returns English name of the given language or empty string if this
language is unknown.
Returns English name of the given language or empty string if this
language is unknown.
+See \helpref{GetLanguageInfo}{wxlocalegetlanguageinfo} for a remark about
+special meaning of \texttt{wxLANGUAGE\_DEFAULT}.
+
\membersection{wxLocale::GetLocale}\label{wxlocalegetlocale}
\membersection{wxLocale::GetLocale}\label{wxlocalegetlocale}
e.g. "English" or "French".
e.g. "English" or "French".
\membersection{wxLocale::GetName}\label{wxlocalegetname}
\constfunc{const wxString\&}{GetName}{\void}
\membersection{wxLocale::GetName}\label{wxlocalegetname}
\constfunc{const wxString\&}{GetName}{\void}
Returns the current short name for the locale (as given to the constructor or
the Init() function).
Returns the current short name for the locale (as given to the constructor or
the Init() function).
\membersection{wxLocale::GetString}\label{wxlocalegetstring}
\constfunc{const char*}{GetString}{\param{const char }{*szOrigString}, \param{const char }{*szDomain = NULL}}
\membersection{wxLocale::GetString}\label{wxlocalegetstring}
\constfunc{const char*}{GetString}{\param{const char }{*szOrigString}, \param{const char }{*szDomain = NULL}}
Domains are searched in the last to first order, i.e. catalogs
added later override those added before.
Domains are searched in the last to first order, i.e. catalogs
added later override those added before.
\membersection{wxLocale::GetSysName}\label{wxlocalegetsysname}
\constfunc{wxString}{GetSysName}{\void}
\membersection{wxLocale::GetSysName}\label{wxlocalegetsysname}
\constfunc{wxString}{GetSysName}{\void}
Compare \helpref{GetCanonicalName}{wxlocalegetcanonicalname}.
Compare \helpref{GetCanonicalName}{wxlocalegetcanonicalname}.
\membersection{wxLocale::GetSystemEncoding}\label{wxlocalegetsystemencoding}
\constfunc{static wxFontEncoding}{GetSystemEncoding}{\void}
\membersection{wxLocale::GetSystemEncoding}\label{wxlocalegetsystemencoding}
\constfunc{static wxFontEncoding}{GetSystemEncoding}{\void}
Returns \helpref{wxFontEncoding}{wxfont} value or
{\bf wxFONTENCODING\_SYSTEM} if it couldn't be determined.
Returns \helpref{wxFontEncoding}{wxfont} value or
{\bf wxFONTENCODING\_SYSTEM} if it couldn't be determined.
\membersection{wxLocale::GetSystemEncodingName}\label{wxlocalegetsystemencodingname}
\constfunc{static wxString}{GetSystemEncodingName}{\void}
\membersection{wxLocale::GetSystemEncodingName}\label{wxlocalegetsystemencodingname}
\constfunc{static wxString}{GetSystemEncodingName}{\void}
Returns a user-readable string value or an empty string if it couldn't be
determined.
Returns a user-readable string value or an empty string if it couldn't be
determined.
\membersection{wxLocale::GetSystemLanguage}\label{wxlocalegetsystemlanguage}
\constfunc{static int}{GetSystemLanguage}{\void}
\membersection{wxLocale::GetSystemLanguage}\label{wxlocalegetsystemlanguage}
\constfunc{static int}{GetSystemLanguage}{\void}
{\bf wxLANGUAGE\_UNKNOWN} if the language-guessing algorithm failed.
{\bf wxLANGUAGE\_UNKNOWN} if the language-guessing algorithm failed.
\membersection{wxLocale::Init}\label{wxlocaleinit}
\membersection{wxLocale::Init}\label{wxlocaleinit}
Returns true on success or false if the given locale couldn't be set.
Returns true on success or false if the given locale couldn't be set.
\membersection{wxLocale::IsLoaded}\label{wxlocaleisloaded}
\constfunc{bool}{IsLoaded}{\param{const char* }{domain}}
\membersection{wxLocale::IsLoaded}\label{wxlocaleisloaded}
\constfunc{bool}{IsLoaded}{\param{const char* }{domain}}
See also: \helpref{AddCatalog}{wxlocaleaddcatalog}
See also: \helpref{AddCatalog}{wxlocaleaddcatalog}
\membersection{wxLocale::IsOk}\label{wxlocaleisok}
\constfunc{bool}{IsOk}{\void}
\membersection{wxLocale::IsOk}\label{wxlocaleisok}
\constfunc{bool}{IsOk}{\void}
+ // calling GetLanguageInfo(wxLANGUAGE_DEFAULT) is a natural thing to do, so
+ // make it work
+ if ( lang == wxLANGUAGE_DEFAULT )
+ lang = GetSystemLanguage();
+
const size_t count = ms_languagesDB->GetCount();
for ( size_t i = 0; i < count; i++ )
{
const size_t count = ms_languagesDB->GetCount();
for ( size_t i = 0; i < count; i++ )
{