summaryrefslogtreecommitdiffstats
path: root/src/nfc/qnearfieldsharetarget.cpp
blob: 606090b597e871a42c44e048032b6ff65b005536 (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
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/***************************************************************************
 **
 ** 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
    \since 5.3

    The QNearFieldShareTarget class can be used for sharing NDEF message or files to a remote
    NFC enabled device supporting the same protocol.

    \sa QNearFieldShareManager
*/

/*!
    \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