1. added a brief overview of Unicode support

2. added and documented wxBITMAP() macros (as wxICON)
3. restructured wxFont class, added support of encoding parameter
4. regenerated makefiles to compile the new fontcmn.cpp file
5. corrected bug with non existing files in document-view history


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@3753 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/latex/wx/font.tex

@@ -41,7 +41,8 @@ wxSWISS\_FONT}
 Default constructor.
 
 \func{}{wxFont}{\param{int}{ pointSize}, \param{int}{ family}, \param{int}{ style}, \param{int}{ weight},
- \param{const bool}{ underline = FALSE}, \param{const wxString\& }{faceName = ""}}
+ \param{const bool}{ underline = FALSE}, \param{const wxString\& }{faceName = ""},
+ \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}
 
 Creates a font object.
 
@@ -70,6 +71,22 @@ Creates a font object.
 \docparam{faceName}{An optional string specifying the actual typeface to be used. If the empty string,
 a default typeface will chosen based on the family.}
 
+\docparam{encoding}{An encoding which may be one of
+\twocolwidtha{5cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf wxFONTENCODING\_SYSTEM}}{Default system encoding.}
+\twocolitem{{\bf wxFONTENCODING\_DEFAULT}}{Default application encoding: this
+is the encoding set by calls to 
+\helpref{SetDefaultEncoding}{wxfontsetdefaultencoding} and which may beset to,
+say, KOI8 to create all fonts by default with KOI8 encoding. Initially, the
+default application encoding is the same as default system encoding.}
+\twocolitem{{\bf wxFONTENCODING\_ISO8859\_1...15}}{ISO8859 encodings.}
+\twocolitem{{\bf wxFONTENCODING\_KOI8}}{The standard russian encoding for Internet.}
+\twocolitem{{\bf wxFONTENCODING\_CP1250...1252}}{Windows encodings similar to ISO8859 (but not identical).}
+\end{twocollist}
+If the specified encoding isn't available, no font is created.
+}
+
 \wxheading{Remarks}
 
 If the desired font does not exist, the closest match will be chosen.

docs/latex/wx/function.tex

@@ -1928,6 +1928,23 @@ base classes.
 
 <wx/object.h>
 
