summaryrefslogtreecommitdiff
path: root/examples/sensors/qmlsensorgestures/doc/src/qmlsensorgestures.qdoc
blob: 2da060a8bf6dc03decbe7cabbf88d77cce0cd7e9 (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
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** 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 http://www.qt.io/terms-conditions. For further
** information use the contact form at http://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: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \example qmlsensorgestures
    \title Qt Sensors - SensorGesture QML Type example
    \ingroup qtsensors-examples

    \brief Demonstrates the use of SensorGesture QML type.

    \section1 Overview
    To write a QML application that will use the gesture plugin, following
    steps are needed:

    Import the QtSensors 5.x module:

    \snippet qmlsensorgestures/GestureView.qml 0

    Add the SensorGesture QML type into your qml file.

    \snippet qmlsensorgestures/GestureView.qml 1

    Each SensorGesture QML type contains a property called gestures. This example
    uses an alias \c gestureId for this property.

    \snippet qmlsensorgestures/GestureView.qml 2

    Then, the gesture or gestures to use can be specified using the alias:

    \snippet qmlsensorgestures/qmlsensorgestures.qml 3
    \dots 12
    \snippet qmlsensorgestures/qmlsensorgestures.qml 4

    A list of all available gestures is accessible through the
    \c availableGestures property:

    \snippet qmlsensorgestures/GestureList.qml 4
    \codeline
    \snippet qmlsensorgestures/GestureList.qml 5
    \dots 12
    \snippet qmlsensorgestures/GestureList.qml 6

    \sa {Qt Sensors - ShakeIt QML Example}, {Qt Sensor Gestures}
*/