diff options
| -rw-r--r-- | doc/src/imports/qtmobilitysensors1.qdoc | 15 | ||||
| -rw-r--r-- | doc/src/sensors.qdoc | 2 | ||||
| -rw-r--r-- | src/imports/sensors/sensors.cpp | 72 |
3 files changed, 72 insertions, 17 deletions
diff --git a/doc/src/imports/qtmobilitysensors1.qdoc b/doc/src/imports/qtmobilitysensors1.qdoc index 341eb7e2..f47c96be 100644 --- a/doc/src/imports/qtmobilitysensors1.qdoc +++ b/doc/src/imports/qtmobilitysensors1.qdoc @@ -33,18 +33,18 @@ \section1 Overview - The identifying string for this component is \e {"QtMobility.sensors"}. - Use this in the QML \e {import} statement. + This is the legacy QML import. It exists for compatibility with the QtMobiltiy 1.2 release + and is not recommended for new applications. - The Sensors QML Plugin registers the C++ Sensors classes directly to the QML environment. + The QtMobility.sensors import has the QtSensors C++ classes directly exported into the QML environment. This causes some limitations due to the use of types that do not work in the QML environment. - See \l{Sensors QML Limitations}{below} for a list of the known limitations. + See \l{QtMobility.sensors QML Limitations}{below} for a list of the known limitations. See \l QtSensors for more information about the Sensors API. - \section1 Sensors QML Limitations + \section1 QtMobility.sensors QML Limitations - The following limitations affect the Sensors QML bindings for Qt Mobility 1.1 and 1.2. + The following limitations affect all versions of the QtMobility.sensors import. \list 1 \o The QSensor::sensorid property cannot be set because QML does not support QByteArray. @@ -69,5 +69,8 @@ The data from a sensor comes through a reading class. \annotatedlist qml-sensors_reading + + \section1 Alphabetical Listing of QML Elements + */ diff --git a/doc/src/sensors.qdoc b/doc/src/sensors.qdoc index 83ef7048..f704ddc9 100644 --- a/doc/src/sensors.qdoc +++ b/doc/src/sensors.qdoc @@ -31,6 +31,8 @@ The QtSensors API provides access to sensors via QML and C++ interfaces. + \section1 Topics + \generatelist related */ diff --git a/src/imports/sensors/sensors.cpp b/src/imports/sensors/sensors.cpp index c1bf21dc..a4188eb3 100644 --- a/src/imports/sensors/sensors.cpp +++ b/src/imports/sensors/sensors.cpp @@ -166,7 +166,7 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara This element cannot be directly created. Please use one of the sub-classes instead. - \sa {Sensors QML Limitations} + \sa {QtMobility.sensors QML Limitations} */ /*! @@ -227,7 +227,7 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara This element wraps the QAccelerometer class. Please see the documentation for QAccelerometer for details. - \sa {Sensors QML Limitations} + \sa {QtMobility.sensors QML Limitations} */ /*! @@ -284,7 +284,7 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara This element wraps the QAmbientLightSensor class. Please see the documentation for QAmbientLightSensor for details. - \sa {Sensors QML Limitations} + \sa {QtMobility.sensors QML Limitations} */ /*! @@ -341,7 +341,7 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara This element wraps the QCompass class. Please see the documentation for QCompass for details. - \sa {Sensors QML Limitations} + \sa {QtMobility.sensors QML Limitations} */ /*! @@ -395,7 +395,7 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara This element wraps the QMagnetometer class. Please see the documentation for QMagnetometer for details. - \sa {Sensors QML Limitations} + \sa {QtMobility.sensors QML Limitations} */ /*! @@ -457,7 +457,7 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara This element wraps the QOrientationSensor class. Please see the documentation for QOrientationSensor for details. - \sa {Sensors QML Limitations} + \sa {QtMobility.sensors QML Limitations} */ /*! @@ -514,7 +514,7 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara This element wraps the QProximitySensor class. Please see the documentation for QProximitySensor for details. - \sa {Sensors QML Limitations} + \sa {QtMobility.sensors QML Limitations} */ /*! @@ -563,7 +563,7 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara This element wraps the QRotationSensor class. Please see the documentation for QRotationSensor for details. - \sa {Sensors QML Limitations} + \sa {QtMobility.sensors QML Limitations} */ /*! @@ -622,7 +622,7 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara This element wraps the QTapSensor class. Please see the documentation for QTapSensor for details. - \sa {Sensors QML Limitations} + \sa {QtMobility.sensors QML Limitations} */ /*! @@ -676,6 +676,7 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara \qmlclass LightSensor QLightSensor \ingroup qml-sensors_type \inqmlmodule QtMobility.sensors 1 + \since QtMobility.sensors 1.2 \inherits Sensor \brief The LightSensor element reports on light levels using LUX. @@ -684,7 +685,7 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara This element wraps the QLightSensor class. Please see the documentation for QLightSensor for details. - \sa {Sensors QML Limitations} + \sa {QtMobility.sensors QML Limitations} */ /*! @@ -703,6 +704,7 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara \qmlclass LightReading QLightReading \ingroup qml-sensors_reading \inqmlmodule QtMobility.sensors 1 + \since QtMobility.sensors 1.2 \inherits SensorReading \brief The LightReading element holds the most recent LightSensor reading. @@ -723,6 +725,7 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara \qmlclass Gyroscope QGyroscope \ingroup qml-sensors_type \inqmlmodule QtMobility.sensors 1 + \since QtMobility.sensors 1.2 \inherits Sensor \brief The Gyroscope element reports on rotational acceleration around the X, Y and Z axes. @@ -730,7 +733,7 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara This element wraps the QGyroscope class. Please see the documentation for QGyroscope for details. - \sa {Sensors QML Limitations} + \sa {QtMobility.sensors QML Limitations} */ /*! @@ -749,6 +752,7 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara \qmlclass GyroscopeReading QGyroscopeReading \ingroup qml-sensors_reading \inqmlmodule QtMobility.sensors 1 + \since QtMobility.sensors 1.2 \inherits SensorReading \brief The GyroscopeReading element holds the most recent Gyroscope reading. @@ -775,4 +779,50 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara Please see QGyroscopeReading::z for information about this property. */ +/*! + \qmlclass IRProximitySensor QIRProximitySensor + \ingroup qml-sensors_type + \inqmlmodule QtMobility.sensors 1 + \since QtMobility.sensors 1.3 + \inherits Sensor + \brief The IRProximitySensor element reports on infra-red reflectance values. + + This element wraps the QIRProximitySensor class. Please see the documentation for + QIRProximitySensor for details. + + \sa {QtMobility.sensors QML Limitations} +*/ + +/*! + \qmlproperty IRProximityReading QtMobility.sensors1::IRProximitySensor::reading + Holds the most recent IR proximity reading. + Please see QSensor::reading for information about this property. +*/ + +/*! + \qmlsignal QtMobility.sensors1::IRProximitySensor::onReadingChanged() + Called when the reading object changes. + Please see QSensor::readingChanged() for information about this signal. +*/ + +/*! + \qmlclass IRProximityReading QIRProximityReading + \ingroup qml-sensors_reading + \inqmlmodule QtMobility.sensors 1 + \since QtMobility.sensors 1.3 + \inherits SensorReading + \brief The IRProximityReading element holds the most recent IR proximity reading. + + The IRProximityReading element holds the most recent IR proximity reading. + + This element wraps the QIRProximityReading class. Please see the documentation for + QIRProximityReading for details. + + This element cannot be directly created. +*/ + +/*! + \qmlproperty qreal QtMobility.sensors1::IRProximityReading::reflectance + Please see QIRProximityReading::reflectance for information about this property. +*/ |