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