GpgFrontend-Doxygen/docs/html/classGpgFrontend_1_1ChannelObject.html

314 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GpgFrontend Project: GpgFrontend::ChannelObject Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">GpgFrontend Project
</div>
<div id="projectbrief">A Free, Powerful, Easy-to-Use, Compact, Cross-Platform, and Installation-Free OpenPGP(pgp) Crypto Tool.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classGpgFrontend_1_1ChannelObject.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#pri-static-attribs">Static Private Attributes</a> &#124;
<a href="classGpgFrontend_1_1ChannelObject-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">GpgFrontend::ChannelObject Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>object which in channel system
<a href="classGpgFrontend_1_1ChannelObject.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="GpgFunctionObject_8h_source.html">GpgFunctionObject.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for GpgFrontend::ChannelObject:</div>
<div class="dyncontent">
<div class="center"><img src="classGpgFrontend_1_1ChannelObject__inherit__graph.png" border="0" usemap="#aGpgFrontend_1_1ChannelObject_inherit__map" alt="Inheritance graph"/></div>
<map name="aGpgFrontend_1_1ChannelObject_inherit__map" id="aGpgFrontend_1_1ChannelObject_inherit__map">
<area shape="rect" title="object which in channel system" alt="" coords="1659,5,1867,156"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="1032,551,1261,833"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="1285,551,1515,833"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="259,551,488,833"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="1539,551,1781,833"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="765,551,1008,833"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="512,551,741,833"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="5,551,235,833"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="3341,551,3571,833"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="2835,551,3064,833"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="2569,551,2810,833"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="1805,551,2035,833"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="3088,551,3317,833"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="2059,551,2291,833"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="2315,551,2544,833"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="1648,205,1877,488"/>
<area shape="rect" href="classGpgFrontend_1_1GpgUIDOperator.html" title=" " alt="" coords="1041,1022,1261,1158"/>
<area shape="rect" href="classGpgFrontend_1_1GpgKeyManager.html" title=" " alt="" coords="1290,1029,1510,1151"/>
<area shape="rect" href="classGpgFrontend_1_1Thread_1_1TaskRunnerGetter.html" title=" " alt="" coords="292,1037,455,1143"/>
<area shape="rect" href="classGpgFrontend_1_1GpgKeyImportExporter.html" title=" " alt="" coords="1556,985,1764,1195"/>
<area shape="rect" href="classGpgFrontend_1_1GpgCommandExecutor.html" title="Extra commands related to GPG." alt="" coords="754,1044,1017,1136"/>
<area shape="rect" href="classGpgFrontend_1_1GpgKeyOpera.html" title=" " alt="" coords="525,993,728,1187"/>
<area shape="rect" href="classGpgFrontend_1_1GpgFileOpera.html" title=" " alt="" coords="19,1000,221,1180"/>
<area shape="rect" href="classGpgFrontend_1_1GpgKeyGetter.html" title=" " alt="" coords="3354,971,3558,1209"/>
<area shape="rect" href="classGpgFrontend_1_1GpgBasicOperator.html" title="Basic operation collection." alt="" coords="2829,985,3059,1195"/>
<area shape="rect" href="classGpgFrontend_1_1GpgAdvancedOperator.html" title=" " alt="" coords="2585,993,2793,1187"/>
<area shape="rect" href="classGpgFrontend_1_1GlobalSettingStation.html" title=" " alt="" coords="1801,883,2025,1297"/>
<area shape="rect" href="classGpgFrontend_1_1DataObjectOperator.html" title=" " alt="" coords="3084,978,3327,1202"/>
<area shape="rect" href="classGpgFrontend_1_1PassphraseGenerator.html" title="The PassphraseGenerator class." alt="" coords="2049,1037,2300,1143"/>
<area shape="rect" href="classGpgFrontend_1_1GpgContext.html" title=" " alt="" coords="2324,934,2553,1246"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for GpgFrontend::ChannelObject:</div>
<div class="dyncontent">
<div class="center"><img src="classGpgFrontend_1_1ChannelObject__coll__graph.png" border="0" usemap="#aGpgFrontend_1_1ChannelObject_coll__map" alt="Collaboration graph"/></div>
<map name="aGpgFrontend_1_1ChannelObject_coll__map" id="aGpgFrontend_1_1ChannelObject_coll__map">
<area shape="rect" title="object which in channel system" alt="" coords="5,5,213,156"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aedbf32eddc701e521bd8e790ef208da0"><td class="memItemLeft" align="right" valign="top"><a id="aedbf32eddc701e521bd8e790ef208da0"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1ChannelObject.html#aedbf32eddc701e521bd8e790ef208da0">ChannelObject</a> () noexcept</td></tr>
<tr class="memdesc:aedbf32eddc701e521bd8e790ef208da0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new Default Channel Object object. <br /></td></tr>
<tr class="separator:aedbf32eddc701e521bd8e790ef208da0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68ad2a19339e3cd50626fe0eaad17ccd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1ChannelObject.html#a68ad2a19339e3cd50626fe0eaad17ccd">ChannelObject</a> (int channel)</td></tr>
<tr class="memdesc:a68ad2a19339e3cd50626fe0eaad17ccd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new Channel Object object. <a href="classGpgFrontend_1_1ChannelObject.html#a68ad2a19339e3cd50626fe0eaad17ccd">More...</a><br /></td></tr>
<tr class="separator:a68ad2a19339e3cd50626fe0eaad17ccd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e13a4bff1cfb679f68a3a2590a3b1b8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1ChannelObject.html#a0e13a4bff1cfb679f68a3a2590a3b1b8">GetChannel</a> () const</td></tr>
<tr class="memdesc:a0e13a4bff1cfb679f68a3a2590a3b1b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the Channel object. <a href="classGpgFrontend_1_1ChannelObject.html#a0e13a4bff1cfb679f68a3a2590a3b1b8">More...</a><br /></td></tr>
<tr class="separator:a0e13a4bff1cfb679f68a3a2590a3b1b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3b19cad6d873b314bba32a3dae85f09"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1ChannelObject.html#aa3b19cad6d873b314bba32a3dae85f09">SetChannel</a> (int channel)</td></tr>
<tr class="memdesc:aa3b19cad6d873b314bba32a3dae85f09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the Channel object. <a href="classGpgFrontend_1_1ChannelObject.html#aa3b19cad6d873b314bba32a3dae85f09">More...</a><br /></td></tr>
<tr class="separator:aa3b19cad6d873b314bba32a3dae85f09"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aece9c525c49900734bc1bebf85b644ef"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1ChannelObject.html#aece9c525c49900734bc1bebf85b644ef">GetDefaultChannel</a> ()</td></tr>
<tr class="memdesc:aece9c525c49900734bc1bebf85b644ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the Default Channel object. <a href="classGpgFrontend_1_1ChannelObject.html#aece9c525c49900734bc1bebf85b644ef">More...</a><br /></td></tr>
<tr class="separator:aece9c525c49900734bc1bebf85b644ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:aee5f8a5575adbdf522da4dd195c091ee"><td class="memItemLeft" align="right" valign="top"><a id="aee5f8a5575adbdf522da4dd195c091ee"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1ChannelObject.html#aee5f8a5575adbdf522da4dd195c091ee">channel_</a> = <a class="el" href="classGpgFrontend_1_1ChannelObject.html#a66295bb572e98fc2fad3afce763ac311">_default_channel</a></td></tr>
<tr class="memdesc:aee5f8a5575adbdf522da4dd195c091ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">The channel id. <br /></td></tr>
<tr class="separator:aee5f8a5575adbdf522da4dd195c091ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-attribs"></a>
Static Private Attributes</h2></td></tr>
<tr class="memitem:a66295bb572e98fc2fad3afce763ac311"><td class="memItemLeft" align="right" valign="top"><a id="a66295bb572e98fc2fad3afce763ac311"></a>
static constexpr int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1ChannelObject.html#a66295bb572e98fc2fad3afce763ac311">_default_channel</a> = 0</td></tr>
<tr class="memdesc:a66295bb572e98fc2fad3afce763ac311"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default channel id. <br /></td></tr>
<tr class="separator:a66295bb572e98fc2fad3afce763ac311"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>object which in channel system </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a68ad2a19339e3cd50626fe0eaad17ccd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68ad2a19339e3cd50626fe0eaad17ccd">&#9670;&nbsp;</a></span>ChannelObject()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GpgFrontend::ChannelObject::ChannelObject </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>channel</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a new Channel Object object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">channel</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a0e13a4bff1cfb679f68a3a2590a3b1b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e13a4bff1cfb679f68a3a2590a3b1b8">&#9670;&nbsp;</a></span>GetChannel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int GpgFrontend::ChannelObject::GetChannel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the Channel object. </p>
<dl class="section return"><dt>Returns</dt><dd>int </dd></dl>
<p class="reference">Referenced by <a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#aa99440b9177f5d0c18840f08a40d64b7">GpgFrontend::SingletonFunctionObject&lt; T &gt;::GetChannel()</a>.</p>
</div>
</div>
<a id="aece9c525c49900734bc1bebf85b644ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aece9c525c49900734bc1bebf85b644ef">&#9670;&nbsp;</a></span>GetDefaultChannel()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int GpgFrontend::ChannelObject::GetDefaultChannel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the Default Channel object. </p>
<dl class="section return"><dt>Returns</dt><dd>int </dd></dl>
<p class="reference">Referenced by <a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#a50e2b3794d6553f4231eaec72d9d0a50">GpgFrontend::SingletonFunctionObject&lt; T &gt;::GetDefaultChannel()</a>.</p>
</div>
</div>
<a id="aa3b19cad6d873b314bba32a3dae85f09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3b19cad6d873b314bba32a3dae85f09">&#9670;&nbsp;</a></span>SetChannel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GpgFrontend::ChannelObject::SetChannel </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>channel</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the Channel object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">channel</td><td>Copyright (C) 2021 Saturneric</td></tr>
</table>
</dd>
</dl>
<p>This file is part of <a class="el" href="namespaceGpgFrontend.html">GpgFrontend</a>.</p>
<p><a class="el" href="namespaceGpgFrontend.html">GpgFrontend</a> 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.</p>
<p><a class="el" href="namespaceGpgFrontend.html">GpgFrontend</a> 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.</p>
<p>You should have received a copy of the GNU General Public License along with <a class="el" href="namespaceGpgFrontend.html">GpgFrontend</a>. If not, see <a href="https://www.gnu.org/licenses/">https://www.gnu.org/licenses/</a>.</p>
<p>The initial version of the source code is inherited from the gpg4usb project, which is under GPL-3.0-or-later.</p>
<p>All the source code of <a class="el" href="namespaceGpgFrontend.html">GpgFrontend</a> was modified and released by Saturneric<a href="#" onclick="location.href='mai'+'lto:'+'eri'+'c@'+'bkt'+'us'+'.co'+'m'; return false;">eric@<span style="display: none;">.nosp@m.</span>bktu<span style="display: none;">.nosp@m.</span>s.com</a> starting on May 12, 2021.</p>
<p>SPDX-License-Identifier: GPL-3.0-or-later </p>
<p class="reference">References <a class="el" href="classGpgFrontend_1_1ChannelObject.html#aee5f8a5575adbdf522da4dd195c091ee">channel_</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/core/<a class="el" href="GpgFunctionObject_8h_source.html">GpgFunctionObject.h</a></li>
<li>src/core/GpgFunctionObject.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceGpgFrontend.html">GpgFrontend</a></li><li class="navelem"><a class="el" href="classGpgFrontend_1_1ChannelObject.html">ChannelObject</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>