From 9d4d08421acb628e0115b140e54656fc779d13db Mon Sep 17 00:00:00 2001 From: Geir Vattekar Date: Thu, 4 Oct 2012 13:48:23 +0200 Subject: Doc: Modularized the Qt Sensor Docs Change-Id: Ie8636ec443f43b1f238342e0f6f7d321e13dce09 Reviewed-by: Jerome Pasion --- examples/sensors/shakeit/doc/src/shakeit.qdoc | 64 +++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 examples/sensors/shakeit/doc/src/shakeit.qdoc (limited to 'examples/sensors/shakeit/doc/src/shakeit.qdoc') diff --git a/examples/sensors/shakeit/doc/src/shakeit.qdoc b/examples/sensors/shakeit/doc/src/shakeit.qdoc new file mode 100644 index 00000000..8f5931fd --- /dev/null +++ b/examples/sensors/shakeit/doc/src/shakeit.qdoc @@ -0,0 +1,64 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** 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 Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/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. +*/ -- cgit v1.2.3