summaryrefslogtreecommitdiff
path: root/examples/sensors/shakeit/doc/src/shakeit.qdoc
blob: ef3f6538a3107811bacb9cd94e338590f52ffc6c (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
/****************************************************************************
**
** 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 shakeit
    \title Qt Sensors - ShakeIt QML Example
    \ingroup qtsensors-examples
    \image shakeit.png

    \section2 ShakeIt in QML
    \brief The sensor gesture example demonstrates the steps for creating a QML application
     that uses sensor gestures and the included shake sensor.

    Writing a QML application that uses the Shake QML sensorgestures type requires the following steps:

    Import the Sensors Declarative module.

    \snippet shakeit/shakeit.qml 0

    Add a SensorGesture QML type.

    \snippet shakeit/shakeit.qml 1

    In the SensorGesture type, specify which gesture to be used.
    Note that this can be a comma separated list. Here we are only interested in one
    gesture recognizer.

    \snippet shakeit/shakeit.qml 2

    Use the 'enabled' property to start the sensor gesture.

    \snippet shakeit/shakeit.qml 3

    Use the onDetected signal to do stuff.

    \snippet shakeit/shakeit.qml 4

    There are additional gestures to shake which are supported:
    whip, twistRight, hover, cover, turnover and pickup.
*/