[wxWidgets.git] / docs / latex / wx / locale.tex

\section{\class{wxLocale}}\label{wxlocale}

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.

\wxheading{Derived from}

No base class

\wxheading{See also}

\helpref{I18n overview}{internationalization}

\wxheading{Include files}

<wx/intl.h>

\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 that.

\func{}{wxLocale}{\param{const char }{*szName}, \param{const char }{*szShort = NULL}, \param{const char }{*szLocale = NULL}, \param{bool }{bLoadDefault = TRUE}, \param{bool }{bConvertEncoding = FALSE}}

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.
\item bConvertEncoding may be set to TRUE to do automatic conversion of message
catalogs to platform's native encoding. Note that it will do only basic 
conversion between well-known pair like iso8859-1 and windows-1252 or
iso8859-2 and windows-1250. 
See \helpref{Writing non-English applications}{nonenglishoverview} for detailed
description of this behaviour.
\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}

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.

\membersection{wxLocale::AddCatalog}\label{wxlocaleaddcatalog}

\func{bool}{AddCatalog}{\param{const char }{*szDomain}}

Add a catalog for use with the current locale: it is searched for in standard
places (current directory first, then the system one), 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/<lang>/LC\_MESSAGES, prefix/LC\_MESSAGES and prefix
(in this order).

This only applies to subsequent invocations of AddCatalog()!

\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::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}}

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).

\wxheading{Remarks}

Domains are searched in the last to first order, i.e. catalogs
added later override those added before.

\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* }{domain}}

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}

\membersection{wxLocale::IsOk}\label{wxlocaleisok}

\constfunc{bool}{IsOk}{\void}

Returns TRUE if the locale could be set successfully.
Commit	Line	Data
c1b7dab0 VZ	1	\section{\class{wxLocale}}\label{wxlocale}
c1b7dab0 VZ	2
dbdb39b2 JS	3	wxLocale class encapsulates all language-dependent settings and is a
dbdb39b2 JS	4	generalization of the C locale concept.
c1b7dab0 VZ	5
	6	In wxWindows this class manages message catalogs which contain the translations
	7	of the strings used to the current language.
	8
	9	\wxheading{Derived from}
	10
	11	No base class
	12
ed93168b VZ	13	\wxheading{See also}
	14
	15	\helpref{I18n overview}{internationalization}
	16
dbdb39b2 JS	17	\wxheading{Include files}
	18
	19	<wx/intl.h>
	20
c1b7dab0 VZ	21	\latexignore{\rtfignore{\wxheading{Members}}}
	22
	23	\membersection{wxLocale::wxLocale}\label{wxlocaledefctor}
	24
	25	\func{}{wxLocale}{\void}
	26
	27	This is the default constructor and it does nothing to initialize the object:
dbdb39b2	28	\helpref{Init()}{wxlocaleinit} must be used to do that.
c1b7dab0	29
7ddef9ed	30	\func{}{wxLocale}{\param{const char }{szName}, \param{const char }{szShort = NULL}, \param{const char }{*szLocale = NULL}, \param{bool }{bLoadDefault = TRUE}, \param{bool }{bConvertEncoding = FALSE}}
c1b7dab0 VZ	31
	32	The parameters have the following meaning:
	33	\begin{itemize}\itemsep=0pt
	34	\item szName is the name of the locale and is only used in diagnostic messages
	35	\item szShort is the standard 2 letter locale abbreviation and is used as the
	36	directory prefix when looking for the message catalog files
	37	\item szLocale is the parameter for the call to setlocale()
	38	\item bLoadDefault may be set to FALSE to prevent loading of the message catalog
	39	for the given locale containing the translations of standard wxWindows messages.
	40	This parameter would be rarely used in normal circumstances.
7ddef9ed VS	41	\item bConvertEncoding may be set to TRUE to do automatic conversion of message
	42	catalogs to platform's native encoding. Note that it will do only basic
	43	conversion between well-known pair like iso8859-1 and windows-1252 or
	44	iso8859-2 and windows-1250.
	45	See \helpref{Writing non-English applications}{nonenglishoverview} for detailed
54cd4332	46	description of this behaviour.
c1b7dab0 VZ	47	\end{itemize}
	48
	49	The call of this function has several global side effects which you should
	50	understand: first of all, the application locale is changed - note that this
	51	will affect many of standard C library functions such as printf() or strftime().
	52	Second, this wxLocale object becomes the new current global locale for the
	53	application and so all subsequent calls to wxGetTranslation() will try to
	54	translate the messages using the message catalogs for this locale.
	55
	56	\membersection{wxLocale::\destruct{wxLocale}}\label{wxlocaledtor}
	57
	58	\func{}{\destruct{wxLocale}}{\void}
	59
dbdb39b2	60	The destructor, like the constructor, also has global side effects: the previously
c1b7dab0 VZ	61	set locale is restored and so the changes described in
	62	\helpref{Init}{wxlocaleinit} documentation are rolled back.
	63
