GpgFrontend-Doxygen/docs/latex/classGpgFrontend_1_1GpgUIDOperator.tex

\hypertarget{classGpgFrontend_1_1GpgUIDOperator}{}\doxysection{Gpg\+Frontend\+::Gpg\+UIDOperator Class Reference}
\label{classGpgFrontend_1_1GpgUIDOperator}\index{GpgFrontend::GpgUIDOperator@{GpgFrontend::GpgUIDOperator}}


Inheritance diagram for Gpg\+Frontend\+::Gpg\+UIDOperator\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=550pt]{classGpgFrontend_1_1GpgUIDOperator__inherit__graph}
\end{center}
\end{figure}


Collaboration diagram for Gpg\+Frontend\+::Gpg\+UIDOperator\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classGpgFrontend_1_1GpgUIDOperator__coll__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classGpgFrontend_1_1GpgUIDOperator_ab74a830c858ab9ff135375743393a7c7}{Gpg\+UIDOperator}} (int channel=\mbox{\hyperlink{classGpgFrontend_1_1SingletonFunctionObject_a50e2b3794d6553f4231eaec72d9d0a50}{Singleton\+Function\+Object\+::\+Get\+Default\+Channel}}())
\begin{DoxyCompactList}\small\item\em Construct a new Gpg UID Opera object. \end{DoxyCompactList}\item 
bool \mbox{\hyperlink{classGpgFrontend_1_1GpgUIDOperator_a7c0de570de59d4ebc6c0bed681119bf7}{Add\+UID}} (const \mbox{\hyperlink{classGpgFrontend_1_1GpgKey}{Gpg\+Key}} \&key, const std\+::string \&uid)
\item 
bool \mbox{\hyperlink{classGpgFrontend_1_1GpgUIDOperator_a672bbf74abac9140233c4e1c7864d15d}{Add\+UID}} (const \mbox{\hyperlink{classGpgFrontend_1_1GpgKey}{Gpg\+Key}} \&key, const std\+::string \&name, const std\+::string \&comment, const std\+::string \&email)
\item 
bool \mbox{\hyperlink{classGpgFrontend_1_1GpgUIDOperator_a47f762666afbc806365877ff70947841}{Rev\+UID}} (const \mbox{\hyperlink{classGpgFrontend_1_1GpgKey}{Gpg\+Key}} \&key, const std\+::string \&uid)
\item 
bool \mbox{\hyperlink{classGpgFrontend_1_1GpgUIDOperator_acbdabec97df508382b0c9b1fffbf1dd5}{Set\+Primary\+UID}} (const \mbox{\hyperlink{classGpgFrontend_1_1GpgKey}{Gpg\+Key}} \&key, const std\+::string \&uid)
\end{DoxyCompactItemize}
\doxysubsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classGpgFrontend_1_1GpgContext}{Gpg\+Context}} \& {\bfseries ctx\+\_\+}
\end{DoxyCompactItemize}
\doxysubsection*{Additional Inherited Members}


\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classGpgFrontend_1_1GpgUIDOperator_ab74a830c858ab9ff135375743393a7c7}\label{classGpgFrontend_1_1GpgUIDOperator_ab74a830c858ab9ff135375743393a7c7}} 
\index{GpgFrontend::GpgUIDOperator@{GpgFrontend::GpgUIDOperator}!GpgUIDOperator@{GpgUIDOperator}}
\index{GpgUIDOperator@{GpgUIDOperator}!GpgFrontend::GpgUIDOperator@{GpgFrontend::GpgUIDOperator}}
\doxysubsubsection{\texorpdfstring{GpgUIDOperator()}{GpgUIDOperator()}}
{\footnotesize\ttfamily Gpg\+Frontend\+::\+Gpg\+UIDOperator\+::\+Gpg\+UIDOperator (\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 UID Opera object. 


\begin{DoxyParams}{Parameters}
{\em channel} & Copyright (C) 2021 Saturneric\\
\hline
\end{DoxyParams}
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_1GpgUIDOperator_a672bbf74abac9140233c4e1c7864d15d}\label{classGpgFrontend_1_1GpgUIDOperator_a672bbf74abac9140233c4e1c7864d15d}} 
\index{GpgFrontend::GpgUIDOperator@{GpgFrontend::GpgUIDOperator}!AddUID@{AddUID}}
\index{AddUID@{AddUID}!GpgFrontend::GpgUIDOperator@{GpgFrontend::GpgUIDOperator}}
\doxysubsubsection{\texorpdfstring{AddUID()}{AddUID()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily bool Gpg\+Frontend\+::\+Gpg\+UIDOperator\+::\+Add\+UID (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classGpgFrontend_1_1GpgKey}{Gpg\+Key}} \&}]{key,  }\item[{const std\+::string \&}]{name,  }\item[{const std\+::string \&}]{comment,  }\item[{const std\+::string \&}]{email }\end{DoxyParamCaption})}

