X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c1b7dab08b1d02b837baab94a8b37e94a0e9d492..e46286351dbfa7ae98e8341e4fc328b134601e87:/docs/latex/wx/locale.tex diff --git a/docs/latex/wx/locale.tex b/docs/latex/wx/locale.tex index 1f34f9e948..e6a0431c51 100644 --- a/docs/latex/wx/locale.tex +++ b/docs/latex/wx/locale.tex @@ -1,13 +1,7 @@ -% -% automatically generated by HelpGen from -% f:\libs\wxwindows\docs\latex\wx/locale.tex at 15/Feb/99 23:37:46 -% - - \section{\class{wxLocale}}\label{wxlocale} -wxLocale class encapsulates all language dependent settings and is a -generalization of the C locale concept (see also setlocale(3)). +wxLocale class encapsulates all language-dependent settings and is a +generalization of the C locale concept. In wxWindows this class manages message catalogs which contain the translations of the strings used to the current language. @@ -16,6 +10,14 @@ of the strings used to the current language. No base class +\wxheading{See also} + +\helpref{I18n overview}{internationalization} + +\wxheading{Include files} + + + \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxLocale::wxLocale}\label{wxlocaledefctor} @@ -23,9 +25,7 @@ No base class \func{}{wxLocale}{\void} This is the default constructor and it does nothing to initialize the object: -\helpref{Init()}{wxlocaleinit} must be used to do it. - -\membersection{wxLocale::wxLocale}\label{wxlocalewxlocale} +\helpref{Init()}{wxlocaleinit} must be used to do that. \func{}{wxLocale}{\param{const char }{*szName}, \param{const char }{*szShort = NULL}, \param{const char }{*szLocale = NULL}, \param{bool }{bLoadDefault = TRUE}} @@ -51,7 +51,7 @@ translate the messages using the message catalogs for this locale. \func{}{\destruct{wxLocale}}{\void} -Destructor, like the constructor, also has global side effects: the previously +The destructor, like the constructor, also has global side effects: the previously set locale is restored and so the changes described in \helpref{Init}{wxlocaleinit} documentation are rolled back. @@ -62,15 +62,14 @@ set locale is restored and so the changes described in Returns the locale name as passed to the constructor or \helpref{Init()}{wxlocaleinit}. - \membersection{wxLocale::AddCatalog}\label{wxlocaleaddcatalog} \func{bool}{AddCatalog}{\param{const char }{*szDomain}} Add a catalog for use with the current locale: it's searched for in standard -places (current directory first, system one after), but you may also prepend +places (current directory first, then the system one), but you may also prepend additional directories to the search path with -\helpref{AddCatalogLookupPathPrefix().}{wxlocaleaddcataloglookuppathprefix}. +\helpref{AddCatalogLookupPathPrefix()}{wxlocaleaddcataloglookuppathprefix}. All loaded catalogs will be used for message lookup by GetString() for the current locale. @@ -93,6 +92,7 @@ This only applies to subsequent invocations of AddCatalog()! \func{bool}{Init}{\param{const char }{*szName}, \param{const char }{*szShort = NULL}, \param{const char }{*szLocale = NULL}, \param{bool }{bLoadDefault = TRUE}} The parameters have the following meaning: + \begin{itemize}\itemsep=0pt \item szName is the name of the locale and is only used in diagnostic messages \item szShort is the standard 2 letter locale abbreviation and is used as the @@ -114,11 +114,12 @@ 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 }{*szDomain}} +\constfunc{bool}{IsLoaded}{\param{const char* }{domain}} -Check if the given catalog (according to GNU gettext tradition each catalog -normally corresponds to 'domain' which is more or less the application name) -is loaded, returns TRUE if it is. +Check if the given catalog is loaded, and returns TRUE if it is. + +According to GNU gettext tradition, each catalog +normally corresponds to 'domain' which is more or less the application name. See also: \helpref{AddCatalog}{wxlocaleaddcatalog} @@ -133,12 +134,15 @@ the Init() function). \constfunc{const char*}{GetString}{\param{const char }{*szOrigString}, \param{const char }{*szDomain = NULL}} -Retrieve the translation for a string in all loaded domains unless the szDomain +Retrieves the translation for a string in all loaded domains unless the szDomain parameter is specified (and then only this catalog/domain is searched). Returns original string if translation is not available (in this case an error message is generated the first time a string is not found; use \helpref{wxLogNull}{wxlogoverview} to suppress it). -Remark: domains are searched in the last to first order, i.e. catalogs +\wxheading{Remarks} + +Domains are searched in the last to first order, i.e. catalogs added later override those added before. +