summaryrefslogtreecommitdiffstats
path: root/examples/nfc/poster/doc/src/poster.qdoc
blob: 26320f5698798a05c67758d669a5c533f5a1ce2a (plain)
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
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt local connectivty modules.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
\example poster
\title QML Poster Example
\brief A QML example about reading and displaying NFC Data Exchange Format (NDEF) messages.

The QML Poster example displays the contents of specifically formatted NFC Data
Exchange Format (NDEF) messages read from an NFC Tag. The NDEF message must
contain a URI record, an optional \c image/* MIME record, and one or more
localized Text records.

\image qml-poster-example.png

\include examples-run.qdocinc

\section1 Applying NDEF Filters

The example is designed to display the content of a very specific type of NFC tag.
The tag must contain at least one URI record and one text record. If those two
record types do not exist, nothing will happen. Such filtering is applied via the
\l NearField type's filter property. The property accepts a list of \l NdefFilter objects.

\snippet poster/poster.qml QML NDEF filtering

\section1 Processing Found NDEF Messages

Once an appropriate tag is found, the \l NearField::messageRecords property reflects the content.
It transports the list of found NDEF records. The QML snippet below
demonstrates how these records can be accessed:

\snippet poster/poster.qml messageRecordsChanged 1
\snippet poster/poster.qml messageRecordsChanged 2
\snippet poster/poster.qml messageRecordsChanged 3

\sa {Qt NFC}
*/