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
  12  @page page_libs 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 @ref page_libs_wxbase library (i.e. they are non-GUI libraries),
  25  and all green boxes depend from @ref page_libs_wxcore library (i.e. they are GUI libraries).
  26
  27
  28  <!--
  29     IMPORTANT: the @sections below don't have the page_libraries_ prefix because
  30                all API pages link to them and using that prefix all times would
  31                make the
  32  -->
  33
  34
  35  @section page_libs_wxbase wxBase
  36
  37  Every wxWidgets application must link against this library. It contains
  38  mandatory classes that any wxWidgets code depends on (e.g. wxString) and
  39  portability classes that abstract differences between platforms.
  40  wxBase can be used to develop console mode applications,
  41  it does not require any GUI libraries or running X Window System on Unix.
  42
  43
  44  @section page_libs_wxcore wxCore
  45
  46  Basic GUI classes such as GDI classes or controls are in this library. All
  47  wxWidgets GUI applications must link against this library, only console mode
  48  applications don't.
  49
  50  Requires @ref page_libs_wxbase.
  51
  52
  53  @section page_libs_wxaui wxAui
  54
  55  This contains the Advanced User Interface docking library.
  56
  57  Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
  58  @ref page_libs_wxcore, @ref page_libs_wxbase.
  59
  60
  61  @section page_libs_wxnet wxNet
  62
  63  Classes for network access:
  64
  65  @li wxSocket classes (wxSocketClient, wxSocketServer and related classes)
  66  @li wxSocketOutputStream and wxSocketInputStream
  67  @li sockets-based IPC classes (wxTCPServer, wxTCPClient and wxTCPConnection)
  68  @li wxURL
  69  @li wxInternetFSHandler (a wxFileSystem handler)
  70
  71  Requires @ref page_libs_wxbase.
  72
  73
  74  @section page_libs_wxrichtext wxRichText
  75
  76  This contains generic rich text control functionality.
  77
  78  Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
  79  @ref page_libs_wxcore, @ref page_libs_wxbase.
  80
  81
  82  @section page_libs_wxxml wxXML
  83
  84  This library contains simple classes for parsing XML documents.
  85
  86  Requires @ref page_libs_wxbase.
  87
  88
  89  @section page_libs_wxadv wxAdvanced
  90
  91  Advanced or rarely used GUI classes:
  92
  93  @li wxCalendarCtrl
  94  @li wxGrid classes
  95  @li wxJoystick
  96  @li wxLayoutAlgorithm
  97  @li wxSplashScreen
  98  @li wxTaskBarIcon
  99  @li wxSound
 100  @li wxWizard
 101  @li wxSashLayoutWindow
 102  @li wxSashWindow
 103  @li ...others
 104
 105  Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
 106
 107
 108  @section page_libs_wxmedia wxMedia
 109
 110  Miscellaneous classes related to multimedia. Currently this library only
 111  contains wxMediaCtrl but more classes will be added in
 112  the future.
 113
 114  Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
 115
 116
 117  @section page_libs_wxgl wxGL
 118
 119  This library contains wxGLCanvas class for integrating
 120  OpenGL library with wxWidgets. Unlike all others, this library is {\em not}
 121  part of the monolithic 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 library,
 129  as well as wxHtmlHelpController, wxBestHelpController and wxHtmlListBox.
 130
 131  Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
 132
 133
 134  @section page_libs_wxqa wxQA
 135
 136  This is the library containing extra classes for quality assurance. Currently
 137  it only contains wxDebugReport and related classes,
 138  but more will be added to it in the future.
 139
 140  Requires @ref page_libs_wxxml, @ref page_libs_wxcore, @ref page_libs_wxbase.
 141
 142
 143  @section page_libs_wxxrc wxXRC
 144
 145  This library contains wxXmlResource class that
 146  provides access to XML resource files in XRC format.
 147
 148  Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
 149  @ref page_libs_wxcore, @ref page_libs_wxbase.
 150
 151
 152  @section page_libs_wxstc wxSTC
 153
 154  STC (Styled Text Control) is a wrapper around Scintilla, a syntax-highlighting text editor.
 155  See http://www.scintilla.org for more info about Scintilla.
 156
 157  Requires @ref page_libs_wxcore, @ref page_libs_wxbase.
 158
 159 */