GpgFrontend-Doxygen/docs/latex/classGpgFrontend_1_1GpgCommandExecutor.tex

136 lines
8.0 KiB
TeX

\hypertarget{classGpgFrontend_1_1GpgCommandExecutor}{}\doxysection{Gpg\+Frontend\+::Gpg\+Command\+Executor Class Reference}
\label{classGpgFrontend_1_1GpgCommandExecutor}\index{GpgFrontend::GpgCommandExecutor@{GpgFrontend::GpgCommandExecutor}}
Extra commands related to GPG.
{\ttfamily \#include $<$Gpg\+Command\+Executor.\+h$>$}
Inheritance diagram for Gpg\+Frontend\+::Gpg\+Command\+Executor\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=550pt]{classGpgFrontend_1_1GpgCommandExecutor__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for Gpg\+Frontend\+::Gpg\+Command\+Executor\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classGpgFrontend_1_1GpgCommandExecutor__coll__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{classGpgFrontend_1_1GpgCommandExecutor_a94240f423464600938bfcafa2b186c38}{Gpg\+Command\+Executor}} (int channel=\mbox{\hyperlink{classGpgFrontend_1_1SingletonFunctionObject_a50e2b3794d6553f4231eaec72d9d0a50}{Singleton\+Function\+Object\+::\+Get\+Default\+Channel}}())
\begin{DoxyCompactList}\small\item\em Construct a new Gpg Command Executor object. \end{DoxyCompactList}\item
void \mbox{\hyperlink{classGpgFrontend_1_1GpgCommandExecutor_affa984ec4c2982c527761289f73c1ab4}{Execute}} (std\+::string cmd, std\+::vector$<$ std\+::string $>$ arguments, std\+::function$<$ void(int, std\+::string, std\+::string)$>$ callback=\mbox{[}$\,$\mbox{]}(int, std\+::string, std\+::string) \{\}, std\+::function$<$ void(QProcess $\ast$)$>$ interact\+\_\+func=\mbox{[}$\,$\mbox{]}(QProcess $\ast$) \{\})
\begin{DoxyCompactList}\small\item\em Excuting a command. \end{DoxyCompactList}\item
\mbox{\Hypertarget{classGpgFrontend_1_1GpgCommandExecutor_a9025336aea731e48e9411dc96f6cbc28}\label{classGpgFrontend_1_1GpgCommandExecutor_a9025336aea731e48e9411dc96f6cbc28}}
void {\bfseries Execute\+Concurrently} (std\+::string cmd, std\+::vector$<$ std\+::string $>$ arguments, std\+::function$<$ void(int, std\+::string, std\+::string)$>$ callback, std\+::function$<$ void(QProcess $\ast$)$>$ interact\+\_\+func=\mbox{[}$\,$\mbox{]}(QProcess $\ast$) \{\})
\end{DoxyCompactItemize}
\doxysubsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{classGpgFrontend_1_1GpgContext}{Gpg\+Context}} \& \mbox{\hyperlink{classGpgFrontend_1_1GpgCommandExecutor_aefc4f18ec852b98c539d97da1c712a02}{ctx\+\_\+}}
\begin{DoxyCompactList}\small\item\em Corresponding context. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Additional Inherited Members}
\doxysubsection{Detailed Description}
Extra commands related to GPG.
\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classGpgFrontend_1_1GpgCommandExecutor_a94240f423464600938bfcafa2b186c38}\label{classGpgFrontend_1_1GpgCommandExecutor_a94240f423464600938bfcafa2b186c38}}
\index{GpgFrontend::GpgCommandExecutor@{GpgFrontend::GpgCommandExecutor}!GpgCommandExecutor@{GpgCommandExecutor}}
\index{GpgCommandExecutor@{GpgCommandExecutor}!GpgFrontend::GpgCommandExecutor@{GpgFrontend::GpgCommandExecutor}}
\doxysubsubsection{\texorpdfstring{GpgCommandExecutor()}{GpgCommandExecutor()}}
{\footnotesize\ttfamily Gpg\+Frontend\+::\+Gpg\+Command\+Executor\+::\+Gpg\+Command\+Executor (\begin{DoxyParamCaption}\item[{int}]{channel = {\ttfamily \mbox{\hyperlink{classGpgFrontend_1_1SingletonFunctionObject_a50e2b3794d6553f4231eaec72d9d0a50}{Singleton\+Function\+Object\+::\+Get\+Default\+Channel}}()} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [explicit]}}
Construct a new Gpg Command Executor object.
\begin{DoxyParams}{Parameters}
{\em channel} & Corresponding context\\
\hline
\end{DoxyParams}
Copyright (C) 2021 Saturneric
This file is part of \mbox{\hyperlink{namespaceGpgFrontend}{Gpg\+Frontend}}.
\mbox{\hyperlink{namespaceGpgFrontend}{Gpg\+Frontend}} 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 3 of the License, or (at your option) any later version.
\mbox{\hyperlink{namespaceGpgFrontend}{Gpg\+Frontend}} 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 \mbox{\hyperlink{namespaceGpgFrontend}{Gpg\+Frontend}}. If not, see \href{https://www.gnu.org/licenses/}{\texttt{ https\+://www.\+gnu.\+org/licenses/}}.
The initial version of the source code is inherited from the gpg4usb project, which is under GPL-\/3.\+0-\/or-\/later.
All the source code of \mbox{\hyperlink{namespaceGpgFrontend}{Gpg\+Frontend}} was modified and released by Saturneric\href{mailto:eric@bktus.com}{\texttt{ eric@bktus.\+com}} starting on May 12, 2021.
SPDX-\/\+License-\/\+Identifier\+: GPL-\/3.\+0-\/or-\/later
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classGpgFrontend_1_1GpgCommandExecutor_affa984ec4c2982c527761289f73c1ab4}\label{classGpgFrontend_1_1GpgCommandExecutor_affa984ec4c2982c527761289f73c1ab4}}
\index{GpgFrontend::GpgCommandExecutor@{GpgFrontend::GpgCommandExecutor}!Execute@{Execute}}
\index{Execute@{Execute}!GpgFrontend::GpgCommandExecutor@{GpgFrontend::GpgCommandExecutor}}
\doxysubsubsection{\texorpdfstring{Execute()}{Execute()}}
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+Gpg\+Command\+Executor\+::\+Execute (\begin{DoxyParamCaption}\item[{std\+::string}]{cmd, }\item[{std\+::vector$<$ std\+::string $>$}]{arguments, }\item[{std\+::function$<$ void(int, std\+::string, std\+::string)$>$}]{callback = {\ttfamily \mbox{[}\mbox{]}(int,~std\+:\+:string,~std\+:\+:string)~\{\}}, }\item[{std\+::function$<$ void(QProcess $\ast$)$>$}]{interact\+\_\+func = {\ttfamily \mbox{[}\mbox{]}(QProcess~$\ast$)~\{\}} }\end{DoxyParamCaption})}
Excuting a command.
\begin{DoxyParams}{Parameters}
{\em arguments} & Command parameters \\
\hline
{\em interact\+\_\+func} & Command answering function \\
\hline
\end{DoxyParams}
References Gpg\+Frontend\+::\+Singleton\+Function\+Object$<$ Task\+Runner\+Getter $>$\+::\+Get\+Instance(), and Gpg\+Frontend\+::\+Thread\+::\+Task\+::\+Signal\+Task\+End().
Referenced by Gpg\+Frontend\+::\+Gpg\+Advanced\+Operator\+::\+Clear\+Gpg\+Password\+Cache(), Gpg\+Frontend\+::\+Gpg\+Context\+::\+Get\+Info(), Gpg\+Frontend\+::\+Gpg\+Advanced\+Operator\+::\+Reload\+Gpg\+Components(), Gpg\+Frontend\+::\+Gpg\+Advanced\+Operator\+::\+Reset\+Configures(), Gpg\+Frontend\+::\+Gpg\+Advanced\+Operator\+::\+Restart\+Gpg\+Components(), Gpg\+Frontend\+::\+Gpg\+Advanced\+Operator\+::\+Start\+Dirmngr(), Gpg\+Frontend\+::\+Gpg\+Advanced\+Operator\+::\+Start\+Gpg\+Agent(), and Gpg\+Frontend\+::\+Gpg\+Advanced\+Operator\+::\+Start\+Key\+Boxd().
\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{classGpgFrontend_1_1GpgCommandExecutor_aefc4f18ec852b98c539d97da1c712a02}\label{classGpgFrontend_1_1GpgCommandExecutor_aefc4f18ec852b98c539d97da1c712a02}}
\index{GpgFrontend::GpgCommandExecutor@{GpgFrontend::GpgCommandExecutor}!ctx\_@{ctx\_}}
\index{ctx\_@{ctx\_}!GpgFrontend::GpgCommandExecutor@{GpgFrontend::GpgCommandExecutor}}
\doxysubsubsection{\texorpdfstring{ctx\_}{ctx\_}}
{\footnotesize\ttfamily \mbox{\hyperlink{classGpgFrontend_1_1GpgContext}{Gpg\+Context}}\& Gpg\+Frontend\+::\+Gpg\+Command\+Executor\+::ctx\+\_\+\hspace{0.3cm}{\ttfamily [private]}}
{\bfseries Initial value\+:}
\begin{DoxyCode}{0}
\DoxyCodeLine{= \mbox{\hyperlink{classGpgFrontend_1_1SingletonFunctionObject_a70484d7cfe9f9dcbcd5f8bb749250f36}{GpgContext::GetInstance}}(}
\DoxyCodeLine{ \mbox{\hyperlink{classGpgFrontend_1_1SingletonFunctionObject_aa99440b9177f5d0c18840f08a40d64b7}{SingletonFunctionObject::GetChannel}}())}
\end{DoxyCode}
Corresponding context.
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
src/core/function/gpg/Gpg\+Command\+Executor.\+h\item
src/core/function/gpg/Gpg\+Command\+Executor.\+cpp\end{DoxyCompactItemize}