remove C++ comment

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

diff --git a/docs/latex/wx/libs.tex b/docs/latex/wx/libs.tex
index cb7be991dcc14b3c7984d7087411493a0fb7144f..4da3b2a772fb7b219fae8047ad384ba76d2d0aee 100644 (file)
--- a/docs/latex/wx/libs.tex
+++ b/docs/latex/wx/libs.tex
@@ -2,26 +2,44 @@
 \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 libraries briefly described below. This
+wxWidgets library is divided into libraries briefly described below. This

 diagram show dependencies between them:
 
 \begin{center}
 \image{}{libs.gif}
 \end{center}
 
 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:


@@ -36,51 +54,57 @@ Classes for network access:
  \helpref{wxTCPConnection}{wxddeconnection}) }
 \item{ \helpref{wxURL}{wxurl} }
 \item{ wxInternetFSHandler (a \helpref{wxFileSystem handler}{fs}) }
  \helpref{wxTCPConnection}{wxddeconnection}) }
 \item{ \helpref{wxURL}{wxurl} }
 \item{ wxInternetFSHandler (a \helpref{wxFileSystem handler}{fs}) }

-Requires wxBase.

 \end{itemize}
 
 \end{itemize}
 

-{\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.

 Requires wxBase.
 
 Requires wxBase.
 

-{\large {\bf wxCore}}
+{\large {\bf wxRichText}}

 
 

-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.
+This contains generic rich text control functionality.
+
+Requires wxAdvanced, wxHTML, wxXML, wxCore, wxBase.
+
+{\large {\bf wxXML}}
+
+This library contains simple classes for parsing XML documents.
+
+Requires wxBase.

 
 {\large {\bf wxAdvanced}}
 
 
 {\large {\bf wxAdvanced}}
 

-More advanced or rarely used GUI classes:
+Advanced or rarely used GUI classes:

 
 \begin{itemize}\itemsep=0pt
 
 \begin{itemize}\itemsep=0pt

-\item{ wxBufferedDC }
+\item{ \helpref{wxBufferedDC}{wxbuffereddc} }

 \item{ \helpref{wxCalendarCtrl}{wxcalendarctrl} }
 \item{ \helpref{wxCalendarCtrl}{wxcalendarctrl} }

-\item{ \helpref{wxDragImage}{wxdragimage} }

 \item{ \helpref{wxGrid classes}{gridoverview} }
 \item{ \helpref{wxJoystick}{wxjoystick} }
 \item{ \helpref{wxLayoutAlgorithm}{wxlayoutalgorithm} }
 \item{ \helpref{wxSplashScreen}{wxsplashscreen} }
 \item{ \helpref{wxTaskBarIcon}{wxtaskbaricon} }
 \item{ \helpref{wxGrid classes}{gridoverview} }
 \item{ \helpref{wxJoystick}{wxjoystick} }
 \item{ \helpref{wxLayoutAlgorithm}{wxlayoutalgorithm} }
 \item{ \helpref{wxSplashScreen}{wxsplashscreen} }
 \item{ \helpref{wxTaskBarIcon}{wxtaskbaricon} }

-\item{ wxTipDialog }
-\item{ \helpref{wxWave}{wxwave} }
+\item{ \helpref{wxSound}{wxsound} }

 \item{ \helpref{wxWizard}{wxwizard} }
 \item{ \helpref{wxSashLayoutWindow}{wxsashlayoutwindow} }
 \item{ \helpref{wxSashWindow}{wxsashwindow} }
 \item{ \helpref{wxWizard}{wxwizard} }
 \item{ \helpref{wxSashLayoutWindow}{wxsashlayoutwindow} }
 \item{ \helpref{wxSashWindow}{wxsashwindow} }

+\item{ ...others }

 \end{itemize}
 
 Requires wxCore and wxBase.
 
 \end{itemize}
 
 Requires wxCore and wxBase.
 

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

 {\large {\bf wxGL}}
 
 This library contains \helpref{wxGLCanvas}{wxglcanvas} class for integrating
 {\large {\bf wxGL}}
 
 This library contains \helpref{wxGLCanvas}{wxglcanvas} class for integrating

-OpenGL library with wxWindows. Unlike all others, this library is {\em not}
+OpenGL library with wxWidgets. Unlike all others, this library is {\em not}

  part of the monolithic library, it is always built as separate library.
  part of the monolithic library, it is always built as separate library.

+

 Requires wxCore and wxBase.
 
 {\large {\bf wxHTML}}
 Requires wxCore and wxBase.
 
 {\large {\bf wxHTML}}


@@ -89,15 +113,38 @@ 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
 contained in this library, as well as
  \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller},
  \helpref{wxBestHelpController}{wxhelpcontroller} and

- \helpref{wxHtmlListBox}{wxhtmllistbox}. Requires wxCore and wxBase.
+ \helpref{wxHtmlListBox}{wxhtmllistbox}.
+
+Requires wxCore and wxBase.

 
 {\large {\bf wxODBC}}
 
 \helpref{Database classes}{odbcoverview}. Requires 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}. 
 {\large {\bf wxDbGrid}}
 
 \helpref{wxDbGridTableBase}{wxdbgridtablebase} class which combines 
  \helpref{wxGrid}{wxgrid} and \helpref{wxDbTable}{wxdbtable}. 

-Requires wxODBC and wxAdvanced.

 
 

+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.