summaryrefslogtreecommitdiffstats
path: root/src/nfc/qnearfieldsharetarget.cpp
diff options
context:
space:
mode:
authorStuart Burge <sburge@blackberry.com>2013-12-18 16:38:09 -0500
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-02-13 06:16:22 +0100
commitdd75b1f776695006ca96fd43f995c3ba0549b968 (patch)
tree9fa3e6180b13d7518e8de26f8a6fa2f210f19db1 /src/nfc/qnearfieldsharetarget.cpp
parent0a9b6759caf2f7c3d5101d541ff01ccaf14050ae (diff)
Add support for NFC file and data sharing
Provide ability to allow NFC enabled devices to exchange file and data content using a high-level API. [ChangeLog][QtNfc][General] A new NFC share API was added. The API provides sharing of NDEF messages and arbitrary files via NFC and may potentially use other communication protocols such as wifi or Bluetooth as part of its implementation. Change-Id: I878df1702ce4164384096d00e53dcd354d1bfafc Reviewed-by: Alex Blasche <alexander.blasche@digia.com> Reviewed-by: Fabian Bumberger <fbumberger@rim.com>
Diffstat (limited to 'src/nfc/qnearfieldsharetarget.cpp')
-rw-r--r--src/nfc/qnearfieldsharetarget.cpp151
1 files changed, 151 insertions, 0 deletions
diff --git a/src/nfc/qnearfieldsharetarget.cpp b/src/nfc/qnearfieldsharetarget.cpp
new file mode 100644
index 00000000..9ac66c5c
--- /dev/null
+++ b/src/nfc/qnearfieldsharetarget.cpp
@@ -0,0 +1,151 @@
+/***************************************************************************
+ **
+ ** Copyright (C) 2013 BlackBerry Limited. All rights reserved.
+ ** Contact: http://www.qt-project.org/legal
+ **
+ ** This file is part of the QtNfc module of the Qt Toolkit.
+ **
+ ** $QT_BEGIN_LICENSE:LGPL$
+ ** 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 Digia. For licensing terms and
+ ** conditions see http://qt.digia.com/licensing. For further information
+ ** use the contact form at http://qt.digia.com/contact-us.
+ **
+ ** GNU Lesser General Public License Usage
+ ** Alternatively, this file may be used under the terms of the GNU Lesser
+ ** General Public License version 2.1 as published by the Free Software
+ ** Foundation and appearing in the file LICENSE.LGPL included in the
+ ** packaging of this file. Please review the following information to
+ ** ensure the GNU Lesser General Public License version 2.1 requirements
+ ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+ **
+ ** In addition, as a special exception, Digia gives you certain additional
+ ** rights. These rights are described in the Digia Qt LGPL Exception
+ ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+ **
+ ** GNU General Public License Usage
+ ** Alternatively, this file may be used under the terms of the GNU
+ ** General Public License version 3.0 as published by the Free Software
+ ** Foundation and appearing in the file LICENSE.GPL included in the
+ ** packaging of this file. Please review the following information to
+ ** ensure the GNU General Public License version 3.0 requirements will be
+ ** met: http://www.gnu.org/copyleft/gpl.html.
+ **
+ **
+ ** $QT_END_LICENSE$
+ **
+ ****************************************************************************/
+
+#include "qnearfieldsharetarget.h"
+#include "qnearfieldsharetarget_p.h"
+
+#if defined(QNX_NFC)
+#include "qnearfieldsharetarget_qnx_p.h"
+#else
+#include "qnearfieldsharetargetimpl_p.h"
+#endif
+
+#include "qnearfieldsharemanager.h"
+
+QT_BEGIN_NAMESPACE
+
+/*!
+ \class QNearFieldShareTarget
+ \brief The QNearFieldShareTarget class transfers data to remote device over NFC.
+
+ \ingroup connectivity-nfc
+ \inmodule QtNfc
+
+ The QNearFieldShareTarget class can be used for sharing NDEF message or files to a remote
+ NFC enabled device supporting the same protocol.
+*/
+
+/*!
+ \fn void QNearFieldShareTarget::error(QNearFieldShareManager::ShareError error)
+
+ This signal is emitted whenever an \a error occurs during transfer.
+*/
+
+/*!
+ \fn void QNearFieldShareTarget::shareFinished()
+
+ This signal is emitted whenever a data or file transfer has completed successfully.
+*/
+
+/*!
+ Constructs a new near field share target with \a parent.
+*/
+QNearFieldShareTarget::QNearFieldShareTarget(QNearFieldShareManager::ShareModes modes, QObject *parent)
+: QObject(parent), d_ptr(new QNearFieldShareTargetPrivateImpl(modes, this))
+{
+}
+
+/*!
+ Destroys the near field share target.
+*/
+QNearFieldShareTarget::~QNearFieldShareTarget()
+{
+}
+
+/*!
+ Returns the share mode supported by the share target.
+*/
+QNearFieldShareManager::ShareModes QNearFieldShareTarget::shareModes() const
+{
+ Q_D(const QNearFieldShareTarget);
+ return d->shareModes();
+}
+
+/*!
+ Share the NDEF \a message via the share target. This method starts sharing asynchronously and returns immediately.
+ The method returns true if the request is accepted, otherwise returns false. Sharing is completed when the shareFinished()
+ signal is emitted.
+*/
+bool QNearFieldShareTarget::share(const QNdefMessage &message)
+{
+ Q_D(QNearFieldShareTarget);
+ return d->share(message);
+}
+
+/*!
+ Share the \a files via the share target. This method starts sharing asynchronously and returns immediately.
+ The method returns true if the request is accepted, otherwise returns false. Sharing is completed when the shareFinished()
+ signal is emitted.
+*/
+bool QNearFieldShareTarget::share(const QList<QFileInfo> &files)
+{
+ Q_D(QNearFieldShareTarget);
+ return d->share(files);
+}
+
+/*!
+ Cancel the data or file sharing in progress.
+*/
+void QNearFieldShareTarget::cancel()
+{
+ Q_D(QNearFieldShareTarget);
+ d->cancel();
+}
+
+/*!
+ Returns true if data or file sharing is in progress, otherwise returns false.
+*/
+bool QNearFieldShareTarget::isShareInProgress() const
+{
+ Q_D(const QNearFieldShareTarget);
+ return d->isShareInProgress();
+}
+
+/*!
+ Returns the error code of the error that occurred.
+ */
+QNearFieldShareManager::ShareError QNearFieldShareTarget::shareError() const
+{
+ Q_D(const QNearFieldShareTarget);
+ return d->shareError();
+}
+
+QT_END_NAMESPACE