aboutsummaryrefslogtreecommitdiffstats
path: root/lang/qt/src/signencryptjob.h
diff options
context:
space:
mode:
Diffstat (limited to 'lang/qt/src/signencryptjob.h')
-rw-r--r--lang/qt/src/signencryptjob.h63
1 files changed, 62 insertions, 1 deletions
diff --git a/lang/qt/src/signencryptjob.h b/lang/qt/src/signencryptjob.h
index ebb866d1..54f4aa53 100644
--- a/lang/qt/src/signencryptjob.h
+++ b/lang/qt/src/signencryptjob.h
@@ -76,6 +76,15 @@ namespace QGpgME
SignEncryptJob instance will have scheduled it's own destruction
with a call to QObject::deleteLater().
+ Alternatively, the job can be started with startIt() after setting
+ an input file and an output file and, optionally, signers, recipients or flags.
+ If the job is started this way then the backend reads the input and
+ writes the output directly from/to the specified input file and output
+ file. In this case the cipherText value of the result signal will always
+ be empty. This direct IO mode is currently only supported for OpenPGP.
+ Note that startIt() does not schedule the job's destruction if starting
+ the job failed.
+
After result() is emitted, the SignEncryptJob will schedule it's
own destruction by calling QObject::deleteLater().
*/
@@ -85,12 +94,64 @@ class QGPGME_EXPORT SignEncryptJob : public Job
protected:
explicit SignEncryptJob(QObject *parent);
public:
- ~SignEncryptJob();
+ ~SignEncryptJob() override;
+ /**
+ * Sets the file name to embed in the encryption result.
+ *
+ * This is only used if one of the start() functions is used.
+ */
void setFileName(const QString &fileName);
QString fileName() const;
/**
+ * Sets the keys to use for signing.
+ *
+ * Used if the job is started with startIt().
+ */
+ void setSigners(const std::vector<GpgME::Key> &signers);
+ std::vector<GpgME::Key> signers() const;
+
+ /**
+ * Sets the keys to use for encryption.
+ *
+ * Used if the job is started with startIt().
+ */
+ void setRecipients(const std::vector<GpgME::Key> &recipients);
+ std::vector<GpgME::Key> recipients() const;
+
+ /**
+ * Sets the path of the file to encrypt.
+ *
+ * Used if the job is started with startIt().
+ */
+ void setInputFile(const QString &path);
+ QString inputFile() const;
+
+ /**
+ * Sets the path of the file to write the encryption result to.
+ *
+ * Used if the job is started with startIt().
+ *
+ * \note If a file with this path exists, then the job will fail, i.e. you
+ * need to delete an existing file that shall be overwritten before you
+ * start the job.
+ */
+ void setOutputFile(const QString &path);
+ QString outputFile() const;
+
+ /**
+ * Sets the flags to use for encryption.
+ *
+ * Defaults to \c EncryptFile.
+ *
+ * Used if the job is started with startIt(). The \c EncryptFile flag is
+ * always assumed set.
+ */
+ void setEncryptionFlags(GpgME::Context::EncryptionFlags flags);
+ GpgME::Context::EncryptionFlags encryptionFlags() const;
+
+ /**
Starts the combined signing and encrypting operation. \a signers
is the list of keys to sign \a plainText with. \a recipients is
a list of keys to encrypt the signed \a plainText to. In both