Sophie

Sophie

distrib > Mageia > 6 > x86_64 > media > core-updates > by-pkgid > aa084d0e0126d94ee0fb846ebdf50e37 > files > 317

qtsensors5-doc-5.9.4-1.mga6.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qtsensors5.qdoc -->
  <title>Qt Sensors QML Types | Qt Sensors 5.9</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td >Qt 5.9</td><td ><a href="qtsensors-index.html">Qt Sensors</a></td><td >Qt Sensors QML Types</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#qml-module-api">QML Module API</a></li>
<li class="level1"><a href="#qml-sensor-types">QML Sensor Types</a></li>
<li class="level1"><a href="#qml-reading-types">QML Reading Types</a></li>
<li class="level1"><a href="#all-qml-types">All QML Types</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Qt Sensors QML Types</h1>
<span class="subtitle"></span>
<!-- $$$QtSensors-description -->
<div class="descr"> <a name="details"></a>
<a name="qml-module-api"></a>
<h2 id="qml-module-api">QML Module API</h2>
<p>If the module is imported into a namespace, some additional methods become available.</p>
<pre class="qml">

  import QtSensors 5.0
  //  ...
      Component.onCompleted: {
          var types = QmlSensors.sensorTypes();
          console.log(types.join(&quot;, &quot;));
      }

