From d20e18dd85e90b892f952940254e1a27ec54ad9c Mon Sep 17 00:00:00 2001 From: Thomas McGuire Date: Thu, 2 Aug 2012 11:33:07 +0200 Subject: Add documentaiton for the new axes remapping properties in QML. Change-Id: I4870c81bf8162da2bb82e5f0aa560e9ef0e796ee Reviewed-by: Thomas McGuire --- plugins/declarative/sensors/sensors.cpp | 115 ++++++++++++++++++++++++++++++++ 1 file changed, 115 insertions(+) diff --git a/plugins/declarative/sensors/sensors.cpp b/plugins/declarative/sensors/sensors.cpp index ae1e147e23..ac6e89982b 100644 --- a/plugins/declarative/sensors/sensors.cpp +++ b/plugins/declarative/sensors/sensors.cpp @@ -250,6 +250,29 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara \sa {Sensors QML Limitations} */ +#if defined(Q_QDOC) && defined(Q_OS_BLACKBERRY) +/*! + \qmlproperty AxesOrientationMode Accelerometer::axesOrientationMode + Holds the mode that affects how the screen orientation changes reading values. + \sa QOrientableSensorBase::axesOrientationMode + \since Mobility 1.3 +*/ + +/*! + \qmlproperty int Accelerometer::currentOrientation + Holds the current orientation that is used for rotating the reading values. + \sa QOrientableSensorBase::currentOrientation + \since Mobility 1.3 +*/ + +/*! + \qmlproperty int Accelerometer::userOrientation + Holds the angle used for rotating the reading values in the UserOrientation mode. + \sa QOrientableSensorBase::userOrientation + \since Mobility 1.3 +*/ +#endif + /*! \qmlproperty AccelerometerReading Accelerometer::reading Holds the most recent accelerometer reading. @@ -373,6 +396,29 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara \sa {Sensors QML Limitations} */ +#if defined(Q_QDOC) && defined(Q_OS_BLACKBERRY) +/*! + \qmlproperty AxesOrientationMode Compass::axesOrientationMode + Holds the mode that affects how the screen orientation changes reading values. + \sa QOrientableSensorBase::axesOrientationMode + \since Mobility 1.3 +*/ + +/*! + \qmlproperty int Compass::currentOrientation + Holds the current orientation that is used for rotating the reading values. + \sa QOrientableSensorBase::currentOrientation + \since Mobility 1.3 +*/ + +/*! + \qmlproperty int Compass::userOrientation + Holds the angle used for rotating the reading values in the UserOrientation mode. + \sa QOrientableSensorBase::userOrientation + \since Mobility 1.3 +*/ +#endif + /*! \qmlproperty CompassReading Compass::reading Holds the most recent compass reading. @@ -431,6 +477,29 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara \sa {Sensors QML Limitations} */ +#if defined(Q_QDOC) && defined(Q_OS_BLACKBERRY) +/*! + \qmlproperty AxesOrientationMode Magnetometer::axesOrientationMode + Holds the mode that affects how the screen orientation changes reading values. + \sa QOrientableSensorBase::axesOrientationMode + \since Mobility 1.3 +*/ + +/*! + \qmlproperty int Magnetometer::currentOrientation + Holds the current orientation that is used for rotating the reading values. + \sa QOrientableSensorBase::currentOrientation + \since Mobility 1.3 +*/ + +/*! + \qmlproperty int Magnetometer::userOrientation + Holds the angle used for rotating the reading values in the UserOrientation mode. + \sa QOrientableSensorBase::userOrientation + \since Mobility 1.3 +*/ +#endif + /*! \qmlproperty MagnetometerReading Magnetometer::reading Holds the most recent magnetometer reading. @@ -611,6 +680,29 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara \sa {Sensors QML Limitations} */ +#if defined(Q_QDOC) && defined(Q_OS_BLACKBERRY) +/*! + \qmlproperty AxesOrientationMode RotationSensor::axesOrientationMode + Holds the mode that affects how the screen orientation changes reading values. + \sa QOrientableSensorBase::axesOrientationMode + \since Mobility 1.3 +*/ + +/*! + \qmlproperty int RotationSensor::currentOrientation + Holds the current orientation that is used for rotating the reading values. + \sa QOrientableSensorBase::currentOrientation + \since Mobility 1.3 +*/ + +/*! + \qmlproperty int RotationSensor::userOrientation + Holds the angle used for rotating the reading values in the UserOrientation mode. + \sa QOrientableSensorBase::userOrientation + \since Mobility 1.3 +*/ +#endif + /*! \qmlproperty RotationReading RotationSensor::reading Holds the most recent rotation reading. @@ -791,6 +883,29 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara \sa {Sensors QML Limitations} */ +#if defined(Q_QDOC) && defined(Q_OS_BLACKBERRY) +/*! + \qmlproperty AxesOrientationMode Gyroscope::axesOrientationMode + Holds the mode that affects how the screen orientation changes reading values. + \sa QOrientableSensorBase::axesOrientationMode + \since Mobility 1.3 +*/ + +/*! + \qmlproperty int Gyroscope::currentOrientation + Holds the current orientation that is used for rotating the reading values. + \sa QOrientableSensorBase::currentOrientation + \since Mobility 1.3 +*/ + +/*! + \qmlproperty int Gyroscope::userOrientation + Holds the angle used for rotating the reading values in the UserOrientation mode. + \sa QOrientableSensorBase::userOrientation + \since Mobility 1.3 +*/ +#endif + /*! \qmlproperty GyroscopeReading Gyroscope::reading \since Mobility 1.2 -- cgit v1.2.3