diff options
author | Geir Vattekar <geir.vattekar@digia.com> | 2012-10-04 13:48:23 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2012-10-12 15:16:15 +0200 |
commit | 9d4d08421acb628e0115b140e54656fc779d13db (patch) | |
tree | eb87c8fbbe0722f70fa536227fa7a311febdea81 /examples/sensors/qmlsensorgestures | |
parent | 8f624bb5d19edb47fc4803a5eb0d6343de5bbae9 (diff) |
Doc: Modularized the Qt Sensor Docs
Change-Id: Ie8636ec443f43b1f238342e0f6f7d321e13dce09
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'examples/sensors/qmlsensorgestures')
-rw-r--r-- | examples/sensors/qmlsensorgestures/doc/src/qmlsensorgtestures.qdoc | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/examples/sensors/qmlsensorgestures/doc/src/qmlsensorgtestures.qdoc b/examples/sensors/qmlsensorgestures/doc/src/qmlsensorgtestures.qdoc new file mode 100644 index 00000000..83f3171d --- /dev/null +++ b/examples/sensors/qmlsensorgestures/doc/src/qmlsensorgtestures.qdoc @@ -0,0 +1,63 @@ +/**************************************************************************** +** +** 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 qmlsensorgestures + \title Qt Sensors - SensorGesture QML Type example + \ingroup qtsensors-examples + + \brief This example demonstrates use of the SensorGesture QML type. + +\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 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. + + In this example an alias 'gestureid' for this property is used. + +\snippet qmlsensorgestures/GestureView.qml 2 + + By using this alias property you define which gestures should be used: + +\snippet qmlsensorgestures/qmlsensorgestures.qml 3 + + A list of all available gestures can be created by calling the 'availableGestures' property: + +\snippet qmlsensorgestures/GestureList.qml 4 + +\sa {Qt Sensors - ShakeIt QML Example} +\sa {Qt Sensor Gestures} +*/ + |