]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/libs.tex
corrected wxUnix2DosFilename signature, added deprecation note
[wxWidgets.git] / docs / latex / wx / libs.tex
1 \chapter{Libraries list}\label{librarieslist}
2 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
3 \setfooter{\thepage}{}{}{}{}{\thepage}%
4
5 Starting from version 2.5.0 wxWidgets can be built either as a single large
6 library (this is called the {\it monolithic build}) or as several smaller
7 libraries ({\it multilib build}). Multilib build is the default.
8
9 wxWidgets library is divided into libraries briefly described below. This
10 diagram show dependencies between them:
11
12 \begin{center}
13 \image{}{libs.gif}
14 \end{center}
15
16 {\large {\bf wxBase}}
17
18 Every wxWidgets application must link against this library. It contains
19 mandatory classes that any wxWidgets code depends on (e.g.
20 \helpref{wxString}{wxstring}) and portability classes that abstract
21 differences between platforms. wxBase can be used to develop console mode
22 applications, it does not require any GUI libraries or running X Window System
23 on Unix.
24
25 {\large {\bf wxNet}}
26
27 Classes for network access:
28
29 \begin{itemize}
30 \item{ wxSocket classes (\helpref{wxSocketClient}{wxsocketclient},
31 \helpref{wxSocketServer}{wxsocketserver} and related classes) }
32 \item{ \helpref{wxSocketOutputStream}{wxsocketoutputstream} and
33 \helpref{wxSocketInputStream}{wxsocketinputstream} }
34 \item{ sockets-based IPC classes (\helpref{wxTCPServer}{wxddeserver},
35 \helpref{wxTCPClient}{wxddeclient} and
36 \helpref{wxTCPConnection}{wxddeconnection}) }
37 \item{ \helpref{wxURL}{wxurl} }
38 \item{ wxInternetFSHandler (a \helpref{wxFileSystem handler}{fs}) }
39 Requires wxBase.
40 \end{itemize}
41
42 {\large {\bf wxXML}}
43
44 This library contains simple classes for parsing XML documents. Note that
45 their API {\em will} change in the future and backward
46 compatibility will not be preserved. Use of this library in your applications
47 is not recommended, it is only meant for use by XML resources system. Future
48 versions of wxWidgets will contain new XML handling classes with DOM-like API.
49 Requires wxBase.
50
51 {\large {\bf wxCore}}
52
53 Basic GUI classes such as GDI classes or controls are in this library. All
54 wxWidgets GUI applications must link against this library, only console mode
55 applications don't.
56
57 {\large {\bf wxAdvanced}}
58
59 Advanced or rarely used GUI classes:
60
61 \begin{itemize}\itemsep=0pt
62 \item{ wxBufferedDC }
63 \item{ \helpref{wxCalendarCtrl}{wxcalendarctrl} }
64 \item{ \helpref{wxGrid classes}{gridoverview} }
65 \item{ \helpref{wxJoystick}{wxjoystick} }
66 \item{ \helpref{wxLayoutAlgorithm}{wxlayoutalgorithm} }
67 \item{ \helpref{wxSplashScreen}{wxsplashscreen} }
68 \item{ \helpref{wxTaskBarIcon}{wxtaskbaricon} }
69 \item{ \helpref{wxSound}{wxsound} }
70 \item{ \helpref{wxWizard}{wxwizard} }
71 \item{ \helpref{wxSashLayoutWindow}{wxsashlayoutwindow} }
72 \item{ \helpref{wxSashWindow}{wxsashwindow} }
73 \end{itemize}
74
75 Requires wxCore and wxBase.
76
77 {\large {\bf wxMedia}}
78
79 Miscellaneous classes related to multimedia. Currently this library only
80 contains \helpref{wxMediaCtrl}{wxmediactrl} but more classes will be added in
81 the future.
82
83 Requires wxCore and wxBase.
84
85 {\large {\bf wxGL}}
86
87 This library contains \helpref{wxGLCanvas}{wxglcanvas} class for integrating
88 OpenGL library with wxWidgets. Unlike all others, this library is {\em not}
89 part of the monolithic library, it is always built as separate library.
90 Requires wxCore and wxBase.
91
92 {\large {\bf wxHTML}}
93
94 Simple HTML renderer and other \helpref{HTML rendering classes}{wxhtml} are
95 contained in this library, as well as
96 \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller},
97 \helpref{wxBestHelpController}{wxhelpcontroller} and
98 \helpref{wxHtmlListBox}{wxhtmllistbox}. Requires wxCore and wxBase.
99
100 {\large {\bf wxODBC}}
101
102 \helpref{Database classes}{odbcoverview}. Requires wxBase.
103
104 {\large {\bf wxQA}}
105
106 This is the library containing extra classes for quality assurance. Currently
107 it only contains \helpref{wxDebugReport}{wxdebugreport} and related classes,
108 but more will be added to it in the future.
109
110 Requires wxCore, wxBase and wxXML.
111
112 {\large {\bf wxDbGrid}}
113
114 \helpref{wxDbGridTableBase}{wxdbgridtablebase} class which combines
115 \helpref{wxGrid}{wxgrid} and \helpref{wxDbTable}{wxdbtable}.
116 Requires wxODBC and wxAdvanced.
117
118 {\large {\bf wxXRC}}
119
120 This library contains \helpref{wxXmlResource}{wxxmlresource} class that
121 provides access to XML resource files in XRC format.
122 Requires wxXML, wxCore, wxAdvanced and wxHTML.
123