]> git.saurik.com Git - wxWidgets.git/blame - docs/doxygen/libs.h
fix wxConfig link and layout the initial list in two columns
[wxWidgets.git] / docs / doxygen / libs.h
CommitLineData
15b6757b
FM
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
25c4a27c
FM
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.
36c9828f 17
15b6757b
FM
18 wxWidgets library is divided into libraries briefly described below. This
19 diagram show dependencies between them:
36c9828f 20
15b6757b 21 @image html libs.gif
36c9828f 22
15b6757b 23 Please note that arrows indicate the "depends from" relation and that
25c4a27c
FM
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
36c9828f 27
15b6757b 28 @section wxBase wxBase
36c9828f 29
15b6757b 30 Every wxWidgets application must link against this library. It contains
25c4a27c
FM
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
36c9828f 36
15b6757b 37 @section wxCore wxCore
36c9828f 38
15b6757b
FM
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.
36c9828f 42
15b6757b 43 Requires wxBase.
36c9828f 44
25c4a27c 45
15b6757b 46 @section wxAui wxAui
36c9828f 47
15b6757b 48 This contains the Advanced User Interface docking library.
36c9828f 49
15b6757b 50 Requires wxAdvanced, wxHTML, wxXML, wxCore, wxBase.
36c9828f 51
25c4a27c 52
15b6757b 53 @section wxNet wxNet
36c9828f 54
15b6757b 55 Classes for network access:
36c9828f 56
25c4a27c
FM
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)
36c9828f 62
15b6757b 63 Requires wxBase.
36c9828f 64
25c4a27c 65
15b6757b 66 @section wxRichText wxRichText
36c9828f 67
15b6757b 68 This contains generic rich text control functionality.
36c9828f 69
15b6757b 70 Requires wxAdvanced, wxHTML, wxXML, wxCore, wxBase.
36c9828f 71
25c4a27c 72
15b6757b 73 @section wxXML wxXML
36c9828f 74
15b6757b 75 This library contains simple classes for parsing XML documents.
36c9828f 76
15b6757b 77 Requires wxBase.
36c9828f 78
25c4a27c 79
15b6757b 80 @section wxAdvanced wxAdvanced
36c9828f 81
15b6757b 82 Advanced or rarely used GUI classes:
36c9828f 83
25c4a27c
FM
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
36c9828f 95
15b6757b 96 Requires wxCore and wxBase.
36c9828f 97
25c4a27c 98
15b6757b 99 @section wxMedia wxMedia
36c9828f 100
15b6757b 101 Miscellaneous classes related to multimedia. Currently this library only
25c4a27c 102 contains wxMediaCtrl but more classes will be added in
15b6757b 103 the future.
36c9828f 104
15b6757b 105 Requires wxCore and wxBase.
36c9828f 106
25c4a27c 107
15b6757b 108 @section wxGL wxGL
36c9828f 109
25c4a27c 110 This library contains wxGLCanvas class for integrating
15b6757b 111 OpenGL library with wxWidgets. Unlike all others, this library is {\em not}
25c4a27c 112 part of the monolithic library, it is always built as separate library.
36c9828f 113
15b6757b 114 Requires wxCore and wxBase.
36c9828f 115
25c4a27c 116
15b6757b 117 @section wxHTML wxHTML
36c9828f 118
25c4a27c
FM
119 Simple HTML renderer and other @ref html_overview are contained in this library,
120 as well as wxHtmlHelpController, wxBestHelpController and wxHtmlListBox.
36c9828f 121
15b6757b 122 Requires wxCore and wxBase.
36c9828f 123
25c4a27c 124
15b6757b 125 @section wxQA wxQA
36c9828f 126
15b6757b 127 This is the library containing extra classes for quality assurance. Currently
25c4a27c 128 it only contains wxDebugReport and related classes,
15b6757b 129 but more will be added to it in the future.
36c9828f 130
15b6757b 131 Requires wxXML, wxCore, wxBase.
36c9828f 132
25c4a27c 133
15b6757b 134 @section wxXRC wxXRC
36c9828f 135
25c4a27c 136 This library contains wxXmlResource class that
15b6757b 137 provides access to XML resource files in XRC format
36c9828f 138
15b6757b 139 Requires wxAdvanced, wxHTML, wxXML, wxCore, wxBase.
36c9828f 140
25c4a27c 141
15b6757b 142 @section wxSTC wxSTC
36c9828f 143
15b6757b 144 STC (Styled Text Control) is a wrapper around Scintilla, a syntax-highlighting text editor.
36c9828f 145
15b6757b 146 Requires wxCore, wxBase.
36c9828f 147
15b6757b 148*/