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