GpgFrontend-Doxygen/docs/latex/classGpgFrontend_1_1KeyPackageOperator.tex

166 lines
8.6 KiB
TeX
Raw Normal View History

2022-05-08 19:59:26 +00:00
\hypertarget{classGpgFrontend_1_1KeyPackageOperator}{}\doxysection{Gpg\+Frontend\+::Key\+Package\+Operator Class Reference}
\label{classGpgFrontend_1_1KeyPackageOperator}\index{GpgFrontend::KeyPackageOperator@{GpgFrontend::KeyPackageOperator}}
give the possibility to import or export a key package
{\ttfamily \#include $<$Key\+Package\+Operator.\+h$>$}
Collaboration diagram for Gpg\+Frontend\+::Key\+Package\+Operator\+:
2022-05-08 22:01:23 +00:00
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=265pt]{classGpgFrontend_1_1KeyPackageOperator__coll__graph}
\end{center}
\end{figure}
2022-05-08 19:59:26 +00:00
\doxysubsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item
static auto \mbox{\hyperlink{classGpgFrontend_1_1KeyPackageOperator_a17bd5bca63876fcd201e98c2fca0582c}{Generate\+Passphrase}} (const QString \&phrase\+\_\+path, QString \&phrase) -\/$>$ bool
2022-05-08 19:59:26 +00:00
\begin{DoxyCompactList}\small\item\em generate passphrase for key package and save it to file \end{DoxyCompactList}\item
static auto \mbox{\hyperlink{classGpgFrontend_1_1KeyPackageOperator_a6c987efc6e6a137ac3eb11170220e299}{Generate\+Key\+Package\+Name}} () -\/$>$ QString
2022-05-08 19:59:26 +00:00
\begin{DoxyCompactList}\small\item\em generate the name of the key package \end{DoxyCompactList}\item
static void \mbox{\hyperlink{classGpgFrontend_1_1KeyPackageOperator_ae01e32a99a0008f8b01ad7afb95b93a3}{Generate\+Key\+Package}} (const QString \&key\+\_\+package\+\_\+path, const QString \&key\+\_\+package\+\_\+name, const Key\+Args\+List \&keys, QString \&phrase, bool secret, const Operation\+Callback \&cb)
2022-05-08 19:59:26 +00:00
\begin{DoxyCompactList}\small\item\em generate key package \end{DoxyCompactList}\item
static void \mbox{\hyperlink{classGpgFrontend_1_1KeyPackageOperator_a3b5e580bfd67cfda094c664e2987e319}{Import\+Key\+Package}} (const QString \&key\+\_\+package\+\_\+path, const QString \&phrase\+\_\+path, const Operation\+Callback \&cb)
2022-05-08 19:59:26 +00:00
\begin{DoxyCompactList}\small\item\em import key package \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Static Private Member Functions}
\begin{DoxyCompactItemize}
\item
static auto \mbox{\hyperlink{classGpgFrontend_1_1KeyPackageOperator_ab0fc5ef8145005f0851311f73f4e7039}{generate\+\_\+key\+\_\+package\+\_\+name}} () -\/$>$ QString
2022-05-08 19:59:26 +00:00
\begin{DoxyCompactList}\small\item\em generate key package name \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
give the possibility to import or export a key package
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classGpgFrontend_1_1KeyPackageOperator_ab0fc5ef8145005f0851311f73f4e7039}\label{classGpgFrontend_1_1KeyPackageOperator_ab0fc5ef8145005f0851311f73f4e7039}}
2022-05-08 19:59:26 +00:00
\index{GpgFrontend::KeyPackageOperator@{GpgFrontend::KeyPackageOperator}!generate\_key\_package\_name@{generate\_key\_package\_name}}
\index{generate\_key\_package\_name@{generate\_key\_package\_name}!GpgFrontend::KeyPackageOperator@{GpgFrontend::KeyPackageOperator}}
\doxysubsubsection{\texorpdfstring{generate\_key\_package\_name()}{generate\_key\_package\_name()}}
{\footnotesize\ttfamily auto Gpg\+Frontend\+::\+Key\+Package\+Operator\+::generate\+\_\+key\+\_\+package\+\_\+name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) -\/$>$ QString\hspace{0.3cm}{\ttfamily [static]}, {\ttfamily [private]}}
2022-05-08 19:59:26 +00:00
generate key package name
\begin{DoxyReturn}{Returns}
QString key package name
2022-05-08 19:59:26 +00:00
\end{DoxyReturn}
\mbox{\Hypertarget{classGpgFrontend_1_1KeyPackageOperator_ae01e32a99a0008f8b01ad7afb95b93a3}\label{classGpgFrontend_1_1KeyPackageOperator_ae01e32a99a0008f8b01ad7afb95b93a3}}
2022-05-08 19:59:26 +00:00
\index{GpgFrontend::KeyPackageOperator@{GpgFrontend::KeyPackageOperator}!GenerateKeyPackage@{GenerateKeyPackage}}
\index{GenerateKeyPackage@{GenerateKeyPackage}!GpgFrontend::KeyPackageOperator@{GpgFrontend::KeyPackageOperator}}
\doxysubsubsection{\texorpdfstring{GenerateKeyPackage()}{GenerateKeyPackage()}}
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+Key\+Package\+Operator\+::\+Generate\+Key\+Package (\begin{DoxyParamCaption}\item[{const QString \&}]{key\+\_\+package\+\_\+path, }\item[{const QString \&}]{key\+\_\+package\+\_\+name, }\item[{const Key\+Args\+List \&}]{keys, }\item[{QString \&}]{phrase, }\item[{bool}]{secret, }\item[{const Operation\+Callback \&}]{cb }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}
2022-05-08 19:59:26 +00:00
generate key package
\begin{DoxyParams}{Parameters}
{\em key\+\_\+package\+\_\+path} & path to key package \\
\hline
{\em key\+\_\+package\+\_\+name} & name of the key package \\
\hline
{\em key\+\_\+ids} & key ids to export \\
\hline
{\em phrase} & passphrase to encrypt key package \\
\hline
{\em secret} & true if secret key should be exported \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if key package was generated
false if key package was not generated
\end{DoxyReturn}
References Gpg\+Frontend\+::\+Check\+Gpg\+Error(), Gpg\+Frontend\+::\+Describe\+Gpg\+Err\+Code(), Gpg\+Frontend\+::\+Singleton\+Function\+Object$<$ Gpg\+Key\+Import\+Exporter $>$\+::\+Get\+Instance(), and Gpg\+Frontend\+::\+Write\+File().
2022-05-08 19:59:26 +00:00
\mbox{\Hypertarget{classGpgFrontend_1_1KeyPackageOperator_a6c987efc6e6a137ac3eb11170220e299}\label{classGpgFrontend_1_1KeyPackageOperator_a6c987efc6e6a137ac3eb11170220e299}}
2022-05-08 19:59:26 +00:00
\index{GpgFrontend::KeyPackageOperator@{GpgFrontend::KeyPackageOperator}!GenerateKeyPackageName@{GenerateKeyPackageName}}
\index{GenerateKeyPackageName@{GenerateKeyPackageName}!GpgFrontend::KeyPackageOperator@{GpgFrontend::KeyPackageOperator}}
\doxysubsubsection{\texorpdfstring{GenerateKeyPackageName()}{GenerateKeyPackageName()}}
{\footnotesize\ttfamily auto Gpg\+Frontend\+::\+Key\+Package\+Operator\+::\+Generate\+Key\+Package\+Name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) -\/$>$ QString\hspace{0.3cm}{\ttfamily [static]}}
2022-05-08 19:59:26 +00:00
generate the name of the key package
\begin{DoxyReturn}{Returns}
QString name of the key package
2022-05-08 19:59:26 +00:00
\end{DoxyReturn}
Referenced by Gpg\+Frontend\+::\+UI\+::\+Export\+Key\+Package\+Dialog\+::\+Export\+Key\+Package\+Dialog().
2022-05-08 19:59:26 +00:00
\mbox{\Hypertarget{classGpgFrontend_1_1KeyPackageOperator_a17bd5bca63876fcd201e98c2fca0582c}\label{classGpgFrontend_1_1KeyPackageOperator_a17bd5bca63876fcd201e98c2fca0582c}}
2022-05-08 19:59:26 +00:00
\index{GpgFrontend::KeyPackageOperator@{GpgFrontend::KeyPackageOperator}!GeneratePassphrase@{GeneratePassphrase}}
\index{GeneratePassphrase@{GeneratePassphrase}!GpgFrontend::KeyPackageOperator@{GpgFrontend::KeyPackageOperator}}
\doxysubsubsection{\texorpdfstring{GeneratePassphrase()}{GeneratePassphrase()}}
{\footnotesize\ttfamily auto Gpg\+Frontend\+::\+Key\+Package\+Operator\+::\+Generate\+Passphrase (\begin{DoxyParamCaption}\item[{const QString \&}]{phrase\+\_\+path, }\item[{QString \&}]{phrase }\end{DoxyParamCaption}) -\/$>$ bool\hspace{0.3cm}{\ttfamily [static]}}
2022-05-08 19:59:26 +00:00
generate passphrase for key package and save it to file
\begin{DoxyParams}{Parameters}
{\em phrase\+\_\+path} & path to passphrase file \\
\hline
{\em phrase} & passphrase generated \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if passphrase was generated and saved
false if passphrase was not generated and saved
\end{DoxyReturn}
References Gpg\+Frontend\+::\+Singleton\+Function\+Object$<$ Passphrase\+Generator $>$\+::\+Get\+Instance(), and Gpg\+Frontend\+::\+Write\+File().
2022-05-08 19:59:26 +00:00
\mbox{\Hypertarget{classGpgFrontend_1_1KeyPackageOperator_a3b5e580bfd67cfda094c664e2987e319}\label{classGpgFrontend_1_1KeyPackageOperator_a3b5e580bfd67cfda094c664e2987e319}}
2022-05-08 19:59:26 +00:00
\index{GpgFrontend::KeyPackageOperator@{GpgFrontend::KeyPackageOperator}!ImportKeyPackage@{ImportKeyPackage}}
\index{ImportKeyPackage@{ImportKeyPackage}!GpgFrontend::KeyPackageOperator@{GpgFrontend::KeyPackageOperator}}
\doxysubsubsection{\texorpdfstring{ImportKeyPackage()}{ImportKeyPackage()}}
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+Key\+Package\+Operator\+::\+Import\+Key\+Package (\begin{DoxyParamCaption}\item[{const QString \&}]{key\+\_\+package\+\_\+path, }\item[{const QString \&}]{phrase\+\_\+path, }\item[{const Operation\+Callback \&}]{cb }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}
2022-05-08 19:59:26 +00:00
import key package
\begin{DoxyParams}{Parameters}
{\em key\+\_\+package\+\_\+path} & path to key package \\
\hline
{\em phrase\+\_\+path} & path to passphrase file \\
\hline
{\em import\+\_\+info} & import info \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if key package was imported
false if key package was not imported
\end{DoxyReturn}
References Gpg\+Frontend\+::\+Singleton\+Function\+Object$<$ Gpg\+Key\+Import\+Exporter $>$\+::\+Get\+Instance(), Gpg\+Frontend\+::\+Read\+File(), and Gpg\+Frontend\+::\+Run\+Opera\+Async().
2022-05-08 19:59:26 +00:00
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
src/core/function/Key\+Package\+Operator.\+h\item
src/core/function/Key\+Package\+Operator.\+cpp\end{DoxyCompactItemize}