summaryrefslogtreecommitdiffstats
path: root/examples/sensors/shakeit/shakeit.qdoc
blob: 34a712d87c89fc857fdaf18589f4d92949ff268c (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
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** GNU Free Documentation License
** 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.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms
** and conditions contained in a signed written agreement between you
** and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \example sensors/shakeit
    \title ShakeIt! QML Sensor Gestures Example
    \ingroup qtsensors-examples
    \brief The sensor gesture example demonstrates the steps for creating a QML application
     that uses sensor gestures and the included shake sensor.
    \image shakeit.jpg

    \section1 Overview
        Writing a QML application that uses the Shake QML sensorgestures element
     requires the following steps:

        Import the Sensors Declarative module.

    \snippet ../examples/sensors/shakeit/shakeit.qml 0

        Add a SensorGesture QML element.

    \snippet ../examples/sensors/shakeit/shakeit.qml 1

       In the SensorGesture element, 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 ../examples/sensors/shakeit/shakeit.qml 2

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

    \snippet ../examples/sensors/shakeit/shakeit.qml 3

        Use the onDetected signal to do stuff.

    \snippet ../examples/sensors/shakeit/shakeit.qml 4

*/