Fixed wxTextCtrl::SetMaxLength for rich edit controls

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

diff --git a/docs/latex/wx/locale.tex b/docs/latex/wx/locale.tex
index bba0d754534a2c4f48d68beb88e23503fa6ccb7b..ab513b33b825128ca5ab480d7d509a1740eb3dea 100644 (file)
--- a/docs/latex/wx/locale.tex
+++ b/docs/latex/wx/locale.tex
@@ -3,12 +3,13 @@
 wxLocale class encapsulates all language-dependent settings and is a
 generalization of the C locale concept.
 
 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
+In wxWidgets this class manages message catalogs which contain the translations

 of the strings used to the current language.
 
 \perlnote{In wxPerl you can't use the '\_' function name, so
 the {\tt Wx::Locale} module can export the {\tt gettext} and 
 {\tt gettext\_noop} under any given name. 
 of the strings used to the current language.
 
 \perlnote{In wxPerl you can't use the '\_' function name, so
 the {\tt Wx::Locale} module can export the {\tt gettext} and 
 {\tt gettext\_noop} under any given name. 

+

 \begin{verbatim}
   # this imports gettext ( equivalent to Wx::GetTranslation
   # and gettext_noop ( a noop )
 \begin{verbatim}
   # this imports gettext ( equivalent to Wx::GetTranslation
   # and gettext_noop ( a noop )


@@ -22,9 +23,11 @@ the {\tt Wx::Locale} module can export the {\tt gettext} and
 
   button = Wx::Button->new( window, -1, gettext( ``Label'' ) );
 \end{verbatim}
 
   button = Wx::Button->new( window, -1, gettext( ``Label'' ) );
 \end{verbatim}

+

 If you need to translate a lot of strings, then adding gettext( ) around
 each one is a long task ( that is why \_( ) was introduced ), so just choose
 a shorter name for gettext:
 If you need to translate a lot of strings, then adding gettext( ) around
 each one is a long task ( that is why \_( ) was introduced ), so just choose
 a shorter name for gettext:

+

 \begin{verbatim}
   #
   use Wx::Locale 'gettext' => 't',
 \begin{verbatim}
   #
   use Wx::Locale 'gettext' => 't',


@@ -37,7 +40,7 @@ a shorter name for gettext:
 
   # ...
 \end{verbatim}
 
   # ...
 \end{verbatim}

-}
+}%

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 


@@ -45,8 +48,8 @@ No base class
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{I18n overview}{internationalization},\\
-\helpref{i18n sample}{sampleinternat}
+\helpref{Internationalization overview}{internationalization},\\
+\helpref{Internat sample}{sampleinternat}

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -56,6 +59,7 @@ No base class
 \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


@@ -309,6 +313,7 @@ this
 
 
 
 
 
 

+

 \membersection{wxLocale::wxLocale}\label{wxlocaledefctor}
 
 \func{}{wxLocale}{\void}
 \membersection{wxLocale::wxLocale}\label{wxlocaledefctor}
 
 \func{}{wxLocale}{\void}


@@ -321,7 +326,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 char }{*szName}, \param{const char }{*szShort = NULL}, \param{const char }{*szLocale = NULL}, \param{bool }{bLoadDefault = true}, \param{bool }{bConvertEncoding = false}}

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


@@ -333,6 +338,7 @@ application and so all subsequent calls to wxGetTranslation() will try to
 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}


@@ -341,21 +347,48 @@ The destructor, like the constructor, also has global side effects: the previous
 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}}
 

