fc51a202b2ffdfa8de5375e4ff9ec652c70bb04d
[gpgme.git] / lang / qt / src / decryptverifyjob.h
1 /*
2     decryptverifyjob.h
3
4     This file is part of qgpgme, the Qt API binding for gpgme
5     Copyright (c) 2004, 2007 Klarälvdalens Datakonsult AB
6     Copyright (c) 2016 Intevation GmbH
7
8     Libkleopatra is free software; you can redistribute it and/or
9     modify it under the terms of the GNU General Public License as
10     published by the Free Software Foundation; either version 2 of the
11     License, or (at your option) any later version.
12
13     Libkleopatra is distributed in the hope that it will be useful,
14     but WITHOUT ANY WARRANTY; without even the implied warranty of
15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16     General Public License for more details.
17
18     You should have received a copy of the GNU General Public License
19     along with this program; if not, write to the Free Software
20     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21
22     In addition, as a special exception, the copyright holders give
23     permission to link the code of this program with any edition of
24     the Qt library by Trolltech AS, Norway (or with modified versions
25     of Qt that use the same license as Qt), and distribute linked
26     combinations including the two.  You must obey the GNU General
27     Public License in all respects for all of the code used other than
28     Qt.  If you modify this file, you may extend this exception to
29     your version of the file, but you are not obligated to do so.  If
30     you do not wish to do so, delete this exception statement from
31     your version.
32 */
33
34 #ifndef __KLEO_DECRYPTVERIFYJOB_H__
35 #define __KLEO_DECRYPTVERIFYJOB_H__
36
37 #include "job.h"
38
39 #include <boost/shared_ptr.hpp>
40
41 class QByteArray;
42 class QIODevice;
43
44 namespace GpgME
45 {
46 class Error;
47 class DecryptionResult;
48 class VerificationResult;
49 }
50
51 namespace QGpgME
52 {
53
54 /**
55    @short An abstract base class for asynchronous combined decrypters and verifiers
56
57    To use a DecryptVerifyJob, first obtain an instance from the
58    CryptoBackend implementation, connect the progress() and result()
59    signals to suitable slots and then start the operation with a
60    call to start(). This call might fail, in which case the
61    DecryptVerifyJob instance will have scheduled it's own destruction with
62    a call to QObject::deleteLater().
63
64    After result() is emitted, the DecryptVerifyJob will schedule it's own
65    destruction by calling QObject::deleteLater().
66 */
67 class QGPGME_EXPORT DecryptVerifyJob : public Job
68 {
69     Q_OBJECT
70 protected:
71     explicit DecryptVerifyJob(QObject *parent);
72 public:
73     ~DecryptVerifyJob();
74
75     /**
76        Starts the combined decryption and verification operation.
77        \a cipherText is the data to decrypt and later verify.
78     */
79     virtual QGPGME_DEPRECATED_EXPORT GpgME::Error start(const QByteArray &cipherText) = 0;
80
81     /*!
82       \overload
83
84       If \a plainText is non-null, the plaintext is written
85       there. Otherwise, it will be delivered in the third argument
86       of result().
87
88       \throws GpgME::Exception if starting fails
89     */
90     virtual void start(const boost::shared_ptr<QIODevice> &cipherText, const boost::shared_ptr<QIODevice> &plainText = boost::shared_ptr<QIODevice>()) = 0;
91
92     /** Synchronous equivalent of start() */
93     virtual std::pair<GpgME::DecryptionResult, GpgME::VerificationResult>
94     exec(const QByteArray &cipherText, QByteArray &plainText) = 0;
95
96 Q_SIGNALS:
97     void result(const GpgME::DecryptionResult &decryptionresult,
98                 const GpgME::VerificationResult &verificationresult,
99                 const QByteArray &plainText, const QString &auditLogAsHtml = QString(),
100                 const GpgME::Error &auditLogError = GpgME::Error());
101 };
102
103 }
104
105 #endif // __KLEO_DECRYPTVERIFYJOB_H__