/usr/share/qt5/doc/qtnfc/qml-qtnfc-nearfield.html is in qtconnectivity5-doc-html 5.5.1-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdeclarativenearfield.cpp -->
<title>NearField QML Type | Qt NFC 5.5</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.5</li>
<li><a href="qtnfc-index.html">Qt NFC</a></li>
<li><a href="qtnfc-qmlmodule.html">QML Types</a></li>
<li>NearField QML Type</li>
<li id="buildversion">Qt 5.5.1 Reference Documentation</li>
</ul>
</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="#signals">Signals</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">NearField QML Type</h1>
<span class="subtitle"></span>
<!-- $$$NearField-brief -->
<p>Provides access to NDEF messages stored on NFC Forum tags. <a href="#details">More...</a></p>
<!-- @@@NearField -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtNfc 5.2</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.2</td></tr></table></div><ul>
<li><a href="qml-qtnfc-nearfield-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><b><a href="qml-qtnfc-nearfield.html#filter-prop">filter</a></b></b> : list<NdefFilter></li>
<li class="fn"><b><b><a href="qml-qtnfc-nearfield.html#messageRecords-prop">messageRecords</a></b></b> : list<NdefRecord></li>
<li class="fn"><b><b><a href="qml-qtnfc-nearfield.html#orderMatch-prop">orderMatch</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtnfc-nearfield.html#polling-prop">polling</a></b></b> : bool</li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtnfc-nearfield.html#tagFound-signal">tagFound</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtnfc-nearfield.html#tagRemoved-signal">tagRemoved</a></b></b>()</li>
</ul>
<!-- $$$NearField-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>The <a href="qml-qtnfc-nearfield.html">NearField</a> type can be used to read NDEF messages from NFC Forum tags. Set the <a href="qml-qtnfc-nearfield.html#filter-prop">filter</a> and <a href="qml-qtnfc-nearfield.html#orderMatch-prop">orderMatch</a> properties to match the required NDEF messages. Once an NDEF message is successfully read from a tag the <a href="qml-qtnfc-nearfield.html#messageRecords-prop">messageRecords</a> property is updated.</p>
<p><b>Note: </b>For platforms using neard, filtering is currently not implemented. For more information on neard see <a href="qnearfieldmanager.html">QNearFieldManager</a>.</p><pre class="qml"> <span class="type"><a href="qml-qtnfc-nearfield.html">NearField</a></span> {
<span class="name">filter</span>: [ <span class="type"><a href="qml-qtnfc-ndeffilter.html">NdefFilter</a></span> { <span class="name">type</span>: <span class="string">"U"</span>; <span class="name">typeNameFormat</span>: <span class="name">NdefRecord</span>.<span class="name">NfcRtd</span>; <span class="name">minimum</span>: <span class="number">1</span>; <span class="name">maximum</span>: <span class="number">1</span> } ]
<span class="name">orderMatch</span>: <span class="number">false</span>
<span class="name">onMessageRecordsChanged</span>: <span class="name">displayMessage</span>()
}</pre>
<p><b>See also </b><a href="qml-qtnfc-ndeffilter.html">NdefFilter</a>, <a href="qml-qtnfc-ndefrecord.html">NdefRecord</a>, <a href="qnearfieldmanager.html">QNearFieldManager</a>, <a href="qndefmessage.html">QNdefMessage</a>, and <a href="qndefrecord.html">QNdefRecord</a>.</p>
<!-- @@@NearField -->
<h2>Property Documentation</h2>
<!-- $$$filter -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="filter-prop"><td class="tblQmlPropNode"><p><a name="filter-prop"></a><span class="name">filter</span> : <span class="type">list</span><<span class="type"><a href="qml-qtnfc-ndeffilter.html">NdefFilter</a></span>></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds the NDEF filter constraints. The <a href="qml-qtnfc-nearfield.html#messageRecords-prop">messageRecords</a> property will only be set to NDEF messages which match the filter. If no filter is set, a message handler for all NDEF messages will be registered.</p>
<p><b>Note: </b>Filtering is not supported when using neard.</p><p><a href="qnearfieldmanager.html#registerNdefMessageHandler">QNearFieldManager::registerNdefMessageHandler()</a></p>
</div></div><!-- @@@filter -->
<br/>
<!-- $$$messageRecords -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="messageRecords-prop"><td class="tblQmlPropNode"><p><a name="messageRecords-prop"></a><span class="name">messageRecords</span> : <span class="type">list</span><<span class="type"><a href="qml-qtnfc-ndefrecord.html">NdefRecord</a></span>></p></td></tr></table></div></div><div class="qmldoc"><p>This property contains the list of NDEF records in the last NDEF message read.</p>
</div></div><!-- @@@messageRecords -->
<br/>
<!-- $$$orderMatch -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="orderMatch-prop"><td class="tblQmlPropNode"><p><a name="orderMatch-prop"></a><span class="name">orderMatch</span> : <span class="type">bool</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property indicates whether the order of records should be taken into account when matching messages. This is not supported when using neard.</p>
</div></div><!-- @@@orderMatch -->
<br/>
<!-- $$$polling -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="polling-prop"><td class="tblQmlPropNode"><p><a name="polling-prop"></a><span class="name">polling</span> : <span class="type">bool</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property indicates if the underlying adapter is currently in polling state. If set to <code>true</code> the adapter will start polling and stop polling if set to <code>false</code>.</p>
<p><b>Note: </b>On platforms using neard, the adapter will stop polling as soon as a tag has been detected. For more information see <a href="qnearfieldmanager.html">QNearFieldManager</a>.</p><p>This QML property was introduced in Qt 5.5.</p>
</div></div><!-- @@@polling -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$tagFound -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="tagFound-signal"><td class="tblQmlFuncNode"><p><a name="tagFound-signal"></a><span class="name">tagFound</span>()</p></td></tr></table></div></div><div class="qmldoc"><p>This signal will be emitted when a tag has been detected.</p>
<p>This QML signal was introduced in Qt 5.5.</p>
</div></div><!-- @@@tagFound -->
<br/>
<!-- $$$tagRemoved -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="tagRemoved-signal"><td class="tblQmlFuncNode"><p><a name="tagRemoved-signal"></a><span class="name">tagRemoved</span>()</p></td></tr></table></div></div><div class="qmldoc"><p>This signal will be emitted when a tag has been removed.</p>
<p>This QML signal was introduced in Qt 5.5.</p>
</div></div><!-- @@@tagRemoved -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 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>
|