]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/libs.tex
Always use wxFULL_REPAINT_ON_RESIZE for generic status bar.
[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
fc2171bd 5Starting from version 2.5.0 wxWidgets 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
27b12131
JS
16{\large {\bf wxAui}}
17
18This contains the Advanced User Interface docking library.
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
29{\large {\bf wxNet}}
30
31Classes for network access:
cf01e37a
VS
32
33\begin{itemize}
34\item{ wxSocket classes (\helpref{wxSocketClient}{wxsocketclient},
0497e172 35 \helpref{wxSocketServer}{wxsocketserver} and related classes) }
cf01e37a 36\item{ \helpref{wxSocketOutputStream}{wxsocketoutputstream} and
0497e172 37 \helpref{wxSocketInputStream}{wxsocketinputstream} }
cf01e37a 38\item{ sockets-based IPC classes (\helpref{wxTCPServer}{wxddeserver},
0497e172
JS
39 \helpref{wxTCPClient}{wxddeclient} and
40 \helpref{wxTCPConnection}{wxddeconnection}) }
cf01e37a
VS
41\item{ \helpref{wxURL}{wxurl} }
42\item{ wxInternetFSHandler (a \helpref{wxFileSystem handler}{fs}) }
8a7fd2e3 43Requires wxBase.
cf01e37a 44\end{itemize}
8a7fd2e3 45
27b12131
JS
46{\large {\bf wxRichText}}
47
48This contains generic rich text control functionality.
49
8a7fd2e3
VS
50{\large {\bf wxXML}}
51
52This library contains simple classes for parsing XML documents. Note that
53their API {\em will} change in the future and backward
54compatibility will not be preserved. Use of this library in your applications
55is not recommended, it is only meant for use by XML resources system. Future
fc2171bd 56versions of wxWidgets will contain new XML handling classes with DOM-like API.
8a7fd2e3
VS
57Requires wxBase.
58
8a7fd2e3
VS
59{\large {\bf wxCore}}
60
61Basic GUI classes such as GDI classes or controls are in this library. All
fc2171bd 62wxWidgets GUI applications must link against this library, only console mode
8a7fd2e3
VS
63applications don't.
64
65{\large {\bf wxAdvanced}}
66
92cd4cf1 67Advanced or rarely used GUI classes:
cf01e37a 68
0497e172 69\begin{itemize}\itemsep=0pt
684761db 70\item{ wxBufferedDC }
cf01e37a 71\item{ \helpref{wxCalendarCtrl}{wxcalendarctrl} }
cf01e37a 72\item{ \helpref{wxGrid classes}{gridoverview} }
8695c06a 73\item{ \helpref{wxJoystick}{wxjoystick} }
cf01e37a
VS
74\item{ \helpref{wxLayoutAlgorithm}{wxlayoutalgorithm} }
75\item{ \helpref{wxSplashScreen}{wxsplashscreen} }
8695c06a 76\item{ \helpref{wxTaskBarIcon}{wxtaskbaricon} }
315ebf68 77\item{ \helpref{wxSound}{wxsound} }
cf01e37a
VS
78\item{ \helpref{wxWizard}{wxwizard} }
79\item{ \helpref{wxSashLayoutWindow}{wxsashlayoutwindow} }
80\item{ \helpref{wxSashWindow}{wxsashwindow} }
81\end{itemize}
82
8a7fd2e3
VS
83Requires wxCore and wxBase.
84
92cd4cf1
RN
85{\large {\bf wxMedia}}
86
50518211
VZ
87Miscellaneous classes related to multimedia. Currently this library only
88contains \helpref{wxMediaCtrl}{wxmediactrl} but more classes will be added in
89the future.
92cd4cf1
RN
90
91Requires wxCore and wxBase.
92
8a7fd2e3
VS
93{\large {\bf wxGL}}
94
95This library contains \helpref{wxGLCanvas}{wxglcanvas} class for integrating
fc2171bd 96OpenGL library with wxWidgets. Unlike all others, this library is {\em not}
0497e172 97 part of the monolithic library, it is always built as separate library.
8a7fd2e3
VS
98Requires wxCore and wxBase.
99
100{\large {\bf wxHTML}}
101
102Simple HTML renderer and other \helpref{HTML rendering classes}{wxhtml} are
103contained in this library, as well as
0497e172
JS
104 \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller},
105 \helpref{wxBestHelpController}{wxhelpcontroller} and
106 \helpref{wxHtmlListBox}{wxhtmllistbox}. Requires wxCore and wxBase.
45293562
VS
107
108{\large {\bf wxODBC}}
109
110\helpref{Database classes}{odbcoverview}. Requires wxBase.
111
61639efb
VZ
112{\large {\bf wxQA}}
113
114This is the library containing extra classes for quality assurance. Currently
af127680
VZ
115it only contains \helpref{wxDebugReport}{wxdebugreport} and related classes,
116but more will be added to it in the future.
61639efb
VZ
117
118Requires wxCore, wxBase and wxXML.
119
45293562
VS
120{\large {\bf wxDbGrid}}
121
122\helpref{wxDbGridTableBase}{wxdbgridtablebase} class which combines
0497e172 123 \helpref{wxGrid}{wxgrid} and \helpref{wxDbTable}{wxdbtable}.
45293562 124Requires wxODBC and wxAdvanced.
684761db 125
f5de33e9
VS
126{\large {\bf wxXRC}}
127
128This library contains \helpref{wxXmlResource}{wxxmlresource} class that
129provides access to XML resource files in XRC format.
130Requires wxXML, wxCore, wxAdvanced and wxHTML.
131