summaryrefslogtreecommitdiff
path: root/doc/src/examples/qmlsensorgtestures.qdoc
diff options
context:
space:
mode:
authorWolfgang Beck <wolfgang.beck@nokia.com>2012-05-25 12:31:38 +1000
committerQt by Nokia <qt-info@nokia.com>2012-05-28 05:02:44 +0200
commit5effd1712aa6f1ae2359762cdadeb70198121f77 (patch)
treed7a48be78f910d7e957252b36a5dbf6f57e786bf /doc/src/examples/qmlsensorgtestures.qdoc
parentdd14ea8acf97103868d6dfcafb7b19275e605e97 (diff)
downloadqtsensors-5effd1712aa6f1ae2359762cdadeb70198121f77.tar.gz
Update Examples using the same name conventions
e.g. Folder of example should start with QtSensorrs_ Example documentation title should start with QtSensors - images folder renamed to content Change-Id: I341fb8510ba3ad64068d786559e8d28af5d135c3 Reviewed-by: Lincoln Ramsay <lincoln.ramsay@nokia.com>
Diffstat (limited to 'doc/src/examples/qmlsensorgtestures.qdoc')
-rw-r--r--doc/src/examples/qmlsensorgtestures.qdoc63
1 files changed, 63 insertions, 0 deletions
diff --git a/doc/src/examples/qmlsensorgtestures.qdoc b/doc/src/examples/qmlsensorgtestures.qdoc
new file mode 100644
index 0000000..1da467a
--- /dev/null
+++ b/doc/src/examples/qmlsensorgtestures.qdoc
@@ -0,0 +1,63 @@
+/****************************************************************************
+**
+** 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 QtSensors/QtSensors_qmlsensorgestures
+ \title Qt Sensors - SensorGesture QML Element example
+ \ingroup qtsensors-examples
+
+ \brief This example demonstrates use of the SensorGesture QML element.
+
+\section1 Overview
+ To write a QML application that will use the gesture plugin you need to to the following steps:
+
+ Import the QtSensors 5.x declarative plugin:
+
+\snippet ../examples/QtSensors/QtSensors_qmlsensorgestures/GestureView.qml 0
+
+ Add the SensorGesture QML element into your qml file.
+
+\snippet ../examples/QtSensors/QtSensors_qmlsensorgestures/GestureView.qml 1
+
+ Each SensorGesture QML element contains a property called gestures.
+
+ In this example an alias 'gestureid' for this property is used.
+
+\snippet ../examples/QtSensors/QtSensors_qmlsensorgestures/GestureView.qml 2
+
+ By using this alias property you define which gestures should be used:
+
+\snippet ../examples/QtSensors/QtSensors_qmlsensorgestures/QtSensors_qmlsensorgestures.qml 3
+
+ A list of all available gestures can be created by calling the 'availableGestures' property:
+
+\snippet ../examples/QtSensors/QtSensors_qmlsensorgestures/GestureList.qml 4
+
+\sa {Qt Sensors - ShakeIt QML Example}
+\sa {Qt Sensor Gestures}
+*/
+