summaryrefslogtreecommitdiffstats
path: root/src/sensors/doc
diff options
context:
space:
mode:
Diffstat (limited to 'src/sensors/doc')
-rw-r--r--src/sensors/doc/qtsensors.qdocconf37
-rw-r--r--src/sensors/doc/src/compatmap.qdoc89
-rw-r--r--src/sensors/doc/src/genericbackend.qdoc3
-rw-r--r--src/sensors/doc/src/porting.qdoc25
-rw-r--r--src/sensors/doc/src/qtsensors.qdoc3
-rw-r--r--src/sensors/doc/src/sensorfwbackend.qdoc39
6 files changed, 169 insertions, 27 deletions
diff --git a/src/sensors/doc/qtsensors.qdocconf b/src/sensors/doc/qtsensors.qdocconf
index 7c53c02b..2ede8cf4 100644
--- a/src/sensors/doc/qtsensors.qdocconf
+++ b/src/sensors/doc/qtsensors.qdocconf
@@ -3,33 +3,36 @@ include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
project = QtSensors
description = Qt Sensors Reference Documentation
-url = http://qt-project.org/doc/qt-5.0/qtsensors-index.html
-version = 5.0.0
+url = http://qt-project.org/doc/qt-$QT_VER/qtsensors
+version = $QT_VERSION
qhp.projects = QtSensors
qhp.QtSensors.file = qtsensors.qhp
-qhp.QtSensors.namespace = org.qt-project.qtsensors.500
-qhp.QtSensors.virtualFolder = qdoc
-qhp.QtSensors.indexTitle = Qt Sensors Reference Documentation
+qhp.QtSensors.namespace = org.qt-project.qtsensors.$QT_VERSION_TAG
+qhp.QtSensors.virtualFolder = qtsensors
+qhp.QtSensors.indexTitle = Qt Sensors
qhp.QtSensors.indexRoot =
-qhp.QtSensors.filterAttributes = qtsensors 5.0.0 qtrefdoc
-qhp.QtSensors.customFilters.Qt.name = QtSensors 5.0.0
-qhp.QtSensors.customFilters.Qt.filterAttributes = qtsensors 5.0.0
-qhp.QtSensors.subprojects = classes overviews examples
-qhp.QtSensors.subprojects.classes.title = Classes
-qhp.QtSensors.subprojects.classes.indexTitle = Qt Sensors's Classes
+qhp.QtSensors.filterAttributes = qtsensors $QT_VERSION qtrefdoc
+qhp.QtSensors.customFilters.Qt.name = QtSensors $QT_VERSION
+qhp.QtSensors.customFilters.Qt.filterAttributes = qtsensors $QT_VERSION
+qhp.QtSensors.subprojects = overviews classes qmltypes examples
+qhp.QtSensors.subprojects.overviews.title = Overview
+qhp.QtSensors.subprojects.overviews.indexTitle = Qt Sensors
+qhp.QtSensors.subprojects.overviews.selectors = fake:page,group,module
+qhp.QtSensors.subprojects.classes.title = C++ Classes
+qhp.QtSensors.subprojects.classes.indexTitle = Qt Sensors C++ Classes
qhp.QtSensors.subprojects.classes.selectors = class fake:headerfile
qhp.QtSensors.subprojects.classes.sortPages = true
-qhp.QtSensors.subprojects.overviews.title = Overviews
-qhp.QtSensors.subprojects.overviews.indexTitle = All Overviews and HOWTOs
-qhp.QtSensors.subprojects.overviews.selectors = fake:page,group,module
-qhp.QtSensors.subprojects.examples.title = Qt Sensors Examples
+qhp.QtSensors.subprojects.qmltypes.title = QML Types
+qhp.QtSensors.subprojects.qmltypes.indexTitle = Qt Sensors QML Types
+qhp.QtSensors.subprojects.qmltypes.selectors = fake:qmlclass
+qhp.QtSensors.subprojects.qmltypes.sortPages = true
+qhp.QtSensors.subprojects.examples.title = Examples
qhp.QtSensors.subprojects.examples.indexTitle = Qt Sensors Examples
qhp.QtSensors.subprojects.examples.selectors = fake:example
-outputdir = ../../../doc/qtsensors
tagfile = ../../../doc/qtsensors/qtsensors.tags
headerdirs += .. \
@@ -45,3 +48,5 @@ exampledirs += ../../../examples/sensors \
imagedirs += images
+
+depends += qtcore qtdoc qtgui
diff --git a/src/sensors/doc/src/compatmap.qdoc b/src/sensors/doc/src/compatmap.qdoc
index 0fd4951c..62f94de0 100644
--- a/src/sensors/doc/src/compatmap.qdoc
+++ b/src/sensors/doc/src/compatmap.qdoc
@@ -54,30 +54,72 @@
<tr>
<td><b>Feature</b></td>
<td><b>Blackberry</b></td>
+ <td><b>Android</b></td>
<td><b>Linux</b></td>
+ <td><b>iOS</b></td>
<td><b>Generic</b></td>
+ <td><b>Sensorfw</b></td>
</tr>
<tr>
<td nowrap="nowrap">Accelerometer</td>
<td bgcolor="green"></td>
<td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="green"></td>
+ </tr>
+ <tr>
+ <td nowrap="nowrap">Altimeter</td>
+ <td bgcolor="green"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
<td bgcolor="gray"></td>
</tr>
<tr>
<td nowrap="nowrap">Ambient Light Sensor</td>
<td bgcolor="green"></td>
<td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
<td bgcolor="green"></td>
</tr>
<tr>
+ <td nowrap="nowrap">Ambient Temperature Sensor</td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ </tr>
+ <tr>
<td nowrap="nowrap">Compass</td>
<td bgcolor="green"></td>
<td bgcolor="gray"></td>
<td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="green"></td>
</tr>
<tr>
<td nowrap="nowrap">Gyroscope</td>
<td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="green"></td>
+ </tr>
+ <tr>
+ <td nowrap="nowrap">Holster Sensor</td>
+ <td bgcolor="green"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
<td bgcolor="gray"></td>
<td bgcolor="gray"></td>
</tr>
@@ -86,48 +128,90 @@
<td bgcolor="green"></td>
<td bgcolor="gray"></td>
<td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="green"></td>
</tr>
<tr>
<td nowrap="nowrap">Light Sensor</td>
<td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="gray"></td>
<td bgcolor="gray"></td>
<td bgcolor="gray"></td>
+ <td bgcolor="green"></td>
</tr>
<tr>
<td nowrap="nowrap">Magnetometer</td>
<td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="gray"></td>
<td bgcolor="gray"></td>
<td bgcolor="gray"></td>
+ <td bgcolor="green"></td>
</tr>
<tr>
<td nowrap="nowrap">Orientation Sensor</td>
<td bgcolor="green"></td>
<td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ </tr>
+ <tr>
+ <td nowrap="nowrap">Pressure Sensor</td>
<td bgcolor="green"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
</tr>
<tr>
<td nowrap="nowrap">Proximity Sensor</td>
<td bgcolor="green"></td>
<td bgcolor="gray"></td>
<td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="green"></td>
</tr>
<tr>
<td nowrap="nowrap">Rotation Sensor</td>
<td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="gray"></td>
<td bgcolor="gray"></td>
<td bgcolor="green"></td>
+ <td bgcolor="green"></td>
</tr>
<tr>
<td nowrap="nowrap">Tap Sensor</td>
<td bgcolor="gray"></td>
<td bgcolor="gray"></td>
<td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ </tr>
+ <tr>
+ <td nowrap="nowrap">Tilt Sensor</td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="gray"></td>
</tr>
<tr>
<td nowrap="nowrap">Sensor Gestures</td>
<td bgcolor="gray"></td>
<td bgcolor="gray"></td>
- <td bgcolor="green">1)</td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="green"></td>
</tr>
</table>
@@ -138,5 +222,8 @@
In addition to the table above, each sensor type might support specific features. For example
a magnetometer might support returning geo values. See QSensor::isFeatureSupported() for
additional details.
+
+ Sensor Gestures are mostly platform independent, and will run if the platform has the needed sensors.
+ Whether they are supported and work well or not depends on the platform.
*/
diff --git a/src/sensors/doc/src/genericbackend.qdoc b/src/sensors/doc/src/genericbackend.qdoc
index 689b4124..a273352b 100644
--- a/src/sensors/doc/src/genericbackend.qdoc
+++ b/src/sensors/doc/src/genericbackend.qdoc
@@ -49,6 +49,9 @@
\row
\li Rotation Sensor
\li Accelerometer
+ \row
+ \li Tilt Sensor
+ \li Accelerometer
\endtable
If a platform doesn't support the source sensor, then the sensor can not be emulated.
*/
diff --git a/src/sensors/doc/src/porting.qdoc b/src/sensors/doc/src/porting.qdoc
index fa2b3fb2..0d5b5723 100644
--- a/src/sensors/doc/src/porting.qdoc
+++ b/src/sensors/doc/src/porting.qdoc
@@ -39,21 +39,26 @@
\section1 QML
- Compatibility for QML applications is provided by shipping the legacy \c QtMobility.sensors
- QML import. QML applications should not require any changes to continue operating.
+ In QtMobility, the C++ classes like QAccelerometer were directly used as QML types.
+ In Qt Sensors, there are now separate classes for the QML types, which have no public
+ C++ API.
- Applications using the legacy QML import may not be able to trivially port over
- to the new QML import because the new QML import does not provide types for
- every sensor like the legacy QML import does.
+ The new QML types in Qt Sensors fix some issues the former QtMobility QML types had,
+ for example:
+ \list
+ \li The reading types now have proper change notifications
+ \li \c availableDataRates and \c outputRanges of the \c Sensor type are now proper list types
+ \li The \c identifier and \c type properties of \c Sensor can now be used
+ \li The \c lux property of \c LightSensorReading has been renamed to \c illuminance
+ \li The \c QmlSensors singleton now allows to query for sensor types
+ \endlist
- \table
- \row
- \li \l {Qt Sensors QML Types}{QML API}
- \li Information about the Qt Sensors QML API
- \endtable
+ For more information, see the \l {Qt Sensors QML Types}{QML API} documentation.
\section1 C++
+ The C++ API mainly remained the same as in QtMobility.
+
\section2 Includes
QtMobility Sensors installed headers into a \c Qt Sensors directory. This is
diff --git a/src/sensors/doc/src/qtsensors.qdoc b/src/sensors/doc/src/qtsensors.qdoc
index 61286733..9213371d 100644
--- a/src/sensors/doc/src/qtsensors.qdoc
+++ b/src/sensors/doc/src/qtsensors.qdoc
@@ -112,6 +112,9 @@
\row
\li \l {Generic Backend}{Generic Backend}
\li Information about the generic sensor backend.
+ \row
+ \li \l {Sensorfw Backend}{Sensorfw Backend}
+ \li Information about the Sensorfw sensor backend.
\endtable
*/
diff --git a/src/sensors/doc/src/sensorfwbackend.qdoc b/src/sensors/doc/src/sensorfwbackend.qdoc
new file mode 100644
index 00000000..fcfbb5d8
--- /dev/null
+++ b/src/sensors/doc/src/sensorfwbackend.qdoc
@@ -0,0 +1,39 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Jolla Mobile
+** 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$
+**
+****************************************************************************/
+
+/*!
+ \page senorfwbackend.html
+ \title Sensorfw Backend
+ \brief Information about the Sensorfw sensor backend
+
+ The Sensorfw sensor backend requires the Sensorfw and sensor daemon. Sensorfw was originally used in MeeGo, and is available
+ from http://meego.gitorious.org/meego-middleware/sensorfw
+
+ To compile the sensorfw backend, you need sensorfw installed and run qmake with CONFIG+=sensorfw
+
+*/
+
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-20 04:57:43 +0000