create a new uid in certain key pair 
\begin{DoxyParams}{Parameters}
{\em key} & target key pair \\
\hline
{\em name} & \\
\hline
{\em comment} & \\
\hline
{\em email} & \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\end{DoxyReturn}
\mbox{\Hypertarget{classGpgFrontend_1_1GpgUIDOperator_a7c0de570de59d4ebc6c0bed681119bf7}\label{classGpgFrontend_1_1GpgUIDOperator_a7c0de570de59d4ebc6c0bed681119bf7}} 
\index{GpgFrontend::GpgUIDOperator@{GpgFrontend::GpgUIDOperator}!AddUID@{AddUID}}
\index{AddUID@{AddUID}!GpgFrontend::GpgUIDOperator@{GpgFrontend::GpgUIDOperator}}
\doxysubsubsection{\texorpdfstring{AddUID()}{AddUID()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily bool Gpg\+Frontend\+::\+Gpg\+UIDOperator\+::\+Add\+UID (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classGpgFrontend_1_1GpgKey}{Gpg\+Key}} \&}]{key,  }\item[{const std\+::string \&}]{uid }\end{DoxyParamCaption})}

create a new uid in certain key pair 
\begin{DoxyParams}{Parameters}
{\em key} & target key pair \\
\hline
{\em uid} & uid args(combine name\&comment\&email) \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
if successful 
\end{DoxyReturn}


References Gpg\+Frontend\+::check\+\_\+gpg\+\_\+error\+\_\+2\+\_\+err\+\_\+code().

\mbox{\Hypertarget{classGpgFrontend_1_1GpgUIDOperator_a47f762666afbc806365877ff70947841}\label{classGpgFrontend_1_1GpgUIDOperator_a47f762666afbc806365877ff70947841}} 
\index{GpgFrontend::GpgUIDOperator@{GpgFrontend::GpgUIDOperator}!RevUID@{RevUID}}
\index{RevUID@{RevUID}!GpgFrontend::GpgUIDOperator@{GpgFrontend::GpgUIDOperator}}
\doxysubsubsection{\texorpdfstring{RevUID()}{RevUID()}}
{\footnotesize\ttfamily bool Gpg\+Frontend\+::\+Gpg\+UIDOperator\+::\+Rev\+UID (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classGpgFrontend_1_1GpgKey}{Gpg\+Key}} \&}]{key,  }\item[{const std\+::string \&}]{uid }\end{DoxyParamCaption})}

Revoke(\+Delete) UID from certain key pair 
\begin{DoxyParams}{Parameters}
{\em key} & target key pair \\
\hline
{\em uid} & target uid \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
if successful 
\end{DoxyReturn}


References Gpg\+Frontend\+::check\+\_\+gpg\+\_\+error(), and Gpg\+Frontend\+::check\+\_\+gpg\+\_\+error\+\_\+2\+\_\+err\+\_\+code().

\mbox{\Hypertarget{classGpgFrontend_1_1GpgUIDOperator_acbdabec97df508382b0c9b1fffbf1dd5}\label{classGpgFrontend_1_1GpgUIDOperator_acbdabec97df508382b0c9b1fffbf1dd5}} 
\index{GpgFrontend::GpgUIDOperator@{GpgFrontend::GpgUIDOperator}!SetPrimaryUID@{SetPrimaryUID}}
\index{SetPrimaryUID@{SetPrimaryUID}!GpgFrontend::GpgUIDOperator@{GpgFrontend::GpgUIDOperator}}
\doxysubsubsection{\texorpdfstring{SetPrimaryUID()}{SetPrimaryUID()}}
{\footnotesize\ttfamily bool Gpg\+Frontend\+::\+Gpg\+UIDOperator\+::\+Set\+Primary\+UID (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classGpgFrontend_1_1GpgKey}{Gpg\+Key}} \&}]{key,  }\item[{const std\+::string \&}]{uid }\end{DoxyParamCaption})}

Set one of a uid of a key pair as primary 
\begin{DoxyParams}{Parameters}
{\em key} & target key pair \\
\hline
{\em uid} & target uid \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
if successful 
\end{DoxyReturn}


References Gpg\+Frontend\+::check\+\_\+gpg\+\_\+error(), and Gpg\+Frontend\+::check\+\_\+gpg\+\_\+error\+\_\+2\+\_\+err\+\_\+code().



\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{classGpgFrontend_1_1GpgUIDOperator_aee04c70b7802699eae70d7b26255f7ec}\label{classGpgFrontend_1_1GpgUIDOperator_aee04c70b7802699eae70d7b26255f7ec}} 
\index{GpgFrontend::GpgUIDOperator@{GpgFrontend::GpgUIDOperator}!ctx\_@{ctx\_}}
\index{ctx\_@{ctx\_}!GpgFrontend::GpgUIDOperator@{GpgFrontend::GpgUIDOperator}}
\doxysubsubsection{\texorpdfstring{ctx\_}{ctx\_}}
{\footnotesize\ttfamily \mbox{\hyperlink{classGpgFrontend_1_1GpgContext}{Gpg\+Context}}\& Gpg\+Frontend\+::\+Gpg\+UIDOperator\+::ctx\+\_\+\hspace{0.3cm}{\ttfamily [private]}}

{\bfseries Initial value\+:}
\begin{DoxyCode}{0}
\DoxyCodeLine{=}
\DoxyCodeLine{      \mbox{\hyperlink{classGpgFrontend_1_1SingletonFunctionObject_a70484d7cfe9f9dcbcd5f8bb749250f36}{GpgContext::GetInstance}}(\mbox{\hyperlink{classGpgFrontend_1_1SingletonFunctionObject_aa99440b9177f5d0c18840f08a40d64b7}{SingletonFunctionObject::GetChannel}}())}

\end{DoxyCode}


The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
src/core/function/gpg/Gpg\+UIDOperator.\+h\item 
src/core/function/gpg/Gpg\+UIDOperator.\+cpp\end{DoxyCompactItemize}