1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtNfc module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QNEARFIELDMANAGER_H
41#define QNEARFIELDMANAGER_H
42
43#include <QtCore/QObject>
44#include <QtNfc/qtnfcglobal.h>
45#include <QtNfc/QNearFieldTarget>
46#include <QtNfc/QNdefRecord>
47#include <QtNfc/QNdefFilter>
48
49QT_BEGIN_NAMESPACE
50
51class QNearFieldManagerPrivate;
52class Q_NFC_EXPORT QNearFieldManager : public QObject
53{
54 Q_OBJECT
55
56 Q_DECLARE_PRIVATE(QNearFieldManager)
57
58public:
59 enum class AdapterState {
60 Offline = 1,
61 TurningOn = 2,
62 Online = 3,
63 TurningOff = 4
64 };
65 Q_ENUM(AdapterState)
66 enum TargetAccessMode {
67 NoTargetAccess = 0x00,
68 NdefReadTargetAccess = 0x01,
69 NdefWriteTargetAccess = 0x02,
70 TagTypeSpecificTargetAccess = 0x04
71 };
72 Q_ENUM(TargetAccessMode)
73 Q_DECLARE_FLAGS(TargetAccessModes, TargetAccessMode)
74
75 explicit QNearFieldManager(QObject *parent = nullptr);
76 explicit QNearFieldManager(QNearFieldManagerPrivate *backend, QObject *parent = nullptr);
77 ~QNearFieldManager();
78
79 bool isAvailable() const;
80 bool isSupported() const;
81
82 void setTargetAccessModes(TargetAccessModes accessModes);
83 TargetAccessModes targetAccessModes() const;
84
85 bool startTargetDetection();
86 void stopTargetDetection();
87
88 //TODO Qt 6 Consider removal of this registration mechanism
89 //None of the currently supported platforms supports the feature
90 //or in fact the implementation (on Android) is not what the
91 //function is supposed to do.
92 int registerNdefMessageHandler(QObject *object, const char *method);
93 int registerNdefMessageHandler(QNdefRecord::TypeNameFormat typeNameFormat,
94 const QByteArray &type,
95 QObject *object, const char *method);
96 int registerNdefMessageHandler(const QNdefFilter &filter,
97 QObject *object, const char *method);
98
99 bool unregisterNdefMessageHandler(int handlerId);
100
101Q_SIGNALS:
102 void adapterStateChanged(QNearFieldManager::AdapterState state);
103 void targetDetected(QNearFieldTarget *target);
104 void targetLost(QNearFieldTarget *target);
105
106private:
107 QNearFieldManagerPrivate *d_ptr;
108};
109
110Q_DECLARE_OPERATORS_FOR_FLAGS(QNearFieldManager::TargetAccessModes)
111
112QT_END_NAMESPACE
113
114#endif // QNEARFIELDMANAGER_H
115

source code of qtconnectivity/src/nfc/qnearfieldmanager.h