sorting support for generic version (patch 1765087 from Bo)

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

diff --git a/docs/latex/wx/libs.tex b/docs/latex/wx/libs.tex
index ee7436b8a76bd1a744602e696ee3529ead68eca0..4da3b2a772fb7b219fae8047ad384ba76d2d0aee 100644 (file)
--- a/docs/latex/wx/libs.tex
+++ b/docs/latex/wx/libs.tex
@@ -2,70 +2,149 @@
 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 
 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 

-Starting from version 2.5.0 wxWindows can be built either as a single large
+wxWidgets can be built either as a single large

 library (this is called the {\it monolithic build}) or as several smaller
 libraries ({\it multilib build}). Multilib build is the default.
 
 library (this is called the {\it monolithic build}) or as several smaller
 libraries ({\it multilib build}). Multilib build is the default.
 

-wxWindows library is divided into following libraries:
+wxWidgets library is divided into libraries briefly described below. This
+diagram show dependencies between them:
+
+\begin{center}
+\image{}{libs.gif}
+\end{center}
+
+Please note that arrows indicate the "depends from" relation and that
+all blue boxes depend from wxBase library (i.e. they are non-GUI libraries), and
+all green boxes depend from wxCore library (i.e. they are GUI libraries).

 
 {\large {\bf wxBase}}
 
 
 {\large {\bf wxBase}}
 

-Every wxWindows application must link against this library. It contains
-mandatory classes that any wxWindows code depends on (e.g.
-\helpref{wxString}{wxstring}) and portability classes that abstract
+Every wxWidgets application must link against this library. It contains
+mandatory classes that any wxWidgets code depends on (e.g.
+ \helpref{wxString}{wxstring}) and portability classes that abstract

 differences between platforms. wxBase can be used to develop console mode
 applications, it does not require any GUI libraries or running X Window System
 on Unix.
 
 differences between platforms. wxBase can be used to develop console mode
 applications, it does not require any GUI libraries or running X Window System
 on Unix.
 

+{\large {\bf wxCore}}
+
+Basic GUI classes such as GDI classes or controls are in this library. All
+wxWidgets GUI applications must link against this library, only console mode
+applications don't.
+
+Requires wxBase.
+
+{\large {\bf wxAui}}
+
+This contains the Advanced User Interface docking library.
+
+Requires wxAdvanced, wxHTML, wxXML, wxCore, wxBase.
+

 {\large {\bf wxNet}}
 
 Classes for network access:
 {\large {\bf wxNet}}
 
 Classes for network access:

-wxSocket classes (\helpref{wxSocketClient}{wxsocketclient},
-\helpref{wxSocketServer}{wxsocketserver} and related classes),
-\helpref{wxSocketOutputStream}{wxsocketoutputstream},
-\helpref{wxSocketInputStream}{wxsocketinputstream},
-sockets-based IPC classes (\helpref{wxTCPServer}{wxddeserver},
-\helpref{wxTCPClient}{wxddeclient} and
-\helpref{wxTCPConnection}{wxddeconnection}),
-\helpref{wxURL}{wxurl},
-wxInternetFSHandler (a \helpref{wxFileSystem handler}{fs}).
+
+\begin{itemize}
+\item{ wxSocket classes (\helpref{wxSocketClient}{wxsocketclient},
+ \helpref{wxSocketServer}{wxsocketserver} and related classes) }
+\item{ \helpref{wxSocketOutputStream}{wxsocketoutputstream} and
+ \helpref{wxSocketInputStream}{wxsocketinputstream} }
+\item{ sockets-based IPC classes (\helpref{wxTCPServer}{wxddeserver},
+ \helpref{wxTCPClient}{wxddeclient} and
+ \helpref{wxTCPConnection}{wxddeconnection}) }
+\item{ \helpref{wxURL}{wxurl} }
+\item{ wxInternetFSHandler (a \helpref{wxFileSystem handler}{fs}) }
+\end{itemize}
+

 Requires wxBase.
 
 Requires wxBase.
 

+{\large {\bf wxRichText}}
+
+This contains generic rich text control functionality.
+
+Requires wxAdvanced, wxHTML, wxXML, wxCore, wxBase.
+

 {\large {\bf wxXML}}
 
 {\large {\bf wxXML}}
 

-This library contains simple classes for parsing XML documents. Note that
-their API {\em will} change in the future and backward
-compatibility will not be preserved. Use of this library in your applications
-is not recommended, it is only meant for use by XML resources system. Future
-versions of wxWindows will contain new XML handling classes with DOM-like API.
+This library contains simple classes for parsing XML documents.
+

 Requires wxBase.
 
 Requires wxBase.
 

