|
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 "qambientlightsensor.h" |
|
43 #include "qambientlightsensor_p.h" |
|
44 |
|
45 QTM_BEGIN_NAMESPACE |
|
46 |
|
47 IMPLEMENT_READING(QAmbientLightReading) |
|
48 |
|
49 /*! |
|
50 \class QAmbientLightReading |
|
51 \ingroup sensors_reading |
|
52 |
|
53 \brief The QAmbientLightReading class represents one reading from the |
|
54 ambient light sensor. |
|
55 |
|
56 \section2 QAmbientLightReading Units |
|
57 The ambient light sensor returns the intensity of the ambient light |
|
58 using the pre-defined values found in the QAmbientLightReading::LightLevel |
|
59 enum. |
|
60 */ |
|
61 |
|
62 /*! |
|
63 \enum QAmbientLightReading::LightLevel |
|
64 |
|
65 This enum represents the ambient light level. |
|
66 |
|
67 \value Undefined The light level is unknown. |
|
68 \value Dark It is dark. |
|
69 \value Twilight It is moderately dark. |
|
70 \value Light It is light (eg. internal lights). |
|
71 \value Bright It is bright (eg. shade). |
|
72 \value Sunny It is very bright (eg. direct sunlight). |
|
73 */ |
|
74 |
|
75 /*! |
|
76 \property QAmbientLightReading::lightLevel |
|
77 \brief the ambient light level. |
|
78 |
|
79 The value represents the ambient light and comes from QAmbientLightReading::LightLevel. |
|
80 \sa {QAmbientLightReading Units} |
|
81 */ |
|
82 |
|
83 QAmbientLightReading::LightLevel QAmbientLightReading::lightLevel() const |
|
84 { |
|
85 return static_cast<LightLevel>(d->lightLevel); |
|
86 } |
|
87 |
|
88 /*! |
|
89 Sets the ambient light level to \a lightLevel. |
|
90 */ |
|
91 void QAmbientLightReading::setLightLevel(QAmbientLightReading::LightLevel lightLevel) |
|
92 { |
|
93 d->lightLevel = lightLevel; |
|
94 } |
|
95 |
|
96 // ===================================================================== |
|
97 |
|
98 /*! |
|
99 \class QAmbientLightFilter |
|
100 \ingroup sensors_filter |
|
101 |
|
102 \brief The QAmbientLightFilter class is a convenience wrapper around QSensorFilter. |
|
103 |
|
104 The only difference is that the filter() method features a pointer to QAmbientLightReading |
|
105 instead of QSensorReading. |
|
106 */ |
|
107 |
|
108 /*! |
|
109 \fn QAmbientLightFilter::filter(QAmbientLightReading *reading) |
|
110 |
|
111 Called when \a reading changes. Returns false to prevent the reading from propagating. |
|
112 |
|
113 \sa QSensorFilter::filter() |
|
114 */ |
|
115 |
|
116 char const * const QAmbientLightSensor::type("QAmbientLightSensor"); |
|
117 |
|
118 /*! |
|
119 \class QAmbientLightSensor |
|
120 \ingroup sensors_type |
|
121 |
|
122 \brief The QAmbientLightSensor class is a convenience wrapper around QSensor. |
|
123 |
|
124 The only behavioural difference is that this class sets the type properly. |
|
125 |
|
126 This class also features a reading() function that returns a QAmbientLightReading instead of a QSensorReading. |
|
127 |
|
128 For details about how the sensor works, see \l QAmbientLightReading. |
|
129 |
|
130 \sa QAmbientLightReading |
|
131 */ |
|
132 |
|
133 /*! |
|
134 \fn QAmbientLightSensor::QAmbientLightSensor(QObject *parent) |
|
135 |
|
136 Construct the sensor as a child of \a parent. |
|
137 */ |
|
138 |
|
139 /*! |
|
140 \fn QAmbientLightSensor::~QAmbientLightSensor() |
|
141 |
|
142 Destroy the sensor. Stops the sensor if it has not already been stopped. |
|
143 */ |
|
144 |
|
145 /*! |
|
146 \fn QAmbientLightSensor::reading() const |
|
147 |
|
148 Returns the reading class for this sensor. |
|
149 |
|
150 \sa QSensor::reading() |
|
151 */ |
|
152 |
|
153 #include "moc_qambientlightsensor.cpp" |
|
154 QTM_END_NAMESPACE |
|
155 |