qtmobility/src/sensors/qproximitysensor.cpp
changeset 4 90517678cc4f
parent 1 2b40d63a9c3d
child 8 71781823f776
--- a/qtmobility/src/sensors/qproximitysensor.cpp	Fri Apr 16 15:51:22 2010 +0300
+++ b/qtmobility/src/sensors/qproximitysensor.cpp	Mon May 03 13:18:40 2010 +0300
@@ -55,46 +55,37 @@
            proximity sensor.
 
     \target QProximityReading_Units
-    The proximity sensor returns an indication of how far the user is
-    away from the device using the pre-defined values found in the
-    QProximityReading::Proximity enum.
-*/
+    The proximity sensor can only indicate if an object is close or not.
 
-/*!
-    \enum QProximityReading::Proximity
-
-    This enum represents the proximity of the user.
-
-    \value Undefined  The proximity is unknown.
-    \value Close      The user is close to the device.
-    \value NotClose   The user is not close to the device.
+    The distance at which an object is considered close is device-specific. This
+    distance may be available in the QSensor::outputRanges property.
 */
 
 /*!
-    \property QProximityReading::proximity
-    \brief the proximity of the user.
+    \property QProximityReading::close
+    \brief a value indicating if something is close.
 
-    The value is an indication of if the user is close or not.
+    Set to true if something is close.
+    Set to false is nothing is close.
+
     \sa QProximityReading_Units
 */
 
-QProximityReading::Proximity QProximityReading::proximity() const
+bool QProximityReading::close() const
 {
-    return static_cast<QProximityReading::Proximity>(d->proximity);
+    return d->close;
 }
 
 /*!
-    Sets the \a proximity of the user.
+    Sets the close value to \a close.
 */
-void QProximityReading::setProximity(QProximityReading::Proximity proximity)
+void QProximityReading::setClose(bool close)
 {
-    d->proximity = proximity;
+    d->close = close;
 }
 
 // =====================================================================
 
-// begin generated code
-
 /*!
     \class QProximityFilter
     \ingroup sensors_filter
@@ -151,7 +142,6 @@
 
     \sa QSensor::reading()
 */
-// end generated code
 
 #include "moc_qproximitysensor.cpp"
 QTM_END_NAMESPACE