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