don't call wxYield() from EnsureVisible(), this is too dangerous - and unnecessary...

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

diff --git a/docs/latex/wx/tunicode.tex b/docs/latex/wx/tunicode.tex
index 43f36eb773e002493589efca84025cf20d7212e8..718c25d6fbfe81b9624160a1ded09e821b744352 100644 (file)
--- a/docs/latex/wx/tunicode.tex
+++ b/docs/latex/wx/tunicode.tex
@@ -19,7 +19,7 @@ characters from languages other than English.
 
 Starting with release 2.1 wxWindows has support for compiling in Unicode mode
 on the platforms which support it. Unicode is a standard for character
 
 Starting with release 2.1 wxWindows has support for compiling in Unicode mode
 on the platforms which support it. Unicode is a standard for character

-encoding which addreses the shortcomings of the previous, 8 bit standards, by
+encoding which addresses the shortcomings of the previous, 8 bit standards, by

 using 16 bit for encoding each character. This allows to have 65536 characters
 instead of the usual 256 and is sufficient to encode all of the world
 languages at once. More details about Unicode may be found at {\tt www.unicode.org}.
 using 16 bit for encoding each character. This allows to have 65536 characters
 instead of the usual 256 and is sufficient to encode all of the world
 languages at once. More details about Unicode may be found at {\tt www.unicode.org}.


@@ -28,14 +28,14 @@ languages at once. More details about Unicode may be found at {\tt www.unicode.o
 
 As this solution is obviously preferable to the previous ones (think of
 incompatible encodings for the same language, locale chaos and so on), many
 
 As this solution is obviously preferable to the previous ones (think of
 incompatible encodings for the same language, locale chaos and so on), many

-modern ooperating systems support it. The probably first example is Windows NT
+modern operating systems support it. The probably first example is Windows NT

 which uses only Unicode internally since its very first version.
 
 Writing internationalized programs is much easier with Unicode and, as the
 support for it improves, it should become more and more so. Moreover, in the
 Windows NT/2000 case, even the program which uses only standard ASCII can profit
 from using Unicode because they will work more efficiently - there will be no
 which uses only Unicode internally since its very first version.
 
 Writing internationalized programs is much easier with Unicode and, as the
 support for it improves, it should become more and more so. Moreover, in the
 Windows NT/2000 case, even the program which uses only standard ASCII can profit
 from using Unicode because they will work more efficiently - there will be no

-need for the system to convert all strings hte program uses to/from Unicode
+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}
 each time a system call is made.
 
 \subsection{Unicode and ANSI modes}


@@ -46,7 +46,8 @@ environment. A better solution is to write programs in such way that they may
 be compiled either in ANSI (traditional) mode or in the Unicode one.
 
 This can be achieved quite simply by using the means provided by wxWindows.
 be compiled either in ANSI (traditional) mode or in the Unicode one.
 
 This can be achieved quite simply by using the means provided by wxWindows.

-Basicly, there are only a few things to watch out for:
+Basically, there are only a few things to watch out for:
+

 \begin{itemize}
 \item Character type ({\tt char} or {\tt wchar\_t})
 \item Literal strings (i.e. {\tt "Hello, world!"} or {\tt '*'})
 \begin{itemize}
 \item Character type ({\tt char} or {\tt wchar\_t})
 \item Literal strings (i.e. {\tt "Hello, world!"} or {\tt '*'})


@@ -89,21 +90,21 @@ in both ANSI and Unicode modes could look like:
 \end{verbatim}
 
 Of course, it would be nearly impossibly to write such programs if it had to
 \end{verbatim}
 
 Of course, it would be nearly impossibly to write such programs if it had to

