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 licence
   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     wxPropertyGrid [fillcolor = green, URL = "\ref page_libs_wxpropgrid"];
  37     wxQA       [fillcolor = green, URL = "\ref page_libs_wxqa"];
  38     wxRibbon   [fillcolor = green, URL = "\ref page_libs_wxribbon"];
  39     wxRichText [fillcolor = green, URL = "\ref page_libs_wxrichtext"];
  40     wxSTC      [fillcolor = green, URL = "\ref page_libs_wxstc"];
  41     wxXRC      [fillcolor = green, URL = "\ref page_libs_wxxrc"];
  42     wxWebView  [fillcolor = green, URL = "\ref page_libs_wxwebview"];
  43
  44     wxCore -> wxBase;
  45     wxNet -> wxBase;
  46     wxXML -> wxBase;
  47
  48     wxAdvanced -> wxCore;
  49     wxAUI -> wxAdvanced; wxAUI -> wxHTML; wxAUI -> wxXML;
  50     wxGL -> wxCore;
  51     wxHTML -> wxCore;
  52     wxMedia -> wxCore;
  53     wxPropertyGrid -> wxAdvanced;
  54     wxQA -> wxCore; wxQA -> wxXML;
  55     wxRibbon -> wxCore;
  56     wxRichText -> wxAdvanced; wxRichText -> wxHTML; wxRichText -> wxXML;
  57     wxSTC -> wxCore;
  58     wxXRC -> wxAdvanced; wxXRC -> wxHTML; wxXRC -> wxXML;
  59     wxWebView -> wxCore;
  60 }
  61 @enddot
  62
  63 Please note that arrows indicate the "depends from" relation and that all blue
  64 libraries depend on the @ref page_libs_wxbase library (i.e. they are non-GUI
  65 libraries), and all green libraries depend on the @ref page_libs_wxcore library
  66 (i.e. they are GUI libraries).
  67
  68
  69 @section page_libs_wxbase wxBase
  70
  71 Every wxWidgets application must link against this library. It contains
  72 mandatory classes that any wxWidgets code depends on (e.g. wxString) and
  73 portability classes that abstract differences between platforms. wxBase can be
  74 used to develop console mode applications, it does not require any GUI
  75 libraries or running X Window System on Unix.
  76
  77
  78 @section page_libs_wxcore wxCore
  79
  80 Basic GUI classes such as GDI classes or controls are in this library. All
  81 wxWidgets GUI applications must link against this library, only console mode
  82 applications don't.
  83
  84 Requires @ref page_libs_wxbase.
  85
  86
  87 @section page_libs_wxaui wxAui
  88
  89 This contains the Advanced User Interface docking library.
  90
  91 Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
  92 @ref page_libs_wxcore, @ref page_libs_wxbase.
  93
  94
  95 @section page_libs_wxnet wxNet
  96
  97 Classes for network access:
  98
  99 @li wxSocket classes (wxSocketClient, wxSocketServer and related classes)
 100 @li wxSocketOutputStream and wxSocketInputStream
 101 @li sockets-based IPC classes (wxTCPServer, wxTCPClient and wxTCPConnection)
 102 @li wxURL
 103 @li wxInternetFSHandler (a wxFileSystem handler)
 104
 105 Requires @ref page_libs_wxbase.
 106
 107
 108 @section page_libs_wxpropgrid wxPropertyGrid
 109
 110 This contains the wxPropertyGrid control.
 111
 112 Requires @ref page_libs_wxadv, @ref page_libs_wxcore, @ref page_libs_wxbase.
 113
 114
 115 @section page_libs_wxribbon wxRibbon
 116
 117 This contains the Ribbon User Interface components library.
 118
 119 Requires @ref page_libs_wxcore, @ref page_libs_wxbase.
 120
 121
 122 @section page_libs_wxrichtext wxRichText
 123
 124 This contains generic rich text control functionality.
 125
 126 Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
 127 @ref page_libs_wxcore, @ref page_libs_wxbase.
 128
 129
 130 @section page_libs_wxxml wxXML
 131
 132 This library contains simple classes for parsing XML documents.
 133
 134 Requires @ref page_libs_wxbase.
 135
 136
 137 @section page_libs_wxadv wxAdvanced
 138
 139 Advanced or rarely used GUI classes:
 140
 141 @li wxCalendarCtrl
 142 @li wxGrid classes
 143 @li wxJoystick
 144 @li wxLayoutAlgorithm
 145 @li wxSplashScreen
 146 @li wxTaskBarIcon
 147 @li wxSound
 148 @li wxWizard
 149 @li wxSashLayoutWindow
 150 @li wxSashWindow
 151 @li ...others
 152
 153 Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
 154
 155
 156 @section page_libs_wxmedia wxMedia
 157
 158 Miscellaneous classes related to multimedia. Currently this library only
 159 contains wxMediaCtrl but more classes will be added in the future.
 160
 161 Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
 162
 163
 164 @section page_libs_wxgl wxGL
 165
 166 This library contains wxGLCanvas class for integrating OpenGL library with
 167 wxWidgets. Unlike all others, this library is @b not part of the monolithic
 168 library, it is always built as separate library.
 169
 170 Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
 171
 172
 173 @section page_libs_wxhtml wxHTML
 174
 175 Simple HTML renderer and other @ref overview_html are contained in this
 176 library, as well as wxHtmlHelpController, wxBestHelpController and
 177 wxHtmlListBox.
 178
 179 Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
 180
 181
 182 @section page_libs_wxqa wxQA
 183
 184 This is the library containing extra classes for quality assurance. Currently
 185 it only contains wxDebugReport and related classes, but more will be added to
 186 it in the future.
 187
 188 Requires @ref page_libs_wxxml, @ref page_libs_wxcore, @ref page_libs_wxbase.
 189
 190
 191 @section page_libs_wxxrc wxXRC
 192
 193 This library contains wxXmlResource class that provides access to XML resource
 194 files in XRC format.
 195
 196 Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
 197 @ref page_libs_wxcore, @ref page_libs_wxbase.
 198
 199
 200 @section page_libs_wxstc wxSTC
 201
 202 STC (Styled Text Control) is a wrapper around Scintilla, a syntax-highlighting
 203 text editor. See <http://www.scintilla.org/> for more info about Scintilla.
 204
 205 Requires @ref page_libs_wxcore, @ref page_libs_wxbase.
 206
 207 @section page_libs_wxwebview wxWebView
 208
 209 The wxWebView library contains the wxWebView control and its associated classes.
 210
 211 Requires @ref page_libs_wxcore, @ref page_libs_wxbase.
 212
 213 */
 214