aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/doc/src/concepts/pointerhandlers/qtquickhandlers-index.qdoc
blob: b17c5ab72834bbbda4b3ed39744c09d0a4c3e6b5 (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
73
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://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 qtquickhandlers-index.html
    \title Qt Quick Pointer Handlers
    \brief A module with a set of QML elements that handle events from pointing devices in a user interface.

    Qt Quick Pointer Handlers are a set of QML types used to handle events from
    touch, mouse, and stylus devices in a UI. In contrast to event-handling
    Items, such as \l MouseArea, Pointer Handlers require less memory and are
    intended to be used in greater numbers: one handler per type of
    interaction. Each Pointer Handler handles events on behalf of its \c parent
    Item. One Item can have multiple Pointer Handlers.

    The module is introduced in Qt 5.10.

    \section1 Pointer Handlers

    \annotatedlist pointerhandlers

    \section1 Getting Started

    The QML types can be imported into your application using the following import statement in your \c {.qml} file.

    \code
     import Qt.labs.handlers 1.0
    \endcode

    \section1 Key Features

    Some of the key features are:

    \list
        \li Handle gestures such as tapping or dragging regardless which device it comes from
        \li Handle gestures from different classes of devices in different ways
        \li Each Item can have unlimited Handlers
    \endlist

    \omit TODO actual overview with snippets and stuff \endomit

    \section1 Related Information

     \list
      \li \l{Qt Quick}
      \li \l{Qt Quick Pointer Handlers Overview}
      \li \l{Qt Quick Pointer Handlers QML Types}{Qt Quick Pointer Handlers QML Types}
     \endlist
*/