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