added wxFileType::GetMimeTypes

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

diff --git a/docs/latex/wx/body.tex b/docs/latex/wx/body.tex
index 8b8c35c2de7373636c74a86a0e9b7042daa483e3..d7f0e29828a0e6f30be57ee42ac2c72a92a73db0 100644 (file)
--- a/docs/latex/wx/body.tex
+++ b/docs/latex/wx/body.tex
@@ -7,14 +7,15 @@
 
 wxWindows is a C++ framework providing GUI (Graphical User
 Interface) and other facilities on more than one platform.  Version 2.0 currently
 
 wxWindows is a C++ framework providing GUI (Graphical User
 Interface) and other facilities on more than one platform.  Version 2.0 currently

-supports MS Windows (16-bit, Windows 95 and Windows NT) and GTK+, with Motif
-and Mac ports in an advanced state.
+supports MS Windows (16-bit, Windows 95 and Windows NT), Unix with GTK+, and Unix with Motif.
+A Mac port is in an advanced state, an OS/2 port and a port to the MGL graphics library
+have been started.

 
 wxWindows was originally developed at the Artificial Intelligence
 Applications Institute, University of Edinburgh, for internal use.
 wxWindows has been released into the public domain in the hope
 that others will also find it useful. Version 2.0 is written and
 
 wxWindows was originally developed at the Artificial Intelligence
 Applications Institute, University of Edinburgh, for internal use.
 wxWindows has been released into the public domain in the hope
 that others will also find it useful. Version 2.0 is written and

