1 /***************************************************************************
2 **
3 ** Copyright (C) 2016 BlackBerry Limited. All rights reserved.
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 #include "qnearfieldsharetarget.h"
41 #include "qnearfieldsharetarget_p.h"
42
43 #include "qnearfieldsharetargetimpl_p.h"
44
45 #include "qnearfieldsharemanager.h"
46
47 QT_BEGIN_NAMESPACE
48
49 /*!
50 \class QNearFieldShareTarget
51 \brief The QNearFieldShareTarget class transfers data to remote device over NFC.
52
53 \ingroup connectivity-nfc
54 \inmodule QtNfc
55 \since 5.3
56
57 The QNearFieldShareTarget class can be used for sharing NDEF message or files to a remote
58 NFC enabled device supporting the same protocol.
59
60 \sa QNearFieldShareManager
61 */
62
63 /*!
64 \fn void QNearFieldShareTarget::error(QNearFieldShareManager::ShareError error)
65
66 This signal is emitted whenever an \a error occurs during transfer.
67 */
68
69 /*!
70 \fn void QNearFieldShareTarget::shareFinished()
71
72 This signal is emitted whenever a data or file transfer has completed successfully.
73 */
74
75 /*!
76 Constructs a new near field share target with \a parent.
77 */
QNearFieldShareTarget(QNearFieldShareManager::ShareModes modes,QObject * parent)78 QNearFieldShareTarget::QNearFieldShareTarget(QNearFieldShareManager::ShareModes modes, QObject *parent)
79 : QObject(parent), d_ptr(new QNearFieldShareTargetPrivateImpl(modes, this))
80 {
81 }
82
83 /*!
84 Destroys the near field share target.
85 */
~QNearFieldShareTarget()86 QNearFieldShareTarget::~QNearFieldShareTarget()
87 {
88 }
89
90 /*!
91 Returns the share mode supported by the share target.
92 */
shareModes() const93 QNearFieldShareManager::ShareModes QNearFieldShareTarget::shareModes() const
94 {
95 Q_D(const QNearFieldShareTarget);
96 return d->shareModes();
97 }
98
99 /*!
100 Share the NDEF \a message via the share target. This method starts sharing asynchronously and returns immediately.
101 The method returns true if the request is accepted, otherwise returns false. Sharing is completed when the shareFinished()
102 signal is emitted.
103 */
share(const QNdefMessage & message)104 bool QNearFieldShareTarget::share(const QNdefMessage &message)
105 {
106 Q_D(QNearFieldShareTarget);
107 return d->share(message);
108 }
109
110 /*!
111 Share the \a files via the share target. This method starts sharing asynchronously and returns immediately.
112 The method returns true if the request is accepted, otherwise returns false. Sharing is completed when the shareFinished()
113 signal is emitted.
114 */
share(const QList<QFileInfo> & files)115 bool QNearFieldShareTarget::share(const QList<QFileInfo> &files)
116 {
117 Q_D(QNearFieldShareTarget);
118 return d->share(files);
119 }
120
121 /*!
122 Cancel the data or file sharing in progress.
123 */
cancel()124 void QNearFieldShareTarget::cancel()
125 {
126 Q_D(QNearFieldShareTarget);
127 d->cancel();
128 }
129
130 /*!
131 Returns true if data or file sharing is in progress, otherwise returns false.
132 */
isShareInProgress() const133 bool QNearFieldShareTarget::isShareInProgress() const
134 {
135 Q_D(const QNearFieldShareTarget);
136 return d->isShareInProgress();
137 }
138
139 /*!
140 Returns the error code of the error that occurred.
141 */
shareError() const142 QNearFieldShareManager::ShareError QNearFieldShareTarget::shareError() const
143 {
144 Q_D(const QNearFieldShareTarget);
145 return d->shareError();
146 }
147
148 QT_END_NAMESPACE
149