diff options
| author | Andre Heinecke <[email protected]> | 2016-05-10 14:43:36 +0000 | 
|---|---|---|
| committer | Andre Heinecke <[email protected]> | 2016-05-10 14:43:36 +0000 | 
| commit | 34e5c5b33de3608bedc2826be27a06e6eec0ea44 (patch) | |
| tree | b04ce687c5dcb72d84af230e05335da0213bf6de /lang/qt/src/encryptjob.h | |
| parent | Allow cc to detect missing cases in a switch. (diff) | |
| parent | Qt / Cpp: Fix make dist (diff) | |
| download | gpgme-34e5c5b33de3608bedc2826be27a06e6eec0ea44.tar.gz gpgme-34e5c5b33de3608bedc2826be27a06e6eec0ea44.zip | |
Merge branch 'gpgmepp'
Diffstat (limited to 'lang/qt/src/encryptjob.h')
| -rw-r--r-- | lang/qt/src/encryptjob.h | 119 | 
1 files changed, 119 insertions, 0 deletions
| diff --git a/lang/qt/src/encryptjob.h b/lang/qt/src/encryptjob.h new file mode 100644 index 00000000..060ff8df --- /dev/null +++ b/lang/qt/src/encryptjob.h @@ -0,0 +1,119 @@ +/* +    encryptjob.h + +    This file is part of qgpgme, the Qt API binding for gpgme +    Copyright (c) 2004, 2007 Klarälvdalens Datakonsult AB +    Copyright (c) 2016 Intevation GmbH + +    QGpgME is free software; you can redistribute it and/or +    modify it under the terms of the GNU General Public License as +    published by the Free Software Foundation; either version 2 of the +    License, or (at your option) any later version. + +    QGpgME is distributed in the hope that it will be useful, +    but WITHOUT ANY WARRANTY; without even the implied warranty of +    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU +    General Public License for more details. + +    You should have received a copy of the GNU General Public License +    along with this program; if not, write to the Free Software +    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA + +    In addition, as a special exception, the copyright holders give +    permission to link the code of this program with any edition of +    the Qt library by Trolltech AS, Norway (or with modified versions +    of Qt that use the same license as Qt), and distribute linked +    combinations including the two.  You must obey the GNU General +    Public License in all respects for all of the code used other than +    Qt.  If you modify this file, you may extend this exception to +    your version of the file, but you are not obligated to do so.  If +    you do not wish to do so, delete this exception statement from +    your version. +*/ + +#ifndef __KLEO_ENCRYPTJOB_H__ +#define __KLEO_ENCRYPTJOB_H__ + +#include "job.h" + +#include <memory> +#include <vector> + +class QByteArray; +class QIODevice; + +namespace GpgME +{ +class Error; +class Key; +class EncryptionResult; +} + +namespace QGpgME +{ + +/** +   @short An abstract base class for asynchronous encrypters + +   To use a EncryptJob, first obtain an instance from the +   CryptoBackend implementation, connect the progress() and result() +   signals to suitable slots and then start the encryption with a +   call to start(). This call might fail, in which case the +   EncryptJob instance will have scheduled it's own destruction with +   a call to QObject::deleteLater(). + +   After result() is emitted, the EncryptJob will schedule it's own +   destruction by calling QObject::deleteLater(). +*/ +class QGPGME_EXPORT EncryptJob : public Job +{ +    Q_OBJECT +protected: +    explicit EncryptJob(QObject *parent); +public: +    ~EncryptJob(); + +    /** +       Starts the encryption operation. \a recipients is the a list of +       keys to encrypt \a plainText to. Empty (null) keys are +       ignored. If \a recipients is empty, performs symmetric +       (passphrase) encryption. + +       If \a alwaysTrust is true, validity checking for the keys will +       not be performed, but full validity assumed for all keys +       without further checks. +    */ +    virtual QGPGME_DEPRECATED_EXPORT GpgME::Error start(const std::vector<GpgME::Key> &recipients, +            const QByteArray &plainText, bool alwaysTrust = false) = 0; + +    /*! +      \overload + +      If \a cipherText is non-null, the ciphertext is written +      there. Otherwise, it will be delivered in the second argument of +      result(). + +      \throws GpgME::Exception if starting fails +    */ +    virtual void start(const std::vector<GpgME::Key> &recipients, +                       const std::shared_ptr<QIODevice> &plainText, +                       const std::shared_ptr<QIODevice> &cipherText = std::shared_ptr<QIODevice>(), +                       bool alwaysTrust = false) = 0; + +    virtual GpgME::EncryptionResult exec(const std::vector<GpgME::Key> &recipients, +                                         const QByteArray &plainText, +                                         bool alwaysTrust, QByteArray &cipherText) = 0; + +    /*! +      This is a hack to request BASE64 output (instead of whatever +      comes out normally). +    */ +    virtual void setOutputIsBase64Encoded(bool) = 0; + +Q_SIGNALS: +    void result(const GpgME::EncryptionResult &result, const QByteArray &cipherText, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error()); +}; + +} + +#endif // __KLEO_ENCRYPTJOB_H__ | 
