summaryrefslogtreecommitdiff
path: root/src/x11extras/doc/src/qtx11extras-index.qdoc
blob: 416df18a254e78ce597cdfbf035954c6d29e532d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file.  Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
    \page qtx11extras-index.html
    \title Qt X11 Extras
    \brief A Qt module which provides tools for developing for the X11 platform.

    Qt X11 Extras enables the Qt programmer to write applications for the Linux/X11
    platform. Applications developed with Qt can also be deployed across several
    other desktop and embedded operating systems without having to rewrite the source
    code.

    \section1 Getting Started

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

    \code
    #include <QX11Info>
    \endcode

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

    \code
    QT += x11extras
    \endcode

    Requirements for using X11 with Qt: \l{Qt for X11 Requirements}

    \section1 API Reference

    Links to the API reference materials:
    \list
    \li \l{Qt X11 Extras C++ Classes}{C++ Classes}
    \endlist
*/