GpgFrontend-Doxygen/docs/html/ChannelObject_8h_source.html

143 lines
11 KiB
HTML
Raw Permalink Normal View History

<!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: src/core/function/basic/ChannelObject.h Source File</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('ChannelObject_8h_source.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="headertitle">
<div class="title">ChannelObject.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &quot;core/GpgConstants.h&quot;</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#include &quot;core/function/SecureMemoryAllocator.h&quot;</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceGpgFrontend.html">GpgFrontend</a> {</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1ChannelObject.html"> 39</a></span>&#160;<span class="keyword">class </span>GPGFRONTEND_CORE_EXPORT <a class="code" href="classGpgFrontend_1_1ChannelObject.html">ChannelObject</a> {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1ChannelObject.html#aedbf32eddc701e521bd8e790ef208da0"> 45</a></span>&#160; <a class="code" href="classGpgFrontend_1_1ChannelObject.html#aedbf32eddc701e521bd8e790ef208da0">ChannelObject</a>() noexcept;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1ChannelObject.html#a85a29ff6a1233114eb9f159c408cbe35"> 51</a></span>&#160; virtual ~<a class="code" href="classGpgFrontend_1_1ChannelObject.html">ChannelObject</a>() noexcept;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; explicit <a class="code" href="classGpgFrontend_1_1ChannelObject.html">ChannelObject</a>(<span class="keywordtype">int</span> channel, QString type);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; static auto GetDefaultChannel() -&gt; <span class="keywordtype">int</span>;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; [[nodiscard]] auto GetChannel() const -&gt; <span class="keywordtype">int</span>;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordtype">void</span> SetChannel(<span class="keywordtype">int</span> channel);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; private:</div>
<div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1ChannelObject.html#aee5f8a5575adbdf522da4dd195c091ee"> 82</a></span>&#160; <span class="keywordtype">int</span> channel_ = kGpgFrontendDefaultChannel; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; QString type_;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;};</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;template &lt;typename Derived&gt;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;auto ConvertToChannelObjectPtr(</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; std::unique_ptr&lt;Derived, <a class="code" href="structGpgFrontend_1_1SecureObjectDeleter.html">SecureObjectDeleter</a>&lt;Derived&gt;&gt; derivedPtr)</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; -&gt; std::unique_ptr&lt;<a class="code" href="classGpgFrontend_1_1ChannelObject.html">ChannelObject</a>, <a class="code" href="structGpgFrontend_1_1SecureObjectDeleter.html">SecureObjectDeleter</a>&lt;<a class="code" href="classGpgFrontend_1_1ChannelObject.html">ChannelObject</a>&gt;&gt; {</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; static_assert(std::is_base_of_v&lt;ChannelObject, Derived&gt;,</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="stringliteral">&quot;Derived must be a subclass of ChannelObject&quot;</span>);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <a class="code" href="classGpgFrontend_1_1ChannelObject.html">ChannelObject</a>* base_ptr = derivedPtr.release();</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordflow">return</span> std::unique_ptr&lt;ChannelObject, SecureObjectDeleter&lt;ChannelObject&gt;&gt;(</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; base_ptr);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;}</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;} <span class="comment">// namespace GpgFrontend</span></div>
<div class="ttc" id="aclassGpgFrontend_1_1ChannelObject_html"><div class="ttname"><a href="classGpgFrontend_1_1ChannelObject.html">GpgFrontend::ChannelObject</a></div><div class="ttdoc">object which in channel system is called &quot;channel&quot;</div><div class="ttdef"><b>Definition:</b> ChannelObject.h:39</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1ChannelObject_html_aedbf32eddc701e521bd8e790ef208da0"><div class="ttname"><a href="classGpgFrontend_1_1ChannelObject.html#aedbf32eddc701e521bd8e790ef208da0">GpgFrontend::ChannelObject::ChannelObject</a></div><div class="ttdeci">ChannelObject() noexcept</div><div class="ttdoc">Construct a new Default Channel Object object.</div></div>
<div class="ttc" id="anamespaceGpgFrontend_html"><div class="ttname"><a href="namespaceGpgFrontend.html">GpgFrontend</a></div><div class="ttdef"><b>Definition:</b> app.cpp:39</div></div>
<div class="ttc" id="astructGpgFrontend_1_1SecureObjectDeleter_html"><div class="ttname"><a href="structGpgFrontend_1_1SecureObjectDeleter.html">GpgFrontend::SecureObjectDeleter</a></div><div class="ttdef"><b>Definition:</b> SecureMemoryAllocator.h:48</div></div>
</div><!-- fragment --></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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_aebb8dcc11953d78e620bbef0b9e2183.html">core</a></li><li class="navelem"><a class="el" href="dir_f8a0abd6d3586538a5b71803e0ab7ffa.html">function</a></li><li class="navelem"><a class="el" href="dir_349f63dde462615a894f6d883b92d19c.html">basic</a></li><li class="navelem"><b>ChannelObject.h</b></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>