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