|
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 "qorientationsensor.h" |
|
43 #include "qorientationsensor_p.h" |
|
44 |
|
45 QTM_BEGIN_NAMESPACE |
|
46 |
|
47 IMPLEMENT_READING(QOrientationReading) |
|
48 |
|
49 /*! |
|
50 \class QOrientationReading |
|
51 \ingroup sensors_reading |
|
52 |
|
53 \brief The QOrientationReading class represents one reading from the |
|
54 orientation sensor. |
|
55 |
|
56 \section2 QOrientationReading Units |
|
57 The orientation sensor returns the orientation of the device using |
|
58 the pre-defined values found in the QOrientationReading::Orientation |
|
59 enum. |
|
60 */ |
|
61 |
|
62 /*! |
|
63 \enum QOrientationReading::Orientation |
|
64 |
|
65 This enum represents the orientation of the device. |
|
66 |
|
67 To explain the meaning of each value it is helpful to refer to the following diagram. |
|
68 |
|
69 \image sensors-sides.jpg |
|
70 |
|
71 The orientations are shown here in order: TopUp, TopDown, LeftUp, RightUp, FaceUp, FaceDown. |
|
72 |
|
73 \image sensors-orientation.jpg |
|
74 |
|
75 \value Undefined The orientation is unknown. |
|
76 \value TopUp The Top edge of the device is pointing up. |
|
77 \value TopDown The Top edge of the device is pointing down. |
|
78 \value LeftUp The Left edge of the device is pointing up. |
|
79 \value RightUp The Right edge of the device is pointing up. |
|
80 \value FaceUp The Face of the device is pointing up. |
|
81 \value FaceDown The Face of the device is pointing down. |
|
82 */ |
|
83 |
|
84 /*! |
|
85 \property QOrientationReading::orientation |
|
86 \brief the orientation of the device. |
|
87 |
|
88 The unit is an enumeration describing the orientation of the screen. |
|
89 \sa {QOrientationReading Units} |
|
90 */ |
|
91 |
|
92 QOrientationReading::Orientation QOrientationReading::orientation() const |
|
93 { |
|
94 return static_cast<QOrientationReading::Orientation>(d->orientation); |
|
95 } |
|
96 |
|
97 /*! |
|
98 Sets the \a orientation for the reading. |
|
99 */ |
|
100 void QOrientationReading::setOrientation(QOrientationReading::Orientation orientation) |
|
101 { |
|
102 d->orientation = orientation; |
|
103 } |
|
104 |
|
105 // ===================================================================== |
|
106 |
|
107 /*! |
|
108 \class QOrientationFilter |
|
109 \ingroup sensors_filter |
|
110 |
|
111 \brief The QOrientationFilter class is a convenience wrapper around QSensorFilter. |
|
112 |
|
113 The only difference is that the filter() method features a pointer to QOrientationReading |
|
114 instead of QSensorReading. |
|
115 */ |
|
116 |
|
117 /*! |
|
118 \fn QOrientationFilter::filter(QOrientationReading *reading) |
|
119 |
|
120 Called when \a reading changes. Returns false to prevent the reading from propagating. |
|
121 |
|
122 \sa QSensorFilter::filter() |
|
123 */ |
|
124 |
|
125 char const * const QOrientationSensor::type("QOrientationSensor"); |
|
126 |
|
127 /*! |
|
128 \class QOrientationSensor |
|
129 \ingroup sensors_type |
|
130 |
|
131 \brief The QOrientationSensor class is a convenience wrapper around QSensor. |
|
132 |
|
133 The only behavioural difference is that this class sets the type properly. |
|
134 |
|
135 This class also features a reading() function that returns a QOrientationReading instead of a QSensorReading. |
|
136 |
|
137 For details about how the sensor works, see \l QOrientationReading. |
|
138 |
|
139 \sa QOrientationReading |
|
140 */ |
|
141 |
|
142 /*! |
|
143 \fn QOrientationSensor::QOrientationSensor(QObject *parent) |
|
144 |
|
145 Construct the sensor as a child of \a parent. |
|
146 */ |
|
147 |
|
148 /*! |
|
149 \fn QOrientationSensor::~QOrientationSensor() |
|
150 |
|
151 Destroy the sensor. Stops the sensor if it has not already been stopped. |
|
152 */ |
|
153 |
|
154 /*! |
|
155 \fn QOrientationSensor::reading() const |
|
156 |
|
157 Returns the reading class for this sensor. |
|
158 |
|
159 \sa QSensor::reading() |
|
160 */ |
|
161 |
|
162 #include "moc_qorientationsensor.cpp" |
|
163 QTM_END_NAMESPACE |
|
164 |