GpgFrontend-Doxygen/docs/latex/classGpgFrontend_1_1ChannelObject.tex

148 lines
6.7 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 is called \char`\"{}channel\char`\"{}
{\ttfamily \#include $<$Channel\+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{\Hypertarget{classGpgFrontend_1_1ChannelObject_aedbf32eddc701e521bd8e790ef208da0}\label{classGpgFrontend_1_1ChannelObject_aedbf32eddc701e521bd8e790ef208da0}}
\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{\Hypertarget{classGpgFrontend_1_1ChannelObject_a85a29ff6a1233114eb9f159c408cbe35}\label{classGpgFrontend_1_1ChannelObject_a85a29ff6a1233114eb9f159c408cbe35}}
virtual \mbox{\hyperlink{classGpgFrontend_1_1ChannelObject_a85a29ff6a1233114eb9f159c408cbe35}{$\sim$\+Channel\+Object}} () noexcept
\begin{DoxyCompactList}\small\item\em Destroy the Channel Object object. \end{DoxyCompactList}\item
\mbox{\hyperlink{classGpgFrontend_1_1ChannelObject_a3d55a57ee60bdb5a747125da9586a0e5}{Channel\+Object}} (int channel, QString type)
\begin{DoxyCompactList}\small\item\em Construct a new Channel Object object. \end{DoxyCompactList}\item
auto \mbox{\hyperlink{classGpgFrontend_1_1ChannelObject_a085b36517fcc46916279b9d633da2d26}{Get\+Channel}} () const -\/$>$ int
\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 auto \mbox{\hyperlink{classGpgFrontend_1_1ChannelObject_a6a3672c8ff3d4fb5ef6bc1bda202bbb8}{Get\+Default\+Channel}} () -\/$>$ int
\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\+\_\+}} = k\+Gpg\+Frontend\+Default\+Channel
\begin{DoxyCompactList}\small\item\em The channel id. \end{DoxyCompactList}\item
\mbox{\Hypertarget{classGpgFrontend_1_1ChannelObject_a2864add31ca45349ac40e7fc275c34ad}\label{classGpgFrontend_1_1ChannelObject_a2864add31ca45349ac40e7fc275c34ad}}
QString {\bfseries type\+\_\+}
\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
object which in channel system is called \char`\"{}channel\char`\"{}
\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classGpgFrontend_1_1ChannelObject_a3d55a57ee60bdb5a747125da9586a0e5}\label{classGpgFrontend_1_1ChannelObject_a3d55a57ee60bdb5a747125da9586a0e5}}
\index{GpgFrontend::ChannelObject@{GpgFrontend::ChannelObject}!ChannelObject@{ChannelObject}}
\index{ChannelObject@{ChannelObject}!GpgFrontend::ChannelObject@{GpgFrontend::ChannelObject}}
\doxysubsubsection{\texorpdfstring{ChannelObject()}{ChannelObject()}}
{\footnotesize\ttfamily Gpg\+Frontend\+::\+Channel\+Object\+::\+Channel\+Object (\begin{DoxyParamCaption}\item[{int}]{channel, }\item[{QString}]{type }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [explicit]}}
Construct a new Channel Object object.
\begin{DoxyParams}{Parameters}
{\em channel} & \\
\hline
\end{DoxyParams}
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classGpgFrontend_1_1ChannelObject_a085b36517fcc46916279b9d633da2d26}\label{classGpgFrontend_1_1ChannelObject_a085b36517fcc46916279b9d633da2d26}}
\index{GpgFrontend::ChannelObject@{GpgFrontend::ChannelObject}!GetChannel@{GetChannel}}
\index{GetChannel@{GetChannel}!GpgFrontend::ChannelObject@{GpgFrontend::ChannelObject}}
\doxysubsubsection{\texorpdfstring{GetChannel()}{GetChannel()}}
{\footnotesize\ttfamily auto Gpg\+Frontend\+::\+Channel\+Object\+::\+Get\+Channel (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const -\/$>$ int}
Get the Channel object.
\begin{DoxyReturn}{Returns}
int
\end{DoxyReturn}
References channel\+\_\+.
Referenced by Gpg\+Frontend\+::\+Singleton\+Function\+Object$<$ T $>$\+::\+Get\+Channel().
\mbox{\Hypertarget{classGpgFrontend_1_1ChannelObject_a6a3672c8ff3d4fb5ef6bc1bda202bbb8}\label{classGpgFrontend_1_1ChannelObject_a6a3672c8ff3d4fb5ef6bc1bda202bbb8}}
\index{GpgFrontend::ChannelObject@{GpgFrontend::ChannelObject}!GetDefaultChannel@{GetDefaultChannel}}
\index{GetDefaultChannel@{GetDefaultChannel}!GpgFrontend::ChannelObject@{GpgFrontend::ChannelObject}}
\doxysubsubsection{\texorpdfstring{GetDefaultChannel()}{GetDefaultChannel()}}
{\footnotesize\ttfamily auto Gpg\+Frontend\+::\+Channel\+Object\+::\+Get\+Default\+Channel (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) -\/$>$ int\hspace{0.3cm}{\ttfamily [static]}}
Get the Default Channel object.
\begin{DoxyReturn}{Returns}
int
\end{DoxyReturn}
Referenced by Gpg\+Frontend\+::\+Singleton\+Function\+Object$<$ T $>$\+::\+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} & \\
\hline
\end{DoxyParams}
References channel\+\_\+.
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
src/core/function/basic/Channel\+Object.\+h\item
src/core/function/basic/Channel\+Object.\+cpp\end{DoxyCompactItemize}