added wxFileName::MakeRelativeTo() and the tests/docs for it

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

diff --git a/docs/latex/wx/locale.tex b/docs/latex/wx/locale.tex
index 571dc9cb627a90ea5ed0834a6d8682a61a7d2b89..121ef3feb54db3796302f0f65a2413d07745dcd5 100644 (file)
--- a/docs/latex/wx/locale.tex
+++ b/docs/latex/wx/locale.tex
@@ -6,16 +6,36 @@ 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.
 
-\perlnote{In wxPerl the {\tt Wx} module exports a '_' function
-that corresponds to the '_' C++ macro.
+\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}
-  use Wx qw(_);
+  # this imports gettext ( equivalent to Wx::GetTranslation
+  # and gettext_noop ( a noop )
+  # into your module
+  use Wx::Locale qw(:default);
 
   # ....
 
-  print _( ``Panic!'' );
+  # use the functions
+  print gettext( ``Panic!'' ); 
 
-  my( \$button ) = Wx::Button->new( \$window, -1, _( ``Label'' ) );
+  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:
+\begin{verbatim}
+  #
+  use Wx::Locale 'gettext' => 't',
+                 'gettext_noop' => 'gettext_noop';
+
+  # ...
+
+  # use the functions
+  print t( ``Panic!!'' );
+
+  # ...
 \end{verbatim}
 }
 
@@ -41,13 +61,17 @@ The following wxLanguage constants may be used to specify the language
 in \helpref{Init}{wxlocaleinit} and are returned by 
 \helpref{GetSystemLanguage}{wxlocalegetsystemlanguage}:
 
+
+
+%% --- --- --- generated code begins here --- --- ---
+
 %% This enum is generated by misc/languages/genlang.py
 %% When making changes, please put them into misc/languages/langtabl.txt
 \begin{itemize}\itemsep=0pt
-\item wxLANGUAGE_DEFAULT -- user's default language as obtained from the operating system 
-\item wxLANGUAGE_UNKNOWN -- returned by \helpref{GetSystemLanguage}{wxlocalegetsystemlanguage}
+\item wxLANGUAGE\_DEFAULT -- user's default language as obtained from the operating system 
+\item wxLANGUAGE\_UNKNOWN -- returned by \helpref{GetSystemLanguage}{wxlocalegetsystemlanguage}
 if it fails to detect the default language 
-\item wxLANGUAGE_USER_DEFINED -- user defined languages' integer identifiers should start from
+\item wxLANGUAGE\_USER\_DEFINED -- user defined languages' integer identifiers should start from
 this
 \item wxLANGUAGE\_ABKHAZIAN
 \item wxLANGUAGE\_AFAR
@@ -279,6 +303,9 @@ this
 \item wxLANGUAGE\_ZULU
 \end{itemize}
 
+%% --- --- --- generated code ends here --- --- ---
+
+
 
 
 \membersection{wxLocale::wxLocale}\label{wxlocaledefctor}
@@ -340,7 +367,7 @@ This only applies to subsequent invocations of AddCatalog()!
 
 \membersection{wxLocale::AddLanguage}\label{wxlocaleaddlanguage}
 
-\func{void}{AddLanguage}{\param{const wxLanguageInfo\& }{info}}
+\func{static void}{AddLanguage}{\param{const wxLanguageInfo\& }{info}}
 
 Adds custom, user-defined language to the database of known languages. This
 database is used in conjuction with the first form of 
@@ -364,6 +391,8 @@ struct WXDLLEXPORT wxLanguageInfo
 
 {\it Language} should be greater than wxLANGUAGE\_USER\_DEFINED.
 
+\perlnote{In wxPerl Wx::LanguageInfo has only one method:\par
+Wx::LanguageInfo->new( language, canonicalName, WinLang, WinSubLang, Description )}
 
 
 \membersection{wxLocale::GetCanonicalName}\label{wxlocalegetcanonicalname}
@@ -431,9 +460,29 @@ Returns current platform-specific locale name as passed to setlocale().
 Compare \helpref{GetCanonicalName}{wxlocalegetcanonicalname}.
 
 
+\membersection{wxLocale::GetSystemEncoding}\label{wxlocalegetsystemencoding}
+
+\constfunc{static wxFontEncoding}{GetSystemEncoding}{\void}
+
+Tries to detect the user's default font encoding.
+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}
+
+Tries to detect the name of the user's default font encoding. This string isn't
+particularly useful for the application as its form is platform-dependent and
+so you should probably use 
+\helpref{GetSystemEncoding}{wxlocalegetsystemencoding} instead.
+
+Returns a user-readable string value or an empty string if it couldn't be
+determined.
+
 \membersection{wxLocale::GetSystemLanguage}\label{wxlocalegetsystemlanguage}
 
-\constfunc{int}{GetSystemLanguage}{\void}
+\constfunc{static int}{GetSystemLanguage}{\void}
 
 Tries to detect the user's default language setting.
 Returns \helpref{wxLanguage}{wxlanguage} value or