docs/doxygen/mainpages/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 @page page_libs Library List
  12
  13 wxWidgets can be built either as a single large library (this is called a
  14 <em>monolithic build</em>) or as several smaller libraries
  15 (<em>multilib build</em>). Multilib build is the default.
  16
  17 wxWidgets library is divided into libraries briefly described below. This
  18 diagram shows the dependencies between them:
  19
  20 @dot
  21 digraph Dependancies
  22 {
  23     node [shape = ellipse, fontname = "Courier", fontsize = 10, style = filled];
  24
  25     wxBase     [URL = "\ref page_libs_wxbase"];
  26
  27     wxCore     [fillcolor = deepskyblue, URL = "\ref page_libs_wxcore"];
  28     wxNet      [fillcolor = deepskyblue, URL = "\ref page_libs_wxnet"];
  29     wxXML      [fillcolor = deepskyblue, URL = "\ref page_libs_wxxml"];
  30
  31     wxAdvanced [fillcolor = green, URL = "\ref page_libs_wxadv"];
  32     wxAUI      [fillcolor = green, URL = "\ref page_libs_wxaui"];
  33     wxGL       [fillcolor = green, URL = "\ref page_libs_wxgl"];
  34     wxHTML     [fillcolor = green, URL = "\ref page_libs_wxhtml"];
  35     wxMedia    [fillcolor = green, URL = "\ref page_libs_wxmedia"];
  36     wxQA       [fillcolor = green, URL = "\ref page_libs_wxqa"];
  37     wxRichText [fillcolor = green, URL = "\ref page_libs_wxrichtext"];
  38     wxSTC      [fillcolor = green, URL = "\ref page_libs_wxstc"];
  39     wxXRC      [fillcolor = green, URL = "\ref page_libs_wxxrc"];
  40
  41     wxCore -> wxBase;
  42     wxNet -> wxBase;
  43     wxXML -> wxBase;
  44
  45     wxAdvanced -> wxCore;
  46     wxAUI -> wxAdvanced; wxAUI -> wxHTML; wxAUI -> wxXML;
  47     wxGL -> wxCore;
  48     wxHTML -> wxCore;
  49     wxMedia -> wxCore;
  50     wxQA -> wxCore; wxQA -> wxXML;
  51     wxRichText -> wxAdvanced; wxRichText -> wxHTML; wxRichText -> wxXML;
  52     wxSTC -> wxCore;
  53     wxXRC -> wxAdvanced; wxXRC -> wxHTML; wxXRC -> wxXML;
  54 }
  55 @enddot
  56
  57 Please note that arrows indicate the "depends from" relation and that all blue
  58 libraries depend on the @ref page_libs_wxbase library (i.e. they are non-GUI
  59 libraries), and all green libraries depend on the @ref page_libs_wxcore library
  60 (i.e. they are GUI libraries).
  61
  62
  63 @section page_libs_wxbase wxBase
  64
  65 Every wxWidgets application must link against this library. It contains
  66 mandatory classes that any wxWidgets code depends on (e.g. wxString) and
  67 portability classes that abstract differences between platforms. wxBase can be
  68 used to develop console mode applications, it does not require any GUI
  69 libraries or running X Window System on Unix.
  70
  71
  72 @section page_libs_wxcore wxCore
  73
  74 Basic GUI classes such as GDI classes or controls are in this library. All
  75 wxWidgets GUI applications must link against this library, only console mode
  76 applications don't.
  77
  78 Requires @ref page_libs_wxbase.
  79
  80
  81 @section page_libs_wxaui wxAui
  82
  83 This contains the Advanced User Interface docking library.
  84
  85 Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
  86 @ref page_libs_wxcore, @ref page_libs_wxbase.
  87
  88
  89 @section page_libs_wxnet wxNet
  90
  91 Classes for network access:
  92
  93 @li wxSocket classes (wxSocketClient, wxSocketServer and related classes)
  94 @li wxSocketOutputStream and wxSocketInputStream
  95 @li sockets-based IPC classes (wxTCPServer, wxTCPClient and wxTCPConnection)
  96 @li wxURL
  97 @li wxInternetFSHandler (a wxFileSystem handler)
  98
  99 Requires @ref page_libs_wxbase.
 100
 101
 102 @section page_libs_wxrichtext wxRichText
 103
 104 This contains generic rich text control functionality.
 105
 106 Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
 107 @ref page_libs_wxcore, @ref page_libs_wxbase.
 108
 109
 110 @section page_libs_wxxml wxXML
 111
 112 This library contains simple classes for parsing XML documents.
 113
 114 Requires @ref page_libs_wxbase.
 115
 116
 117 @section page_libs_wxadv wxAdvanced
 118
 119 Advanced or rarely used GUI classes:
 120
 121 @li wxCalendarCtrl
 122 @li wxGrid classes
 123 @li wxJoystick
 124 @li wxLayoutAlgorithm
 125 @li wxSplashScreen
 126 @li wxTaskBarIcon
 127 @li wxSound
 128 @li wxWizard
 129 @li wxSashLayoutWindow
 130 @li wxSashWindow
 131 @li ...others
 132
 133 Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
 134
 135
 136 @section page_libs_wxmedia wxMedia
 137
 138 Miscellaneous classes related to multimedia. Currently this library only
 139 contains wxMediaCtrl but more classes will be added in the future.
 140
 141 Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
 142
 143
 144 @section page_libs_wxgl wxGL
 145
 146 This library contains wxGLCanvas class for integrating OpenGL library with
 147 wxWidgets. Unlike all others, this library is @b not part of the monolithic
 148 library, it is always built as separate library.
 149
 150 Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
 151
 152
 153 @section page_libs_wxhtml wxHTML
 154
 155 Simple HTML renderer and other @ref overview_html are contained in this
 156 library, as well as wxHtmlHelpController, wxBestHelpController and
 157 wxHtmlListBox.
 158
 159 Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
 160
 161
 162 @section page_libs_wxqa wxQA
 163
 164 This is the library containing extra classes for quality assurance. Currently
 165 it only contains wxDebugReport and related classes, but more will be added to
 166 it in the future.
 167
 168 Requires @ref page_libs_wxxml, @ref page_libs_wxcore, @ref page_libs_wxbase.
 169
 170
 171 @section page_libs_wxxrc wxXRC
 172
 173 This library contains wxXmlResource class that provides access to XML resource
 174 files in XRC format.
 175
 176 Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
 177 @ref page_libs_wxcore, @ref page_libs_wxbase.
 178
 179
 180 @section page_libs_wxstc wxSTC
 181
 182 STC (Styled Text Control) is a wrapper around Scintilla, a syntax-highlighting
 183 text editor. See <http://www.scintilla.org/> for more info about Scintilla.
 184
 185 Requires @ref page_libs_wxcore, @ref page_libs_wxbase.
 186
 187 */
 188