added ReadType convenience functions (patch 1764160)

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

diff --git a/docs/latex/wx/tunicode.tex b/docs/latex/wx/tunicode.tex
index 5c6b2378a61196c80843a2b9580976c4dc9df8d3..606859f61f78870a1e952e0b39988d9f94601368 100644 (file)
--- a/docs/latex/wx/tunicode.tex
+++ b/docs/latex/wx/tunicode.tex
@@ -6,7 +6,7 @@
 %% Created:     22.09.99
 %% RCS-ID:      $Id$
 %% Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 %% Created:     22.09.99
 %% RCS-ID:      $Id$
 %% Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

-%% Licence:     wxWidgets license
+%% Licence:     wxWindows license

 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{Unicode support in wxWidgets}\label{unicode}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{Unicode support in wxWidgets}\label{unicode}


@@ -15,9 +15,9 @@ This section briefly describes the state of the Unicode support in wxWidgets.
 Read it if you want to know more about how to write programs able to work with
 characters from languages other than English.
 
 Read it if you want to know more about how to write programs able to work with
 characters from languages other than English.
 

-\subsection{What is Unicode?}
+\subsection{What is Unicode?}\label{whatisunicode}

 
 

-Starting with release 2.1 wxWidgets has support for compiling in Unicode mode
+wxWidgets has support for compiling in Unicode mode

 on the platforms which support it. Unicode is a standard for character
 encoding which addresses the shortcomings of the previous, 8 bit standards, by
 using at least 16 (and possibly 32) bits for encoding each character. This
 on the platforms which support it. Unicode is a standard for character
 encoding which addresses the shortcomings of the previous, 8 bit standards, by
 using at least 16 (and possibly 32) bits for encoding each character. This


@@ -40,7 +40,7 @@ from using Unicode because they will work more efficiently - there will be no
 need for the system to convert all strings the program uses to/from Unicode
 each time a system call is made.
 
 need for the system to convert all strings the program uses to/from Unicode
 each time a system call is made.
 

-\subsection{Unicode and ANSI modes}
+\subsection{Unicode and ANSI modes}\label{unicodeandansi}

 
 As not all platforms supported by wxWidgets support Unicode (fully) yet, in
 many cases it is unwise to write a program which can only work in Unicode
 
 As not all platforms supported by wxWidgets support Unicode (fully) yet, in
 many cases it is unwise to write a program which can only work in Unicode


@@ -109,7 +109,7 @@ be done this way (try to imagine the number of {\tt \#ifdef UNICODE} an average
 program would have had!). Luckily, there is another way - see the next
 section.
 
 program would have had!). Luckily, there is another way - see the next
 section.
 

-\subsection{Unicode support in wxWidgets}
+\subsection{Unicode support in wxWidgets}\label{unicodeinsidewxw}

 
 In wxWidgets, the code fragment from above should be written instead:
 
 
 In wxWidgets, the code fragment from above should be written instead:
 


@@ -121,7 +121,7 @@ In wxWidgets, the code fragment from above should be written instead:
 
 What happens here? First of all, you see that there are no more {\tt \#ifdef}s
 at all. Instead, we define some types and macros which behave differently in
 
 What happens here? First of all, you see that there are no more {\tt \#ifdef}s
 at all. Instead, we define some types and macros which behave differently in

-the Unicode and ANSI builds and allows us to avoid using conditional
+the Unicode and ANSI builds and allow us to avoid using conditional

 compilation in the program itself.
 
 We have a {\tt wxChar} type which maps either on {\tt char} or {\tt wchar\_t} 
 compilation in the program itself.
 
 We have a {\tt wxChar} type which maps either on {\tt char} or {\tt wchar\_t} 


@@ -152,7 +152,7 @@ to an external function which doesn't accept wide-character strings.
 \item Use {\tt wxString} instead of C style strings.
 \end{itemize}
 
 \item Use {\tt wxString} instead of C style strings.
 \end{itemize}
 

-\subsection{Unicode and the outside world}
+\subsection{Unicode and the outside world}\label{unicodeoutsidewxw}

 
 We have seen that it was easy to write Unicode programs using wxWidgets types
 and macros, but it has been also mentioned that it isn't quite enough.
 
 We have seen that it was easy to write Unicode programs using wxWidgets types
 and macros, but it has been also mentioned that it isn't quite enough.


@@ -162,7 +162,7 @@ ANSI strings (a notable exception is the entire Win32 API which accepts either
 Unicode or ANSI strings and which thus makes it unnecessary to ever perform
 any conversions in the program). GTK 2.0 only accepts UTF-8 strings.
 
 Unicode or ANSI strings and which thus makes it unnecessary to ever perform
 any conversions in the program). GTK 2.0 only accepts UTF-8 strings.
 

-To get a ANSI string from a wxString, you may use the 
+To get an ANSI string from a wxString, you may use the 

 mb\_str() function which always returns an ANSI
 string (independently of the mode - while the usual 
 \helpref{c\_str()}{wxstringcstr} returns a pointer to the internal
 mb\_str() function which always returns an ANSI
 string (independently of the mode - while the usual 
 \helpref{c\_str()}{wxstringcstr} returns a pointer to the internal


@@ -170,14 +170,26 @@ representation which is either ASCII or Unicode). More rarely used, but still
 useful, is wc\_str() function which always returns
 the Unicode string.
 
 useful, is wc\_str() function which always returns
 the Unicode string.
 

+Sometimes it is also necessary to go from ANSI strings to wxStrings.  
+In this case, you can use the converter-constructor, as follows:
+ 
+\begin{verbatim}
+   const char* ascii_str = "Some text";
+   wxString str(ascii_str, wxConvUTF8);
+\end{verbatim}
+
+This code also compiles fine under a non-Unicode build of wxWidgets,
+but in that case the converter is ignored.
+
+For more information about converters and Unicode see
+the \helpref{wxMBConv classes overview}{mbconvclasses}.
+

 % TODO describe fn_str(), wx_str(), wxCharBuf classes, ...
 
 % TODO describe fn_str(), wx_str(), wxCharBuf classes, ...
 

-\subsection{Unicode-related compilation settings}
+\subsection{Unicode-related compilation settings}\label{unicodesettings}

 
 You should define {\tt wxUSE\_UNICODE} to $1$ to compile your program in
 
 You should define {\tt wxUSE\_UNICODE} to $1$ to compile your program in

-Unicode mode. Note that it currently only works in Win32 and GTK 2.0 and
-that some parts of
-wxWidgets are not Unicode-compliant yet (ODBC classes, for example). If you
+Unicode mode. This currently works for wxMSW, wxGTK, wxMac and wxX11. If you

 compile your program in ANSI mode you can still define {\tt wxUSE\_WCHAR\_T} 
 to get some limited support for {\tt wchar\_t} type.
 
 compile your program in ANSI mode you can still define {\tt wxUSE\_WCHAR\_T} 
 to get some limited support for {\tt wchar\_t} type.