+\membersection{wxBITMAP}\label{wxbitmap}
+
+\func{}{wxBITMAP}{bitmapName}
+
+This macro loads a bitmap from either application resources (on the platforms
+for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
+avoid using {\tt #ifdef}s when creating bitmaps.
+
+\wxheading{See also}
+
+\helpref{Bitmaps and icons overview}{wxbitmapoverview},
+\helpref{wxICON}{wxicon}
+
+\wxheading{Include files}
+
+<wx/gdicmn.h>
+
 \membersection{WXDEBUG\_NEW}\label{debugnew}
 
 \func{}{WXDEBUG\_NEW}{arg}
@@ -1975,6 +1992,23 @@ Example:
 
 \helpref{RTTI overview}{runtimeclassoverview}
 
+\membersection{wxICON}\label{wxicon}
+
+\func{}{wxICON}{iconName}
+
+This macro loads an icon from either application resources (on the platforms
+for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
+avoid using {\tt #ifdef}s when creating icons.
+
+\wxheading{See also}
+
+\helpref{Bitmaps and icons overview}{wxbitmapoverview},
+\helpref{wxBITMAP}{wxbitmap}
+
+\wxheading{Include files}
+
+<wx/gdicmn.h>
+
 \membersection{WXTRACE}\label{trace}
 
 \wxheading{Include files}

docs/latex/wx/tbitmap.tex

@@ -30,7 +30,7 @@ XPM icon file to be available at run-time.
 #endif
 \end{verbatim}
 
-A macro, wxICON, is available which creates an icon using an XPM
+A macro, \helpref{wxICON}{wxicon}, is available which creates an icon using an XPM
 on the appropriate platform, or an icon resource on Windows.
 
 \begin{verbatim}
@@ -47,6 +47,30 @@ wxIcon icon("mondrian");
 #endif
 \end{verbatim}
 
+There is also a corresponding \helpref{wxBITMAP}{wxbitmap} macro which allows
+to create the bitmaps in much the same way as \helpref{wxICON}{wxicon} creates
+icons. It assumes that bitmaps live in resources under Windows or OS2 and XPM
+files under all other platforms (for XPMs, the corresponding file must be
+included before this macro is used, of course, and the name of the bitmap
+should be the same as the resource name under Windows with {\tt \_xpm}
+suffix). For example:
+
+\begin{verbatim}
+// an easy and portable way to create a bitmap
+wxBitmap bmp(wxBITMAP(bmpname));
+
+// which is roughly equivalent to the following
+#if defined(__WXMSW__) || defined(__WXPM__)
+    wxBitmap bmp("bmpname", wxBITMAP_TYPE_RESOURCE);
+#else // Unix
+    wxBitmap bmp(bmpname_xpm, wxBITMAP_TYPE_XPM);
+#endif
+\end{verbatim}
+
+You should always use wxICON and wxBITMAP macros because they work for any
+platform (unlike the code above which doesn't deal with wxMac, wxBe, ...) and
+are more short and clear than versions with {\tt #ifdef}s.
+
 \subsection{Supported bitmap file formats}\label{supportedbitmapformats}
 
 The following lists the formats handled on different platforms. Note

docs/latex/wx/tunicode.tex

@@ -0,0 +1,156 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        tunicode.tex
+%% Purpose:     Overview of the Unicode support in wxWindows
+%% Author:      Vadim Zeitlin
+%% Modified by:
+%% Created:     22.09.99
+%% RCS-ID:      $Id$
+%% Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
+%% Licence:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\section{Unicode support in wxWindows}\label{unicode}
+
+This section briefly describes the state of the Unicode support in wxWindows.
+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?}
+
+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
+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}.
+
+% TODO expand on it, say that Unicode extends ASCII, mention ISO8859, ...
+
+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
+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
+each time a system call is made.
+
+\subsection{Unicode and ANSI modes}
+
+As not all platforms supported by wxWindows support Unicode (fully) yet, in
+many cases it is unwise to write a program which can only work in Unicode
+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.
+Basicly, 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 '*'})
+\item String functions ({\tt strlen()}, {\tt strcpy()}, ...)
+\end{itemize}
+
+Let's look at them in order. First of all, each character in an Unicode
+program takes 2 bytes instead of usual one, so another type should be used to
+store the characters ({\tt char} only holds 1 byte usually). This type is
+called {\tt wchar\_t} which stands for {\it wide-character type}.
+
+Also, the string and character constants should be encoded on 2 bytes instead
+of one. This is achieved by using the standard C (and C++) way: just put the
+letter {\tt 'L'} after any string constant and it becomes a {\it long}
+constant, i.e. a wide character one. To make things a bit more readable, you
+are also allowed to prefix the constant with {\tt 'L'} instead of putting it
+after it.
+
+Finally, the standard C functions don't work with {\tt wchar\_t} strings, so
+another set of functions exists which do the same thing but accept 
+{\tt wchar\_t *} instead of {\tt char *}. For example, a function to get the
+length of a wide-character string is called {\tt wcslen()} (compare with 
+{\tt strlen()} - you see that the only difference is that the "str" prefix
+standing for "string" has been replaced with "wcs" standing for
+"wide-character string").
+
+To summarize, here is a brief example of how a program which can be compiled
+in both ANSI and Unicode modes could look like:
+
+\begin{verbatim}
+#ifdef __UNICODE__
+    wchar_t wch = L'*';
+    const wchar_t *ws = L"Hello, world!";
+    int len = wcslen(ws);
+#else // ANSI
+    char ch = '*';
+    const char *s = "Hello, world!";
+    int len = strlen(s);
+#endif // Unicode/ANSI
+\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
+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:
+
+\begin{verbatim}
+    wxChar ch = T('*');
+    wxString s = T("Hello, world!");
+    int len = s.Len();
+\end{verbatim}
+
+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.
+
+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.
+
+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
+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
+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}
+\item Always enclose literal string constants in {\tt T()} macro unless
+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
+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.
+\end{itemize}
+
+\subsection{Unicode and the outside world}
+
+We have seen that it was easy to write Unicode programs using wxWindows types
+and macros, but it has been also mentioned that it isn't quite enough.
+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
+any convertions in the program).
+
+To get a ANSI string from a wxString, you may use 
+\helpref{mb\_str()}{wxstringmbstr} 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
+useful, is \helpref{wc\_str()}{wxstringwcstr} function which always returns
+the Unicode string.
+
+% TODO describe fn_str(), wx_str(), wxCharBuf classes, ...