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