docs/doxygen/libs.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        libs.h
   3 // Purpose:     Libraries page of the Doxygen manual
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9
  10 /*!
  11
  12  @page libraries_page Libraries list
  13
  14  wxWidgets can be built either as a single large
  15  library (this is called the {\it monolithic build}) or as several smaller
  16  libraries ({\it multilib build}). Multilib build is the default.
  17
  18  wxWidgets library is divided into libraries briefly described below. This
  19  diagram show dependencies between them:
  20
  21  @image html libs.gif
  22
  23  Please note that arrows indicate the "depends from" relation and that
  24  all blue boxes depend from wxBase library (i.e. they are non-GUI libraries), and
  25  all green boxes depend from wxCore library (i.e. they are GUI libraries).
  26
  27  @section wxBase wxBase
  28
  29  Every wxWidgets application must link against this library. It contains
  30  mandatory classes that any wxWidgets code depends on (e.g.
  31   \helpref{wxString}{wxstring}) and portability classes that abstract
  32  differences between platforms. wxBase can be used to develop console mode
  33  applications, it does not require any GUI libraries or running X Window System
  34  on Unix.
  35
  36  @section wxCore wxCore
  37
  38  Basic GUI classes such as GDI classes or controls are in this library. All
  39  wxWidgets GUI applications must link against this library, only console mode
  40  applications don't.
  41
  42  Requires wxBase.
  43
  44  @section wxAui wxAui
  45
  46  This contains the Advanced User Interface docking library.
  47
  48  Requires wxAdvanced, wxHTML, wxXML, wxCore, wxBase.
  49
  50  @section wxNet wxNet
  51
  52  Classes for network access:
  53
  54  \begin{itemize}
  55  \item{ wxSocket classes (\helpref{wxSocketClient}{wxsocketclient},
  56   \helpref{wxSocketServer}{wxsocketserver} and related classes) }
  57  \item{ \helpref{wxSocketOutputStream}{wxsocketoutputstream} and
  58   \helpref{wxSocketInputStream}{wxsocketinputstream} }
  59  \item{ sockets-based IPC classes (\helpref{wxTCPServer}{wxddeserver},
  60   \helpref{wxTCPClient}{wxddeclient} and
  61   \helpref{wxTCPConnection}{wxddeconnection}) }
  62  \item{ \helpref{wxURL}{wxurl} }
  63  \item{ wxInternetFSHandler (a \helpref{wxFileSystem handler}{fs}) }
  64  \end{itemize}
  65
  66  Requires wxBase.
  67
  68  @section wxRichText wxRichText
  69
  70  This contains generic rich text control functionality.
  71
  72  Requires wxAdvanced, wxHTML, wxXML, wxCore, wxBase.
  73
  74  @section wxXML wxXML
  75
  76  This library contains simple classes for parsing XML documents.
  77
  78  Requires wxBase.
  79
  80  @section wxAdvanced wxAdvanced
  81
  82  Advanced or rarely used GUI classes:
  83
  84  \begin{itemize}\itemsep=0pt
  85  \item{ \helpref{wxCalendarCtrl}{wxcalendarctrl} }
  86  \item{ \helpref{wxGrid classes}{gridoverview} }
  87  \item{ \helpref{wxJoystick}{wxjoystick} }
  88  \item{ \helpref{wxLayoutAlgorithm}{wxlayoutalgorithm} }
  89  \item{ \helpref{wxSplashScreen}{wxsplashscreen} }
  90  \item{ \helpref{wxTaskBarIcon}{wxtaskbaricon} }
  91  \item{ \helpref{wxSound}{wxsound} }
  92  \item{ \helpref{wxWizard}{wxwizard} }
  93  \item{ \helpref{wxSashLayoutWindow}{wxsashlayoutwindow} }
  94  \item{ \helpref{wxSashWindow}{wxsashwindow} }
  95  \item{ ...others }
  96  \end{itemize}
  97
  98  Requires wxCore and wxBase.
  99
 100  @section wxMedia wxMedia
 101
 102  Miscellaneous classes related to multimedia. Currently this library only
 103  contains \helpref{wxMediaCtrl}{wxmediactrl} but more classes will be added in
 104  the future.
 105
 106  Requires wxCore and wxBase.
 107
 108  @section wxGL wxGL
 109
 110  This library contains \helpref{wxGLCanvas}{wxglcanvas} class for integrating
 111  OpenGL library with wxWidgets. Unlike all others, this library is {\em not}
 112   part of the monolithic library, it is always built as separate library.
 113
 114  Requires wxCore and wxBase.
 115
 116  @section wxHTML wxHTML
 117
 118  Simple HTML renderer and other \helpref{HTML rendering classes}{wxhtml} are
 119  contained in this library, as well as
 120   \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller},
 121   \helpref{wxBestHelpController}{wxhelpcontroller} and
 122   \helpref{wxHtmlListBox}{wxhtmllistbox}.
 123
 124  Requires wxCore and wxBase.
 125
 126  @section wxQA wxQA
 127
 128  This is the library containing extra classes for quality assurance. Currently
 129  it only contains \helpref{wxDebugReport}{wxdebugreport} and related classes,
 130  but more will be added to it in the future.
 131
 132  Requires wxXML, wxCore, wxBase.
 133
 134  @section wxXRC wxXRC
 135
 136  This library contains \helpref{wxXmlResource}{wxxmlresource} class that
 137  provides access to XML resource files in XRC format
 138
 139  Requires wxAdvanced, wxHTML, wxXML, wxCore, wxBase.
 140
 141  @section wxSTC wxSTC
 142
 143  STC (Styled Text Control) is a wrapper around Scintilla, a syntax-highlighting text editor.
 144
 145  Requires wxCore, wxBase.
 146
 147 */