diff options
author | Thomas McGuire <thomas.mcguire.qnx@kdab.com> | 2013-02-26 13:56:27 +0100 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-03-01 10:11:47 +0100 |
commit | fa17193dedbcbb46ecc9493f5f43cfe5738d8d0a (patch) | |
tree | 5b5c33c54838799ff19e70171735abd8f9b2ec50 | |
parent | 8c86ff31f47e1e1f11374c4723f254cb4b34ece7 (diff) | |
download | qtsensors-fa17193dedbcbb46ecc9493f5f43cfe5738d8d0a.tar.gz |
Update the porting documentation
- Remove some references to the legacy imports
- Mention the biggest change, separate QML types
- Add some examples on what changed in the QML API
Change-Id: Icdbf8271935499ec449a35919d947ad762d2cf03
Reviewed-by: Bernd Weimer <bweimer@rim.com>
Reviewed-by: Lorn Potter <lorn.potter@jollamobile.com>
-rw-r--r-- | src/sensors/doc/src/porting.qdoc | 25 |
1 files changed, 15 insertions, 10 deletions
diff --git a/src/sensors/doc/src/porting.qdoc b/src/sensors/doc/src/porting.qdoc index fa2b3fb..0d5b572 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 |