+\func{bool}{AddCatalog}{\param{const char }{*szDomain}, \param{wxLanguage}{msgIdLanguage}, \param{const char }{*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
 additional directories to the search path with 
 \helpref{AddCatalogLookupPathPrefix()}{wxlocaleaddcataloglookuppathprefix}.
 
 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.
+All loaded catalogs will be used for message lookup by
+\helpref{GetString()}{wxlocalegetstring} for the current locale.

 
 

-Returns TRUE if catalog was successfully loaded, FALSE otherwise (which might
+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).
 
 mean that the catalog is not found or that it isn't in the correct format).
 

+The second form of this method takes two additional arguments,
+\arg{msgIdLanguage} and \arg{msgIdCharset}.
+
+\arg{msgIdLanguage} specifies the language of "msgid" strings in source code
+(i.e. arguments to \helpref{GetString}{wxlocalegetstring},
+\helpref{wxGetTranslation}{wxgettranslation} and the 
+\helpref{\_()}{underscore} macro). It is used if AddCatalog cannot find any
+catalog for current language: if the language is same as source code language,
+then strings from source code are used instead. 
+
+\arg{msgIdCharset} lets you specify the charset used for msgids in sources
+in case they use 8-bit characters (e.g. German or French strings).  This
+argument has no effect in Unicode build, because literals in sources are
+Unicode strings; you have to use compiler-specific method of setting the right
+charset when compiling with Unicode.
+
+By default (i.e. when you use the first form), msgid strings are assumed
+to be in English and written only using 7-bit ASCII characters.
+
+If you have to deal with non-English strings or 8-bit characters in the source
+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}}


@@ -366,6 +399,7 @@ looked up under prefix/<lang>/LC\_MESSAGES, prefix/LC\_MESSAGES and 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}}


@@ -396,6 +430,24 @@ struct WXDLLEXPORT wxLanguageInfo
 Wx::LanguageInfo->new( language, canonicalName, WinLang, WinSubLang, Description )}
 
 
 Wx::LanguageInfo->new( language, canonicalName, WinLang, WinSubLang, Description )}
 
 

+\membersection{wxLocale::FindLanguageInfo}{wxlocalefindlanguageinfo}
+
+\constfunc{static wxLanguageInfo *}{FindLanguageInfo}{\param{const wxString\& }{locale}}
+
+This function may be used to find the language description structure for the
+given locale, specified either as a two letter ISO language code (for example,
+"pt"), a language code followed by the country code ("pt\_BR") or a full, human
+readable, language description ("Portuguese-Brazil").
+
+Returns the information for the given language or {\tt NULL} if this language
+is unknown. Note that even if the returned pointer is valid, the caller should
+{\it not} delete it.
+
+\wxheading{See also}
+
+\helpref{GetLanguageInfo}{wxlocalegetlanguageinfo}
+
+

 \membersection{wxLocale::GetCanonicalName}\label{wxlocalegetcanonicalname}
 
 \constfunc{wxString}{GetSysName}{\void}
 \membersection{wxLocale::GetCanonicalName}\label{wxlocalegetcanonicalname}
 
 \constfunc{wxString}{GetSysName}{\void}


@@ -411,6 +463,7 @@ Compare \helpref{GetSysName}{wxlocalegetsysname}.
 
 
 
 
 
 

+

 \membersection{wxLocale::GetLanguage}\label{wxlocalegetlanguage}
 
 \constfunc{int}{GetLanguage}{\void}
 \membersection{wxLocale::GetLanguage}\label{wxlocalegetlanguage}
 
 \constfunc{int}{GetLanguage}{\void}


@@ -419,6 +472,7 @@ Returns \helpref{wxLanguage}{wxlanguage} constant of current language.
 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}}


@@ -430,6 +484,21 @@ returned pointer is valid, the caller should {\it not} delete it.
 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}}
+
+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}
 


@@ -440,6 +509,7 @@ Returns the locale name as passed to the constructor or
 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}


@@ -447,10 +517,13 @@ e.g. "English" or "French".
 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}}
 

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


@@ -458,11 +531,34 @@ 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).
 
 (in this case an error message is generated the first time
 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
+other language. It takes two extra arguments: \arg{szOrigString}
+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 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}.
+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}
+function and \helpref{\_()}{underscore} macro.
+

 \wxheading{Remarks}
 
 Domains are searched in the last to first order, i.e. catalogs
 added later override those added before.
 
 \wxheading{Remarks}
 
 Domains are searched in the last to first order, i.e. catalogs
 added later override those added before.
 

