]>
git.saurik.com Git - wxWidgets.git/blob - docs/doxygen/libs.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Libraries page of the Doxygen manual
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
12 @page libraries_page Libraries list
14 wxWidgets can be built either as a single large
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.
18 wxWidgets library is divided into libraries briefly described below. This
19 diagram show dependencies between them:
23 Please note that arrows indicate the "depends from" relation and that
24 all blue boxes depend from @ref wxbase library (i.e. they are non-GUI libraries),
25 and all green boxes depend from @ref wxcore library (i.e. they are GUI libraries).
28 @section wxbase wxBase
30 Every wxWidgets application must link against this library. It contains
31 mandatory classes that any wxWidgets code depends on (e.g. wxString) and
32 portability classes that abstract differences between platforms.
33 @ref wxbase can be used to develop console mode applications, it does not require
34 any GUI libraries or running X Window System on Unix.
37 @section wxcore wxCore
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
48 This contains the Advanced User Interface docking library.
50 Requires @ref wxadv, @ref wxhtml, @ref wxxml, @ref wxcore, @ref wxbase.
55 Classes for network access:
57 @li wxSocket classes (wxSocketClient, wxSocketServer and related classes)
58 @li wxSocketOutputStream and wxSocketInputStream
59 @li sockets-based IPC classes (wxTCPServer, wxTCPClient and wxTCPConnection)
61 @li wxInternetFSHandler (a wxFileSystem handler)
66 @section wxrichtext wxRichText
68 This contains generic rich text control functionality.
70 Requires @ref wxadv, @ref wxhtml, @ref wxxml, @ref wxcore, @ref wxbase.
75 This library contains simple classes for parsing XML documents.
80 @section wxadv wxAdvanced
82 Advanced or rarely used GUI classes:
92 @li wxSashLayoutWindow
96 Requires @ref wxcore and @ref wxbase.
99 @section wxmedia wxMedia
101 Miscellaneous classes related to multimedia. Currently this library only
102 contains wxMediaCtrl but more classes will be added in
105 Requires @ref wxcore and @ref wxbase.
110 This library contains wxGLCanvas class for integrating
111 OpenGL library with wxWidgets. Unlike all others, this library is {\em not}
112 part of the monolithic library, it is always built as separate library.
114 Requires @ref wxcore and @ref wxbase.
117 @section wxhtml wxHTML
119 Simple HTML renderer and other @ref html_overview are contained in this library,
120 as well as wxHtmlHelpController, wxBestHelpController and wxHtmlListBox.
122 Requires @ref wxcore and @ref wxbase.
127 This is the library containing extra classes for quality assurance. Currently
128 it only contains wxDebugReport and related classes,
129 but more will be added to it in the future.
131 Requires @ref wxxml, @ref wxcore, @ref wxbase.
136 This library contains wxXmlResource class that
137 provides access to XML resource files in XRC format.
139 Requires @ref wxadv, @ref wxhtml, @ref wxxml, @ref wxcore, @ref wxbase.
144 STC (Styled Text Control) is a wrapper around Scintilla, a syntax-highlighting text editor.
145 See http://www.scintilla.org for more info about Scintilla.
147 Requires @ref wxcore, @ref wxbase.