-maintained by Julian Smart, Robert Roebling and others.
+maintained by Julian Smart, Robert Roebling, Vadim Zeitlin and others.

 
 This manual discusses wxWindows in the context of multi-platform
 development.\helpignore{For more detail on the wxWindows version 2.0 API
 
 This manual discusses wxWindows in the context of multi-platform
 development.\helpignore{For more detail on the wxWindows version 2.0 API


@@ -78,27 +79,29 @@ here are some of the benefits:
 \item Low cost (free, in fact!)
 \item You get the source.
 \item Available on a variety of popular platforms.
 \item Low cost (free, in fact!)
 \item You get the source.
 \item Available on a variety of popular platforms.

-\item Works with almost all popular C++ compilers.
-\item Several example programs.
-\item Over 700 pages of printable and on-line documentation.
+\item Works with almost all popular C++ compilers and Python.
+\item Over 40 example programs.
+\item Over 900 pages of printable and on-line documentation.

 \item Includes Tex2RTF, to allow you to produce your own documentation
 in Windows Help, HTML and Word RTF formats.
 \item Simple-to-use, object-oriented API.
 \item Flexible event system.
 \item Graphics calls include lines, rounded rectangles, splines, polylines, etc.
 \item Includes Tex2RTF, to allow you to produce your own documentation
 in Windows Help, HTML and Word RTF formats.
 \item Simple-to-use, object-oriented API.
 \item Flexible event system.
 \item Graphics calls include lines, rounded rectangles, splines, polylines, etc.

-\item Constraint-based layout option.
+\item Constraint-based and sizer-based layouting.

 \item Print/preview and document/view architectures.
 \item Toolbar, notebook, tree control, advanced list control classes.
 \item Print/preview and document/view architectures.
 \item Toolbar, notebook, tree control, advanced list control classes.

-\item PostScript generation under Unix, normal MS Windows printing on the
-PC.
+\item PostScript generation under Unix, normal MS Windows printing on the PC.

 \item MDI (Multiple Document Interface) support.
 \item Can be used to create DLLs under Windows, dynamic libraries on Unix.
 \item Common dialogs for file browsing, printing, colour selection, etc.
 \item Under MS Windows, support for creating metafiles and copying
 them to the clipboard.
 \item An API for invoking help from applications.
 \item MDI (Multiple Document Interface) support.
 \item Can be used to create DLLs under Windows, dynamic libraries on Unix.
 \item Common dialogs for file browsing, printing, colour selection, etc.
 \item Under MS Windows, support for creating metafiles and copying
 them to the clipboard.
 \item An API for invoking help from applications.

+\item Ready to use HTML window (supporting a subset of HTML).

 \item Dialog Editor for building dialogs.
 \item Network support via a family of socket and protocol classes.
 \item Dialog Editor for building dialogs.
 \item Network support via a family of socket and protocol classes.

+\item Support for platform independent image procesing.
+\item Built-in support for many file formats (BMP, PNG, JPEG, GIF, XPM, PNM, PCX).

 \end{itemize}
 
 \section{Changes from version 1.xx}\label{versionchanges}
 \end{itemize}
 
 \section{Changes from version 1.xx}\label{versionchanges}


@@ -148,7 +151,7 @@ same API;
 temporarily with the window as an argument;
 \item events from sliders and scrollbars can be handled more flexibly;
 \item the handling of window close events has been changed in line with the new
 temporarily with the window as an argument;
 \item events from sliders and scrollbars can be handled more flexibly;
 \item the handling of window close events has been changed in line with the new

-event system, but backward {\bf OnClose} compatibility has been retained;
+event system;

 \item the concept of {\it validator} has been added to allow much easier coding of
 the relationship between controls and application data;
 \item the documentation has been revised, with more cross-referencing.
 \item the concept of {\it validator} has been added to allow much easier coding of
 the relationship between controls and application data;
 \item the documentation has been revised, with more cross-referencing.


@@ -164,6 +167,36 @@ borders;
 \item MDI classes brought out of wxFrame into separate classes, and made more flexible.
 \end{itemize}
 
 \item MDI classes brought out of wxFrame into separate classes, and made more flexible.
 \end{itemize}
 

+
+\section{Changes from version 2.0}\label{versionchanges20}
+
+These are a few of the differences between versions 2.0 and 2.2.
+
+Removals:
+
+\begin{itemize}\itemsep=0pt
+\item GTK 1.0 no longer supported.
+\end{itemize}
+
+Additions and changes:
+
+\begin{itemize}\itemsep=0pt
+\item Corrected many classes to conform better to documented behaviour.
+\item Added handlers for more image formats (Now GIF, JPEG, PCX, BMP, XPM, PNG, PNM).
+\item Improved support for socket and network functions.
+\item Support for different national font encodings.
+\item Sizer based layout system.
+\item HTML widget and help system.
+\item Added some controls (e.g. wxSpinCtrl) and supplemented many.
+\item Many optical improvements to GTK port.
+\item Support for menu accelerators in GTK port.
+\item Enhanced and improved support for scrolling, including child windows.
+\item Complete rewrite of clipboard and drag'n'drop classes.
+\item Improved support for ODBC databases.
+\item Improved tab traversal in dialogs.
+\end{itemize}
+
+

 \section{wxWindows requirements}\label{requirements}
 
 To make use of wxWindows, you currently need one or both of the
 \section{wxWindows requirements}\label{requirements}
 
 To make use of wxWindows, you currently need one or both of the


@@ -182,20 +215,25 @@ Metrowerks CodeWarrior.
 (b) Unix:
 
 \begin{enumerate}\itemsep=0pt
 (b) Unix:
 
 \begin{enumerate}\itemsep=0pt

-\item Almost any C++ compiler, including GNU C++.
-\item Almost any Unix workstation, and one of: GTK+ 1.0, Motif 1.2 or higher, Lesstif.
+\item Almost any C++ compiler, including GNU C++ (EGCS 1.1.1 or above).
+\item Almost any Unix workstation, and one of: GTK+ 1.2, Motif 1.2 or higher, Lesstif.

 \item At least 60 MB of disk space.
 \end{enumerate}
 
 \section{Availability and location of wxWindows}
 
 \item At least 60 MB of disk space.
 \end{enumerate}
 
 \section{Availability and location of wxWindows}
 

-wxWindows is currently available from the Artificial Intelligence
-Applications Institute by anonymous FTP and World Wide Web:
+wxWindows is available by anonymous FTP and World Wide Web
+from \urlref{ftp://www.remstar.com/pub/wxwin}{ftp://www.remstar.com/pub/wxwin} 
+and/or \urlref{http://www.wxwindows.org}{http://www.wxwindows.org}

 
 

-\begin{verbatim}
-  ftp://www.remstar.com/pub/wxwin
-  http://wxwin.home.ml.org
-\end{verbatim}
+You can also buy a CD-ROM using the form on the Web site, or by contacting:
+
+Julian Smart\\
+12 North Street West\\
+Uppingham\\
+Rutland\\
+LE15 9SG\\
+julian.smart@ukonline.co.uk

 
 \section{Acknowledgments}
 
 
 \section{Acknowledgments}
 


@@ -211,7 +249,7 @@ Dunn, Hermann Dunkel, Jos van Eijndhoven, Tom Felici, Thomas Fettig, Matthew Fla
 Wolfram Gloger, Norbert Grotz, Stefan Gunter, Bill Hale, Patrick Halke, Stefan Hammes, Guillaume Helle, Harco de Hilster, Cord Hockemeyer, Markus 
 Holzem, Olaf Klein, Leif Jensen, Bart Jourquin, Guilhem Lavaux, Jan Lessner, Nicholas Liebmann, Torsten Liermann, Per Lindqvist, Thomas Runge, Tatu
 M\"{a}nnist\"{o}, Scott Maxwell, Thomas Myers, Oliver Niedung, Hernan Otero, Ian Perrigo, Timothy Peters, Giordano Pezzoli, Harri Pasanen, Thomaso Paoletti, 
 Wolfram Gloger, Norbert Grotz, Stefan Gunter, Bill Hale, Patrick Halke, Stefan Hammes, Guillaume Helle, Harco de Hilster, Cord Hockemeyer, Markus 
 Holzem, Olaf Klein, Leif Jensen, Bart Jourquin, Guilhem Lavaux, Jan Lessner, Nicholas Liebmann, Torsten Liermann, Per Lindqvist, Thomas Runge, Tatu
 M\"{a}nnist\"{o}, Scott Maxwell, Thomas Myers, Oliver Niedung, Hernan Otero, Ian Perrigo, Timothy Peters, Giordano Pezzoli, Harri Pasanen, Thomaso Paoletti, 

-Garrett Potts, Marcel Rasche, Robert Roebling, Dino Scaringella, Jobst Schmalenbach, Arthur Seaton, Paul Shirley, Stein Somers, Petr Smilauer, Neil Smith, 
+Garrett Potts, Marcel Rasche, Robert Roebling, Dino Scaringella, Jobst Schmalenbach, Arthur Seaton, Paul Shirley, Vaclav Slavik, Stein Somers, Petr Smilauer, Neil Smith, 

 Kari Syst\"{a}, Arthur Tetzlaff-Deas, Jonathan Tonberg, Jyrki Tuomi, Janos Vegh, Andrea Venturoli, Vadim Zeitlin, Xiaokun Zhu, Edward Zimmermann.
 
 `Graphplace', the basis for the wxGraphLayout library, is copyright Dr. Jos
 Kari Syst\"{a}, Arthur Tetzlaff-Deas, Jonathan Tonberg, Jyrki Tuomi, Janos Vegh, Andrea Venturoli, Vadim Zeitlin, Xiaokun Zhu, Edward Zimmermann.
 
 `Graphplace', the basis for the wxGraphLayout library, is copyright Dr. Jos


@@ -281,31 +319,52 @@ multi-megabyte .pch files.
 
 \section{Libraries}
 
 
 \section{Libraries}
 

-Please the wxGTK or wxMotif documentation for use of the Unix version of wxWindows.
+The GTK and Motif ports of wxWindow can create either a static library or a shared
+library on most Unix or Unix-like systems. The static library is called libwx\_gtk.a
+and libwx\_motif.a whereas the name of the shared library is dependent on the
+system it is created on and the version you are using. The library name for the
+GTK version of wxWindows 2.2 on Linux and Solaris will be libwx\_gtk-2.2.so.0.0.0,
+on HP-UX, it will be libwx\_gtk-2.2.sl, on AIX just libwx\_gtk.a etc.
+

 Under Windows, use the library wx.lib for stand-alone Windows
 applications, or wxdll.lib for creating DLLs.
 
 \section{Configuration}
 
 Options are configurable in the file
 Under Windows, use the library wx.lib for stand-alone Windows
 applications, or wxdll.lib for creating DLLs.
 
 \section{Configuration}
 
 Options are configurable in the file

-\rtfsp{\tt "wx/XXX/setup.h"} where XXX is the required platform (such as msw, motif, gtk, mac). Some settings are a matter
-of taste, some help with platform-specific problems, and
+\rtfsp{\tt "wx/XXX/setup.h"} where XXX is the required platform (such as msw, motif, gtk, mac). Some 
+settings are a matter of taste, some help with platform-specific problems, and

 others can be set to minimize the size of the library. Please see the setup.h file
 and {\tt install.txt} files for details on configuration.
 
 others can be set to minimize the size of the library. Please see the setup.h file
 and {\tt install.txt} files for details on configuration.
 

+Under Unix (GTK and Motif) the corresponding setup.h files are generated automatically
+when configuring the wxWindows using the "configure" script. When using the RPM packages
+for installing wxWindows on Linux, a correct setup.h is shipped in the package and
+this must not be changed.
+

 \section{Makefiles}
 
 At the moment there is no attempt to make Unix makefiles and
 PC makefiles compatible, i.e. one makefile is required for
 \section{Makefiles}
 
 At the moment there is no attempt to make Unix makefiles and
 PC makefiles compatible, i.e. one makefile is required for

-each environment. wxGTK has its own configure system which can also
-be used with wxMotif, although wxMotif has a simple makefile system of its own.
-
-Sample makefiles for Unix (suffix .UNX), MS C++ (suffix .DOS and .NT), Borland
+each environment. The Unix ports use a sophisticated system based
+on the GNU autoconf tool and this system will create the
+makefiles as required on the respective platform. Although the
+makefiles are not identical in Windows, Mac and Unix, care has
+been taken to make them relatively similar so that moving from
+one platform to another will be painless.
+
+Sample makefiles for Unix (suffix .unx), MS C++ (suffix .DOS and .NT), Borland

 C++ (.BCC and .B32) and Symantec C++ (.SC) are included for the library, demos
 and utilities.
 
 C++ (.BCC and .B32) and Symantec C++ (.SC) are included for the library, demos
 and utilities.
 

-The controlling makefile for wxWindows is in the platform-specific
-directory, such as {\tt src/msw} or {\tt src/motif}.
+The controlling makefile for wxWindows is in the MS-Windows
+directory {\tt src/msw} for the different Windows compiler and
+in the build directory when using the Unix ports. The build
+directory can be chosen by the user. It is the directory in
+which the "configure" script is run. This can be the normal
+base directory (by running {\tt ./configure} there) or any other
+directory (e.g. {\tt ../configure} after creating a build-directory
+in the directory level above the base directory).

 
 Please see the platform-specific {\tt install.txt} file for further details.
 
 
 Please see the platform-specific {\tt install.txt} file for further details.
 


@@ -356,7 +415,7 @@ STACKSIZE    8192
 The only lines which will usually have to be changed per application are
 NAME and DESCRIPTION.
 
 The only lines which will usually have to be changed per application are
 NAME and DESCRIPTION.
 

-\subsection{Allocating and deleting wxWindows objects}
+\section{Allocating and deleting wxWindows objects}

 
 In general, classes derived from wxWindow must dynamically allocated
 with {\it new} and deleted with {\it delete}. If you delete a window,
 
 In general, classes derived from wxWindow must dynamically allocated
 with {\it new} and deleted with {\it delete}. If you delete a window,


@@ -386,6 +445,26 @@ make calls like wxDC::SetPen(wxNullPen) or wxDC::SelectObject(wxNullBitmap) befo
 a drawing object that may be in use. Code that doesn't do this will probably work
 fine on some platforms, and then fail under Windows.
 
 a drawing object that may be in use. Code that doesn't do this will probably work
 fine on some platforms, and then fail under Windows.
 

+\section{Architecture dependency}
+
+A problem which sometimes arises from writing multi-platform programs is that
+the basic C types are not defiend the same on all platforms. This holds true
+for both the length in bits of the standard types (such as int and long) as 
+well as their byte order, which might be little endian (typically
+on Intel computers) or big endian (typically on some Unix workstations). wxWindows
+defines types and macros that make it easy to write architecture independent
+code. The types are:
+
+wxInt32, wxInt16, wxInt8, wxUint32, wxUint16 = wxWord, wxUint8 = wxByte
+
+where wxInt32 stands for a 32-bit signed integer type etc. You can also check
+which architecture the program is compiled on using the wxBYTE\_ORDER define
+which is either wxBIG\_ENDIAN or wxLITTLE\_ENDIAN (in the future maybe wxPDP\_ENDIAN
+as well).
+
+The macros handling bit-swapping with respect to the applications endianness
+are described in the \helpref{Macros}{macros} section.
+

 \section{Conditional compilation}
 
 One of the purposes of wxWindows is to reduce the need for conditional
 \section{Conditional compilation}
 
 One of the purposes of wxWindows is to reduce the need for conditional


@@ -403,6 +482,27 @@ The following documents some miscellaneous C++ issues.
 
 wxWindows does not use templates since it is a notoriously unportable feature.
 
 
 wxWindows does not use templates since it is a notoriously unportable feature.
 

+\subsection{RTTI}
+
+wxWindows does not use run-time type information since wxWindows provides
+its own run-time type information system, implemented using macros.
+
+\subsection{Type of NULL}
+
+Some compilers (e.g. the native IRIX cc) define NULL to be 0L so that
+no conversion to pointers is allowed. Because of that, all these
+occurences of NULL in the GTK port use an explicit conversion such 
+as
+
+{\small
+\begin{verbatim}
+  wxWindow *my_window = (wxWindow*) NULL;
+\end{verbatim}
+}
+
+It is recommended to adhere to this in all code using wxWindows as
+this make the code (a bit) more portable.
+

 \subsection{Precompiled headers}
 
 Some compilers, such as Borland C++ and Microsoft C++, support
 \subsection{Precompiled headers}
 
 Some compilers, such as Borland C++ and Microsoft C++, support


@@ -677,7 +777,8 @@ See the \helpref{debugging overview}{debuggingoverview} for further information.
 
 \subsection{Check Windows debug messages}
 
 
 \subsection{Check Windows debug messages}
 

-Under Windows, it's worth running your program with DBWIN running or
+Under Windows, it's worth running your program with 
+\urlref{DbgView}{http://www.sysinternals.com} running or

 some other program that shows Windows-generated debug messages. It's
 possible it'll show invalid handles being used. You may have fun seeing
 what commercial programs cause these normally hidden errors! Microsoft
 some other program that shows Windows-generated debug messages. It's
 possible it'll show invalid handles being used. You may have fun seeing
 what commercial programs cause these normally hidden errors! Microsoft