+
+\membersection{wxLocale::GetHeaderValue}\label{wxlocalegetheadervalue}
+
+\constfunc{wxString}{GetHeaderValue}{\param{const char }{*szHeader}, \param{const char }{*szDomain = NULL}}
+
+Returns the header value for header \arg{szHeader}. The search for \arg{szHeader} is case sensitive. If an \arg{szDomain}
+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.
+

 \membersection{wxLocale::GetSysName}\label{wxlocalegetsysname}
 
 \constfunc{wxString}{GetSysName}{\void}
 \membersection{wxLocale::GetSysName}\label{wxlocalegetsysname}
 
 \constfunc{wxString}{GetSysName}{\void}


@@ -472,6 +568,7 @@ Returns current platform-specific locale name as passed to setlocale().
 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}


@@ -480,6 +577,7 @@ Tries to detect the user's default font encoding.
 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}


@@ -492,6 +590,7 @@ so you should probably use
 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}


@@ -501,13 +600,14 @@ Returns \helpref{wxLanguage}{wxlanguage} value or
  {\bf wxLANGUAGE\_UNKNOWN} if the language-guessing algorithm failed.
 
 
  {\bf wxLANGUAGE\_UNKNOWN} if the language-guessing algorithm failed.
 
 

+

 \membersection{wxLocale::Init}\label{wxlocaleinit}
 
 
 \func{bool}{Init}{\param{int }{language = wxLANGUAGE\_DEFAULT}, \param{int }{flags =
                           wxLOCALE\_LOAD\_DEFAULT | wxLOCALE\_CONV\_ENCODING}}
 
 \membersection{wxLocale::Init}\label{wxlocaleinit}
 
 
 \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 char }{*szName}, \param{const char }{*szShort = NULL}, \param{const char }{*szLocale = NULL}, \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. 


@@ -520,9 +620,11 @@ wxLANGUAGE\_DEFAULT has special meaning -- wxLocale will use system's default
 language (see \helpref{GetSystemLanguage}{wxlocalegetsystemlanguage}).}
 
 \docparam{flags}{Combination of the following:
 language (see \helpref{GetSystemLanguage}{wxlocalegetsystemlanguage}).}
 
 \docparam{flags}{Combination of the following:

+
+

 \begin{twocollist}\itemsep=0pt
 \twocolitem{\windowstyle{wxLOCALE\_LOAD\_DEFAULT}}{Load the message catalog
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\windowstyle{wxLOCALE\_LOAD\_DEFAULT}}{Load the message catalog

-for the given locale containing the translations of standard wxWindows messages
+for the given locale containing the translations of standard wxWidgets messages

 automatically.}
 \twocolitem{\windowstyle{wxLOCALE\_CONV\_ENCODING}}{Automatically convert message
 catalogs to platform's default encoding. Note that it will do only basic 
 automatically.}
 \twocolitem{\windowstyle{wxLOCALE\_CONV\_ENCODING}}{Automatically convert message
 catalogs to platform's default encoding. Note that it will do only basic 


@@ -540,11 +642,11 @@ directory prefix when looking for the message catalog files.}
 \docparam{szLocale}{The parameter for the call to setlocale(). Note that it is
 platform-specific.}
 
 \docparam{szLocale}{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
-for the given locale containing the translations of standard wxWindows messages.
+\docparam{bLoadDefault}{May be set to false to prevent loading of the message catalog
+for the given locale containing the translations of standard wxWidgets messages.

 This parameter would be rarely used in normal circumstances.}
 
 This parameter would be rarely used in normal circumstances.}
 

-\docparam{bConvertEncoding}{May be set to TRUE to do automatic conversion of message
+\docparam{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. 
 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. 


@@ -556,25 +658,28 @@ 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
 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
+application and so all subsequent calls to
+\helpref{wxGetTranslation()}{wxgettranslation} will try to

 translate the messages using the message catalogs for this locale.
 
 translate the messages using the message catalogs for this locale.
 

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

-Check if the given catalog is loaded, and 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}
 
 
 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}
 
 \membersection{wxLocale::IsOk}\label{wxlocaleisok}
 
 \constfunc{bool}{IsOk}{\void}
 

-Returns TRUE if the locale could be set successfully.
+Returns true if the locale could be set successfully.