source: trunk/doc/src/modules.qdoc@ 564

/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation ([email protected])
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial Usage
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you have questions regarding the use of this file, please contact
** Nokia at [email protected].
** $QT_END_LICENSE$
**
****************************************************************************/

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

    \brief Qt 4 comprises several modules. Each module is a separate
    library.

    \table 80%
    \header \o {2,1} \bold{Modules for general software development}
    \row \o \l{QtCore} \o Core non-graphical classes used by other modules
    \row \o \l{QtGui} \o Graphical user interface (GUI) components
    \row \o \l{QtMultimedia} \o Classes for low-level multimedia functionality
    \row \o \l{QtNetwork} \o Classes for network programming
    \row \o \l{QtOpenGL} \o OpenGL support classes
    \row \o \l{QtOpenVG} \o OpenVG support classes
    \row \o \l{QtScript} \o Classes for evaluating Qt Scripts
    \row \o \l{QtScriptTools} \o Additional Qt Script components
    \row \o \l{QtSql} \o Classes for database integration using SQL
    \row \o \l{QtSvg} \o Classes for displaying the contents of SVG files
    \row \o \l{QtWebKit} \o Classes for displaying and editing Web content
    \row \o \l{QtXml} \o Classes for handling XML
    \row \o \l{QtXmlPatterns} \o An XQuery & XPath engine for XML and custom data models
    \row \o \l{Phonon Module}{Phonon} \o Multimedia framework classes
    \row \o \l{Qt3Support} \o Qt 3 compatibility classes
    \header \o {2,1} \bold{Modules for working with Qt's tools}
    \row \o \l{QtDesigner} \o Classes for extending \QD
    \row \o \l{QtUiTools} \o Classes for handling \QD forms in applications
    \row \o \l{QtHelp} \o Classes for online help    
    \row \o \l{QtTest} \o Tool classes for unit testing
    \header \o {2,1} \bold{Modules for Windows developers}
    \row \o \l{QAxContainer} \o Extension for accessing ActiveX controls
    \row \o \l{QAxServer} \o Extension for writing ActiveX servers
    \header \o {2,1} \bold{Modules for Unix developers}
    \row \o \l{QtDBus} \o Classes for Inter-Process Communication using the D-Bus
    \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.qdoc 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.

    \sa {Class and Function Documentation}
*/

/*!
    \module QtCore
    \title QtCore Module
    \contentspage All Qt Modules
    \previouspage All Qt Modules
    \nextpage QtGui
    \ingroup modules

    \keyword QtCore

    \brief The QtCore module contains core non-GUI functionality.

    All other Qt modules rely on this module. To include the
    definitions of the module's classes, use the following directive:

    \snippet doc/src/snippets/code/doc_src_qtcore.qdoc 0

    The QtCore module is part of all \l{Qt editions}.
*/


/*!
    \module QtGui
    \title QtGui Module
    \contentspage All Qt Modules
    \previouspage QtCore
    \nextpage QtNetwork
    \ingroup modules

    \brief The QtGui module extends QtCore with GUI functionality.

    To include the definitions of both modules' classes, use the
    following directive:

    \snippet doc/src/snippets/code/doc_src_qtgui.qdoc 0

    The QtGui module is part of the \l{Qt GUI Framework Edition},
    the \l{Qt Full Framework Edition}, and the \l{Open Source Versions of Qt}.
*/

/*!
    \module QtMultimedia
    \title QtMultimedia Module
    \contentspage All Qt Modules
    \previouspage QtCore
    \nextpage QtNetwork
    \ingroup modules

    \brief The QtMultimedia module provides low-level multimedia functionality.

    To include the definitions of the module's classes, use the
    following directive:

    \snippet doc/src/snippets/code/doc_src_qtmultimedia.qdoc 1

    To link against the module, add this line to your \l qmake \c
    .pro file:

    \snippet doc/src/snippets/code/doc_src_qtmultimedia.qdoc 0

    The functionality provided by the \l{Phonon Module} is on a higher level
    and in many cases more suitable for application developers.
*/

/*!
    \module QtNetwork
    \title QtNetwork Module
    \contentspage All Qt Modules
    \previouspage QtMultimedia
    \nextpage QtOpenGL
    \ingroup modules

    \brief The QtNetwork module provides classes to make network programming
    easier and portable.

    To include the definitions of the module's classes, use the
    following directive:

    \snippet doc/src/snippets/code/doc_src_qtnetwork.qdoc 1

    To link against the module, add this line to your \l qmake \c
    .pro file:

    \snippet doc/src/snippets/code/doc_src_qtnetwork.qdoc 0

    The QtNetwork module is part of the \l{Qt Full Framework Edition} and the
    \l{Open Source Versions of Qt}.
*/

/*!
    \module QtOpenGL
    \title QtOpenGL Module
    \contentspage All Qt Modules
    \previouspage QtNetwork
    \nextpage QtOpenVG
    \ingroup modules

    \brief The QtOpenGL module offers classes that make it easy to
    use OpenGL in Qt applications.

    OpenGL is a standard API for rendering 3D graphics. OpenGL only
    deals with 3D rendering and provides little or no support for GUI
    programming issues. The user interface for an OpenGL application
    must be created with another toolkit, such as Motif on the X
    platform, Microsoft Foundation Classes (MFC) under Windows, or Qt
    on both platforms.

    \note OpenGL is a trademark of Silicon Graphics, Inc. in
    the United States and other countries.

    The Qt OpenGL module makes it easy to use OpenGL in Qt applications.
    It provides an OpenGL widget class that can be used just like any
    other Qt widget, except that it opens an OpenGL display buffer where
    you can use the OpenGL API to render the contents.

    To include the definitions of the module's classes, use the
    following directive:

    \snippet doc/src/snippets/code/doc_src_qtopengl.qdoc 0

    To link against the module, add this line to your \l qmake \c
    .pro file:

    \snippet doc/src/snippets/code/doc_src_qtopengl.qdoc 1

    The Qt OpenGL module is implemented as a platform-independent Qt/C++
    wrapper around the platform-dependent GLX (version 1.3 or later),
    WGL, or AGL C APIs. Although the basic functionality provided is very
    similar to Mark Kilgard's GLUT library, applications using the Qt
    OpenGL module can take advantage of the whole Qt API for
    non-OpenGL-specific GUI functionality.

    The QtOpenGL module is part of the \l{Qt Full Framework Edition} and the
    \l{Open Source Versions of Qt}. It is available on Windows, X11, and Mac OS X.
    \l{Qt for Embedded Linux and OpenGL} supports OpenGL ES (OpenGL for Embedded Systems).
    \note To be able to use the OpenGL API in \l{Qt for Embedded Linux}, it must be
    integrated with the Q Window System (QWS). See the
    \l{Qt for Embedded Linux and OpenGL} documentation for details.

*/

/*!
    \module QtOpenVG
    \title QtOpenVG Module
    \since 4.6
    \contentspage All Qt Modules
    \previouspage QtOpenGL
    \nextpage QtScript
    \ingroup modules

    \brief The QtOpenVG module is a plugin that provides support for
    OpenVG painting.

    OpenVG is a standard API from the
    \l{http://www.khronos.org/openvg}{Khronos Group} for accelerated
    2D vector graphics that is appearing in an increasing number of
    embedded devices.

    OpenVG support can be enabled by passing the \c{-openvg} option
    to configure. It is assumed that the following qmake variables
    are set to appropriate values in the qmake.conf file for your
    platform:

    \list
    \o QMAKE_INCDIR_OPENVG
    \o QMAKE_LIBDIR_OPENVG
    \o QMAKE_LIBS_OPENVG
    \endlist

    Most OpenVG implementations are based on EGL, so the following
    variables may also need to be set:

    \list
    \o QMAKE_INCDIR_EGL
    \o QMAKE_LIBDIR_EGL
    \o QMAKE_LIBS_EGL
    \endlist

    See \l{qmake Variable Reference} for more information on these variables.

    Two kinds of OpenVG engines are currently supported: EGL based,
    and engines built on top of OpenGL such as
    \l{http://sourceforge.net/projects/shivavg}{ShivaVG}.
    EGL based engines are preferred.

    Once the graphics system plugin has been built and installed,
    applications can be run as follows to use the plugin:

    \code
    app -graphicssystem OpenVG
    \endcode

    If ShivaVG is being used, then substitute \c ShivaVG instead of
    \c OpenVG in the line above.
*/

/*!
        \module QtScript
        \title QtScript Module
        \since 4.3
        \contentspage All Qt Modules
        \previouspage QtOpenVG
        \nextpage QtScriptTools
        \ingroup modules

        \brief The QtScript module provides classes for making Qt applications scriptable.

        The QtScript module only provides core scripting facilities; the
        QtScriptTools module provides additional Qt Script-related
        components that application developers may find useful.

        \tableofcontents

        To include the definitions of the module's classes, use the
        following directive:

        \snippet doc/src/snippets/code/doc_src_qtscript.qdoc 0

        To link against the module, add this line to your \l qmake \c .pro file:

        \snippet doc/src/snippets/code/doc_src_qtscript.qdoc 1

        For detailed information on how to make your application
        scriptable with QtScript, see \l{Making Applications
        Scriptable}.

        The QtScript module is part of the \l{Qt Full Framework Edition} and the
        \l{Open Source Versions of Qt}.

        \section1 License Information

        Qt Commercial Edition licensees that wish to distribute applications that
        use the QtScript module need to be aware of their obligations under the
        GNU Library General Public License (LGPL).

        Developers using the Open Source Edition can choose to redistribute
        the module under the appropriate version of the GNU LGPL.

        \legalese
        QtScript is licensed under the GNU Library General Public License.
        Individual contributor names and copyright dates can be found
        inline in the code.

        This library is free software; you can redistribute it and/or
        modify it under the terms of the GNU Library General Public
        License as published by the Free Software Foundation; either
        version 2 of the License, or (at your option) any later version.

        This library is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
        Library General Public License for more details.

        You should have received a copy of the GNU Library General Public License
        along with this library; see the file COPYING.LIB.  If not, write to
        the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
        Boston, MA 02110-1301, USA.
        \endlegalese

*/

/*!
  \module QtScriptTools
  \title QtScriptTools Module
  \since 4.5
  \contentspage All Qt Modules
  \previouspage QtScript
  \nextpage QtSql
  \ingroup modules

  \brief The QtScriptTools module provides additional components for applications that use Qt Script.

  \tableofcontents

  \section1 Configuring the Build Process

  Applications that use the Qt Script Tools classes need to
  be configured to be built against the QtScriptTools module.
  To include the definitions of the module's classes, use the
  following directive:

  \snippet doc/src/snippets/code/doc.src.qtscripttools.qdoc 0

  To link against the module, add this line to your \l qmake \c .pro file:

  \snippet doc/src/snippets/code/doc.src.qtscripttools.qdoc 1

  The QtScriptTools module is part of the \l{Qt Full Framework Edition} and
  the \l{Open Source Versions of Qt}.
*/

/*!
    \module QtSql
    \title QtSql Module
    \contentspage All Qt Modules
    \previouspage QtScript
    \nextpage QtSvg
    \ingroup modules

    To include the definitions of the module's classes, use the
    following directive:

    \snippet doc/src/snippets/code/doc_src_qtsql.qdoc 0

    To link against the module, add this line to your \l qmake \c
    .pro file:

    \snippet doc/src/snippets/code/doc_src_qtsql.qdoc 1

    The QtSql module is part of the \l{Qt Full Framework Edition} and the
    \l{Open Source Versions of Qt}.

    See the \l{SQL Programming} guide for information about using this
    module in your applications.
*/

/*!
        \module QtSvg
        \title QtSvg Module
        \since 4.1
        \contentspage All Qt Modules
        \previouspage QtSql
        \nextpage QtWebKit
        \ingroup modules

        \brief The QtSvg module provides classes for displaying and creating SVG files.

        To include the definitions of the module's classes, use the
        following directive:

        \snippet doc/src/snippets/code/doc_src_qtsvg.qdoc 0

        To link against the module, add this line to your \l qmake \c
        .pro file:

        \snippet doc/src/snippets/code/doc_src_qtsvg.qdoc 1

        The QtSvg module is part of the \l{Qt Full Framework Edition} and the
        \l{Open Source Versions of Qt}.

        \section1 License Information

        Some code for arc handling in this module is derived from code with
        the following license:

        \legalese
        Copyright  2002 USC/Information Sciences Institute

        Permission to use, copy, modify, distribute, and sell this software
        and its documentation for any purpose is hereby granted without
        fee, provided that the above copyright notice appear in all copies
        and that both that copyright notice and this permission notice
        appear in supporting documentation, and that the name of
        Information Sciences Institute not be used in advertising or
        publicity pertaining to distribution of the software without
        specific, written prior permission.  Information Sciences Institute
        makes no representations about the suitability of this software for
        any purpose.  It is provided "as is" without express or implied
        warranty.

        INFORMATION SCIENCES INSTITUTE DISCLAIMS ALL WARRANTIES WITH REGARD
        TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
        MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL INFORMATION SCIENCES
        INSTITUTE BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
        DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
        OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
        TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
        PERFORMANCE OF THIS SOFTWARE.
        \endlegalese
*/

/*!
    \module QtXml
    \title QtXml Module
    \contentspage All Qt Modules
    \previouspage QtSvg
    \nextpage QtXmlPatterns
    \ingroup modules

    \brief The QtXml module provides a stream reader and writer for
    XML documents, and C++ implementations of SAX and DOM.

    To include the definitions of the module's classes, use the
    following directive:

    \snippet doc/src/snippets/code/doc_src_qtxml.qdoc 0

    To link against the module, add this line to your \l qmake \c
    .pro file:

    \snippet doc/src/snippets/code/doc_src_qtxml.qdoc 1

    Further XML support is provided by the \l{Qt Solutions} group who
    provide, for example, classes that support SOAP and MML with the
    Qt XML classes. 

    This module is part of the \l{Qt Full Framework Edition} and the
    \l{Open Source Versions of Qt}.
*/

/*!
    \module QtXmlPatterns
    \title QtXmlPatterns Module
    \since 4.4
    \contentspage All Qt Modules
    \previouspage QtXml
    \nextpage Phonon Module
    \ingroup modules

    \brief The QtXmlPatterns module provides support for XPath,
    XQuery, XSLT and XML Schema validation.

    To include the definitions of the module's classes, use the
    following directive: