|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the Qt Mobility Components. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 #include "qproximitysensor.h" |
|
43 #include "qproximitysensor_p.h" |
|
44 |
|
45 QTM_BEGIN_NAMESPACE |
|
46 |
|
47 IMPLEMENT_READING(QProximityReading) |
|
48 |
|
49 /*! |
|
50 \class QProximityReading |
|
51 \ingroup sensors_reading |
|
52 |
|
53 \brief The QProximityReading class represents one reading from the |
|
54 proximity sensor. |
|
55 |
|
56 \target QProximityReading_Units |
|
57 The proximity sensor can only indicate if an object is close or not. |
|
58 |
|
59 The distance at which an object is considered close is device-specific. This |
|
60 distance may be available in the QSensor::outputRanges property. |
|
61 */ |
|
62 |
|
63 /*! |
|
64 \property QProximityReading::close |
|
65 \brief a value indicating if something is close. |
|
66 |
|
67 Set to true if something is close. |
|
68 Set to false is nothing is close. |
|
69 |
|
70 \sa QProximityReading_Units |
|
71 */ |
|
72 |
|
73 bool QProximityReading::close() const |
|
74 { |
|
75 return d->close; |
|
76 } |
|
77 |
|
78 /*! |
|
79 Sets the close value to \a close. |
|
80 */ |
|
81 void QProximityReading::setClose(bool close) |
|
82 { |
|
83 d->close = close; |
|
84 } |
|
85 |
|
86 // ===================================================================== |
|
87 |
|
88 /*! |
|
89 \class QProximityFilter |
|
90 \ingroup sensors_filter |
|
91 |
|
92 \brief The QProximityFilter class is a convenience wrapper around QSensorFilter. |
|
93 |
|
94 The only difference is that the filter() method features a pointer to QProximityReading |
|
95 instead of QSensorReading. |
|
96 */ |
|
97 |
|
98 /*! |
|
99 \fn QProximityFilter::filter(QProximityReading *reading) |
|
100 |
|
101 Called when \a reading changes. Returns false to prevent the reading from propagating. |
|
102 |
|
103 \sa QSensorFilter::filter() |
|
104 */ |
|
105 |
|
106 char const * const QProximitySensor::type("QProximitySensor"); |
|
107 |
|
108 /*! |
|
109 \class QProximitySensor |
|
110 \ingroup sensors_type |
|
111 |
|
112 \brief The QProximitySensor class is a convenience wrapper around QSensor. |
|
113 |
|
114 The only behavioural difference is that this class sets the type properly. |
|
115 |
|
116 This class also features a reading() function that returns a QProximityReading instead of a QSensorReading. |
|
117 |
|
118 For details about how the sensor works, see \l QProximityReading. |
|
119 |
|
120 \sa QProximityReading |
|
121 */ |
|
122 |
|
123 /*! |
|
124 \fn QProximitySensor::QProximitySensor(QObject *parent) |
|
125 |
|
126 Construct the sensor as a child of \a parent. |
|
127 */ |
|
128 |
|
129 /*! |
|
130 \fn QProximitySensor::~QProximitySensor() |
|
131 |
|
132 Destroy the sensor. Stops the sensor if it has not already been stopped. |
|
133 */ |
|
134 |
|
135 /*! |
|
136 \fn QProximitySensor::reading() const |
|
137 |
|
138 Returns the reading class for this sensor. |
|
139 |
|
140 \sa QSensor::reading() |
|
141 */ |
|
142 |
|
143 #include "moc_qproximitysensor.cpp" |
|
144 QTM_END_NAMESPACE |
|
145 |