summaryrefslogtreecommitdiffstats
path: root/doc/src/imports/qtsensors5.qdoc
diff options
context:
space:
mode:
authorLincoln Ramsay <lincoln.ramsay@nokia.com>2012-08-17 12:02:20 +1000
committerThe Qt Project <gerrit-noreply@qt-project.org>2012-10-11 10:19:46 +0200
commitbe4e63b220108a959f1d016403aa95389060630e (patch)
treeaeedb34f815135e4ead5c2e7cb61c289ac5fb83e /doc/src/imports/qtsensors5.qdoc
parentceb982907c98d2e71e1d7b84c87b06328c6c391f (diff)
Rename QtMobility.sensors 1.3 to QtSensors 5.0
Change-Id: I2b24533d38db1f8e205de19b67fe0b21625bbf6b Reviewed-by: Lorn Potter <lorn.potter@gmail.com>
Diffstat (limited to 'doc/src/imports/qtsensors5.qdoc')
-rw-r--r--doc/src/imports/qtsensors5.qdoc69
1 files changed, 69 insertions, 0 deletions
diff --git a/doc/src/imports/qtsensors5.qdoc b/doc/src/imports/qtsensors5.qdoc
new file mode 100644
index 00000000..02b53603
--- /dev/null
+++ b/doc/src/imports/qtsensors5.qdoc
@@ -0,0 +1,69 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+/*!
+ \qmlmodule QtSensors 5.0
+ \title Qt Sensors QML API
+ \brief QML import for QtSensors
+
+ \section1 Overview
+
+ This is the QtSensors QML import.
+
+ \section1 QML Module API
+
+ If the module is imported into a namespace, some additional methods become available.
+
+ \code
+ import QtSensors 5.0 as Sensors
+ ...
+ Component.onCompleted: {
+ var types = Sensors.sensorTypes();
+ console.log(types.join(", "));
+ }
+ \endcode
+
+ The documentation for the module API can be found in SensorGlobal.
+
+ \section1 QML Sensor types
+
+ These types represent specific types of sensors.
+
+ Note that most properties come from the abstract \l{QtSensors::Sensor}{Sensor} element.
+
+ \annotatedlist qml-sensors_type
+
+ \section1 QML Reading types
+
+ The data from a sensor comes through a reading class.
+
+ \annotatedlist qml-sensors_reading
+
+ \section1 Alphabetical Listing of QML Types
+
+*/
+