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