QOrientationReading Class
The QOrientationReading class represents one reading from the orientation sensor. More...
| Header: | #include <QOrientationReading> |
| qmake: | QT += sensors |
| Since: | Qt 5.1 |
| Inherits: | QSensorReading |
Public Types
| enum | Orientation { Undefined, TopUp, TopDown, LeftUp, ..., FaceDown } |
Properties
- orientation : const Orientation
- 1 property inherited from QSensorReading
- 1 property inherited from QObject
Public Functions
| QOrientationReading(QObject *parent = DECLARE_READING(QOrientationReading)) | |
| virtual | ~QOrientationReading() |
| QOrientationReading::Orientation | orientation() const |
| void | setOrientation(QOrientationReading::Orientation orientation) |
Reimplemented Public Functions
| virtual void | copyValuesFrom(QSensorReading *other) override |
- 4 public functions inherited from QSensorReading
- 31 public functions inherited from QObject
Static Public Members
| const QMetaObject | staticMetaObject |
- 9 static public members inherited from QObject
Additional Inherited Members
- 1 public slot inherited from QObject
- 2 signals inherited from QObject
- 9 protected functions inherited from QObject
Detailed Description
The QOrientationReading class represents one reading from the orientation sensor.
The orientation sensor reports the orientation of the device. As it operates below the UI level it does not report on or even know how the UI is rotated. Most importantly this means that this sensor cannot be used to detect if a device is in portrait or landscape mode.
This sensor is useful to detect that a particular side of the device is pointing up.
QOrientationReading Units
The orientation sensor returns the orientation of the device using the pre-defined values found in the QOrientationReading::Orientation enum.
Member Type Documentation
enum QOrientationReading::Orientation
This enum represents the orientation of the device.
To explain the meaning of each value it is helpful to refer to the following diagram.
The orientations are shown here in order: TopUp, TopDown, LeftUp, RightUp, FaceUp, FaceDown.
| Constant | Value | Description |
|---|---|---|
QOrientationReading::Undefined | 0 | The orientation is unknown. |
QOrientationReading::TopUp | 1 | The Top edge of the device is pointing up. |
QOrientationReading::TopDown | 2 | The Top edge of the device is pointing down. |
QOrientationReading::LeftUp | 3 | The Left edge of the device is pointing up. |
QOrientationReading::RightUp | 4 | The Right edge of the device is pointing up. |
QOrientationReading::FaceUp | 5 | The Face of the device is pointing up. |
QOrientationReading::FaceDown | 6 | The Face of the device is pointing down. |
It should be noted that the orientation sensor reports the orientation of the device and not the UI. The orientation of the device will not change just because the UI is rotated. This means this sensor cannot be used to detect if a device is in portrait or landscape mode.
Property Documentation
orientation : const Orientation
This property holds the orientation of the device.
The unit is an enumeration describing the orientation of the device.
Access functions:
| QOrientationReading::Orientation | orientation() const |
See also QOrientationReading Units.
Member Function Documentation
QOrientationReading::QOrientationReading(QObject *parent = DECLARE_READING(QOrientationReading))
Default constructs an instance of QOrientationReading.
[virtual] QOrientationReading::~QOrientationReading()
Destroys the instance of QOrientationReading. The destructor is virtual.
[override virtual] void QOrientationReading::copyValuesFrom(QSensorReading *other)
void QOrientationReading::setOrientation(QOrientationReading::Orientation orientation)
Sets the orientation for the reading.
See also orientation().
© 2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.