added ReadType convenience functions (patch 1764160)

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

diff --git a/docs/latex/wx/locale.tex b/docs/latex/wx/locale.tex
index 66197b87e8a2c9d7934f8b44e218cf80d494bb0e..22f4d123dc658fff531b27c8d570581c7f3b11ee 100644 (file)
--- a/docs/latex/wx/locale.tex
+++ b/docs/latex/wx/locale.tex
@@ -55,6 +55,10 @@ No base class
 
 <wx/intl.h>
 
 
 <wx/intl.h>
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 


@@ -80,7 +84,7 @@ This is the default constructor and it does nothing to initialize the object:
 
 See \helpref{Init()}{wxlocaleinit} for parameters description.
 
 
 See \helpref{Init()}{wxlocaleinit} for parameters description.
 

-\func{}{wxLocale}{\param{const char }{*szName}, \param{const char }{*szShort = NULL}, \param{const char }{*szLocale = NULL}, \param{bool }{bLoadDefault = true}, \param{bool }{bConvertEncoding = false}}
+\func{}{wxLocale}{\param{const wxString\& }{name}, \param{const wxString\& }{short = wxEmptyString}, \param{const wxString\& }{locale = wxEmptyString}, \param{bool }{bLoadDefault = true}, \param{bool }{bConvertEncoding = false}}

 
 See \helpref{Init()}{wxlocaleinit} for parameters description.
 
 
 See \helpref{Init()}{wxlocaleinit} for parameters description.
 


@@ -104,9 +108,9 @@ set locale is restored and so the changes described in
 
 \membersection{wxLocale::AddCatalog}\label{wxlocaleaddcatalog}
 
 
 \membersection{wxLocale::AddCatalog}\label{wxlocaleaddcatalog}
 

-\func{bool}{AddCatalog}{\param{const char }{*szDomain}}
+\func{bool}{AddCatalog}{\param{const wxString\& }{domain}}

 
 

-\func{bool}{AddCatalog}{\param{const char }{*szDomain}, \param{wxLanguage}{msgIdLanguage}, \param{const char }{*msgIdCharset}}
+\func{bool}{AddCatalog}{\param{const wxString\& }{domain}, \param{wxLanguage}{msgIdLanguage}, \param{const wxString\& }{msgIdCharset}}

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


@@ -255,7 +259,7 @@ special meaning of \texttt{wxLANGUAGE\_DEFAULT}.
 
 \membersection{wxLocale::GetLocale}\label{wxlocalegetlocale}
 
 
 \membersection{wxLocale::GetLocale}\label{wxlocalegetlocale}
 

-\constfunc{const char*}{GetLocale}{\void}
+\constfunc{const wxString\& }{GetLocale}{\void}

 
 Returns the locale name as passed to the constructor or 
 \helpref{Init()}{wxlocaleinit}. This is full, human-readable name,
 
 Returns the locale name as passed to the constructor or 
 \helpref{Init()}{wxlocaleinit}. This is full, human-readable name,


@@ -265,7 +269,7 @@ e.g. "English" or "French".
 
 \membersection{wxLocale::GetName}\label{wxlocalegetname}
 
 
 \membersection{wxLocale::GetName}\label{wxlocalegetname}
 

-\constfunc{const wxString\&}{GetName}{\void}
+\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).


@@ -273,9 +277,9 @@ the Init() function).
 
 \membersection{wxLocale::GetString}\label{wxlocalegetstring}
 
 
 \membersection{wxLocale::GetString}\label{wxlocalegetstring}
 

-\constfunc{const char*}{GetString}{\param{const char }{*szOrigString}, \param{const char }{*szDomain = NULL}}
+\constfunc{const wxString\& }{GetString}{\param{const wxString\& }{origString}, \param{const wxString\& }{domain = wxEmptyString}}

 
 

-\constfunc{const char*}{GetString}{\param{const char }{*szOrigString}, \param{const char }{*szOrigString2}, \param{size\_t }{n}, \param{const char }{*szDomain = NULL}}
+\constfunc{const wxString\& }{GetString}{\param{const wxString\& }{origString}, \param{const wxString\& }{origString2}, \param{size\_t }{n}, \param{const wxString\& }{domain = 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).
 
 Retrieves the translation for a string in all loaded domains unless the szDomain
 parameter is specified (and then only this catalog/domain is searched).


@@ -286,13 +290,13 @@ a string is not found; use \helpref{wxLogNull}{wxlogoverview} to suppress it).
 
 The second form is used when retrieving translation of string that has
 different singular and plural form in English or different plural forms in some
 
 The second form is used when retrieving translation of string that has
 different singular and plural form in English or different plural forms in some

-other language. It takes two extra arguments: \arg{szOrigString}
+other language. It takes two extra arguments: \arg{origString}

 parameter must contain the singular form of the string to be converted.
 It is also used as the key for the search in the catalog.
 parameter must contain the singular form of the string to be converted.
 It is also used as the key for the search in the catalog.