</pre>
<p>The documentation for the module API can be found in <a href="qml-qtsensors-sensorglobal.html">SensorGlobal</a>.</p>
<a name="qml-sensor-types"></a>
<h2 id="qml-sensor-types">QML Sensor Types</h2>
<p>These types represent specific types of sensors.</p>
<p>Note that most properties come from the abstract <a href="qml-qtsensors-sensor.html">Sensor</a> element.</p>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-accelerometer.html">Accelerometer</a></p></td><td class="tblDescr"><p>Element reports on linear acceleration along the X, Y and Z axes</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-altimeter.html">Altimeter</a></p></td><td class="tblDescr"><p>Element reports on altitude</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-ambientlightsensor.html">AmbientLightSensor</a></p></td><td class="tblDescr"><p>Element repors on ambient lighting conditions</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-ambienttemperaturesensor.html">AmbientTemperatureSensor</a></p></td><td class="tblDescr"><p>Element reports on the ambient temperature</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-compass.html">Compass</a></p></td><td class="tblDescr"><p>Element reports on heading using magnetic north as a reference</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-distancesensor.html">DistanceSensor</a></p></td><td class="tblDescr"><p>Element reports the distance in cm from an object to the device</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-gyroscope.html">Gyroscope</a></p></td><td class="tblDescr"><p>Element reports on rotational acceleration around the X, Y and Z axes</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-holstersensor.html">HolsterSensor</a></p></td><td class="tblDescr"><p>Element reports on whether a device is holstered</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-humiditysensor.html">HumiditySensor</a></p></td><td class="tblDescr"><p>Element reports on humidity</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-irproximitysensor.html">IRProximitySensor</a></p></td><td class="tblDescr"><p>Element reports on infra-red reflectance values</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-lidsensor.html">LidSensor</a></p></td><td class="tblDescr"><p>Element reports on whether a device is closed</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-lightsensor.html">LightSensor</a></p></td><td class="tblDescr"><p>Element reports on light levels using LUX</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-magnetometer.html">Magnetometer</a></p></td><td class="tblDescr"><p>Element reports on magnetic field strength along the Z, Y and Z axes</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-orientationsensor.html">OrientationSensor</a></p></td><td class="tblDescr"><p>Element reports device orientation</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-pressuresensor.html">PressureSensor</a></p></td><td class="tblDescr"><p>Element reports on atmospheric pressure values</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-proximitysensor.html">ProximitySensor</a></p></td><td class="tblDescr"><p>Element reports on object proximity</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-rotationsensor.html">RotationSensor</a></p></td><td class="tblDescr"><p>Element reports on device rotation around the X, Y and Z axes</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-tapsensor.html">TapSensor</a></p></td><td class="tblDescr"><p>Element reports tap and double tap events along the X, Y and Z axes</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-tiltsensor.html">TiltSensor</a></p></td><td class="tblDescr"><p>Element reports tilt events along the X and Y axes</p></td></tr>
</table></div>
<a name="qml-reading-types"></a>
<h2 id="qml-reading-types">QML Reading Types</h2>
<p>The data from a sensor comes via a reading class.</p>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-accelerometerreading.html">AccelerometerReading</a></p></td><td class="tblDescr"><p>Element holds the most recent Accelerometer reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-altimeterreading.html">AltimeterReading</a></p></td><td class="tblDescr"><p>Element holds the most recent Altimeter reading</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-ambientlightreading.html">AmbientLightReading</a></p></td><td class="tblDescr"><p>Element holds the most AmbientLightSensor reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-ambienttemperaturereading.html">AmbientTemperatureReading</a></p></td><td class="tblDescr"><p>Element holds the most recent temperature reading</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-compassreading.html">CompassReading</a></p></td><td class="tblDescr"><p>Element holds the most recent Compass reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-distancereading.html">DistanceReading</a></p></td><td class="tblDescr"><p>Element holds the most recent DistanceSensor reading</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-gyroscopereading.html">GyroscopeReading</a></p></td><td class="tblDescr"><p>Element holds the most recent Gyroscope reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-holsterreading.html">HolsterReading</a></p></td><td class="tblDescr"><p>Element holds the most recent HolsterSensor reading</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-humidityreading.html">HumidityReading</a></p></td><td class="tblDescr"><p>Element holds the most recent HumiditySensor reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-irproximityreading.html">IRProximityReading</a></p></td><td class="tblDescr"><p>Element holds the most recent IR proximity reading</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-lidreading.html">LidReading</a></p></td><td class="tblDescr"><p>Element holds the most recent LidSensor reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-lightreading.html">LightReading</a></p></td><td class="tblDescr"><p>Element holds the most recent LightSensor reading</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-magnetometerreading.html">MagnetometerReading</a></p></td><td class="tblDescr"><p>Element holds the most recent Magnetometer reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-orientationreading.html">OrientationReading</a></p></td><td class="tblDescr"><p>Element holds the most recent OrientationSensor reading</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-pressurereading.html">PressureReading</a></p></td><td class="tblDescr"><p>Element holds the most recent PressureSensor reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-proximityreading.html">ProximityReading</a></p></td><td class="tblDescr"><p>Element holds the most recent ProximitySensor reading</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-rotationreading.html">RotationReading</a></p></td><td class="tblDescr"><p>Element holds the most recent RotationSensor reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-tapreading.html">TapReading</a></p></td><td class="tblDescr"><p>Element holds the most recent TapSensor reading</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-tiltreading.html">TiltReading</a></p></td><td class="tblDescr"><p>Element holds the most recent TiltSensor reading</p></td></tr>
</table></div>
<a name="all-qml-types"></a>
<h2 id="all-qml-types">All QML Types</h2>
</div>
<!-- @@@QtSensors -->
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-accelerometer.html">Accelerometer</a></p></td><td class="tblDescr"><p>Element reports on linear acceleration along the X, Y and Z axes</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-accelerometerreading.html">AccelerometerReading</a></p></td><td class="tblDescr"><p>Element holds the most recent Accelerometer reading</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-altimeter.html">Altimeter</a></p></td><td class="tblDescr"><p>Element reports on altitude</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-altimeterreading.html">AltimeterReading</a></p></td><td class="tblDescr"><p>Element holds the most recent Altimeter reading</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-ambientlightreading.html">AmbientLightReading</a></p></td><td class="tblDescr"><p>Element holds the most AmbientLightSensor reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-ambientlightsensor.html">AmbientLightSensor</a></p></td><td class="tblDescr"><p>Element repors on ambient lighting conditions</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-ambienttemperaturereading.html">AmbientTemperatureReading</a></p></td><td class="tblDescr"><p>Element holds the most recent temperature reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-ambienttemperaturesensor.html">AmbientTemperatureSensor</a></p></td><td class="tblDescr"><p>Element reports on the ambient temperature</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-compass.html">Compass</a></p></td><td class="tblDescr"><p>Element reports on heading using magnetic north as a reference</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-compassreading.html">CompassReading</a></p></td><td class="tblDescr"><p>Element holds the most recent Compass reading</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-distancereading.html">DistanceReading</a></p></td><td class="tblDescr"><p>Element holds the most recent DistanceSensor reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-distancesensor.html">DistanceSensor</a></p></td><td class="tblDescr"><p>Element reports the distance in cm from an object to the device</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-gyroscope.html">Gyroscope</a></p></td><td class="tblDescr"><p>Element reports on rotational acceleration around the X, Y and Z axes</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-gyroscopereading.html">GyroscopeReading</a></p></td><td class="tblDescr"><p>Element holds the most recent Gyroscope reading</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-holsterreading.html">HolsterReading</a></p></td><td class="tblDescr"><p>Element holds the most recent HolsterSensor reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-holstersensor.html">HolsterSensor</a></p></td><td class="tblDescr"><p>Element reports on whether a device is holstered</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-humidityreading.html">HumidityReading</a></p></td><td class="tblDescr"><p>Element holds the most recent HumiditySensor reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-humiditysensor.html">HumiditySensor</a></p></td><td class="tblDescr"><p>Element reports on humidity</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-irproximityreading.html">IRProximityReading</a></p></td><td class="tblDescr"><p>Element holds the most recent IR proximity reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-irproximitysensor.html">IRProximitySensor</a></p></td><td class="tblDescr"><p>Element reports on infra-red reflectance values</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-lidreading.html">LidReading</a></p></td><td class="tblDescr"><p>Element holds the most recent LidSensor reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-lidsensor.html">LidSensor</a></p></td><td class="tblDescr"><p>Element reports on whether a device is closed</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-lightreading.html">LightReading</a></p></td><td class="tblDescr"><p>Element holds the most recent LightSensor reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-lightsensor.html">LightSensor</a></p></td><td class="tblDescr"><p>Element reports on light levels using LUX</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-magnetometer.html">Magnetometer</a></p></td><td class="tblDescr"><p>Element reports on magnetic field strength along the Z, Y and Z axes</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-magnetometerreading.html">MagnetometerReading</a></p></td><td class="tblDescr"><p>Element holds the most recent Magnetometer reading</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-orientationreading.html">OrientationReading</a></p></td><td class="tblDescr"><p>Element holds the most recent OrientationSensor reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-orientationsensor.html">OrientationSensor</a></p></td><td class="tblDescr"><p>Element reports device orientation</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-pressurereading.html">PressureReading</a></p></td><td class="tblDescr"><p>Element holds the most recent PressureSensor reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-pressuresensor.html">PressureSensor</a></p></td><td class="tblDescr"><p>Element reports on atmospheric pressure values</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-proximityreading.html">ProximityReading</a></p></td><td class="tblDescr"><p>Element holds the most recent ProximitySensor reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-proximitysensor.html">ProximitySensor</a></p></td><td class="tblDescr"><p>Element reports on object proximity</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-rotationreading.html">RotationReading</a></p></td><td class="tblDescr"><p>Element holds the most recent RotationSensor reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-rotationsensor.html">RotationSensor</a></p></td><td class="tblDescr"><p>Element reports on device rotation around the X, Y and Z axes</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-sensor.html">Sensor</a></p></td><td class="tblDescr"><p>Element serves as a base type for sensors</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-sensorreading.html">SensorReading</a></p></td><td class="tblDescr"><p>Element serves as a base type for sensor readings</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-sensorgesture.html">SensorGesture</a></p></td><td class="tblDescr"><p>Provides notifications when sensor-based gestures are detected</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-sensorglobal.html">SensorGlobal</a></p></td><td class="tblDescr"><p>Element provides the module API</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-tapreading.html">TapReading</a></p></td><td class="tblDescr"><p>Element holds the most recent TapSensor reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-tapsensor.html">TapSensor</a></p></td><td class="tblDescr"><p>Element reports tap and double tap events along the X, Y and Z axes</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtsensors-tiltreading.html">TiltReading</a></p></td><td class="tblDescr"><p>Element holds the most recent TiltSensor reading</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtsensors-tiltsensor.html">TiltSensor</a></p></td><td class="tblDescr"><p>Element reports tilt events along the X and Y axes</p></td></tr>
</table></div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2017 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br>    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. </p>
</div>
</body>
</html>