docs/latex/wx/libs.tex

   1 \chapter{Libraries list}\label{librarieslist}
   2 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
   3 \setfooter{\thepage}{}{}{}{}{\thepage}%
   4
   5 Starting from version 2.5.0 wxWidgets can be built either as a single large
   6 library (this is called the {\it monolithic build}) or as several smaller
   7 libraries ({\it multilib build}). Multilib build is the default.
   8
   9 wxWidgets library is divided into libraries briefly described below. This
  10 diagram show dependencies between them:
  11
  12 \begin{center}
  13 \image{}{libs.gif}
  14 \end{center}
  15
  16 {\large {\bf wxAui}}
  17
  18 This contains the Advanced User Interface docking library.
  19
  20 {\large {\bf wxBase}}
  21
  22 Every wxWidgets application must link against this library. It contains
  23 mandatory classes that any wxWidgets code depends on (e.g.
  24  \helpref{wxString}{wxstring}) and portability classes that abstract
  25 differences between platforms. wxBase can be used to develop console mode
  26 applications, it does not require any GUI libraries or running X Window System
  27 on Unix.
  28
  29 {\large {\bf wxNet}}
  30
  31 Classes for network access:
  32
  33 \begin{itemize}
  34 \item{ wxSocket classes (\helpref{wxSocketClient}{wxsocketclient},
  35  \helpref{wxSocketServer}{wxsocketserver} and related classes) }
  36 \item{ \helpref{wxSocketOutputStream}{wxsocketoutputstream} and
  37  \helpref{wxSocketInputStream}{wxsocketinputstream} }
  38 \item{ sockets-based IPC classes (\helpref{wxTCPServer}{wxddeserver},
  39  \helpref{wxTCPClient}{wxddeclient} and
  40  \helpref{wxTCPConnection}{wxddeconnection}) }
  41 \item{ \helpref{wxURL}{wxurl} }
  42 \item{ wxInternetFSHandler (a \helpref{wxFileSystem handler}{fs}) }
  43 Requires wxBase.
  44 \end{itemize}
  45
  46 {\large {\bf wxRichText}}
  47
  48 This contains generic rich text control functionality.
  49
  50 {\large {\bf wxXML}}
  51
  52 This library contains simple classes for parsing XML documents. Note that
  53 their API {\em will} change in the future and backward
  54 compatibility will not be preserved. Use of this library in your applications
  55 is not recommended, it is only meant for use by XML resources system. Future
  56 versions of wxWidgets will contain new XML handling classes with DOM-like API.
  57 Requires wxBase.
  58
  59 {\large {\bf wxCore}}
  60
  61 Basic GUI classes such as GDI classes or controls are in this library. All
  62 wxWidgets GUI applications must link against this library, only console mode
  63 applications don't.
  64
  65 {\large {\bf wxAdvanced}}
  66
  67 Advanced or rarely used GUI classes:
  68
  69 \begin{itemize}\itemsep=0pt
  70 \item{ wxBufferedDC }
  71 \item{ \helpref{wxCalendarCtrl}{wxcalendarctrl} }
  72 \item{ \helpref{wxGrid classes}{gridoverview} }
  73 \item{ \helpref{wxJoystick}{wxjoystick} }
  74 \item{ \helpref{wxLayoutAlgorithm}{wxlayoutalgorithm} }
  75 \item{ \helpref{wxSplashScreen}{wxsplashscreen} }
  76 \item{ \helpref{wxTaskBarIcon}{wxtaskbaricon} }
  77 \item{ \helpref{wxSound}{wxsound} }
  78 \item{ \helpref{wxWizard}{wxwizard} }
  79 \item{ \helpref{wxSashLayoutWindow}{wxsashlayoutwindow} }
  80 \item{ \helpref{wxSashWindow}{wxsashwindow} }
  81 \end{itemize}
  82
  83 Requires wxCore and wxBase.
  84
  85 {\large {\bf wxMedia}}
  86
  87 Miscellaneous classes related to multimedia. Currently this library only
  88 contains \helpref{wxMediaCtrl}{wxmediactrl} but more classes will be added in
  89 the future.
  90
  91 Requires wxCore and wxBase.
  92
  93 {\large {\bf wxGL}}
  94
  95 This library contains \helpref{wxGLCanvas}{wxglcanvas} class for integrating
  96 OpenGL library with wxWidgets. Unlike all others, this library is {\em not}
  97  part of the monolithic library, it is always built as separate library.
  98 Requires wxCore and wxBase.
  99
 100 {\large {\bf wxHTML}}
 101
 102 Simple HTML renderer and other \helpref{HTML rendering classes}{wxhtml} are
 103 contained in this library, as well as
 104  \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller},
 105  \helpref{wxBestHelpController}{wxhelpcontroller} and
 106  \helpref{wxHtmlListBox}{wxhtmllistbox}. Requires wxCore and wxBase.
 107
 108 {\large {\bf wxODBC}}
 109
 110 \helpref{Database classes}{odbcoverview}. Requires wxBase.
 111
 112 {\large {\bf wxQA}}
 113
 114 This is the library containing extra classes for quality assurance. Currently
 115 it only contains \helpref{wxDebugReport}{wxdebugreport} and related classes,
 116 but more will be added to it in the future.
 117
 118 Requires wxCore, wxBase and wxXML.
 119
 120 {\large {\bf wxDbGrid}}
 121
 122 \helpref{wxDbGridTableBase}{wxdbgridtablebase} class which combines
 123  \helpref{wxGrid}{wxgrid} and \helpref{wxDbTable}{wxdbtable}.
 124 Requires wxODBC and wxAdvanced.
 125
 126 {\large {\bf wxXRC}}
 127
 128 This library contains \helpref{wxXmlResource}{wxxmlresource} class that
 129 provides access to XML resource files in XRC format.
 130 Requires wxXML, wxCore, wxAdvanced and wxHTML.
 131