summaryrefslogtreecommitdiff
path: root/doc/src/modules.qdoc
blob: 5c1b413f60e42f4d46c5f209d5ced71e2057d019 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file.  Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \group modules
    \title All Modules
    \startpage index.html Qt Reference Documentation
    \nextpage QtCore

    \ingroup classlists

    \brief Qt 5 consists of essential modules, add-on modules, and tools.

    \section1 Qt Essentials

    Qt essentials define the foundation of Qt on all platforms. They are
    available on all supported development platforms and on the tested target
    platforms. They will remain source and binary compatible during Qt 5.

    Essential modules are general and useful for a majority of Qt applications.
    A module that is used for a special purpose is considered an add-on module
    even if it is available on all supported platforms.

    The following table lists the Qt essentials:

    \table 80%
    \header
        \li Module
        \li Description
    \row
        \li \l{Qt Core}
        \li Core non-graphical classes used by other modules.
    \row
        \li \l{Qt GUI}
        \li Base classes for graphical user interface (GUI) components.
            Includes OpenGL.
    \row
        \li \l{Qt Multimedia}
        \li Classes for audio, video, radio and camera functionality.
    \row
        \li \l{Qt Multimedia Widgets}
        \li Widget-based classes for implementing multimedia functionality.
    \row
        \li \l{Qt Network}
        \li Classes to make network programming easier and more portable.
    \row
        \li \l{Qt QML}
        \li Classes for QML and JavaScript languages.
    \row
        \li \l{Qt Quick}
        \li A declarative framework for building highly dynamic applications
            with custom user interfaces.
    \row
        \li \l{Qt Quick Controls}
        \li Reusable Qt Quick based UI controls to create classic desktop-style
            user interfaces
    \row
        \li \l{Qt SQL}
        \li Classes for database integration using SQL.
    \row
        \li \l{Qt Test}
        \li Classes for unit testing Qt applications and libraries.
    \row
        \li \l{Qt WebKit}
        \li Classes for a WebKit2 based implementation and a new QML API.
            See also Qt WebKit Widgets in the add-on modules.
    \row
        \li \l{Qt WebKit Widgets}
        \li WebKit1 and QWidget-based classes from Qt 4.
    \row
        \li \l{Qt Widgets}
        \li Classes to extend Qt GUI with C++ widgets.
    \endtable

    If you use \l qmake to build your projects, the QtCore and QtGui
    modules are included by default. To link only against QtCore, add
    the following line to your \c .pro file:

    \snippet doc/src/snippets/code/doc_src_modules.pro 0

    On Windows, if you do not use \l qmake
    or other build tools such as CMake, you also need to link against
    the \c qtmain library.

    \section1 Qt Add-Ons

    Qt add-on modules bring additional value for specific purposes. These
    modules may only be available on some development platform for some target
    platforms. Some of them are included in the Qt releases on particular
    platforms. Each add-on module specifies its compatibility promise
    separately.

    The following table lists the Qt add-ons:

    \table 80%
    \header
        \li Module
        \li Development Platforms
        \li Target Platforms
        \li Description
    \row
        \li \l{Active Qt}
        \li Windows
        \li
        \li Classes for applications which use ActiveX and COM
    \row
        \li \l{Qt Concurrent}
        \li
        \li
        \li Classes for writing multi-threaded programs without using low-level
            threading primitives.
    \row
        \li \l{Qt D-Bus}
        \li Unix
        \li
        \li Classes for inter-process communication over the D-Bus protocol.
    \row
        \li \l{Qt Graphical Effects}
        \li All
        \li
        \li Graphical effects for use with Qt Quick 2.
    \row
        \li \l{Qt Image Formats}
        \li All
        \li
        \li Plugins for additional image formats: TIFF, MNG, TGA, WBMP.
    \row
        \li \l{Qt OpenGL}
        \li
        \li
        \li OpenGL support classes.
        \note Provided to ease porting from Qt 4.x. Please use the QOpenGL
        classes in QtGui for new code.
    \row
        \li \l{Qt Print Support}
        \li All
        \li
        \li Classes to make printing easier and more portable.
    \row
        \li \l{Qt Quick 1 Reference Documentation}{Qt Declarative}
        \li All
        \li
        \li Qt Declarative is provided for \l{Qt 4.8 Reference Documentation}{Qt 4}
        compatibility. The documentation is available through the Qt 4.8
        \l{Qt Quick 1 Reference Documentation}{Qt Quick} documentation.
    \row
        \li \l{Qt Script}
        \li All
        \li
        \li Classes for making Qt applications scriptable. Provided for Qt 4.x
            compatibility. Please use the QJS* classes in the QtQml module for
            new code.
    \row
        \li \l{Qt Script Tools}
        \li All
        \li
        \li Additional components for applications that use Qt Script.
    \row
        \li \l{Qt Sensors}
        \li All
        \li \l{Android}, \l{BlackBerry}, \l{iOS}, and Mer.
        \li Provides access to sensor hardware and motion gesture recognition.
    \row
        \li \l{Qt Serial Port}
        \li All
        \li \l{Support for Windows}{Windows}, \l{Support for Linux/X11}{Linux}, and \l{Support for Mac OS X}{Mac OS X}.
        \li Provides access to hardware and virtual serial ports.
    \row
        \li \l{Qt SVG}
        \li All
        \li
        \li Classes for displaying the contents of SVG files.
    \row
        \li \l{Qt X11 Extras}
        \li All
        \li \l{Support for Linux/X11}{Linux/X11}
        \li Provides specific APIs for X11.
    \row
        \li \l{Qt XML}
        \li
        \li
        \li C++ implementations of SAX and DOM.
            \note Deprecated, please use QXmlStreamReader and QXmlStreamWriter
            for new functionality.
    \row
        \li \l{Qt XML Patterns}
        \li
        \li
        \li Support for XPath, XQuery, XSLT and XML schema validation.
    \endtable

    \section1 Qt Tools

    Tools that are officially a part of Qt. The official tools run on all the
    supported development platforms.

    The following table lists the Qt tools:

    \table 80%
    \header
        \li Tool
        \li Description
    \row
        \li \l{Qt Designer}
        \li Classes for extending \QD.
    \row
        \li \l{Qt Help}
        \li Classes for online help.
    \row
        \li \l{Qt UI Tools}
        \li Classes for UI tools.
    \endtable

    \sa {Class and Function Documentation}

*/

/*!
    \page qtmain.html
    \title The qtmain Library
    \ingroup licensing
    \brief Describes the use and license of the qtmain helper library.

    qtmain is a helper library that enables the developer to write a
    cross-platform main() function on Windows.
    If you do not use \l qmake or other build tools such as CMake, then you
    need to link against the \c qtmain library.

    \section1 License Information

    The QAxContainer module is not covered by the \l{GNU General Public License (GPL)},
    the \l{GNU Lesser General Public License (LGPL)}, or the
    \l{Qt Commercial Edition}{Qt Commercial License}. Instead, it is distributed under
    the following license.

    \legalese
    Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).\br
    Contact: http://www.qt-project.org/legal

    You may use this file under the terms of the BSD license as follows:

    "Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are
    met:
      * Redistributions of source code must retain the above copyright
        notice, this list of conditions and the following disclaimer.
      * Redistributions in binary form must reproduce the above copyright
        notice, this list of conditions and the following disclaimer in
        the documentation and/or other materials provided with the
        distribution.
      * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
        of its contributors may be used to endorse or promote products derived
        from this software without specific prior written permission.


    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
    \endlegalese
*/