]>
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 /////////////////////////////////////////////////////////////////////////////
12 @page page_libraries 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).
29 IMPORTANT: the @sections below don't have the page_libraries_ prefix because
30 all API pages link to them and using that prefix all times would
35 @section page_libraries_wxbase wxBase
37 Every wxWidgets application must link against this library. It contains
38 mandatory classes that any wxWidgets code depends on (e.g. wxString) and
39 portability classes that abstract differences between platforms.
40 @ref wxbase can be used to develop console mode applications, it does not require
41 any GUI libraries or running X Window System on Unix.
44 @section page_libraries_wxcore wxCore
46 Basic GUI classes such as GDI classes or controls are in this library. All
47 wxWidgets GUI applications must link against this library, only console mode
55 This contains the Advanced User Interface docking library.
57 Requires @ref wxadv, @ref wxhtml, @ref wxxml, @ref wxcore, @ref wxbase.
62 Classes for network access:
64 @li wxSocket classes (wxSocketClient, wxSocketServer and related classes)
65 @li wxSocketOutputStream and wxSocketInputStream
66 @li sockets-based IPC classes (wxTCPServer, wxTCPClient and wxTCPConnection)
68 @li wxInternetFSHandler (a wxFileSystem handler)
73 @section wxrichtext wxRichText
75 This contains generic rich text control functionality.
77 Requires @ref wxadv, @ref wxhtml, @ref wxxml, @ref wxcore, @ref wxbase.
82 This library contains simple classes for parsing XML documents.
87 @section wxadv wxAdvanced
89 Advanced or rarely used GUI classes:
99 @li wxSashLayoutWindow
103 Requires @ref wxcore and @ref wxbase.
106 @section wxmedia wxMedia
108 Miscellaneous classes related to multimedia. Currently this library only
109 contains wxMediaCtrl but more classes will be added in
112 Requires @ref wxcore and @ref wxbase.
117 This library contains wxGLCanvas class for integrating
118 OpenGL library with wxWidgets. Unlike all others, this library is {\em not}
119 part of the monolithic library, it is always built as separate library.
121 Requires @ref wxcore and @ref wxbase.
124 @section wxhtml wxHTML
126 Simple HTML renderer and other @ref html_overview are contained in this library,
127 as well as wxHtmlHelpController, wxBestHelpController and wxHtmlListBox.
129 Requires @ref wxcore and @ref wxbase.
134 This is the library containing extra classes for quality assurance. Currently
135 it only contains wxDebugReport and related classes,
136 but more will be added to it in the future.
138 Requires @ref wxxml, @ref wxcore, @ref wxbase.
143 This library contains wxXmlResource class that
144 provides access to XML resource files in XRC format.
146 Requires @ref wxadv, @ref wxhtml, @ref wxxml, @ref wxcore, @ref wxbase.
151 STC (Styled Text Control) is a wrapper around Scintilla, a syntax-highlighting text editor.
152 See http://www.scintilla.org for more info about Scintilla.
154 Requires @ref wxcore, @ref wxbase.