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 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 wxBase}}
  17
  18 Every wxWidgets application must link against this library. It contains
  19 mandatory classes that any wxWidgets code depends on (e.g.
  20  \helpref{wxString}{wxstring}) and portability classes that abstract
  21 differences between platforms. wxBase can be used to develop console mode
  22 applications, it does not require any GUI libraries or running X Window System
  23 on Unix.
  24
  25 {\large {\bf wxCore}}
  26
  27 Basic GUI classes such as GDI classes or controls are in this library. All
  28 wxWidgets GUI applications must link against this library, only console mode
  29 applications don't.
  30
  31 {\large {\bf wxAui}}
  32
  33 This contains the Advanced User Interface docking library.
  34
  35 Requires wxHTML, wxAdvanced, wxCore, wxBase, wxXML.
  36
  37 {\large {\bf wxNet}}
  38
  39 Classes for network access:
  40
  41 \begin{itemize}
  42 \item{ wxSocket classes (\helpref{wxSocketClient}{wxsocketclient},
  43  \helpref{wxSocketServer}{wxsocketserver} and related classes) }
  44 \item{ \helpref{wxSocketOutputStream}{wxsocketoutputstream} and
  45  \helpref{wxSocketInputStream}{wxsocketinputstream} }
  46 \item{ sockets-based IPC classes (\helpref{wxTCPServer}{wxddeserver},
  47  \helpref{wxTCPClient}{wxddeclient} and
  48  \helpref{wxTCPConnection}{wxddeconnection}) }
  49 \item{ \helpref{wxURL}{wxurl} }
  50 \item{ wxInternetFSHandler (a \helpref{wxFileSystem handler}{fs}) }
  51 \end{itemize}
  52
  53 Requires wxBase.
  54
  55 {\large {\bf wxRichText}}
  56
  57 This contains generic rich text control functionality.
  58
  59 Requires wxAdvanced, wxHTML, wxCore, wxXML, wxBase.
  60
  61 {\large {\bf wxXML}}
  62
  63 This library contains simple classes for parsing XML documents.
  64
  65 Requires wxBase.
  66
  67 {\large {\bf wxAdvanced}}
  68
  69 Advanced or rarely used GUI classes:
  70
  71 \begin{itemize}\itemsep=0pt
  72 \item{ \helpref{wxBufferedDC}{wxbuffereddc} }
  73 \item{ \helpref{wxCalendarCtrl}{wxcalendarctrl} }
  74 \item{ \helpref{wxGrid classes}{gridoverview} }
  75 \item{ \helpref{wxJoystick}{wxjoystick} }
  76 \item{ \helpref{wxLayoutAlgorithm}{wxlayoutalgorithm} }
  77 \item{ \helpref{wxSplashScreen}{wxsplashscreen} }
  78 \item{ \helpref{wxTaskBarIcon}{wxtaskbaricon} }
  79 \item{ \helpref{wxSound}{wxsound} }
  80 \item{ \helpref{wxWizard}{wxwizard} }
  81 \item{ \helpref{wxSashLayoutWindow}{wxsashlayoutwindow} }
  82 \item{ \helpref{wxSashWindow}{wxsashwindow} }
  83 \item{ ...others }
  84 \end{itemize}
  85
  86 Requires wxCore and wxBase.
  87
  88 {\large {\bf wxMedia}}
  89
  90 Miscellaneous classes related to multimedia. Currently this library only
  91 contains \helpref{wxMediaCtrl}{wxmediactrl} but more classes will be added in
  92 the future.
  93
  94 Requires wxCore and wxBase.
  95
  96 {\large {\bf wxGL}}
  97
  98 This library contains \helpref{wxGLCanvas}{wxglcanvas} class for integrating
  99 OpenGL library with wxWidgets. Unlike all others, this library is {\em not}
 100  part of the monolithic library, it is always built as separate library.
 101
 102 Requires wxCore and wxBase.
 103
 104 {\large {\bf wxHTML}}
 105
 106 Simple HTML renderer and other \helpref{HTML rendering classes}{wxhtml} are
 107 contained in this library, as well as
 108  \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller},
 109  \helpref{wxBestHelpController}{wxhelpcontroller} and
 110  \helpref{wxHtmlListBox}{wxhtmllistbox}.
 111
 112 Requires wxCore and wxBase.
 113
 114 {\large {\bf wxODBC}}
 115
 116 \helpref{Database classes}{odbcoverview}. Requires wxBase.
 117
 118 {\large {\bf wxQA}}
 119
 120 This is the library containing extra classes for quality assurance. Currently
 121 it only contains \helpref{wxDebugReport}{wxdebugreport} and related classes,
 122 but more will be added to it in the future.
 123
 124 Requires wxCore, wxBase and wxXML.
 125
 126 {\large {\bf wxDbGrid}}
 127
 128 \helpref{wxDbGridTableBase}{wxdbgridtablebase} class which combines
 129  \helpref{wxGrid}{wxgrid} and \helpref{wxDbTable}{wxdbtable}.
 130
 131 Requires wxODBC and wxAdvanced.
 132
 133 {\large {\bf wxXRC}}
 134
 135 This library contains \helpref{wxXmlResource}{wxxmlresource} class that
 136 provides access to XML resource files in XRC format
 137
 138 Requires wxXML, wxCore, wxAdvanced and wxHTML.
 139
 140 {\large {\bf wxSTC}}
 141
 142 STC (Styled Text Control) is a wrapper around Scintilla, a syntax-highlighting text editor.
 143
 144 Requires wxCore, wxBase.