]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/libs.tex
Added DetachOldLog to avoid destruction of old log target
[wxWidgets.git] / docs / latex / wx / libs.tex
CommitLineData
8a7fd2e3
VS
1\chapter{Libraries list}\label{librarieslist}
2\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
3\setfooter{\thepage}{}{}{}{}{\thepage}%
4
598e55d7 5wxWidgets can be built either as a single large
8a7fd2e3
VS
6library (this is called the {\it monolithic build}) or as several smaller
7libraries ({\it multilib build}). Multilib build is the default.
8
fc2171bd 9wxWidgets library is divided into libraries briefly described below. This
dea7a9eb
VS
10diagram show dependencies between them:
11
12\begin{center}
13\image{}{libs.gif}
14\end{center}
8a7fd2e3
VS
15
16{\large {\bf wxBase}}
17
fc2171bd
JS
18Every wxWidgets application must link against this library. It contains
19mandatory classes that any wxWidgets code depends on (e.g.
bc9fa1f6 20 \helpref{wxString}{wxstring}) and portability classes that abstract
8a7fd2e3
VS
21differences between platforms. wxBase can be used to develop console mode
22applications, it does not require any GUI libraries or running X Window System
23on Unix.
24
598e55d7
VZ
25{\large {\bf wxCore}}
26
27Basic GUI classes such as GDI classes or controls are in this library. All
28wxWidgets GUI applications must link against this library, only console mode
29applications don't.
30
31{\large {\bf wxAui}}
32
33This contains the Advanced User Interface docking library.
34
35Requires wxHTML, wxAdvanced, wxCore, wxBase, wxXML.
36
8a7fd2e3
VS
37{\large {\bf wxNet}}
38
39Classes for network access:
cf01e37a
VS
40
41\begin{itemize}
42\item{ wxSocket classes (\helpref{wxSocketClient}{wxsocketclient},
0497e172 43 \helpref{wxSocketServer}{wxsocketserver} and related classes) }
cf01e37a 44\item{ \helpref{wxSocketOutputStream}{wxsocketoutputstream} and
0497e172 45 \helpref{wxSocketInputStream}{wxsocketinputstream} }
cf01e37a 46\item{ sockets-based IPC classes (\helpref{wxTCPServer}{wxddeserver},
0497e172
JS
47 \helpref{wxTCPClient}{wxddeclient} and
48 \helpref{wxTCPConnection}{wxddeconnection}) }
cf01e37a
VS
49\item{ \helpref{wxURL}{wxurl} }
50\item{ wxInternetFSHandler (a \helpref{wxFileSystem handler}{fs}) }
cf01e37a 51\end{itemize}
8a7fd2e3 52
598e55d7
VZ
53Requires wxBase.
54
27b12131
JS
55{\large {\bf wxRichText}}
56
57This contains generic rich text control functionality.
58
598e55d7 59Requires wxAdvanced, wxHTML, wxCore, wxXML, wxBase.
8a7fd2e3 60
598e55d7 61{\large {\bf wxXML}}
8a7fd2e3 62
598e55d7 63This library contains simple classes for parsing XML documents.
8a7fd2e3 64
598e55d7 65Requires wxBase.
8a7fd2e3
VS
66
67{\large {\bf wxAdvanced}}
68
92cd4cf1 69Advanced or rarely used GUI classes:
cf01e37a 70
0497e172 71\begin{itemize}\itemsep=0pt
598e55d7 72\item{ \helpref{wxBufferedDC}{wxbuffereddc} }
cf01e37a 73\item{ \helpref{wxCalendarCtrl}{wxcalendarctrl} }
cf01e37a 74\item{ \helpref{wxGrid classes}{gridoverview} }
8695c06a 75\item{ \helpref{wxJoystick}{wxjoystick} }
cf01e37a
VS
76\item{ \helpref{wxLayoutAlgorithm}{wxlayoutalgorithm} }
77\item{ \helpref{wxSplashScreen}{wxsplashscreen} }
8695c06a 78\item{ \helpref{wxTaskBarIcon}{wxtaskbaricon} }
315ebf68 79\item{ \helpref{wxSound}{wxsound} }
cf01e37a
VS
80\item{ \helpref{wxWizard}{wxwizard} }
81\item{ \helpref{wxSashLayoutWindow}{wxsashlayoutwindow} }
82\item{ \helpref{wxSashWindow}{wxsashwindow} }
598e55d7 83\item{ ...others }
cf01e37a
VS
84\end{itemize}
85
8a7fd2e3
VS
86Requires wxCore and wxBase.
87
92cd4cf1
RN
88{\large {\bf wxMedia}}
89
50518211
VZ
90Miscellaneous classes related to multimedia. Currently this library only
91contains \helpref{wxMediaCtrl}{wxmediactrl} but more classes will be added in
92the future.
92cd4cf1
RN
93
94Requires wxCore and wxBase.
95
8a7fd2e3
VS
96{\large {\bf wxGL}}
97
98This library contains \helpref{wxGLCanvas}{wxglcanvas} class for integrating
fc2171bd 99OpenGL library with wxWidgets. Unlike all others, this library is {\em not}
0497e172 100 part of the monolithic library, it is always built as separate library.
598e55d7 101
8a7fd2e3
VS
102Requires wxCore and wxBase.
103
104{\large {\bf wxHTML}}
105
106Simple HTML renderer and other \helpref{HTML rendering classes}{wxhtml} are
107contained in this library, as well as
0497e172
JS
108 \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller},
109 \helpref{wxBestHelpController}{wxhelpcontroller} and
598e55d7
VZ
110 \helpref{wxHtmlListBox}{wxhtmllistbox}.
111
112Requires wxCore and wxBase.
45293562
VS
113
114{\large {\bf wxODBC}}
115
116\helpref{Database classes}{odbcoverview}. Requires wxBase.
117
61639efb
VZ
118{\large {\bf wxQA}}
119
120This is the library containing extra classes for quality assurance. Currently
af127680
VZ
121it only contains \helpref{wxDebugReport}{wxdebugreport} and related classes,
122but more will be added to it in the future.
61639efb
VZ
123
124Requires wxCore, wxBase and wxXML.
125
45293562
VS
126{\large {\bf wxDbGrid}}
127
128\helpref{wxDbGridTableBase}{wxdbgridtablebase} class which combines
0497e172 129 \helpref{wxGrid}{wxgrid} and \helpref{wxDbTable}{wxdbtable}.
598e55d7 130
45293562 131Requires wxODBC and wxAdvanced.
684761db 132
f5de33e9
VS
133{\large {\bf wxXRC}}
134
135This library contains \helpref{wxXmlResource}{wxxmlresource} class that
598e55d7
VZ
136provides access to XML resource files in XRC format
137
f5de33e9
VS
138Requires wxXML, wxCore, wxAdvanced and wxHTML.
139
598e55d7
VZ
140{\large {\bf wxSTC}}
141
142STC (Styled Text Control) is a wrapper around Scintilla, a syntax-highlighting text editor.
143
144Requires wxCore, wxBase.