lang/qt/src/exportjob.h

   1 /*
   2     exportjob.h
   3
   4     This file is part of qgpgme, the Qt API binding for gpgme
   5     Copyright (c) 2004 Klarälvdalens Datakonsult AB
   6     Copyright (c) 2016 by Bundesamt für Sicherheit in der Informationstechnik
   7     Software engineering by Intevation GmbH
   8
   9     QGpgME is free software; you can redistribute it and/or
  10     modify it under the terms of the GNU General Public License as
  11     published by the Free Software Foundation; either version 2 of the
  12     License, or (at your option) any later version.
  13
  14     QGpgME is distributed in the hope that it will be useful,
  15     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17     General Public License for more details.
  18
  19     You should have received a copy of the GNU General Public License
  20     along with this program; if not, write to the Free Software
  21     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  22
  23     In addition, as a special exception, the copyright holders give
  24     permission to link the code of this program with any edition of
  25     the Qt library by Trolltech AS, Norway (or with modified versions
  26     of Qt that use the same license as Qt), and distribute linked
  27     combinations including the two.  You must obey the GNU General
  28     Public License in all respects for all of the code used other than
  29     Qt.  If you modify this file, you may extend this exception to
  30     your version of the file, but you are not obligated to do so.  If
  31     you do not wish to do so, delete this exception statement from
  32     your version.
  33 */
  34
  35 #ifndef __QGPGME_EXPORTJOB_H__
  36 #define __QGPGME_EXPORTJOB_H__
  37
  38 #include "qgpgme_export.h"
  39 #include "job.h"
  40
  41 #include <QtCore/QByteArray>
  42
  43 namespace GpgME
  44 {
  45 class Error;
  46 }
  47
  48 class QStringList;
  49
  50 namespace QGpgME
  51 {
  52
  53 /**
  54    @short An abstract base class for asynchronous exporters
  55
  56    To use a ExportJob, first obtain an instance from the
  57    CryptoBackend implementation, connect the progress() and result()
  58    signals to suitable slots and then start the export with a call
  59    to start(). This call might fail, in which case the ExportJob
  60    instance will have scheduled it's own destruction with a call to
  61    QObject::deleteLater().
  62
  63    After result() is emitted, the ExportJob will schedule it's own
  64    destruction by calling QObject::deleteLater().
  65 */
  66 class QGPGME_EXPORT ExportJob : public Job
  67 {
  68     Q_OBJECT
  69 protected:
  70     explicit ExportJob(QObject *parent);
  71 public:
  72     ~ExportJob();
  73
  74     /**
  75        Starts the export operation. \a patterns is a list of patterns
  76        used to restrict the list of keys exported. Empty patterns are
  77        ignored. If \a patterns is empty or contains only empty
  78        strings, all available keys are exported.
  79     */
  80     virtual GpgME::Error start(const QStringList &patterns) = 0;
  81
  82     virtual void setExportFlags (unsigned int flags);
  83
  84 Q_SIGNALS:
  85     void result(const GpgME::Error &result, const QByteArray &keyData, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error());
  86 };
  87
  88 }
  89
  90 #endif // __QGPGME_EXPORTJOB_H__