|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the documentation of the Qt Toolkit. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 /*! |
|
43 \group modules |
|
44 \title All Qt Modules |
|
45 \startpage index.html Qt Reference Documentation |
|
46 \nextpage QtCore |
|
47 |
|
48 \ingroup classlists |
|
49 |
|
50 \brief Qt 4 comprises several modules. Each module is a separate |
|
51 library. |
|
52 |
|
53 \table 80% |
|
54 \header \o {2,1} \bold{Modules for general software development} |
|
55 \row \o \l{QtCore} \o Core non-graphical classes used by other modules |
|
56 \row \o \l{QtGui} \o Graphical user interface (GUI) components |
|
57 \row \o \l{QtMultimedia} \o Classes for low-level multimedia functionality |
|
58 \row \o \l{QtNetwork} \o Classes for network programming |
|
59 \row \o \l{QtOpenGL} \o OpenGL support classes |
|
60 \row \o \l{QtOpenVG} \o OpenVG support classes |
|
61 \row \o \l{QtScript} \o Classes for evaluating Qt Scripts |
|
62 \row \o \l{QtScriptTools} \o Additional Qt Script components |
|
63 \row \o \l{QtSql} \o Classes for database integration using SQL |
|
64 \row \o \l{QtSvg} \o Classes for displaying the contents of SVG files |
|
65 \row \o \l{QtWebKit} \o Classes for displaying and editing Web content |
|
66 \row \o \l{QtXml} \o Classes for handling XML |
|
67 \row \o \l{QtXmlPatterns} \o An XQuery & XPath engine for XML and custom data models |
|
68 \row \o \l{Phonon Module}{Phonon} \o Multimedia framework classes |
|
69 \row \o \l{Qt3Support} \o Qt 3 compatibility classes |
|
70 \header \o {2,1} \bold{Modules for working with Qt's tools} |
|
71 \row \o \l{QtDesigner} \o Classes for extending \QD |
|
72 \row \o \l{QtUiTools} \o Classes for handling \QD forms in applications |
|
73 \row \o \l{QtHelp} \o Classes for online help |
|
74 \row \o \l{QtTest} \o Tool classes for unit testing |
|
75 \header \o {2,1} \bold{Modules for Windows developers} |
|
76 \row \o \l{QAxContainer} \o Extension for accessing ActiveX controls |
|
77 \row \o \l{QAxServer} \o Extension for writing ActiveX servers |
|
78 \header \o {2,1} \bold{Modules for Unix developers} |
|
79 \row \o \l{QtDBus} \o Classes for Inter-Process Communication using the D-Bus |
|
80 \endtable |
|
81 |
|
82 If you use \l qmake to build your projects, the QtCore and QtGui |
|
83 modules are included by default. To link only against QtCore, add |
|
84 the following line to your \c .pro file: |
|
85 |
|
86 \snippet doc/src/snippets/code/doc_src_modules.qdoc 0 |
|
87 |
|
88 On Windows, if you do not use \l qmake |
|
89 or other build tools such as CMake, you also need to link against |
|
90 the \c qtmain library. |
|
91 |
|
92 \sa {Class and Function Documentation} |
|
93 */ |
|
94 |
|
95 /*! |
|
96 \module QtCore |
|
97 \title QtCore Module |
|
98 \contentspage All Qt Modules |
|
99 \previouspage All Qt Modules |
|
100 \nextpage QtGui |
|
101 \ingroup modules |
|
102 |
|
103 \keyword QtCore |
|
104 |
|
105 \brief The QtCore module contains core non-GUI functionality. |
|
106 |
|
107 All other Qt modules rely on this module. To include the |
|
108 definitions of the module's classes, use the following directive: |
|
109 |
|
110 \snippet doc/src/snippets/code/doc_src_qtcore.qdoc 0 |
|
111 |
|
112 The QtCore module is part of all \l{Qt editions}. |
|
113 */ |
|
114 |
|
115 |
|
116 /*! |
|
117 \module QtGui |
|
118 \title QtGui Module |
|
119 \contentspage All Qt Modules |
|
120 \previouspage QtCore |
|
121 \nextpage QtNetwork |
|
122 \ingroup modules |
|
123 |
|
124 \brief The QtGui module extends QtCore with GUI functionality. |
|
125 |
|
126 To include the definitions of both modules' classes, use the |
|
127 following directive: |
|
128 |
|
129 \snippet doc/src/snippets/code/doc_src_qtgui.qdoc 0 |
|
130 |
|
131 The QtGui module is part of the \l{Qt GUI Framework Edition}, |
|
132 the \l{Qt Full Framework Edition}, and the \l{Open Source Versions of Qt}. |
|
133 */ |
|
134 |
|
135 /*! |
|
136 \module QtMultimedia |
|
137 \title QtMultimedia Module |
|
138 \contentspage All Qt Modules |
|
139 \previouspage QtCore |
|
140 \nextpage QtNetwork |
|
141 \ingroup modules |
|
142 |
|
143 \brief The QtMultimedia module provides low-level multimedia functionality. |
|
144 |
|
145 To include the definitions of the module's classes, use the |
|
146 following directive: |
|
147 |
|
148 \snippet doc/src/snippets/code/doc_src_qtmultimedia.qdoc 1 |
|
149 |
|
150 To link against the module, add this line to your \l qmake \c |
|
151 .pro file: |
|
152 |
|
153 \snippet doc/src/snippets/code/doc_src_qtmultimedia.qdoc 0 |
|
154 |
|
155 The functionality provided by the \l{Phonon Module} is on a higher level |
|
156 and in many cases more suitable for application developers. |
|
157 */ |
|
158 |
|
159 /*! |
|
160 \module QtNetwork |
|
161 \title QtNetwork Module |
|
162 \contentspage All Qt Modules |
|
163 \previouspage QtMultimedia |
|
164 \nextpage QtOpenGL |
|
165 \ingroup modules |
|
166 |
|
167 \brief The QtNetwork module provides classes to make network programming |
|
168 easier and portable. |
|
169 |
|
170 To include the definitions of the module's classes, use the |
|
171 following directive: |
|
172 |
|
173 \snippet doc/src/snippets/code/doc_src_qtnetwork.qdoc 1 |
|
174 |
|
175 To link against the module, add this line to your \l qmake \c |
|
176 .pro file: |
|
177 |
|
178 \snippet doc/src/snippets/code/doc_src_qtnetwork.qdoc 0 |
|
179 |
|
180 The QtNetwork module is part of the \l{Qt Full Framework Edition} and the |
|
181 \l{Open Source Versions of Qt}. |
|
182 */ |
|
183 |
|
184 /*! |
|
185 \module QtOpenGL |
|
186 \title QtOpenGL Module |
|
187 \contentspage All Qt Modules |
|
188 \previouspage QtNetwork |
|
189 \nextpage QtOpenVG |
|
190 \ingroup modules |
|
191 |
|
192 \brief The QtOpenGL module offers classes that make it easy to |
|
193 use OpenGL in Qt applications. |
|
194 |
|
195 OpenGL is a standard API for rendering 3D graphics. OpenGL only |
|
196 deals with 3D rendering and provides little or no support for GUI |
|
197 programming issues. The user interface for an OpenGL application |
|
198 must be created with another toolkit, such as Motif on the X |
|
199 platform, Microsoft Foundation Classes (MFC) under Windows, or Qt |
|
200 on both platforms. |
|
201 |
|
202 \note OpenGL is a trademark of Silicon Graphics, Inc. in |
|
203 the United States and other countries. |
|
204 |
|
205 The Qt OpenGL module makes it easy to use OpenGL in Qt applications. |
|
206 It provides an OpenGL widget class that can be used just like any |
|
207 other Qt widget, except that it opens an OpenGL display buffer where |
|
208 you can use the OpenGL API to render the contents. |
|
209 |
|
210 To include the definitions of the module's classes, use the |
|
211 following directive: |
|
212 |
|
213 \snippet doc/src/snippets/code/doc_src_qtopengl.qdoc 0 |
|
214 |
|
215 To link against the module, add this line to your \l qmake \c |
|
216 .pro file: |
|
217 |
|
218 \snippet doc/src/snippets/code/doc_src_qtopengl.qdoc 1 |
|
219 |
|
220 The Qt OpenGL module is implemented as a platform-independent Qt/C++ |
|
221 wrapper around the platform-dependent GLX (version 1.3 or later), |
|
222 WGL, or AGL C APIs. Although the basic functionality provided is very |
|
223 similar to Mark Kilgard's GLUT library, applications using the Qt |
|
224 OpenGL module can take advantage of the whole Qt API for |
|
225 non-OpenGL-specific GUI functionality. |
|
226 |
|
227 The QtOpenGL module is part of the \l{Qt Full Framework Edition} and the |
|
228 \l{Open Source Versions of Qt}. It is available on Windows, X11, and Mac OS X. |
|
229 \l{Qt for Embedded Linux} supports OpenGL ES (OpenGL for Embedded Systems). |
|
230 To be able to use the OpenGL API in \l{Qt for Embedded Linux}, it must be |
|
231 integrated with the Q Window System (QWS). See the |
|
232 \l{Qt for Embedded Linux and OpenGL} documentation for details. |
|
233 */ |
|
234 |
|
235 /*! |
|
236 \module QtOpenVG |
|
237 \title QtOpenVG Module |
|
238 \since 4.6 |
|
239 \contentspage All Qt Modules |
|
240 \previouspage QtOpenGL |
|
241 \nextpage QtScript |
|
242 \ingroup modules |
|
243 |
|
244 \brief The QtOpenVG module is a plugin that provides support for |
|
245 OpenVG painting. |
|
246 |
|
247 OpenVG is a standard API from the |
|
248 \l{http://www.khronos.org/openvg}{Khronos Group} for accelerated |
|
249 2D vector graphics that is appearing in an increasing number of |
|
250 embedded devices. |
|
251 |
|
252 OpenVG support can be enabled by passing the \c{-openvg} option |
|
253 to configure. It is assumed that the following qmake variables |
|
254 are set to appropriate values in the qmake.conf file for your |
|
255 platform: |
|
256 |
|
257 \list |
|
258 \o QMAKE_INCDIR_OPENVG |
|
259 \o QMAKE_LIBDIR_OPENVG |
|
260 \o QMAKE_LIBS_OPENVG |
|
261 \endlist |
|
262 |
|
263 Most OpenVG implementations are based on EGL, so the following |
|
264 variables may also need to be set: |
|
265 |
|
266 \list |
|
267 \o QMAKE_INCDIR_EGL |
|
268 \o QMAKE_LIBDIR_EGL |
|
269 \o QMAKE_LIBS_EGL |
|
270 \endlist |
|
271 |
|
272 See \l{qmake Variable Reference} for more information on these variables. |
|
273 |
|
274 Two kinds of OpenVG engines are currently supported: EGL based, |
|
275 and engines built on top of OpenGL such as |
|
276 \l{http://sourceforge.net/projects/shivavg}{ShivaVG}. |
|
277 EGL based engines are preferred. |
|
278 |
|
279 Once the graphics system plugin has been built and installed, |
|
280 applications can be run as follows to use the plugin: |
|
281 |
|
282 \code |
|
283 app -graphicssystem OpenVG |
|
284 \endcode |
|
285 |
|
286 If ShivaVG is being used, then substitute \c ShivaVG instead of |
|
287 \c OpenVG in the line above. |
|
288 */ |
|
289 |
|
290 /*! |
|
291 \module QtScript |
|
292 \title QtScript Module |
|
293 \since 4.3 |
|
294 \contentspage All Qt Modules |
|
295 \previouspage QtOpenVG |
|
296 \nextpage QtScriptTools |
|
297 \ingroup modules |
|
298 |
|
299 \brief The QtScript module provides classes for making Qt applications scriptable. |
|
300 |
|
301 The QtScript module only provides core scripting facilities; the |
|
302 QtScriptTools module provides additional Qt Script-related |
|
303 components that application developers may find useful. |
|
304 |
|
305 \tableofcontents |
|
306 |
|
307 To include the definitions of the module's classes, use the |
|
308 following directive: |
|
309 |
|
310 \snippet doc/src/snippets/code/doc_src_qtscript.qdoc 0 |
|
311 |
|
312 To link against the module, add this line to your \l qmake \c .pro file: |
|
313 |
|
314 \snippet doc/src/snippets/code/doc_src_qtscript.qdoc 1 |
|
315 |
|
316 The QtScript module is part of the \l{Qt Full Framework Edition} and the |
|
317 \l{Open Source Versions of Qt}. |
|
318 */ |
|
319 |
|
320 /*! |
|
321 \module QtScriptTools |
|
322 \title QtScriptTools Module |
|
323 \since 4.5 |
|
324 \contentspage All Qt Modules |
|
325 \previouspage QtScript |
|
326 \nextpage QtSql |
|
327 \ingroup modules |
|
328 |
|
329 \brief The QtScriptTools module provides additional components for applications that use Qt Script. |
|
330 |
|
331 \tableofcontents |
|
332 |
|
333 \section1 Configuring the Build Process |
|
334 |
|
335 Applications that use the Qt Script Tools classes need to |
|
336 be configured to be built against the QtScriptTools module. |
|
337 To include the definitions of the module's classes, use the |
|
338 following directive: |
|
339 |
|
340 \snippet doc/src/snippets/code/doc.src.qtscripttools.qdoc 0 |
|
341 |
|
342 To link against the module, add this line to your \l qmake \c .pro file: |
|
343 |
|
344 \snippet doc/src/snippets/code/doc.src.qtscripttools.qdoc 1 |
|
345 |
|
346 The QtScriptTools module is part of the \l{Qt Full Framework Edition} and |
|
347 the \l{Open Source Versions of Qt}. |
|
348 */ |
|
349 |
|
350 /*! |
|
351 \module QtSql |
|
352 \title QtSql Module |
|
353 \contentspage All Qt Modules |
|
354 \previouspage QtScript |
|
355 \nextpage QtSvg |
|
356 \ingroup modules |
|
357 |
|
358 To include the definitions of the module's classes, use the |
|
359 following directive: |
|
360 |
|
361 \snippet doc/src/snippets/code/doc_src_qtsql.qdoc 0 |
|
362 |
|
363 To link against the module, add this line to your \l qmake \c |
|
364 .pro file: |
|
365 |
|
366 \snippet doc/src/snippets/code/doc_src_qtsql.qdoc 1 |
|
367 |
|
368 The QtSql module is part of the \l{Qt Full Framework Edition} and the |
|
369 \l{Open Source Versions of Qt}. |
|
370 */ |
|
371 |
|
372 /*! |
|
373 \module QtSvg |
|
374 \title QtSvg Module |
|
375 \since 4.1 |
|
376 \contentspage All Qt Modules |
|
377 \previouspage QtSql |
|
378 \nextpage QtWebKit |
|
379 \ingroup modules |
|
380 |
|
381 \brief The QtSvg module provides classes for displaying the contents of SVG |
|
382 files. |
|
383 |
|
384 To include the definitions of the module's classes, use the |
|
385 following directive: |
|
386 |
|
387 \snippet doc/src/snippets/code/doc_src_qtsvg.qdoc 0 |
|
388 |
|
389 To link against the module, add this line to your \l qmake \c |
|
390 .pro file: |
|
391 |
|
392 \snippet doc/src/snippets/code/doc_src_qtsvg.qdoc 1 |
|
393 |
|
394 The QtSvg module is part of the \l{Qt Full Framework Edition} and the |
|
395 \l{Open Source Versions of Qt}. |
|
396 |
|
397 \section1 License Information |
|
398 |
|
399 Some code for arc handling in this module is derived from code with |
|
400 the following license: |
|
401 |
|
402 \legalese |
|
403 Copyright 2002 USC/Information Sciences Institute |
|
404 |
|
405 Permission to use, copy, modify, distribute, and sell this software |
|
406 and its documentation for any purpose is hereby granted without |
|
407 fee, provided that the above copyright notice appear in all copies |
|
408 and that both that copyright notice and this permission notice |
|
409 appear in supporting documentation, and that the name of |
|
410 Information Sciences Institute not be used in advertising or |
|
411 publicity pertaining to distribution of the software without |
|
412 specific, written prior permission. Information Sciences Institute |
|
413 makes no representations about the suitability of this software for |
|
414 any purpose. It is provided "as is" without express or implied |
|
415 warranty. |
|
416 |
|
417 INFORMATION SCIENCES INSTITUTE DISCLAIMS ALL WARRANTIES WITH REGARD |
|
418 TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF |
|
419 MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL INFORMATION SCIENCES |
|
420 INSTITUTE BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL |
|
421 DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA |
|
422 OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER |
|
423 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR |
|
424 PERFORMANCE OF THIS SOFTWARE. |
|
425 \endlegalese |
|
426 */ |
|
427 |
|
428 /*! |
|
429 \module QtXml |
|
430 \title QtXml Module |
|
431 \contentspage All Qt Modules |
|
432 \previouspage QtSvg |
|
433 \nextpage QtXmlPatterns |
|
434 \ingroup modules |
|
435 |
|
436 \brief The QtXml module provides a stream reader and writer for |
|
437 XML documents, and C++ implementations of SAX and DOM. |
|
438 |
|
439 To include the definitions of the module's classes, use the |
|
440 following directive: |
|
441 |
|
442 \snippet doc/src/snippets/code/doc_src_qtxml.qdoc 0 |
|
443 |
|
444 To link against the module, add this line to your \l qmake \c |
|
445 .pro file: |
|
446 |
|
447 \snippet doc/src/snippets/code/doc_src_qtxml.qdoc 1 |
|
448 |
|
449 Further XML support is provided by the \l{Qt Solutions} group who |
|
450 provide, for example, classes that support SOAP and MML with the |
|
451 Qt XML classes. |
|
452 |
|
453 This module is part of the \l{Qt Full Framework Edition} and the |
|
454 \l{Open Source Versions of Qt}. |
|
455 */ |
|
456 |
|
457 /*! |
|
458 \module QtXmlPatterns |
|
459 \title QtXmlPatterns Module |
|
460 \since 4.4 |
|
461 \contentspage All Qt Modules |
|
462 \previouspage QtXml |
|
463 \nextpage Phonon Module |
|
464 \ingroup modules |
|
465 |
|
466 \brief The QtXmlPatterns module provides support for XPath, |
|
467 XQuery, XSLT and XML schema-validation. |
|
468 |
|
469 To include the definitions of the module's classes, use the |
|
470 following directive: |
|
471 |
|
472 \snippet doc/src/snippets/code/doc_src_qtxmlpatterns.qdoc 0 |
|
473 |
|
474 To link against the module, add this line to your \l qmake \c |
|
475 .pro file: |
|
476 |
|
477 \snippet doc/src/snippets/code/doc_src_qtxmlpatterns.qdoc 1 |
|
478 |
|
479 This module is part of the \l{Qt Full Framework Edition} and the |
|
480 \l{Open Source Versions of Qt}. |
|
481 |
|
482 \section1 License Information |
|
483 |
|
484 The XML Schema implementation provided by this module contains the \c xml.xsd file |
|
485 (located in \c{src/xmlpatterns/schema/schemas}) which is licensed under the terms |
|
486 given below. This module is always built with XML Schema support enabled. |
|
487 |
|
488 \legalese |
|
489 W3C\copyright SOFTWARE NOTICE AND LICENSE |
|
490 |
|
491 This license came from: http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231 |
|
492 |
|
493 This work (and included software, documentation such as READMEs, or other |
|
494 related items) is being provided by the copyright holders under the following |
|
495 license. By obtaining, using and/or copying this work, you (the licensee) |
|
496 agree that you have read, understood, and will comply with the following |
|
497 terms and conditions. |
|
498 |
|
499 Permission to copy, modify, and distribute this software and its |
|
500 documentation, with or without modification, for any purpose and without |
|
501 fee or royalty is hereby granted, provided that you include the following on |
|
502 ALL copies of the software and documentation or portions thereof, including |
|
503 modifications: |
|
504 |
|
505 1. The full text of this NOTICE in a location viewable to users of the |
|
506 redistributed or derivative work.\br |
|
507 2. Any pre-existing intellectual property disclaimers, notices, or terms |
|
508 and conditions. If none exist, the W3C Software Short Notice should be |
|
509 included (hypertext is preferred, text is permitted) |
|
510 within the body of any redistributed or derivative code.\br |
|
511 3. Notice of any changes or modifications to the files, including the date |
|
512 changes were made. (We recommend you provide URIs to the location from |
|
513 which the code is derived.) |
|
514 |
|
515 THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS |
|
516 MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT |
|
517 LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR |
|
518 PURPOSE OR THAT THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE |
|
519 ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS. |
|
520 |
|
521 COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR |
|
522 CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR |
|
523 DOCUMENTATION. |
|
524 |
|
525 The name and trademarks of copyright holders may NOT be used in |
|
526 advertising or publicity pertaining to the software without specific, written |
|
527 prior permission. Title to copyright in this software and any associated |
|
528 documentation will at all times remain with copyright holders. |
|
529 \endlegalese |
|
530 */ |
|
531 |
|
532 /*! |
|
533 \page phonon-module.html |
|
534 \module Phonon |
|
535 \title Phonon Module |
|
536 \contentspage All Qt Modules |
|
537 \previouspage QtXmlPatterns |
|
538 \nextpage Qt3Support |
|
539 \ingroup modules |
|
540 |
|
541 \brief The Phonon module contains namespaces and classes for multimedia functionality. |
|
542 |
|
543 \generatelist{classesbymodule Phonon} |
|
544 |
|
545 Phonon is a cross-platform multimedia framework that enables the use of |
|
546 audio and video content in Qt applications. The \l{Phonon Overview} |
|
547 document provides an introduction to the architecture and features included |
|
548 in Phonon. The \l{Phonon} namespace contains a list of all classes, functions |
|
549 and namespaces provided by the module. |
|
550 |
|
551 Applications that use Phonon's classes need to |
|
552 be configured to be built against the Phonon module. |
|
553 The following declaration in a \c qmake project file ensures that |
|
554 an application is compiled and linked appropriately: |
|
555 |
|
556 \snippet doc/src/snippets/code/doc_src_phonon.qdoc 1 |
|
557 |
|
558 The Phonon module is part of the \l{Qt Full Framework Edition} and the |
|
559 \l{Open Source Versions of Qt}. |
|
560 |
|
561 \section1 Qt Backends |
|
562 |
|
563 Qt Backends are currently developed for Phonon version 4.1. The Phonon |
|
564 project has moved on and introduced new features that the Qt Backends do not |
|
565 implement. We have chosen not to document the part of Phonon that we do not |
|
566 support. Any class or function not appearing in our documentation can be |
|
567 considered unsupported. |
|
568 |
|
569 \section1 License Information |
|
570 |
|
571 Qt Commercial Edition licensees that wish to distribute applications that |
|
572 use the Phonon module need to be aware of their obligations under the |
|
573 GNU Lesser General Public License (LGPL). |
|
574 |
|
575 Developers using the Open Source Edition can choose to redistribute |
|
576 the module under the appropriate version of the GNU LGPL; version 2.1 |
|
577 for applications and libraries licensed under the GNU GPL version 2, |
|
578 or version 3 for applications and libraries licensed under the GNU |
|
579 GPL version 2. |
|
580 |
|
581 \legalese |
|
582 This file is part of the KDE project |
|
583 |
|
584 Copyright (C) 2004-2009 Matthias Kretz <kretz@kde.org> \BR |
|
585 Copyright (C) 2008 Ian Monroe <ian@monroe.nu> \BR |
|
586 Copyright (C) 2007-2008 Trolltech ASA \BR |
|
587 Copyright (C) 2008-2009 Nokia Corporation and/or its subsidiary(-ies). \BR |
|
588 Contact: Nokia Corporation (qt-info@nokia.com) |
|
589 |
|
590 This library is free software; you can redistribute it and/or |
|
591 modify it under the terms of the GNU Library General Public |
|
592 License version 2 as published by the Free Software Foundation. |
|
593 |
|
594 This library is distributed in the hope that it will be useful, |
|
595 but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
596 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|
597 Library General Public License for more details. |
|
598 |
|
599 You should have received a copy of the GNU Library General Public License |
|
600 along with this library; see the file COPYING.LIB. If not, write to |
|
601 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
|
602 Boston, MA 02110-1301, USA. |
|
603 \endlegalese |
|
604 */ |
|
605 |
|
606 /*! |
|
607 \module Qt3Support |
|
608 \title Qt3Support Module |
|
609 \contentspage All Qt Modules |
|
610 \previouspage Phonon Module |
|
611 \nextpage QtDesigner |
|
612 \ingroup modules |
|
613 |
|
614 \keyword Qt3Support |
|
615 \brief The Qt3Support module provides classes that ease porting |
|
616 from Qt 3 to Qt 4. |
|
617 |
|
618 \warning The classes in this module are intended to be used in |
|
619 intermediate stages of a porting process and are not intended |
|
620 to be used in production code. |
|
621 |
|
622 To include the definitions of the module's classes, use the |
|
623 following directive: |
|
624 |
|
625 \snippet doc/src/snippets/code/doc_src_qt3support.qdoc 0 |
|
626 |
|
627 To link against the module, add this line to your \l qmake \c |
|
628 .pro file: |
|
629 |
|
630 \snippet doc/src/snippets/code/doc_src_qt3support.qdoc 1 |
|
631 |
|
632 \note Since this module provides compatibility classes for |
|
633 diverse parts of the Qt 3 API, it has dependencies on the QtCore, |
|
634 QtGui, QtNetwork, QtSql, and QtXml modules. |
|
635 |
|
636 This module is part of the \l{Qt Full Framework Edition} and the |
|
637 \l{Open Source Versions of Qt}. Most classes offered by this module are |
|
638 also part of the \l{Qt GUI Framework Edition}. |
|
639 Classes that are not available for \l{Qt GUI Framework Edition} |
|
640 users are marked as such in the class documentation. |
|
641 |
|
642 \sa {Porting to Qt 4} |
|
643 */ |
|
644 |
|
645 /*! |
|
646 \module QtDesigner |
|
647 \title QtDesigner Module |
|
648 \contentspage All Qt Modules |
|
649 \previouspage Qt3Support |
|
650 \nextpage QtUiTools |
|
651 \ingroup modules |
|
652 |
|
653 \brief The QtDesigner module provides classes that allow you to |
|
654 create your own custom widget plugins for Qt Designer, and classes |
|
655 that enable you to access Qt Designer's components. |
|
656 |
|
657 In addition, the QFormBuilder class provides the possibility of |
|
658 constructing user interfaces from UI files at run-time. |
|
659 |
|
660 To include the definitions of the module's classes, use the |
|
661 following directive: |
|
662 |
|
663 \snippet doc/src/snippets/code/doc_src_qtdesigner.qdoc 0 |
|
664 |
|
665 To link against the module, add this line to your \c qmake .pro |
|
666 file: |
|
667 |
|
668 \snippet doc/src/snippets/code/doc_src_qtdesigner.qdoc 1 |
|
669 |
|
670 \note These classes are part of the \l{Open Source Versions of Qt} and |
|
671 \l{Qt Commercial Editions}{Qt Full Framework Edition} for commercial |
|
672 users. |
|
673 */ |
|
674 |
|
675 /*! |
|
676 \module QtUiTools |
|
677 \title QtUiTools Module |
|
678 \since 4.1 |
|
679 \contentspage All Qt Modules |
|
680 \previouspage QtDesigner |
|
681 \nextpage QtHelp |
|
682 \ingroup modules |
|
683 |
|
684 \brief The QtUiTools module provides classes to handle forms created |
|
685 with Qt Designer. |
|
686 |
|
687 These forms are processed at run-time to produce dynamically-generated |
|
688 user interfaces. In order to generate a form at run-time, a resource |
|
689 file containing a UI file is needed. Applications that use the |
|
690 form handling classes need to be configured to be built against the |
|
691 QtUiTools module. This is done by including the following declaration |
|
692 in a \c qmake project file to ensure that the application is compiled |
|
693 and linked appropriately. |
|
694 |
|
695 \snippet doc/src/snippets/code/doc_src_qtuiloader.qdoc 0 |
|
696 |
|
697 A form loader object, provided by the QUiLoader class, is used to |
|
698 construct the user interface. This user interface can |
|
699 be retrieved from any QIODevice; for example, a QFile object can be |
|
700 used to obtain a form stored in a project's resources. The |
|
701 QUiLoader::load() function takes the user interface description |
|
702 contained in the file and constructs the form widget. |
|
703 |
|
704 To include the definitions of the module's classes, use the following |
|
705 directive: |
|
706 |
|
707 \snippet doc/src/snippets/code/doc_src_qtuiloader.qdoc 1 |
|
708 |
|
709 \note These classes are part of the \l{Open Source Versions of Qt} and |
|
710 \l{Qt Commercial Editions}{Qt Full Framework Edition} for commercial |
|
711 users. |
|
712 |
|
713 \sa{Calculator Builder Example}, {World Time Clock Builder Example} |
|
714 */ |
|
715 |
|
716 /*! |
|
717 \module QtHelp |
|
718 \title QtHelp Module |
|
719 \contentspage All Qt Modules |
|
720 \previouspage QtUiTools |
|
721 \nextpage QtTest |
|
722 \ingroup modules |
|
723 |
|
724 \brief The QtHelp module provides classes for integrating |
|
725 online documentation in applications. |
|
726 |
|
727 To include the definitions of the module's classes, use the |
|
728 following directive: |
|
729 |
|
730 \snippet doc/src/snippets/code/doc_src_qthelp.qdoc 0 |
|
731 |
|
732 To link against the module, add this line to your \l qmake \c |
|
733 .pro file: |
|
734 |
|
735 \snippet doc/src/snippets/code/doc_src_qthelp.qdoc 1 |
|
736 |
|
737 These classes are part of the \l{Open Source Versions of Qt} and |
|
738 \l{Qt Commercial Editions}{Qt Full Framework Edition} for commercial |
|
739 users. |
|
740 |
|
741 \section1 License Information |
|
742 |
|
743 The QtHelp module uses the CLucene indexing library to provide full-text |
|
744 searching capabilities for Qt Assistant and applications that use the |
|
745 features of QtHelp. |
|
746 |
|
747 Qt Commercial Edition licensees that wish to distribute applications that |
|
748 use these features of the QtHelp module need to be aware of their |
|
749 obligations under the GNU Lesser General Public License (LGPL). |
|
750 |
|
751 Developers using the Open Source Edition can choose to redistribute |
|
752 the module under the appropriate version of the GNU LGPL; version 2.1 |
|
753 for applications and libraries licensed under the GNU GPL version 2, |
|
754 or version 3 for applications and libraries licensed under the GNU |
|
755 GPL version 3. |
|
756 |
|
757 \legalese |
|
758 Copyright (C) 2003-2006 Ben van Klinken and the CLucene Team \BR |
|
759 Changes are Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
760 |
|
761 This library is free software; you can redistribute it and/or |
|
762 modify it under the terms of the GNU Lesser General Public |
|
763 License as published by the Free Software Foundation; either |
|
764 version 2.1 of the License, or (at your option) any later version. |
|
765 |
|
766 This library is distributed in the hope that it will be useful, |
|
767 but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
768 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|
769 Lesser General Public License for more details. |
|
770 |
|
771 You should have received a copy of the GNU Lesser General Public |
|
772 License along with this library; if not, write to the Free Software |
|
773 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
|
774 \endlegalese |
|
775 |
|
776 \sa {The Qt Help Framework} |
|
777 */ |
|
778 |
|
779 /*! |
|
780 \module QtTest |
|
781 \title QtTest Module |
|
782 \contentspage All Qt Modules |
|
783 \previouspage QtHelp |
|
784 \nextpage QAxContainer |
|
785 \ingroup modules |
|
786 |
|
787 \keyword QtTest |
|
788 |
|
789 \brief The QtTest module provides classes for unit testing Qt applications and libraries. |
|
790 |
|
791 Applications that use Qt's unit testing classes need to |
|
792 be configured to be built against the QtTest module. |
|
793 To include the definitions of the module's classes, use the |
|
794 following directive: |
|
795 |
|
796 \snippet doc/src/snippets/code/doc_src_qttest.qdoc 0 |
|
797 |
|
798 To link against the module, add this line to your \l qmake \c |
|
799 .pro file: |
|
800 |
|
801 \snippet doc/src/snippets/code/doc_src_qttest.qdoc 1 |
|
802 |
|
803 See the \l{QTestLib Manual} for a detailed introduction on how to use |
|
804 Qt's unit testing features with your applications. |
|
805 |
|
806 The QtTest module is part of all \l{Qt editions}. |
|
807 */ |
|
808 |
|
809 /*! |
|
810 \module QAxContainer |
|
811 \title QAxContainer Module |
|
812 \contentspage All Qt Modules |
|
813 \previouspage QtTest |
|
814 \nextpage QAxServer |
|
815 \ingroup modules |
|
816 |
|
817 \brief The QAxContainer module is a Windows-only extension for |
|
818 accessing ActiveX controls and COM objects. |
|
819 |
|
820 \section1 License Information |
|
821 |
|
822 The QAxContainer module is not covered by the \l{GNU General Public License (GPL)}, |
|
823 the \l{GNU Lesser General Public License (LGPL)}, or the |
|
824 \l{Qt Commercial Editions}{Qt Commercial License}. Instead, it is distributed under |
|
825 the following license. |
|
826 |
|
827 \legalese |
|
828 Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).\br |
|
829 All rights reserved. |
|
830 |
|
831 Contact: Nokia Corporation (qt-info@nokia.com)\br |
|
832 |
|
833 You may use this file under the terms of the BSD license as follows:\br |
|
834 |
|
835 "Redistribution and use in source and binary forms, with or without modification, |
|
836 are permitted provided that the following conditions are met: |
|
837 |
|
838 * Redistributions of source code must retain the above copyright notice, this list |
|
839 of conditions and the following disclaimer.\br |
|
840 * Redistributions in binary form must reproduce the above copyright notice, this |
|
841 list of conditions and the following disclaimer in the documentation and/or other |
|
842 materials provided with the distribution.\br |
|
843 * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor the names of |
|
844 its contributors may be used to endorse or promote products derived from this |
|
845 software without specific prior written permission. |
|
846 |
|
847 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY |
|
848 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
|
849 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT |
|
850 SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
|
851 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED |
|
852 TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR |
|
853 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
|
854 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
|
855 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." |
|
856 \endlegalese |
|
857 */ |
|
858 |
|
859 /*! |
|
860 \module QAxServer |
|
861 \title QAxServer Module |
|
862 \contentspage All Qt Modules |
|
863 \previouspage QAxContainer |
|
864 \nextpage QtDBus module |
|
865 \ingroup modules |
|
866 |
|
867 \brief The QAxServer module is a Windows-only static library that |
|
868 you can use to turn a standard Qt binary into a COM server. |
|
869 |
|
870 \section1 License Information |
|
871 |
|
872 The QAxContainer module is not covered by the \l{GNU General Public License (GPL)}, |
|
873 the \l{GNU Lesser General Public License (LGPL)}, or the |
|
874 \l{Qt Commercial Editions}{Qt Commercial License}. Instead, it is distributed under |
|
875 the following license. |
|
876 |
|
877 \legalese |
|
878 Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).\br |
|
879 All rights reserved. |
|
880 |
|
881 Contact: Nokia Corporation (qt-info@nokia.com)\br |
|
882 |
|
883 You may use this file under the terms of the BSD license as follows:\br |
|
884 |
|
885 "Redistribution and use in source and binary forms, with or without modification, |
|
886 are permitted provided that the following conditions are met: |
|
887 |
|
888 * Redistributions of source code must retain the above copyright notice, this list |
|
889 of conditions and the following disclaimer.\br |
|
890 * Redistributions in binary form must reproduce the above copyright notice, this |
|
891 list of conditions and the following disclaimer in the documentation and/or other |
|
892 materials provided with the distribution.\br |
|
893 * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor the names of |
|
894 its contributors may be used to endorse or promote products derived from this |
|
895 software without specific prior written permission. |
|
896 |
|
897 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY |
|
898 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
|
899 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT |
|
900 SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
|
901 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED |
|
902 TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR |
|
903 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
|
904 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
|
905 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." |
|
906 \endlegalese |
|
907 */ |
|
908 |
|
909 /*! |
|
910 \module QtDBus |
|
911 \title QtDBus module |
|
912 \contentspage All Qt Modules |
|
913 \previouspage QAxServer |
|
914 \ingroup modules |
|
915 |
|
916 \keyword QtDBus |
|
917 \target The QDBus compiler |
|
918 |
|
919 \brief The QtDBus module is a Unix-only library that you can use |
|
920 to perform Inter-Process Communication using the \l{Introduction to |
|
921 D-Bus}{D-Bus} protocol. |
|
922 |
|
923 Applications using the QtDBus module can provide services to |
|
924 other, remote applications by exporting objects, as well as use |
|
925 services exported by those applications by placing calls and |
|
926 accessing properties. |
|
927 |
|
928 The QtDBus module provides an interface that extends the Qt \l |
|
929 {signalsandslots.html}{Signals and Slots} mechanism, allowing one |
|
930 to connect to a signal emitted remotely as well as to connect a |
|
931 local signal to remote slot. |
|
932 |
|
933 To use this module, use the following code in your application: |
|
934 |
|
935 \snippet doc/src/snippets/code/doc_src_qtdbus.qdoc 0 |
|
936 |
|
937 If you're using qmake to build your application, you can add this |
|
938 line to your .pro file to make it link against the QtDBus |
|
939 libraries: |
|
940 |
|
941 \snippet doc/src/snippets/code/doc_src_qtdbus.qdoc 1 |
|
942 |
|
943 \note The source code for this module is located in the \c{src/qdbus} |
|
944 directory. When installing Qt from source, this module is built when Qt's |
|
945 tools are built. |
|
946 |
|
947 See the \l {Introduction to D-Bus} page for detailed information on |
|
948 how to use this module. |
|
949 |
|
950 This module is part of all \l{Qt editions}. |
|
951 */ |
|
952 |
|
953 /*! |
|
954 \page qtmain.html |
|
955 \title The qtmain Library |
|
956 \ingroup licensing |
|
957 \ingroup platform-specific |
|
958 \brief Describes the use and license of the qtmain helper library. |
|
959 |
|
960 qtmain is a helper library that enables the developer to write a |
|
961 cross-platform main() function on Windows. If you do not use \l qmake |
|
962 or other build tools such as CMake, then you need to link against |
|
963 the \c qtmain library. |
|
964 |
|
965 \section1 License Information |
|
966 |
|
967 The QAxContainer module is not covered by the \l{GNU General Public License (GPL)}, |
|
968 the \l{GNU Lesser General Public License (LGPL)}, or the |
|
969 \l{Qt Commercial Editions}{Qt Commercial License}. Instead, it is distributed under |
|
970 the following license. |
|
971 |
|
972 \legalese |
|
973 Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).\br |
|
974 All rights reserved. |
|
975 |
|
976 Contact: Nokia Corporation (qt-info@nokia.com)\br |
|
977 |
|
978 You may use this file under the terms of the BSD license as follows:\br |
|
979 |
|
980 "Redistribution and use in source and binary forms, with or without modification, |
|
981 are permitted provided that the following conditions are met: |
|
982 |
|
983 * Redistributions of source code must retain the above copyright notice, this list |
|
984 of conditions and the following disclaimer.\br |
|
985 * Redistributions in binary form must reproduce the above copyright notice, this |
|
986 list of conditions and the following disclaimer in the documentation and/or other |
|
987 materials provided with the distribution.\br |
|
988 * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor the names of |
|
989 its contributors may be used to endorse or promote products derived from this |
|
990 software without specific prior written permission. |
|
991 |
|
992 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY |
|
993 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
|
994 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT |
|
995 SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
|
996 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED |
|
997 TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR |
|
998 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
|
999 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
|
1000 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." |
|
1001 \endlegalese |
|
1002 */ |
|
1003 |
|
1004 /*! |
|
1005 \page qtassistant.html |
|
1006 \title QtAssistant |
|
1007 |
|
1008 This module is no longer needed. Use the QtHelp module to integrate documentation |
|
1009 into your application. |
|
1010 |
|
1011 \sa {QtHelp} |
|
1012 */ |