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 <em>monolithic build</em>) or as several smaller
  16  libraries (<em>multilib build</em>}). 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),
  25  and all green boxes depend from wxCore library (i.e. they are GUI libraries).
  26
  27
  28  @section wxBase wxBase
  29
  30  Every wxWidgets application must link against this library. It contains
  31  mandatory classes that any wxWidgets code depends on (e.g. wxString) and
  32  portability classes that abstract differences between platforms.
  33  wxBase can be used to develop console mode applications, it does not require
  34  any GUI libraries or running X Window System on Unix.
  35
  36
  37  @section wxCore wxCore
  38
  39  Basic GUI classes such as GDI classes or controls are in this library. All
  40  wxWidgets GUI applications must link against this library, only console mode
  41  applications don't.
  42
  43  Requires wxBase.
  44
  45
  46  @section wxAui wxAui
  47
  48  This contains the Advanced User Interface docking library.
  49
  50  Requires wxAdvanced, wxHTML, wxXML, wxCore, wxBase.
  51
  52
  53  @section wxNet wxNet
  54
  55  Classes for network access:
  56
  57  @li wxSocket classes (wxSocketClient, wxSocketServer and related classes)
  58  @li wxSocketOutputStream and wxSocketInputStream
  59  @li sockets-based IPC classes (wxTCPServer, wxTCPClient and wxTCPConnection)
  60  @li wxURL
  61  @li wxInternetFSHandler (a wxFileSystem handler)
  62
  63  Requires wxBase.
  64
  65
  66  @section wxRichText wxRichText
  67
  68  This contains generic rich text control functionality.
  69
  70  Requires wxAdvanced, wxHTML, wxXML, wxCore, wxBase.
  71
  72
  73  @section wxXML wxXML
  74
  75  This library contains simple classes for parsing XML documents.
  76
  77  Requires wxBase.
  78
  79
  80  @section wxAdvanced wxAdvanced
  81
  82  Advanced or rarely used GUI classes:
  83
  84  @li wxCalendarCtrl
  85  @li wxGrid classes
  86  @li wxJoystick
  87  @li wxLayoutAlgorithm
  88  @li wxSplashScreen
  89  @li wxTaskBarIcon
  90  @li wxSound
  91  @li wxWizard
  92  @li wxSashLayoutWindow
  93  @li wxSashWindow
  94  @li ...others
  95
  96  Requires wxCore and wxBase.
  97
  98
  99  @section wxMedia wxMedia
 100
 101  Miscellaneous classes related to multimedia. Currently this library only
 102  contains wxMediaCtrl but more classes will be added in
 103  the future.
 104
 105  Requires wxCore and wxBase.
 106
 107
 108  @section wxGL wxGL
 109
 110  This library contains 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
 117  @section wxHTML wxHTML
 118
 119  Simple HTML renderer and other @ref html_overview are contained in this library,
 120  as well as wxHtmlHelpController, wxBestHelpController and wxHtmlListBox.
 121
 122  Requires wxCore and wxBase.
 123
 124
 125  @section wxQA wxQA
 126
 127  This is the library containing extra classes for quality assurance. Currently
 128  it only contains wxDebugReport and related classes,
 129  but more will be added to it in the future.
 130
 131  Requires wxXML, wxCore, wxBase.
 132
 133
 134  @section wxXRC wxXRC
 135
 136  This library contains wxXmlResource class that
 137  provides access to XML resource files in XRC format
 138
 139  Requires wxAdvanced, wxHTML, wxXML, wxCore, wxBase.
 140
 141
 142  @section wxSTC wxSTC
 143
 144  STC (Styled Text Control) is a wrapper around Scintilla, a syntax-highlighting text editor.
 145
 146  Requires wxCore, wxBase.
 147
 148 */