-{\large {\bf wxODBC}}
+{\large {\bf wxAdvanced}}

 
 

-\helpref{Database classes}{odbcoverview}. Requires wxBase.
+Advanced or rarely used GUI classes:
+
+\begin{itemize}\itemsep=0pt
+\item{ \helpref{wxBufferedDC}{wxbuffereddc} }
+\item{ \helpref{wxCalendarCtrl}{wxcalendarctrl} }
+\item{ \helpref{wxGrid classes}{gridoverview} }
+\item{ \helpref{wxJoystick}{wxjoystick} }
+\item{ \helpref{wxLayoutAlgorithm}{wxlayoutalgorithm} }
+\item{ \helpref{wxSplashScreen}{wxsplashscreen} }
+\item{ \helpref{wxTaskBarIcon}{wxtaskbaricon} }
+\item{ \helpref{wxSound}{wxsound} }
+\item{ \helpref{wxWizard}{wxwizard} }
+\item{ \helpref{wxSashLayoutWindow}{wxsashlayoutwindow} }
+\item{ \helpref{wxSashWindow}{wxsashwindow} }
+\item{ ...others }
+\end{itemize}

 
 

-{\large {\bf wxCore}}
+Requires wxCore and wxBase.

 
 

-Basic GUI classes such as GDI classes or controls are in this library. All
-wxWindows GUI applications must link against this library, only console mode
-applications don't.
+{\large {\bf wxMedia}}

 
 

-{\large {\bf wxAdvanced}}
+Miscellaneous classes related to multimedia. Currently this library only
+contains \helpref{wxMediaCtrl}{wxmediactrl} but more classes will be added in
+the future.

 
 

-More advanced or rarely used GUI classes are in this library.

 Requires wxCore and wxBase.
 
 {\large {\bf wxGL}}
 
 This library contains \helpref{wxGLCanvas}{wxglcanvas} class for integrating
 Requires wxCore and wxBase.
 
 {\large {\bf wxGL}}
 
 This library contains \helpref{wxGLCanvas}{wxglcanvas} class for integrating

-OpenGL library with wxWindows. Unlike all other, this library is {\em not}
-part of the monolithic library, it is always built as separate library.
+OpenGL library with wxWidgets. Unlike all others, this library is {\em not}
+ part of the monolithic library, it is always built as separate library.
+

 Requires wxCore and wxBase.
 
 {\large {\bf wxHTML}}
 
 Simple HTML renderer and other \helpref{HTML rendering classes}{wxhtml} are
 contained in this library, as well as
 Requires wxCore and wxBase.
 
 {\large {\bf wxHTML}}
 
 Simple HTML renderer and other \helpref{HTML rendering classes}{wxhtml} are
 contained in this library, as well as

-\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller},
-\helpref{wxBestHelpController}{wxhelpcontroller} and
-\helpref{wxHtmlListBox}{wxhtmllistbox}. Requires wxCore and wxBase.
+ \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller},
+ \helpref{wxBestHelpController}{wxhelpcontroller} and
+ \helpref{wxHtmlListBox}{wxhtmllistbox}.
+
+Requires wxCore and wxBase.
+
+{\large {\bf wxODBC}}
+
+\helpref{Database classes}{odbcoverview}. Requires wxBase.
+
+{\large {\bf wxQA}}
+
+This is the library containing extra classes for quality assurance. Currently
+it only contains \helpref{wxDebugReport}{wxdebugreport} and related classes,
+but more will be added to it in the future.
+
+Requires wxXML, wxCore, wxBase.
+
+{\large {\bf wxDbGrid}}
+
+\helpref{wxDbGridTableBase}{wxdbgridtablebase} class which combines 
+ \helpref{wxGrid}{wxgrid} and \helpref{wxDbTable}{wxdbtable}. 
+
+Requires wxODBC, wxAdvanced, wxCore, wxBase.
+
+{\large {\bf wxXRC}}
+
+This library contains \helpref{wxXmlResource}{wxxmlresource} class that
+provides access to XML resource files in XRC format
+
+Requires wxAdvanced, wxHTML, wxXML, wxCore, wxBase.
+
+{\large {\bf wxSTC}}
+
+STC (Styled Text Control) is a wrapper around Scintilla, a syntax-highlighting text editor.
+
+Requires wxCore, wxBase.