-The \arg{szOrigString2} parameter is the plural form (in English).
+The \arg{origString2} parameter is the plural form (in English).

 The parameter \arg{n} is used to determine the plural form.  If no
 The parameter \arg{n} is used to determine the plural form.  If no

-message catalog is found \arg{szOrigString} is returned if `n == 1',
-otherwise \arg{szOrigString2}.
+message catalog is found \arg{origString} is returned if `n == 1',
+otherwise \arg{origString2}.

 See \urlref{GNU gettext manual}{http://www.gnu.org/manual/gettext/html\_chapter/gettext\_10.html\#SEC150} for additional information on plural forms handling.
 
 This method is called by the \helpref{wxGetTranslation}{wxgettranslation}
 See \urlref{GNU gettext manual}{http://www.gnu.org/manual/gettext/html\_chapter/gettext\_10.html\#SEC150} for additional information on plural forms handling.
 
 This method is called by the \helpref{wxGetTranslation}{wxgettranslation}


@@ -306,9 +310,9 @@ added later override those added before.
 
 \membersection{wxLocale::GetHeaderValue}\label{wxlocalegetheadervalue}
 
 
 \membersection{wxLocale::GetHeaderValue}\label{wxlocalegetheadervalue}
 

-\constfunc{wxString}{GetHeaderValue}{\param{const char }{*szHeader}, \param{const char }{*szDomain = NULL}}
+\constfunc{wxString}{GetHeaderValue}{\param{const wxString\& }{header}, \param{const wxString\& }{domain = wxEmptyString}}

 
 

-Returns the header value for header \arg{szHeader}. The search for \arg{szHeader} is case sensitive. If an \arg{szDomain}
+Returns the header value for header \arg{header}. The search for \arg{header} is case sensitive. If an \arg{domain}

 is passed, this domain is searched. Else all domains will be searched until a header has been found.
 The return value is the value of the header if found. Else this will be empty.
 
 is passed, this domain is searched. Else all domains will be searched until a header has been found.
 The return value is the value of the header if found. Else this will be empty.
 


@@ -360,7 +364,7 @@ Returns \helpref{wxLanguage}{wxlanguage} value or
 \func{bool}{Init}{\param{int }{language = wxLANGUAGE\_DEFAULT}, \param{int }{flags =
                           wxLOCALE\_LOAD\_DEFAULT | wxLOCALE\_CONV\_ENCODING}}
 
 \func{bool}{Init}{\param{int }{language = wxLANGUAGE\_DEFAULT}, \param{int }{flags =
                           wxLOCALE\_LOAD\_DEFAULT | wxLOCALE\_CONV\_ENCODING}}
 

-\func{bool}{Init}{\param{const char }{*szName}, \param{const char }{*szShort = NULL}, \param{const char }{*szLocale = NULL}, \param{bool }{bLoadDefault = true}, \param{bool }{bConvertEncoding = false}}
+\func{bool}{Init}{\param{const wxString\& }{name}, \param{const wxString\& }{short = wxEmptyString}, \param{const wxString\& }{locale = wxEmptyString}, \param{bool }{bLoadDefault = true}, \param{bool }{bConvertEncoding = false}}

 
 The second form is deprecated, use the first one unless you know what you are
 doing. 
 
 The second form is deprecated, use the first one unless you know what you are
 doing. 


@@ -387,12 +391,12 @@ description of this behaviour. Note that this flag is meaningless in Unicode bui
 \end{twocollist}
 }
 
 \end{twocollist}
 }
 

-\docparam{szName}{The name of the locale. Only used in diagnostic messages.}
+\docparam{name}{The name of the locale. Only used in diagnostic messages.}

 
 

-\docparam{szShort}{The standard 2 letter locale abbreviation; it is used as the
+\docparam{short}{The standard 2 letter locale abbreviation; it is used as the

 directory prefix when looking for the message catalog files.}
 
 directory prefix when looking for the message catalog files.}
 

-\docparam{szLocale}{The parameter for the call to setlocale(). Note that it is
+\docparam{locale}{The parameter for the call to setlocale(). Note that it is

 platform-specific.}
 
 \docparam{bLoadDefault}{May be set to false to prevent loading of the message catalog
 platform-specific.}
 
 \docparam{bLoadDefault}{May be set to false to prevent loading of the message catalog


@@ -433,7 +437,7 @@ given a two letter ISO language code, use
 wxLanguageInfo structure. See \helpref{AddLanguage}{wxlocaleaddlanguage} for
 the wxLanguageInfo description.
 
 wxLanguageInfo structure. See \helpref{AddLanguage}{wxlocaleaddlanguage} for
 the wxLanguageInfo description.
 

-\newsince{2.7.1}. Currently only implemented under Windows.
+\newsince{2.7.1}. 

 
 
 \membersection{wxLocale::IsLoaded}\label{wxlocaleisloaded}
 
 
 \membersection{wxLocale::IsLoaded}\label{wxlocaleisloaded}