171 lines
8.5 KiB
TeX
171 lines
8.5 KiB
TeX
\hypertarget{classGpgFrontend_1_1ChannelObject}{}\doxysection{Gpg\+Frontend\+::Channel\+Object Class Reference}
|
|
\label{classGpgFrontend_1_1ChannelObject}\index{GpgFrontend::ChannelObject@{GpgFrontend::ChannelObject}}
|
|
|
|
|
|
object which in channel system
|
|
|
|
|
|
|
|
|
|
{\ttfamily \#include $<$Gpg\+Function\+Object.\+h$>$}
|
|
|
|
|
|
|
|
Inheritance diagram for Gpg\+Frontend\+::Channel\+Object\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{classGpgFrontend_1_1ChannelObject__inherit__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
|
|
|
|
Collaboration diagram for Gpg\+Frontend\+::Channel\+Object\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=236pt]{classGpgFrontend_1_1ChannelObject__coll__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{classGpgFrontend_1_1ChannelObject_aedbf32eddc701e521bd8e790ef208da0}{Channel\+Object}} () noexcept
|
|
\begin{DoxyCompactList}\small\item\em Construct a new Default Channel Object object. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classGpgFrontend_1_1ChannelObject_a68ad2a19339e3cd50626fe0eaad17ccd}{Channel\+Object}} (int channel)
|
|
\begin{DoxyCompactList}\small\item\em Construct a new Channel Object object. \end{DoxyCompactList}\item
|
|
int \mbox{\hyperlink{classGpgFrontend_1_1ChannelObject_a0e13a4bff1cfb679f68a3a2590a3b1b8}{Get\+Channel}} () const
|
|
\begin{DoxyCompactList}\small\item\em Get the Channel object. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classGpgFrontend_1_1ChannelObject_aa3b19cad6d873b314bba32a3dae85f09}{Set\+Channel}} (int channel)
|
|
\begin{DoxyCompactList}\small\item\em Set the Channel object. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsection*{Static Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
static int \mbox{\hyperlink{classGpgFrontend_1_1ChannelObject_aece9c525c49900734bc1bebf85b644ef}{Get\+Default\+Channel}} ()
|
|
\begin{DoxyCompactList}\small\item\em Get the Default Channel object. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsection*{Private Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\Hypertarget{classGpgFrontend_1_1ChannelObject_aee5f8a5575adbdf522da4dd195c091ee}\label{classGpgFrontend_1_1ChannelObject_aee5f8a5575adbdf522da4dd195c091ee}}
|
|
int \mbox{\hyperlink{classGpgFrontend_1_1ChannelObject_aee5f8a5575adbdf522da4dd195c091ee}{channel\+\_\+}} = \mbox{\hyperlink{classGpgFrontend_1_1ChannelObject_a66295bb572e98fc2fad3afce763ac311}{\+\_\+default\+\_\+channel}}
|
|
\begin{DoxyCompactList}\small\item\em The channel id. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsection*{Static Private Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\Hypertarget{classGpgFrontend_1_1ChannelObject_a66295bb572e98fc2fad3afce763ac311}\label{classGpgFrontend_1_1ChannelObject_a66295bb572e98fc2fad3afce763ac311}}
|
|
static constexpr int \mbox{\hyperlink{classGpgFrontend_1_1ChannelObject_a66295bb572e98fc2fad3afce763ac311}{\+\_\+default\+\_\+channel}} = 0
|
|
\begin{DoxyCompactList}\small\item\em The default channel id. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
object which in channel system
|
|
|
|
|
|
|
|
\doxysubsection{Constructor \& Destructor Documentation}
|
|
\mbox{\Hypertarget{classGpgFrontend_1_1ChannelObject_aedbf32eddc701e521bd8e790ef208da0}\label{classGpgFrontend_1_1ChannelObject_aedbf32eddc701e521bd8e790ef208da0}}
|
|
\index{GpgFrontend::ChannelObject@{GpgFrontend::ChannelObject}!ChannelObject@{ChannelObject}}
|
|
\index{ChannelObject@{ChannelObject}!GpgFrontend::ChannelObject@{GpgFrontend::ChannelObject}}
|
|
\doxysubsubsection{\texorpdfstring{ChannelObject()}{ChannelObject()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily Gpg\+Frontend\+::\+Channel\+Object\+::\+Channel\+Object (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [default]}, {\ttfamily [noexcept]}}
|
|
|
|
|
|
|
|
Construct a new Default Channel Object object.
|
|
|
|
\mbox{\Hypertarget{classGpgFrontend_1_1ChannelObject_a68ad2a19339e3cd50626fe0eaad17ccd}\label{classGpgFrontend_1_1ChannelObject_a68ad2a19339e3cd50626fe0eaad17ccd}}
|
|
\index{GpgFrontend::ChannelObject@{GpgFrontend::ChannelObject}!ChannelObject@{ChannelObject}}
|
|
\index{ChannelObject@{ChannelObject}!GpgFrontend::ChannelObject@{GpgFrontend::ChannelObject}}
|
|
\doxysubsubsection{\texorpdfstring{ChannelObject()}{ChannelObject()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily Gpg\+Frontend\+::\+Channel\+Object\+::\+Channel\+Object (\begin{DoxyParamCaption}\item[{int}]{channel }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Construct a new Channel Object object.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em channel} & \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{classGpgFrontend_1_1ChannelObject_a0e13a4bff1cfb679f68a3a2590a3b1b8}\label{classGpgFrontend_1_1ChannelObject_a0e13a4bff1cfb679f68a3a2590a3b1b8}}
|
|
\index{GpgFrontend::ChannelObject@{GpgFrontend::ChannelObject}!GetChannel@{GetChannel}}
|
|
\index{GetChannel@{GetChannel}!GpgFrontend::ChannelObject@{GpgFrontend::ChannelObject}}
|
|
\doxysubsubsection{\texorpdfstring{GetChannel()}{GetChannel()}}
|
|
{\footnotesize\ttfamily int Gpg\+Frontend\+::\+Channel\+Object\+::\+Get\+Channel (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}
|
|
|
|
|
|
|
|
Get the Channel object.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
int
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Referenced by Gpg\+Frontend\+::\+Singleton\+Function\+Object$<$ Gpg\+Context $>$\+::\+Get\+Channel().
|
|
|
|
\mbox{\Hypertarget{classGpgFrontend_1_1ChannelObject_aece9c525c49900734bc1bebf85b644ef}\label{classGpgFrontend_1_1ChannelObject_aece9c525c49900734bc1bebf85b644ef}}
|
|
\index{GpgFrontend::ChannelObject@{GpgFrontend::ChannelObject}!GetDefaultChannel@{GetDefaultChannel}}
|
|
\index{GetDefaultChannel@{GetDefaultChannel}!GpgFrontend::ChannelObject@{GpgFrontend::ChannelObject}}
|
|
\doxysubsubsection{\texorpdfstring{GetDefaultChannel()}{GetDefaultChannel()}}
|
|
{\footnotesize\ttfamily int Gpg\+Frontend\+::\+Channel\+Object\+::\+Get\+Default\+Channel (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}
|
|
|
|
|
|
|
|
Get the Default Channel object.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
int
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Referenced by Gpg\+Frontend\+::\+Singleton\+Function\+Object$<$ Gpg\+Context $>$\+::\+Get\+Default\+Channel().
|
|
|
|
\mbox{\Hypertarget{classGpgFrontend_1_1ChannelObject_aa3b19cad6d873b314bba32a3dae85f09}\label{classGpgFrontend_1_1ChannelObject_aa3b19cad6d873b314bba32a3dae85f09}}
|
|
\index{GpgFrontend::ChannelObject@{GpgFrontend::ChannelObject}!SetChannel@{SetChannel}}
|
|
\index{SetChannel@{SetChannel}!GpgFrontend::ChannelObject@{GpgFrontend::ChannelObject}}
|
|
\doxysubsubsection{\texorpdfstring{SetChannel()}{SetChannel()}}
|
|
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+Channel\+Object\+::\+Set\+Channel (\begin{DoxyParamCaption}\item[{int}]{channel }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Set the Channel 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 G\+NU 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 W\+I\+T\+H\+O\+UT A\+NY W\+A\+R\+R\+A\+N\+TY; without even the implied warranty of M\+E\+R\+C\+H\+A\+N\+T\+A\+B\+I\+L\+I\+TY or F\+I\+T\+N\+E\+SS F\+OR A P\+A\+R\+T\+I\+C\+U\+L\+AR P\+U\+R\+P\+O\+SE. See the G\+NU General Public License for more details.
|
|
|
|
You should have received a copy of the G\+NU 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 G\+P\+L-\/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.
|
|
|
|
S\+P\+D\+X-\/\+License-\/\+Identifier\+: G\+P\+L-\/3.\+0-\/or-\/later
|
|
|
|
References channel\+\_\+.
|
|
|
|
|
|
|
|
Referenced by Gpg\+Frontend\+::\+Singleton\+Storage\+::\+Set\+Object\+In\+Channel().
|
|
|
|
|
|
|
|
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
src/core/Gpg\+Function\+Object.\+h\item
|
|
src/core/Gpg\+Function\+Object.\+cpp\end{DoxyCompactItemize}
|