wxWidgets/docs/doxygen/libs.h
Francesco Montorsi 2ab7c5760e use lowercase for anchor names of wxlibs
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@51927 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-02-19 22:31:17 +00:00

150 lines
3.9 KiB
C

/////////////////////////////////////////////////////////////////////////////
// Name: libs.h
// Purpose: Libraries page of the Doxygen manual
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/*!
@page libraries_page Libraries list
wxWidgets can be built either as a single large
library (this is called the <em>monolithic build</em>) or as several smaller
libraries (<em>multilib build</em>}). Multilib build is the default.
wxWidgets library is divided into libraries briefly described below. This
diagram show dependencies between them:
@image html libs.gif
Please note that arrows indicate the "depends from" relation and that
all blue boxes depend from @ref wxbase library (i.e. they are non-GUI libraries),
and all green boxes depend from @ref wxcore library (i.e. they are GUI libraries).
@section wxbase wxBase
Every wxWidgets application must link against this library. It contains
mandatory classes that any wxWidgets code depends on (e.g. wxString) and
portability classes that abstract differences between platforms.
@ref wxbase can be used to develop console mode applications, it does not require
any GUI libraries or running X Window System on Unix.
@section wxcore wxCore
Basic GUI classes such as GDI classes or controls are in this library. All
wxWidgets GUI applications must link against this library, only console mode
applications don't.
Requires @ref wxbase.
@section wxaui wxAui
This contains the Advanced User Interface docking library.
Requires @ref wxadv, @ref wxhtml, @ref wxxml, @ref wxcore, @ref wxbase.
@section wxnet wxNet
Classes for network access:
@li wxSocket classes (wxSocketClient, wxSocketServer and related classes)
@li wxSocketOutputStream and wxSocketInputStream
@li sockets-based IPC classes (wxTCPServer, wxTCPClient and wxTCPConnection)
@li wxURL
@li wxInternetFSHandler (a wxFileSystem handler)
Requires @ref wxbase.
@section wxrichtext wxRichText
This contains generic rich text control functionality.
Requires @ref wxadv, @ref wxhtml, @ref wxxml, @ref wxcore, @ref wxbase.
@section wxxml wxXML
This library contains simple classes for parsing XML documents.
Requires @ref wxbase.
@section wxadv wxAdvanced
Advanced or rarely used GUI classes:
@li wxCalendarCtrl
@li wxGrid classes
@li wxJoystick
@li wxLayoutAlgorithm
@li wxSplashScreen
@li wxTaskBarIcon
@li wxSound
@li wxWizard
@li wxSashLayoutWindow
@li wxSashWindow
@li ...others
Requires @ref wxcore and @ref wxbase.
@section wxmedia wxMedia
Miscellaneous classes related to multimedia. Currently this library only
contains wxMediaCtrl but more classes will be added in
the future.
Requires @ref wxcore and @ref wxbase.
@section wxgl wxGL
This library contains wxGLCanvas class for integrating
OpenGL library with wxWidgets. Unlike all others, this library is {\em not}
part of the monolithic library, it is always built as separate library.
Requires @ref wxcore and @ref wxbase.
@section wxhtml wxHTML
Simple HTML renderer and other @ref html_overview are contained in this library,
as well as wxHtmlHelpController, wxBestHelpController and wxHtmlListBox.
Requires @ref wxcore and @ref wxbase.
@section wxqa wxQA
This is the library containing extra classes for quality assurance. Currently
it only contains wxDebugReport and related classes,
but more will be added to it in the future.
Requires @ref wxxml, @ref wxcore, @ref wxbase.
@section wxxrc wxXRC
This library contains wxXmlResource class that
provides access to XML resource files in XRC format.
Requires @ref wxadv, @ref wxhtml, @ref wxxml, @ref wxcore, @ref wxbase.
@section wxstc wxSTC
STC (Styled Text Control) is a wrapper around Scintilla, a syntax-highlighting text editor.
See http://www.scintilla.org for more info about Scintilla.
Requires @ref wxcore, @ref wxbase.
*/