c1b7dab0 VZ	64	\membersection{wxLocale::AddCatalog}\label{wxlocaleaddcatalog}
	65
	66	\func{bool}{AddCatalog}{\param{const char }{*szDomain}}
	67
f6bcfd97	68	Add a catalog for use with the current locale: it is searched for in standard
dbdb39b2	69	places (current directory first, then the system one), but you may also prepend
c1b7dab0	70	additional directories to the search path with
dbdb39b2	71	\helpref{AddCatalogLookupPathPrefix()}{wxlocaleaddcataloglookuppathprefix}.
c1b7dab0 VZ	72
	73	All loaded catalogs will be used for message lookup by GetString() for the
	74	current locale.
	75
	76	Returns TRUE if catalog was successfully loaded, FALSE otherwise (which might
	77	mean that the catalog is not found or that it isn't in the correct format).
	78
	79	\membersection{wxLocale::AddCatalogLookupPathPrefix}\label{wxlocaleaddcataloglookuppathprefix}
	80
	81	\func{void}{AddCatalogLookupPathPrefix}{\param{const wxString\& }{prefix}}
	82
	83	Add a prefix to the catalog lookup path: the message catalog files will be
	84	looked up under prefix/<lang>/LC\_MESSAGES, prefix/LC\_MESSAGES and prefix
	85	(in this order).
	86
	87	This only applies to subsequent invocations of AddCatalog()!
	88
3ca6a5f0 BP	89	\membersection{wxLocale::GetLocale}\label{wxlocalegetlocale}
	90
	91	\constfunc{const char*}{GetLocale}{\void}
	92
	93	Returns the locale name as passed to the constructor or
	94	\helpref{Init()}{wxlocaleinit}.
	95
	96	\membersection{wxLocale::GetName}\label{wxlocalegetname}
	97
	98	\constfunc{const wxString\&}{GetName}{\void}
	99
	100	Returns the current short name for the locale (as given to the constructor or
	101	the Init() function).
	102
	103	\membersection{wxLocale::GetString}\label{wxlocalegetstring}
	104
	105	\constfunc{const char}{GetString}{\param{const char }{szOrigString}, \param{const char }{*szDomain = NULL}}
	106
	107	Retrieves the translation for a string in all loaded domains unless the szDomain
	108	parameter is specified (and then only this catalog/domain is searched).
	109
	110	Returns original string if translation is not available
	111	(in this case an error message is generated the first time
	112	a string is not found; use \helpref{wxLogNull}{wxlogoverview} to suppress it).
	113
	114	\wxheading{Remarks}
	115
	116	Domains are searched in the last to first order, i.e. catalogs
	117	added later override those added before.
	118
c1b7dab0 VZ	119	\membersection{wxLocale::Init}\label{wxlocaleinit}
	120
	121	\func{bool}{Init}{\param{const char }{szName}, \param{const char }{szShort = NULL}, \param{const char }{*szLocale = NULL}, \param{bool }{bLoadDefault = TRUE}}
	122
	123	The parameters have the following meaning:
dbdb39b2	124
c1b7dab0 VZ	125	\begin{itemize}\itemsep=0pt
	126	\item szName is the name of the locale and is only used in diagnostic messages
	127	\item szShort is the standard 2 letter locale abbreviation and is used as the
	128	directory prefix when looking for the message catalog files
	129	\item szLocale is the parameter for the call to setlocale()
	130	\item bLoadDefault may be set to FALSE to prevent loading of the message catalog
	131	for the given locale containing the translations of standard wxWindows messages.
	132	This parameter would be rarely used in normal circumstances.
	133	\end{itemize}
	134
	135	The call of this function has several global side effects which you should
	136	understand: first of all, the application locale is changed - note that this
	137	will affect many of standard C library functions such as printf() or strftime().
	138	Second, this wxLocale object becomes the new current global locale for the
	139	application and so all subsequent calls to wxGetTranslation() will try to
	140	translate the messages using the message catalogs for this locale.
	141
	142	Returns TRUE on success or FALSE if the given locale couldn't be set.
	143
	144	\membersection{wxLocale::IsLoaded}\label{wxlocaleisloaded}
	145
dbdb39b2 JS	146	\constfunc{bool}{IsLoaded}{\param{const char* }{domain}}
	147
	148	Check if the given catalog is loaded, and returns TRUE if it is.
c1b7dab0	149
dbdb39b2 JS	150	According to GNU gettext tradition, each catalog
dbdb39b2 JS	151	normally corresponds to 'domain' which is more or less the application name.
c1b7dab0 VZ	152
	153	See also: \helpref{AddCatalog}{wxlocaleaddcatalog}
	154
3ca6a5f0	155	\membersection{wxLocale::IsOk}\label{wxlocaleisok}
c1b7dab0	156
3ca6a5f0	157	\constfunc{bool}{IsOk}{\void}
dbdb39b2	158
3ca6a5f0	159	Returns TRUE if the locale could be set successfully.
dbdb39b2	160