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/qmlqtsensors/doc/src/qmlqtsensors.qdoc | |
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/qmlqtsensors/doc/src/qmlqtsensors.qdoc')
-rw-r--r-- | examples/sensors/qmlqtsensors/doc/src/qmlqtsensors.qdoc | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/examples/sensors/qmlqtsensors/doc/src/qmlqtsensors.qdoc b/examples/sensors/qmlqtsensors/doc/src/qmlqtsensors.qdoc new file mode 100644 index 00000000..f6b4738c --- /dev/null +++ b/examples/sensors/qmlqtsensors/doc/src/qmlqtsensors.qdoc @@ -0,0 +1,70 @@ +/**************************************************************************** +** +** 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 qmlqtsensors + \title Qt Sensors - QML example + \ingroup qtsensors-examples + \image qmlqtsensors.png + + \section2 Qt Sensors in QML + \brief The QtSensors - QML example demonstrates the QML sensors types in the QtSensors 5 import. + + + To write a QML application that will use the QML sensors types in the QtSensors 5 import you need to to the following steps: + + Import the QtSensors 5.x declarative plugin: + + \snippet qmlqtsensors/qmlqtsensors.qml 0 + + Add the Sensor QML types into your qml file. + + In this example we use the TiltSensor: + + \snippet qmlqtsensors/qmlqtsensors.qml 1 + + The Tilt-, AmbientLight- and the Proximity QML sensor types have the 'enabled' property in common. + To start or stop the sensor set this property to true or false. + + \snippet qmlqtsensors/qmlqtsensors.qml 2 + + Reading the data can be done for each sensor type like following: + + \l {QtSensors::TiltSensor} {TiltSensor} + + \snippet qmlqtsensors/qmlqtsensors.qml 3 + \snippet qmlqtsensors/qmlqtsensors.qml 4 + + \l {QtSensors::AmbientLightSensor} {AmbientLightSensor} + + \snippet qmlqtsensors/qmlqtsensors.qml 5 + + \l {QtSensors::ProximitySensor} {ProximitySensor} + + \snippet qmlqtsensors/qmlqtsensors.qml 6 +*/ + |