]>
git.saurik.com Git - wxWidgets.git/blob - docs/doxygen/mainpages/libs.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Libraries page of the Doxygen manual
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
11 @page page_libs Library List
13 wxWidgets 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.
17 wxWidgets library is divided into libraries briefly described below. This
18 diagram show dependencies between them:
23 node [shape = ellipse, fontname = "Courier", fontsize = 10, style = filled];
25 wxBase [URL = "\ref page_libs_wxbase"];
27 wxCore [fillcolor = deepskyblue, URL = "\ref page_libs_wxcore"];
28 wxNet [fillcolor = deepskyblue, URL = "\ref page_libs_wxnet"];
29 wxXML [fillcolor = deepskyblue, URL = "\ref page_libs_wxxml"];
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"];
36 wxQA [fillcolor = green, URL = "\ref page_libs_wxqa"];
37 wxRichText [fillcolor = green, URL = "\ref page_libs_wxrichtext"];
38 wxSTC [fillcolor = green, URL = "\ref page_libs_wxstc"];
39 wxXRC [fillcolor = green, URL = "\ref page_libs_wxxrc"];
46 wxAUI -> wxAdvanced; wxAUI -> wxHTML; wxAUI -> wxXML;
50 wxQA -> wxCore; wxQA -> wxXML;
51 wxRichText -> wxAdvanced; wxRichText -> wxHTML; wxRichText -> wxXML;
53 wxXRC -> wxAdvanced; wxXRC -> wxHTML; wxXRC -> wxXML;
57 Please note that arrows indicate the "depends from" relation and that all blue
58 boxes depend on the @ref page_libs_wxbase library (i.e. they are non-GUI
59 libraries), and all green boxes depend on the @ref page_libs_wxcore library
60 (i.e. they are GUI libraries).
63 @section page_libs_wxbase wxBase
65 Every wxWidgets application must link against this library. It contains
66 mandatory classes that any wxWidgets code depends on (e.g. wxString) and
67 portability classes that abstract differences between platforms. wxBase can be
68 used to develop console mode applications, it does not require any GUI
69 libraries or running X Window System on Unix.
72 @section page_libs_wxcore wxCore
74 Basic GUI classes such as GDI classes or controls are in this library. All
75 wxWidgets GUI applications must link against this library, only console mode
78 Requires @ref page_libs_wxbase.
81 @section page_libs_wxaui wxAui
83 This contains the Advanced User Interface docking library.
85 Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
86 @ref page_libs_wxcore, @ref page_libs_wxbase.
89 @section page_libs_wxnet wxNet
91 Classes for network access:
93 @li wxSocket classes (wxSocketClient, wxSocketServer and related classes)
94 @li wxSocketOutputStream and wxSocketInputStream
95 @li sockets-based IPC classes (wxTCPServer, wxTCPClient and wxTCPConnection)
97 @li wxInternetFSHandler (a wxFileSystem handler)
99 Requires @ref page_libs_wxbase.
102 @section page_libs_wxrichtext wxRichText
104 This contains generic rich text control functionality.
106 Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
107 @ref page_libs_wxcore, @ref page_libs_wxbase.
110 @section page_libs_wxxml wxXML
112 This library contains simple classes for parsing XML documents.
114 Requires @ref page_libs_wxbase.
117 @section page_libs_wxadv wxAdvanced
119 Advanced or rarely used GUI classes:
124 @li wxLayoutAlgorithm
129 @li wxSashLayoutWindow
133 Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
136 @section page_libs_wxmedia wxMedia
138 Miscellaneous classes related to multimedia. Currently this library only
139 contains wxMediaCtrl but more classes will be added in the future.
141 Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
144 @section page_libs_wxgl wxGL
146 This library contains wxGLCanvas class for integrating OpenGL library with
147 wxWidgets. Unlike all others, this library is @b not part of the monolithic
148 library, it is always built as separate library.
150 Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
153 @section page_libs_wxhtml wxHTML
155 Simple HTML renderer and other @ref overview_html are contained in this
156 library, as well as wxHtmlHelpController, wxBestHelpController and
159 Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
162 @section page_libs_wxqa wxQA
164 This is the library containing extra classes for quality assurance. Currently
165 it only contains wxDebugReport and related classes, but more will be added to
168 Requires @ref page_libs_wxxml, @ref page_libs_wxcore, @ref page_libs_wxbase.
171 @section page_libs_wxxrc wxXRC
173 This library contains wxXmlResource class that provides access to XML resource
176 Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
177 @ref page_libs_wxcore, @ref page_libs_wxbase.
180 @section page_libs_wxstc wxSTC
182 STC (Styled Text Control) is a wrapper around Scintilla, a syntax-highlighting
183 text editor. See <http://www.scintilla.org/> for more info about Scintilla.
185 Requires @ref page_libs_wxcore, @ref page_libs_wxbase.