qlidreading.html 12 KB
Newer Older
xuebingbing's avatar
xuebingbing committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qlidsensor.cpp -->
  <title>QLidReading Class | Qt Sensors 5.11</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 ><a href="../qtdoc/index.html">Qt 5.11</a></td><td ><a href="qtsensors-index.html">Qt Sensors</a></td><td ><a href="qtsensors-module.html">C++ Classes</a></td><td >QLidReading</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.11.2 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="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#reimplemented-public-functions">Reimplemented Public Functions</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
<li class="level2"><a href="#qlidreading-units">QLidReading Units</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QLidReading Class</h1>
<!-- $$$QLidReading-brief -->
<p>The <a href="qlidreading.html">QLidReading</a> class holds readings from the Lid sensor. <a href="#details">More...</a></p>
<!-- @@@QLidReading -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QLidReading&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += sensors</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  Qt 5.9</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qsensorreading.html">QSensorReading</a></td></tr></table></div><ul>
<li><a href="qlidreading-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="qlidreading.html#backLidClosed-prop">backLidClosed</a></b> : const bool</li>
<li class="fn"><b><a href="qlidreading.html#frontLidClosed-prop">frontLidClosed</a></b> : const bool</li>
</ul>
<ul>
<li class="fn">1 property inherited from <a href="qsensorreading.html#properties">QSensorReading</a></li>
<li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlidreading.html#QLidReading">QLidReading</a></b>(QObject *<i>parent</i> = DECLARE_READING(QLidReading))</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qlidreading.html#dtor.QLidReading">~QLidReading</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qlidreading.html#backLidClosed-prop">backLidClosed</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qlidreading.html#frontLidClosed-prop">frontLidClosed</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlidreading.html#setBackLidClosed">setBackLidClosed</a></b>(bool <i>closed</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlidreading.html#setFrontLidClosed">setFrontLidClosed</a></b>(bool <i>closed</i>)</td></tr>
</table></div>
<a name="reimplemented-public-functions"></a>
<h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qlidreading.html#copyValuesFrom">copyValuesFrom</a></b>(QSensorReading *<i>other</i>) override</td></tr>
</table></div>
<ul>
<li class="fn">4 public functions inherited from <a href="qsensorreading.html#public-functions">QSensorReading</a></li>
<li class="fn">34 public functions inherited from <a href="../qtcore/qobject.html#public-functions">QObject</a></li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlidreading.html#backLidChanged">backLidChanged</a></b>(bool <i>closed</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlidreading.html#frontLidChanged">frontLidChanged</a></b>(bool <i>closed</i>)</td></tr>
</table></div>
<ul>
<li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 public slot inherited from <a href="../qtcore/qobject.html#public-slots">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="../qtcore/qobject.html#public-variables">QObject</a></li>
<li class="fn">10 static public members inherited from <a href="../qtcore/qobject.html#static-public-members">QObject</a></li>
<li class="fn">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="../qtcore/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QLidReading-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qlidreading.html">QLidReading</a> class holds readings from the Lid sensor.</p>
<p>A normal laptop has what we call a front lid.</p>
<p>If the laptop can be converted to a tablet by rotating or closing the lid where the display is out, this is known as a back lid.</p>
<a name="qlidreading-units"></a>
<h4 >QLidReading Units</h4>
<p>The Lid sensor can detect if a device's lid is closed or not. A lid can be a laptop, a laptop that converts to a tablet, or even a cover for a tablet or phone.</p>
</div>
<!-- @@@QLidReading -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$backLidClosed-prop$$$backLidClosed -->
<h3 class="fn" id="backLidClosed-prop"><a name="backLidClosed-prop"></a><span class="name">backLidClosed</span> : const <span class="type">bool</span></h3>
<p>This property holds a value indicating whether the back lid is closed. A back lid can be when a convertable laptop is closed into to tablet mode without keyboard.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>backLidClosed</b></span>() const</td></tr>
</table></div>
<p><b>See also </b><a href="qlidreading.html#qlidreading-units">QLidReading Units</a>.</p>
<!-- @@@backLidClosed -->
<!-- $$$frontLidClosed-prop$$$frontLidClosed -->
<h3 class="fn" id="frontLidClosed-prop"><a name="frontLidClosed-prop"></a><span class="name">frontLidClosed</span> : const <span class="type">bool</span></h3>
<p>This property holds a value indicating whether the front lid is closed. A front lid would be a normal laptop lid.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>frontLidClosed</b></span>() const</td></tr>
</table></div>
<p><b>See also </b><a href="qlidreading.html#qlidreading-units">QLidReading Units</a>.</p>
<!-- @@@frontLidClosed -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QLidReading[overload1]$$$QLidReadingQObject* -->
<h3 class="fn" id="QLidReading"><a name="QLidReading"></a>QLidReading::<span class="name">QLidReading</span>(<span class="type"><a href="../qtcore/qobject.html#QObject">QObject</a></span> *<i>parent</i> = DECLARE_READING(QLidReading))</h3>
<p>Default constructs an instance of QLidReading.</p><!-- @@@QLidReading -->
<!-- $$$~QLidReading[overload1]$$$~QLidReading -->
<h3 class="fn" id="dtor.QLidReading"><a name="dtor.QLidReading"></a><code>[virtual] </code>QLidReading::<span class="name">~QLidReading</span>()</h3>
<p>Destroys the instance of QLidReading. The destructor is virtual.</p><!-- @@@~QLidReading -->
<!-- $$$backLidChanged[overload1]$$$backLidChangedbool -->
<h3 class="fn" id="backLidChanged"><a name="backLidChanged"></a><code>[signal] </code><span class="type">void</span> QLidReading::<span class="name">backLidChanged</span>(<span class="type">bool</span> <i>closed</i>)</h3>
<!-- @@@backLidChanged -->
<!-- $$$copyValuesFrom[overload1]$$$copyValuesFromQSensorReading* -->
<h3 class="fn" id="copyValuesFrom"><a name="copyValuesFrom"></a><code>[override virtual] </code><span class="type">void</span> QLidReading::<span class="name">copyValuesFrom</span>(<span class="type">QSensorReading</span> *<i>other</i>)</h3>
<!-- @@@copyValuesFrom -->
<!-- $$$frontLidChanged[overload1]$$$frontLidChangedbool -->
<h3 class="fn" id="frontLidChanged"><a name="frontLidChanged"></a><code>[signal] </code><span class="type">void</span> QLidReading::<span class="name">frontLidChanged</span>(<span class="type">bool</span> <i>closed</i>)</h3>
<!-- @@@frontLidChanged -->
<!-- $$$setBackLidClosed[overload1]$$$setBackLidClosedbool -->
<h3 class="fn" id="setBackLidClosed"><a name="setBackLidClosed"></a><span class="type">void</span> QLidReading::<span class="name">setBackLidClosed</span>(<span class="type">bool</span> <i>closed</i>)</h3>
<p>Sets the <a href="qlidreading.html#backLidClosed-prop">backLidClosed</a> value to <i>closed</i>.</p>
<p><b>See also </b><a href="qlidreading.html#backLidClosed-prop">backLidClosed</a>().</p>
<!-- @@@setBackLidClosed -->
<!-- $$$setFrontLidClosed[overload1]$$$setFrontLidClosedbool -->
<h3 class="fn" id="setFrontLidClosed"><a name="setFrontLidClosed"></a><span class="type">void</span> QLidReading::<span class="name">setFrontLidClosed</span>(<span class="type">bool</span> <i>closed</i>)</h3>
<p>Sets the <a href="qlidreading.html#frontLidClosed-prop">frontLidClosed</a> value to <i>closed</i>.</p>
<p><b>See also </b><a href="qlidreading.html#frontLidClosed-prop">frontLidClosed</a>().</p>
<!-- @@@setFrontLidClosed -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2018 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>