GpgFrontend-Doxygen/docs/html/classGpgFrontend_1_1ChannelObject.html

330 lines
19 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="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 is called "channel"
<a href="classGpgFrontend_1_1ChannelObject.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ChannelObject_8h_source.html">ChannelObject.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 is called &quot;channel&quot;" alt="" coords="1907,5,2115,171"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="2050,565,2279,848"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="263,565,493,848"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="1037,565,1266,848"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="1290,565,1519,848"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="770,565,1013,848"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="1543,565,1773,848"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="10,565,239,848"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="517,565,746,848"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="3317,565,3546,848"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="3826,565,4055,848"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="2557,565,2786,848"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="3063,565,3293,848"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="1797,565,2026,848"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="2810,565,3039,848"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="3570,565,3802,848"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="2303,565,2533,848"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="1897,220,2126,503"/>
<area shape="rect" href="classGpgFrontend_1_1GpgUIDOperator.html" title=" " alt="" coords="2055,963,2275,1099"/>
<area shape="rect" href="classGpgFrontend_1_1GpgKeyManager.html" title=" " alt="" coords="268,956,488,1107"/>
<area shape="rect" href="classGpgFrontend_1_1Thread_1_1TaskRunnerGetter.html" title=" " alt="" coords="1055,963,1247,1099"/>
<area shape="rect" href="classGpgFrontend_1_1Module_1_1ModuleManager.html" title=" " alt="" coords="1295,912,1514,1151"/>
<area shape="rect" href="classGpgFrontend_1_1GpgKeyImportExporter.html" title=" " alt="" coords="788,956,995,1107"/>
<area shape="rect" href="classGpgFrontend_1_1GpgKeyGetter_1_1Impl.html" title=" " alt="" coords="1556,897,1760,1165"/>
<area shape="rect" href="classGpgFrontend_1_1GpgKeyOpera.html" title=" " alt="" coords="5,905,244,1158"/>
<area shape="rect" href="classGpgFrontend_1_1GpgFileOpera.html" title=" " alt="" coords="516,912,747,1151"/>
<area shape="rect" href="classGpgFrontend_1_1GpgKeyGetter.html" title=" " alt="" coords="3329,934,3533,1129"/>
<area shape="rect" href="classGpgFrontend_1_1CacheManager.html" title=" " alt="" coords="3835,934,4046,1129"/>
<area shape="rect" href="classGpgFrontend_1_1LoggerManager.html" title=" " alt="" coords="2564,934,2779,1129"/>
<area shape="rect" href="classGpgFrontend_1_1GpgBasicOperator.html" title="Basic operation collection." alt="" coords="3071,919,3301,1143"/>
<area shape="rect" href="classGpgFrontend_1_1GlobalSettingStation.html" title="Singleton class for managing global settings in the application." alt="" coords="1808,912,2015,1151"/>
<area shape="rect" href="classGpgFrontend_1_1DataObjectOperator.html" title=" " alt="" coords="2803,934,3046,1129"/>
<area shape="rect" href="classGpgFrontend_1_1PassphraseGenerator.html" title="The PassphraseGenerator class." alt="" coords="3561,978,3811,1085"/>
<area shape="rect" href="classGpgFrontend_1_1GpgContext.html" title=" " alt="" coords="2323,956,2513,1107"/>
</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 is called &quot;channel&quot;" alt="" coords="5,5,213,171"/>
</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:a85a29ff6a1233114eb9f159c408cbe35"><td class="memItemLeft" align="right" valign="top"><a id="a85a29ff6a1233114eb9f159c408cbe35"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1ChannelObject.html#a85a29ff6a1233114eb9f159c408cbe35">~ChannelObject</a> () noexcept</td></tr>
<tr class="memdesc:a85a29ff6a1233114eb9f159c408cbe35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy the Channel Object object. <br /></td></tr>
<tr class="separator:a85a29ff6a1233114eb9f159c408cbe35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d55a57ee60bdb5a747125da9586a0e5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1ChannelObject.html#a3d55a57ee60bdb5a747125da9586a0e5">ChannelObject</a> (int channel, QString type)</td></tr>
<tr class="memdesc:a3d55a57ee60bdb5a747125da9586a0e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new Channel Object object. <a href="classGpgFrontend_1_1ChannelObject.html#a3d55a57ee60bdb5a747125da9586a0e5">More...</a><br /></td></tr>
<tr class="separator:a3d55a57ee60bdb5a747125da9586a0e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a085b36517fcc46916279b9d633da2d26"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1ChannelObject.html#a085b36517fcc46916279b9d633da2d26">GetChannel</a> () const -&gt; int</td></tr>
<tr class="memdesc:a085b36517fcc46916279b9d633da2d26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the Channel object. <a href="classGpgFrontend_1_1ChannelObject.html#a085b36517fcc46916279b9d633da2d26">More...</a><br /></td></tr>
<tr class="separator:a085b36517fcc46916279b9d633da2d26"><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:a6a3672c8ff3d4fb5ef6bc1bda202bbb8"><td class="memItemLeft" align="right" valign="top">static auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1ChannelObject.html#a6a3672c8ff3d4fb5ef6bc1bda202bbb8">GetDefaultChannel</a> () -&gt; int</td></tr>
<tr class="memdesc:a6a3672c8ff3d4fb5ef6bc1bda202bbb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the Default Channel object. <a href="classGpgFrontend_1_1ChannelObject.html#a6a3672c8ff3d4fb5ef6bc1bda202bbb8">More...</a><br /></td></tr>
<tr class="separator:a6a3672c8ff3d4fb5ef6bc1bda202bbb8"><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> = kGpgFrontendDefaultChannel</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>
<tr class="memitem:a2864add31ca45349ac40e7fc275c34ad"><td class="memItemLeft" align="right" valign="top"><a id="a2864add31ca45349ac40e7fc275c34ad"></a>
QString&#160;</td><td class="memItemRight" valign="bottom"><b>type_</b></td></tr>
<tr class="separator:a2864add31ca45349ac40e7fc275c34ad"><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 is called "channel" </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3d55a57ee60bdb5a747125da9586a0e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d55a57ee60bdb5a747125da9586a0e5">&#9670;&nbsp;</a></span>ChannelObject()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QString&#160;</td>
<td class="paramname"><em>type</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </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="a085b36517fcc46916279b9d633da2d26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a085b36517fcc46916279b9d633da2d26">&#9670;&nbsp;</a></span>GetChannel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">auto GpgFrontend::ChannelObject::GetChannel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const -&gt; int</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">References <a class="el" href="classGpgFrontend_1_1ChannelObject.html#aee5f8a5575adbdf522da4dd195c091ee">channel_</a>.</p>
<p class="reference">Referenced by <a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#a94ee1e1251023610590e675ae3de8bd5">GpgFrontend::SingletonFunctionObject&lt; T &gt;::GetChannel()</a>.</p>
</div>
</div>
<a id="a6a3672c8ff3d4fb5ef6bc1bda202bbb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a3672c8ff3d4fb5ef6bc1bda202bbb8">&#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">auto GpgFrontend::ChannelObject::GetDefaultChannel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> -&gt; int</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#ad983153cbe3a0c32c123c506e04f31fc">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></td></tr>
</table>
</dd>
</dl>
<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/function/basic/<a class="el" href="ChannelObject_8h_source.html">ChannelObject.h</a></li>
<li>src/core/function/basic/ChannelObject.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>