1 /* 2 deletejob.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 __KLEO_DELETEJOB_H__ 36 #define __KLEO_DELETEJOB_H__ 37 38 #include "qgpgme_export.h" 39 #include "job.h" 40 41 namespace GpgME 42 { 43 class Error; 44 class Key; 45 } 46 47 namespace QGpgME 48 { 49 50 /** 51 @short An abstract base class for asynchronous deleters 52 53 To use a DeleteJob, first obtain an instance from the 54 CryptoBackend implementation, connect the progress() and result() 55 signals to suitable slots and then start the delete with a call 56 to start(). This call might fail, in which case the DeleteJob 57 instance will have scheduled it's own destruction with a call to 58 QObject::deleteLater(). 59 60 After result() is emitted, the DeleteJob will schedule it's own 61 destruction by calling QObject::deleteLater(). 62 */ 63 class QGPGME_EXPORT DeleteJob : public Job 64 { 65 Q_OBJECT 66 protected: 67 explicit DeleteJob(QObject *parent); 68 public: 69 ~DeleteJob(); 70 71 /** 72 Starts the delete operation. \a key represents the key to 73 delete, \a allowSecretKeyDeletion specifies if a key may also 74 be deleted if the secret key part is available, too. 75 */ 76 virtual GpgME::Error start(const GpgME::Key &key, bool allowSecretKeyDeletion = false) = 0; 77 78 Q_SIGNALS: 79 void result(const GpgME::Error &result, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error()); 80 }; 81 82 } 83 84 #endif // __KLEO_DELETEJOB_H__ 85