Qt: Add static factor methods for protocol
[gpgme.git] / lang / qt / src / encryptjob.h
1 /*
2     encryptjob.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_ENCRYPTJOB_H__
35 #define __KLEO_ENCRYPTJOB_H__
36
37 #include "job.h"
38
39 #include <boost/shared_ptr.hpp>
40
41 #include <vector>
42
43 class QByteArray;
44 class QIODevice;
45
46 namespace GpgME
47 {
48 class Error;
49 class Key;
50 class EncryptionResult;
51 }
52
53 namespace QGpgME
54 {
55
56 /**
57    @short An abstract base class for asynchronous encrypters
58
59    To use a EncryptJob, first obtain an instance from the
60    CryptoBackend implementation, connect the progress() and result()
61    signals to suitable slots and then start the encryption with a
62    call to start(). This call might fail, in which case the
63    EncryptJob instance will have scheduled it's own destruction with
64    a call to QObject::deleteLater().
65
66    After result() is emitted, the EncryptJob will schedule it's own
67    destruction by calling QObject::deleteLater().
68 */
69 class QGPGME_EXPORT EncryptJob : public Job
70 {
71     Q_OBJECT
72 protected:
73     explicit EncryptJob(QObject *parent);
74 public:
75     ~EncryptJob();
76
77     /**
78        Starts the encryption operation. \a recipients is the a list of
79        keys to encrypt \a plainText to. Empty (null) keys are
80        ignored. If \a recipients is empty, performs symmetric
81        (passphrase) encryption.
82
83        If \a alwaysTrust is true, validity checking for the keys will
84        not be performed, but full validity assumed for all keys
85        without further checks.
86     */
87     virtual QGPGME_DEPRECATED_EXPORT GpgME::Error start(const std::vector<GpgME::Key> &recipients,
88             const QByteArray &plainText, bool alwaysTrust = false) = 0;
89
90     /*!
91       \overload
92
93       If \a cipherText is non-null, the ciphertext is written
94       there. Otherwise, it will be delivered in the second argument of
95       result().
96
97       \throws GpgME::Exception if starting fails
98     */
99     virtual void start(const std::vector<GpgME::Key> &recipients,
100                        const boost::shared_ptr<QIODevice> &plainText,
101                        const boost::shared_ptr<QIODevice> &cipherText = boost::shared_ptr<QIODevice>(),
102                        bool alwaysTrust = false) = 0;
103
104     virtual GpgME::EncryptionResult exec(const std::vector<GpgME::Key> &recipients,
105                                          const QByteArray &plainText,
106                                          bool alwaysTrust, QByteArray &cipherText) = 0;
107
108     /*!
109       This is a hack to request BASE64 output (instead of whatever
110       comes out normally).
111     */
112     virtual void setOutputIsBase64Encoded(bool) = 0;
113
114 Q_SIGNALS:
115     void result(const GpgME::EncryptionResult &result, const QByteArray &cipherText, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error());
116 };
117
118 }
119
120 #endif // __KLEO_ENCRYPTJOB_H__