diff --git a/lang/qt/src/gpgcardjob.h b/lang/qt/src/gpgcardjob.h index 63f5cf7c..3f1b2391 100644 --- a/lang/qt/src/gpgcardjob.h +++ b/lang/qt/src/gpgcardjob.h @@ -1,92 +1,74 @@ /* gpgcardjob.h This file is part of qgpgme, the Qt API binding for gpgme Copyright (c) 2020 g10 Code 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_GPGCARDJOB_H__ #define __KLEO_GPGCARDJOB_H__ #include #include "job.h" namespace GpgME { class Error; } namespace QGpgME { -/** - @short Get the best key to use for a Mailbox - - To use the keyformailboxjob, first obtain an instance from the - CryptoBackend and either exec it or start and - conncet the result() signals to a suitable slot. - The job will be automatically deleted in which - case the KeylistJob instance will have schedules it's own - destruction with a call to QObject::deleteLater(). - - The best key is defined as the key with a UID that has an - E-Mail that matches the mailbox provided. If multiple - keys are found the one with the highest validity is returned. - - After result() is emitted, the - KeyListJob will schedule it's own destruction by calling - QObject::deleteLater(). -*/ class QGPGME_EXPORT GpgCardJob: public Job { Q_OBJECT protected: explicit GpgCardJob(QObject *parent); public: ~GpgCardJob(); /** Starts the operation. \a cmds are the commands to execute. */ virtual GpgME::Error start(const QStringList &cmds) = 0; virtual GpgME::Error exec(const QStringList &cmds, QString &std_out, QString &std_err, int &exitCode) = 0; Q_SIGNALS: /** The resulting stdout and stderr of gpgcard and the exitCode * * The auditlog params are always null / empty. */ void result(const QString &std_out, const QString &std_err, int exitCode, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error()); }; } #endif diff --git a/lang/qt/src/keyformailboxjob.h b/lang/qt/src/keyformailboxjob.h index 42d1729f..5e089074 100644 --- a/lang/qt/src/keyformailboxjob.h +++ b/lang/qt/src/keyformailboxjob.h @@ -1,107 +1,103 @@ /* keyformailboxjob.h This file is part of qgpgme, the Qt API binding for gpgme Copyright (c) 2016 by Bundesamt für Sicherheit in der Informationstechnik Software engineering by 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_KEYFORMAILBOX_H__ #define __KLEO_KEYFORMAILBOX_H__ #include #include "job.h" #ifdef BUILDING_QGPGME # include "key.h" #else # include #endif namespace GpgME { class Error; class KeyListResult; } namespace QGpgME { /** @short Get the best key to use for a Mailbox To use the keyformailboxjob, first obtain an instance from the CryptoBackend and either exec it or start and - conncet the result() signals to a suitable slot. - The job will be automatically deleted in which - case the KeylistJob instance will have schedules it's own - destruction with a call to QObject::deleteLater(). + connect the result() signal to a suitable slot. The best key is defined as the key with a UID that has an E-Mail that matches the mailbox provided. If multiple keys are found the one with the highest validity is returned. - After result() is emitted, the - KeyListJob will schedule it's own destruction by calling - QObject::deleteLater(). + After result() is emitted, the job will schedule it's own + destruction by calling QObject::deleteLater(). */ class QGPGME_EXPORT KeyForMailboxJob: public Job { Q_OBJECT protected: explicit KeyForMailboxJob(QObject *parent); public: ~KeyForMailboxJob(); /** Starts the operation. \a mailbox is the mailbox to look for. The result is the same as for the LocateKeysJob. If \a canEncrypt is true, only keys that have a subkey for encryption usage are returned. Use this if you need to select a key for signing. */ virtual GpgME::Error start(const QString &mailbox, bool canEncrypt = true) = 0; virtual GpgME::KeyListResult exec(const QString &mailbox, bool canEncrypt, GpgME::Key &key, GpgME::UserID &uid) = 0; Q_SIGNALS: /** The result. \a Key is the key found or a Null key. * * The userid is the uid where the mailbox matches. * * The auditlog params are always null / empty. */ void result(const GpgME::KeyListResult &result, const GpgME::Key &key, const GpgME::UserID &uid, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error()); }; } #endif diff --git a/lang/qt/src/keylistjob.h b/lang/qt/src/keylistjob.h index 88eac871..515a0e4d 100644 --- a/lang/qt/src/keylistjob.h +++ b/lang/qt/src/keylistjob.h @@ -1,110 +1,110 @@ /* keylistjob.h This file is part of qgpgme, the Qt API binding for gpgme Copyright (c) 2004 Klarälvdalens Datakonsult AB Copyright (c) 2016 by Bundesamt für Sicherheit in der Informationstechnik Software engineering by 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_KEYLISTJOB_H__ #define __KLEO_KEYLISTJOB_H__ #include "job.h" #include "qgpgme_export.h" #ifdef BUILDING_QGPGME # include "key.h" #else # include #endif #include namespace GpgME { class Error; class KeyListResult; } class QStringList; namespace QGpgME { /** @short An abstract base class for asynchronous key listers To use a KeyListJob, first obtain an instance from the CryptoBackend implementation, connect the nextKey(), progress() and result() signals to suitable slots and then start the key listing with a call to start(). This call might fail, in which - case the KeylistJob instance will have schedules it's own + case the KeylistJob instance will have scheduled it's own destruction with a call to QObject::deleteLater(). During keylisting, you will receive new key objects through the nextKey() signal as they arrive. After result() is emitted, the KeyListJob will schedule it's own destruction by calling QObject::deleteLater(). */ class QGPGME_EXPORT KeyListJob : public Job { Q_OBJECT protected: explicit KeyListJob(QObject *parent); public: ~KeyListJob(); /** Starts the keylist operation. \a pattern is a list of patterns used to restrict the list of keys returned. Empty patterns are ignored. If \a pattern is empty or contains only empty strings, all keys are returned (however, the backend is free to truncate the result and should do so; when this happens, it will be reported by the reult object). If \a secretOnly is true, only keys for which the secret key is also available are returned. Use this if you need to select a key for signing. */ virtual GpgME::Error start(const QStringList &patterns, bool secretOnly = false) = 0; virtual GpgME::KeyListResult exec(const QStringList &patterns, bool secretOnly, std::vector &keys) = 0; /** Add a flag to the keylistmode used. */ virtual void addMode(GpgME::KeyListMode mode) = 0; Q_SIGNALS: void nextKey(const GpgME::Key &key); void result(const GpgME::KeyListResult &result, const std::vector &keys = std::vector(), const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error()); }; } #endif // __KLEO_KEYLISTJOB_H__ diff --git a/lang/qt/src/refreshkeysjob.h b/lang/qt/src/refreshkeysjob.h index cc051fc3..92b3b8f4 100644 --- a/lang/qt/src/refreshkeysjob.h +++ b/lang/qt/src/refreshkeysjob.h @@ -1,96 +1,96 @@ /* refreshkeysjob.h This file is part of qgpgme, the Qt API binding for gpgme Copyright (c) 2004 Klarälvdalens Datakonsult AB Copyright (c) 2016 by Bundesamt für Sicherheit in der Informationstechnik Software engineering by 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_REFRESHKEYSJOB_H__ #define __KLEO_REFRESHKEYSJOB_H__ #include "job.h" #include "qgpgme_export.h" #include namespace GpgME { class Error; class Key; } class QStringList; namespace QGpgME { /** @short An abstract base class for asynchronous key refreshers. To use a RefreshKeysJob, first obtain an instance from the CryptoBackend implementation, connect the progress() and result() signals to suitable slots and then start the key refresh with a call to start(). This call might fail, in which case the RefreshKeysJob instance will have scheduled its own destruction with a call to QObject::deleteLater(). - After result() is emitted, the KeyListJob will schedule it's own + After result() is emitted, the job will schedule it's own destruction by calling QObject::deleteLater(). */ class QGPGME_EXPORT RefreshKeysJob : public Job { Q_OBJECT protected: explicit RefreshKeysJob(QObject *parent); public: ~RefreshKeysJob(); /** Starts the refresh operation. \a pattern is a list of patterns used to restrict the list of keys returned. Empty patterns are ignored. If \a pattern is empty or contains only empty strings, all keys are refreshed. Only implemented for S/MIME. */ virtual GpgME::Error start(const QStringList &patterns) = 0; /** Starts a refresh of the \a keys. */ virtual GpgME::Error start(const std::vector &keys) = 0; Q_SIGNALS: void result(const GpgME::Error &result, const QString &auditLogAsHtml = {}, const GpgME::Error &auditLogError = {}); }; } #endif // __KLEO_REFRESHKEYSJOB_H__