-be done this way (try to imagine the number of {\tt #ifdef UNICODE} an average
+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.
 
 \subsection{Unicode support in wxWindows}
 
 program would have had!). Luckily, there is another way - see the next
 section.
 
 \subsection{Unicode support in wxWindows}
 

-In wxWindows, the code fragment froim above should be written instead:
+In wxWindows, the code fragment from above should be written instead:

 
 \begin{verbatim}
 
 \begin{verbatim}

-    wxChar ch = T('*');
-    wxString s = T("Hello, world!");
+    wxChar ch = wxT('*');
+    wxString s = wxT("Hello, world!");

     int len = s.Len();
 \end{verbatim}
 
     int len = s.Len();
 \end{verbatim}
 

-What happens here? First of all, you see that there are no more {\tt #ifdef}s
+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
 compilation in the program itself.
 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
 compilation in the program itself.


@@ -111,25 +112,26 @@ compilation in the program itself.
 We have a {\tt wxChar} type which maps either on {\tt char} or {\tt wchar\_t} 
 depending on the mode in which program is being compiled. There is no need for
 a separate type for strings though, because the standard 
 We have a {\tt wxChar} type which maps either on {\tt char} or {\tt wchar\_t} 
 depending on the mode in which program is being compiled. There is no need for
 a separate type for strings though, because the standard 

-\helpref{wxString}{wxstring} supports Unicode, i.e. it stores iether ANSI or
-Unicode strings depending on the mode.
+\helpref{wxString}{wxstring} supports Unicode, i.e. it stores either ANSI or
+Unicode strings depending on the compile mode.

 
 

-Finally, there is a special {\tt T()} macro which should enclose all literal
-strings in the program. As it's easy to see comparing the last fragment with
+Finally, there is a special {\tt wxT()} macro which should enclose all literal
+strings in the program. As it is easy to see comparing the last fragment with

 the one above, this macro expands to nothing in the (usual) ANSI mode and
 prefixes {\tt 'L'} to its argument in the Unicode mode.
 
 The important conclusion is that if you use {\tt wxChar} instead of 
 {\tt char}, avoid using C style strings and use {\tt wxString} instead and
 the one above, this macro expands to nothing in the (usual) ANSI mode and
 prefixes {\tt 'L'} to its argument in the Unicode mode.
 
 The important conclusion is that if you use {\tt wxChar} instead of 
 {\tt char}, avoid using C style strings and use {\tt wxString} instead and

-don't forget to enclose all string literals inside {\tt T()} macro, your
+don't forget to enclose all string literals inside {\tt wxT()} macro, your

 program automatically becomes (almost) Unicode compliant!
 
 Just let us state once again the rules:
 program automatically becomes (almost) Unicode compliant!
 
 Just let us state once again the rules:

+

 \begin{itemize}
 \item Always use {\tt wxChar} instead of {\tt char}
 \begin{itemize}
 \item Always use {\tt wxChar} instead of {\tt char}

-\item Always enclose literal string constants in {\tt T()} macro unless
+\item Always enclose literal string constants in {\tt wxT()} macro unless

 they're already converted to the right representation (another standard
 they're already converted to the right representation (another standard

-wxWindows macro {\tt \_()} does it, so there is no need for {\tt T()} in this
+wxWindows macro {\tt \_()} does it, so there is no need for {\tt wxT()} in this

 case) or you intend to pass the constant directly to an external function
 which doesn't accept wide-character strings.
 \item Use {\tt wxString} instead of C style strings.
 case) or you intend to pass the constant directly to an external function
 which doesn't accept wide-character strings.
 \item Use {\tt wxString} instead of C style strings.


@@ -143,14 +145,28 @@ Although everything works fine inside the program, things can get nasty when
 it tries to communicate with the outside world which, sadly, often expects
 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
 it tries to communicate with the outside world which, sadly, often expects
 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 convertions in the program).
+any conversions in the program).

 
 

-To get a ANSI string from a wxString, you may use 
-\helpref{mb\_str()}{wxstringmbstr} function which always returns an ANSI
+To get a 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
 representation which is either ASCII or Unicode). More rarely used, but still
 string (independently of the mode - while the usual 
 \helpref{c\_str()}{wxstringcstr} returns a pointer to the internal
 representation which is either ASCII or Unicode). More rarely used, but still

-useful, is \helpref{wc\_str()}{wxstringwcstr} function which always returns
+useful, is wc\_str() function which always returns

 the Unicode string.
 
 % TODO describe fn_str(), wx_str(), wxCharBuf classes, ...
 the Unicode string.
 
 % TODO describe fn_str(), wx_str(), wxCharBuf classes, ...

+
+\subsection{Unicode-related compilation settings}
+
+You should define {\tt wxUSE\_UNICODE} to $1$ to compile your program in
+Unicode mode. Note that it currently only works in Win32 and that some parts of
+wxWindows are not Unicode-compliant yet (ODBC classes, for example). 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.
+
+This will allow your program to perform conversions between Unicode strings and
+ANSI ones (\helpref{wxEncodingConverter}{wxencodingconverter} depends on this
+partially) and construct wxString objects from Unicode strings (presumably read
+from some external file or elsewhere).
+