From: Vadim Zeitlin Date: Mon, 15 Feb 1999 23:04:52 +0000 (+0000) Subject: started wxIntl documentation X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/c1b7dab08b1d02b837baab94a8b37e94a0e9d492 started wxIntl documentation git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1699 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex index 5768d09eea..78a3024914 100644 --- a/docs/latex/wx/classes.tex +++ b/docs/latex/wx/classes.tex @@ -120,6 +120,7 @@ $$\image{14cm;0cm}{wxclass.ps}$$ \input listbox.tex \input listctrl.tex \input listevt.tex +\input locale.tex \input log.tex \input mask.tex \input mdi.tex diff --git a/docs/latex/wx/locale.tex b/docs/latex/wx/locale.tex new file mode 100644 index 0000000000..1f34f9e948 --- /dev/null +++ b/docs/latex/wx/locale.tex @@ -0,0 +1,144 @@ +% +% 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)). + +In wxWindows this class manages message catalogs which contain the translations +of the strings used to the current language. + +\wxheading{Derived from} + +No base class + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxLocale::wxLocale}\label{wxlocaledefctor} + +\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} + +\func{}{wxLocale}{\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 +directory prefix when looking for the message catalog files +\item szLocale is the parameter for the call to setlocale() +\item bLoadDefault may be set to FALSE to prevent loading of the message catalog +for the given locale containing the translations of standard wxWindows messages. +This parameter would be rarely used in normal circumstances. +\end{itemize} + +The call of this function has several global side effects which you should +understand: first of all, the application locale is changed - note that this +will affect many of standard C library functions such as printf() or strftime(). +Second, this wxLocale object becomes the new current global locale for the +application and so all subsequent calls to wxGetTranslation() will try to +translate the messages using the message catalogs for this locale. + +\membersection{wxLocale::\destruct{wxLocale}}\label{wxlocaledtor} + +\func{}{\destruct{wxLocale}}{\void} + +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. + +\membersection{wxLocale::GetLocale}\label{wxlocalegetlocale} + +\constfunc{const char*}{GetLocale}{\void} + +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 +additional directories to the search path with +\helpref{AddCatalogLookupPathPrefix().}{wxlocaleaddcataloglookuppathprefix}. + +All loaded catalogs will be used for message lookup by GetString() for the +current locale. + +Returns TRUE if catalog was successfully loaded, FALSE otherwise (which might +mean that the catalog is not found or that it isn't in the correct format). + +\membersection{wxLocale::AddCatalogLookupPathPrefix}\label{wxlocaleaddcataloglookuppathprefix} + +\func{void}{AddCatalogLookupPathPrefix}{\param{const wxString\& }{prefix}} + +Add a prefix to the catalog lookup path: the message catalog files will be +looked up under prefix//LC\_MESSAGES, prefix/LC\_MESSAGES and prefix +(in this order). + +This only applies to subsequent invocations of AddCatalog()! + +\membersection{wxLocale::Init}\label{wxlocaleinit} + +\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 +directory prefix when looking for the message catalog files +\item szLocale is the parameter for the call to setlocale() +\item bLoadDefault may be set to FALSE to prevent loading of the message catalog +for the given locale containing the translations of standard wxWindows messages. +This parameter would be rarely used in normal circumstances. +\end{itemize} + +The call of this function has several global side effects which you should +understand: first of all, the application locale is changed - note that this +will affect many of standard C library functions such as printf() or strftime(). +Second, this wxLocale object becomes the new current global locale for the +application and so all subsequent calls to wxGetTranslation() will try to +translate the messages using the message catalogs for this locale. + +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}} + +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. + +See also: \helpref{AddCatalog}{wxlocaleaddcatalog} + +\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). + +\membersection{wxLocale::GetString}\label{wxlocalegetstring} + +\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 +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 +added later override those added before.