aboutsummaryrefslogtreecommitdiffstats
path: root/src/winextras/doc/src/qtwinextras-index.qdoc
blob: 00ab266d48b88bca1310c5b5b2f25f86a3f53b21 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
/****************************************************************************
**
** Copyright (C) 2013 Ivan Vizir <define-true-false@yandex.com>
** Contact: http://www.qt.io/licensing/
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \page qtwinextras-index.html
    \title Qt Windows Extras
    \brief Provides classes and functions for using some Windows APIs in a Qt way

    Qt Windows Extras provide classes and functions that enable you to use
    miscellaneous Windows-specific functions. For example, you can convert Qt
    objects to Windows object handles and manipulate DWM glass frames.

    In addition, you can use features introduced with Windows 7, such as Aero
    Peek, Jump Lists, a progress indicator on a taskbar button, or a thumbnail
    toolbar.

    \section1 Getting Started

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

    \snippet code/use-qtwinextras.cpp include

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

    \snippet code/use-qtwinextras.pro link

    \section1 Articles and Guides

    \list
    \li \l {Qt Windows Extras Overview}
    \endlist

    \section1 Examples

    \list
    \li \l {Qt Windows Extras Examples}
    \endlist

    \section1 API Reference

    These are links to the API reference materials.

    \list
    \li \l {Qt Windows Extras C++ Classes}{C++ Classes and Namespaces}
    \li \l {Qt Windows Extras QML Types}{QML Types}
    \endlist
*/