GpgFrontend-Doxygen/docs/html/classGpgFrontend_1_1GpgBasicOperator.html

780 lines
60 KiB
HTML
Raw Normal View History

2022-05-08 19:59:26 +00:00
<!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"/>
2022-05-08 22:01:23 +00:00
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
2022-05-08 19:59:26 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GpgFrontend Project: GpgFrontend::GpgBasicOperator 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>
2022-05-08 22:01:23 +00:00
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
2022-05-08 19:59:26 +00:00
<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 -->
2022-05-08 19:59:26 +00:00
<script type="text/javascript">
2022-05-08 22:01:23 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
2022-05-08 19:59:26 +00:00
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
2022-05-08 22:01:23 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2022-05-08 19:59:26 +00:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
2022-05-08 22:01:23 +00:00
/* @license-end */</script>
2022-05-08 19:59:26 +00:00
<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">
2022-05-08 22:01:23 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2022-05-08 19:59:26 +00:00
$(document).ready(function(){initNavTree('classGpgFrontend_1_1GpgBasicOperator.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="#pri-attribs">Private Attributes</a> &#124;
<a href="classGpgFrontend_1_1GpgBasicOperator-members.html">List of all members</a> </div>
2022-05-08 22:01:23 +00:00
<div class="headertitle">
<div class="title">GpgFrontend::GpgBasicOperator Class Reference</div> </div>
2022-05-08 19:59:26 +00:00
</div><!--header-->
<div class="contents">
<p>Basic operation collection.
<a href="classGpgFrontend_1_1GpgBasicOperator.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="GpgBasicOperator_8h_source.html">GpgBasicOperator.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for GpgFrontend::GpgBasicOperator:</div>
<div class="dyncontent">
<div class="center"><img src="classGpgFrontend_1_1GpgBasicOperator__inherit__graph.png" border="0" usemap="#aGpgFrontend_1_1GpgBasicOperator_inherit__map" alt="Inheritance graph"/></div>
<map name="aGpgFrontend_1_1GpgBasicOperator_inherit__map" id="aGpgFrontend_1_1GpgBasicOperator_inherit__map">
<area shape="rect" title="Basic operation collection." alt="" coords="5,883,236,1092"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="6,551,235,833"/>
<area shape="rect" href="classGpgFrontend_1_1ChannelObject.html" title="object which in channel system" alt="" coords="11,5,219,156"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="137,205,366,488"/>
2022-05-08 22:01:23 +00:00
</map>
2022-05-08 19:59:26 +00:00
</div>
<div class="dynheader">
Collaboration diagram for GpgFrontend::GpgBasicOperator:</div>
<div class="dyncontent">
<div class="center"><img src="classGpgFrontend_1_1GpgBasicOperator__coll__graph.png" border="0" usemap="#aGpgFrontend_1_1GpgBasicOperator_coll__map" alt="Collaboration graph"/></div>
<map name="aGpgFrontend_1_1GpgBasicOperator_coll__map" id="aGpgFrontend_1_1GpgBasicOperator_coll__map">
<area shape="rect" title="Basic operation collection." alt="" coords="97,1832,327,2041"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="5,1156,235,1439"/>
<area shape="rect" href="classGpgFrontend_1_1ChannelObject.html" title="object which in channel system" alt="" coords="192,315,400,465"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="181,675,411,957"/>
<area shape="rect" href="classGpgFrontend_1_1SingletonFunctionObject.html" title=" " alt="" coords="357,1156,587,1439"/>
<area shape="rect" href="classGpgFrontend_1_1GpgContext.html" title=" " alt="" coords="509,1501,739,1769"/>
<area shape="rect" title=" " alt="" coords="259,1259,333,1336"/>
<area shape="rect" title=" " alt="" coords="548,517,735,623"/>
<area shape="rect" title=" " alt="" coords="751,160,908,237"/>
<area shape="rect" title=" " alt="" coords="1206,13,1245,90"/>
<area shape="rect" title=" " alt="" coords="1177,160,1306,237"/>
<area shape="rect" title=" " alt="" coords="1359,160,1494,237"/>
<area shape="rect" title=" " alt="" coords="699,777,842,855"/>
<area shape="rect" href="classGpgFrontend_1_1GpgInfo.html" title="Use to record some info about gnupg." alt="" coords="951,1259,1115,1336"/>
<area shape="rect" href="structGpgFrontend_1_1GpgContextInitArgs.html" title=" " alt="" coords="725,981,965,1132"/>
<area shape="rect" title=" " alt="" coords="1051,160,1138,237"/>
<area shape="rect" title=" " alt="" coords="1133,770,1339,862"/>
<area shape="rect" title=" " alt="" coords="1192,351,1379,429"/>
<area shape="rect" title=" " alt="" coords="1025,5,1164,97"/>
<area shape="rect" title=" " alt="" coords="1422,13,1461,90"/>
2022-05-08 22:01:23 +00:00
</map>
2022-05-08 19:59:26 +00:00
</div>
<table class="memberdecls">
2022-05-08 22:01:23 +00:00
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
2022-05-08 19:59:26 +00:00
Public Member Functions</h2></td></tr>
<tr class="memitem:a139be86330f88e5f833aa24263a3b2ae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html#a139be86330f88e5f833aa24263a3b2ae">GpgBasicOperator</a> (int channel=<a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#a50e2b3794d6553f4231eaec72d9d0a50">SingletonFunctionObject::GetDefaultChannel</a>())</td></tr>
<tr class="memdesc:a139be86330f88e5f833aa24263a3b2ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new Basic Operator object. <a href="classGpgFrontend_1_1GpgBasicOperator.html#a139be86330f88e5f833aa24263a3b2ae">More...</a><br /></td></tr>
<tr class="separator:a139be86330f88e5f833aa24263a3b2ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32e1eac6bb0f322588ae75ae36a9884a"><td class="memItemLeft" align="right" valign="top">gpg_error_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html#a32e1eac6bb0f322588ae75ae36a9884a">Encrypt</a> (KeyListPtr keys, BypeArrayRef in_buffer, ByteArrayPtr &amp;out_buffer, GpgEncrResult &amp;result)</td></tr>
<tr class="memdesc:a32e1eac6bb0f322588ae75ae36a9884a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Call the interface provided by gpgme for encryption operation. <a href="classGpgFrontend_1_1GpgBasicOperator.html#a32e1eac6bb0f322588ae75ae36a9884a">More...</a><br /></td></tr>
<tr class="separator:a32e1eac6bb0f322588ae75ae36a9884a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f4ef57e941a066ad9d070eee51e2073"><td class="memItemLeft" align="right" valign="top">gpg_error_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html#a8f4ef57e941a066ad9d070eee51e2073">EncryptSymmetric</a> (BypeArrayRef in_buffer, ByteArrayPtr &amp;out_buffer, GpgEncrResult &amp;result)</td></tr>
<tr class="memdesc:a8f4ef57e941a066ad9d070eee51e2073"><td class="mdescLeft">&#160;</td><td class="mdescRight">Call the interface provided by GPGME to symmetrical encryption. <a href="classGpgFrontend_1_1GpgBasicOperator.html#a8f4ef57e941a066ad9d070eee51e2073">More...</a><br /></td></tr>
<tr class="separator:a8f4ef57e941a066ad9d070eee51e2073"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08906cf2bc2ddad8489438610f388f8a"><td class="memItemLeft" align="right" valign="top">gpgme_error_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html#a08906cf2bc2ddad8489438610f388f8a">EncryptSign</a> (KeyListPtr keys, KeyListPtr signers, BypeArrayRef in_buffer, ByteArrayPtr &amp;out_buffer, GpgEncrResult &amp;encr_result, GpgSignResult &amp;sign_result)</td></tr>
<tr class="memdesc:a08906cf2bc2ddad8489438610f388f8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Call the interface provided by gpgme to perform encryption and signature operations at the same time. <a href="classGpgFrontend_1_1GpgBasicOperator.html#a08906cf2bc2ddad8489438610f388f8a">More...</a><br /></td></tr>
<tr class="separator:a08906cf2bc2ddad8489438610f388f8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ea9e81194917e08f46eb657281b7953"><td class="memItemLeft" align="right" valign="top">gpgme_error_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html#a9ea9e81194917e08f46eb657281b7953">Decrypt</a> (BypeArrayRef in_buffer, ByteArrayPtr &amp;out_buffer, GpgDecrResult &amp;result)</td></tr>
<tr class="memdesc:a9ea9e81194917e08f46eb657281b7953"><td class="mdescLeft">&#160;</td><td class="mdescRight">Call the interface provided by gpgme for decryption operation. <a href="classGpgFrontend_1_1GpgBasicOperator.html#a9ea9e81194917e08f46eb657281b7953">More...</a><br /></td></tr>
<tr class="separator:a9ea9e81194917e08f46eb657281b7953"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11845a9a3ea2941e14faa9130f0ac9ef"><td class="memItemLeft" align="right" valign="top">gpgme_error_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html#a11845a9a3ea2941e14faa9130f0ac9ef">DecryptVerify</a> (BypeArrayRef in_buffer, ByteArrayPtr &amp;out_buffer, GpgDecrResult &amp;decrypt_result, GpgVerifyResult &amp;verify_result)</td></tr>
<tr class="memdesc:a11845a9a3ea2941e14faa9130f0ac9ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Call the interface provided by gpgme to perform decryption and verification operations at the same time. <a href="classGpgFrontend_1_1GpgBasicOperator.html#a11845a9a3ea2941e14faa9130f0ac9ef">More...</a><br /></td></tr>
<tr class="separator:a11845a9a3ea2941e14faa9130f0ac9ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0347cb28ff73b2250395ceaa9001509"><td class="memItemLeft" align="right" valign="top">gpgme_error_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html#af0347cb28ff73b2250395ceaa9001509">Verify</a> (BypeArrayRef in_buffer, ByteArrayPtr &amp;sig_buffer, GpgVerifyResult &amp;result) const</td></tr>
<tr class="memdesc:af0347cb28ff73b2250395ceaa9001509"><td class="mdescLeft">&#160;</td><td class="mdescRight">Call the interface provided by gpgme for verification operation. <a href="classGpgFrontend_1_1GpgBasicOperator.html#af0347cb28ff73b2250395ceaa9001509">More...</a><br /></td></tr>
<tr class="separator:af0347cb28ff73b2250395ceaa9001509"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a988d7e65e85fc7a578f26300332a65d3"><td class="memItemLeft" align="right" valign="top">gpg_error_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html#a988d7e65e85fc7a578f26300332a65d3">Sign</a> (KeyListPtr signers, BypeArrayRef in_buffer, ByteArrayPtr &amp;out_buffer, gpgme_sig_mode_t mode, GpgSignResult &amp;result)</td></tr>
<tr class="memdesc:a988d7e65e85fc7a578f26300332a65d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Call the interface provided by gpgme for signing operation. <a href="classGpgFrontend_1_1GpgBasicOperator.html#a988d7e65e85fc7a578f26300332a65d3">More...</a><br /></td></tr>
<tr class="separator:a988d7e65e85fc7a578f26300332a65d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6ea3596ba7d7543fb1b8233d09996df"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html#ad6ea3596ba7d7543fb1b8233d09996df">SetSigners</a> (KeyArgsList &amp;signers)</td></tr>
<tr class="memdesc:ad6ea3596ba7d7543fb1b8233d09996df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the private key for signatures, this operation is a global operation. <a href="classGpgFrontend_1_1GpgBasicOperator.html#ad6ea3596ba7d7543fb1b8233d09996df">More...</a><br /></td></tr>
<tr class="separator:ad6ea3596ba7d7543fb1b8233d09996df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78f37b8d5afd6c0248665a4415f880cf"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; KeyArgsList &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html#a78f37b8d5afd6c0248665a4415f880cf">GetSigners</a> ()</td></tr>
<tr class="memdesc:a78f37b8d5afd6c0248665a4415f880cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a global signature private keys that has been set. <a href="classGpgFrontend_1_1GpgBasicOperator.html#a78f37b8d5afd6c0248665a4415f880cf">More...</a><br /></td></tr>
<tr class="separator:a78f37b8d5afd6c0248665a4415f880cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classGpgFrontend_1_1SingletonFunctionObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classGpgFrontend_1_1SingletonFunctionObject')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html">GpgFrontend::SingletonFunctionObject&lt; GpgBasicOperator &gt;</a></td></tr>
<tr class="memitem:a194e49b07d46345bdad386505d743a61 inherit pub_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memItemLeft" align="right" valign="top"><a id="a194e49b07d46345bdad386505d743a61"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#a194e49b07d46345bdad386505d743a61">SingletonFunctionObject</a> (const <a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html">SingletonFunctionObject</a>&lt; <a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html">GpgBasicOperator</a> &gt; &amp;)=delete</td></tr>
<tr class="memdesc:a194e49b07d46345bdad386505d743a61 inherit pub_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">prohibit copy <br /></td></tr>
<tr class="separator:a194e49b07d46345bdad386505d743a61 inherit pub_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabc5fe8e5a372ac276a265286457cb9a inherit pub_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memItemLeft" align="right" valign="top"><a id="aabc5fe8e5a372ac276a265286457cb9a"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#aabc5fe8e5a372ac276a265286457cb9a">SingletonFunctionObject</a> (<a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html">GpgBasicOperator</a> &amp;&amp;)=delete</td></tr>
<tr class="memdesc:aabc5fe8e5a372ac276a265286457cb9a inherit pub_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new Singleton Function Object object. <br /></td></tr>
2022-05-08 19:59:26 +00:00
<tr class="separator:aabc5fe8e5a372ac276a265286457cb9a inherit pub_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7090636bed6f4bad5b99f28f6872c645 inherit pub_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memItemLeft" align="right" valign="top"><a id="a7090636bed6f4bad5b99f28f6872c645"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#a7090636bed6f4bad5b99f28f6872c645">SingletonFunctionObject</a> (const <a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html">GpgBasicOperator</a> &amp;)=delete</td></tr>
<tr class="memdesc:a7090636bed6f4bad5b99f28f6872c645 inherit pub_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new Singleton Function Object object. <br /></td></tr>
2022-05-08 19:59:26 +00:00
<tr class="separator:a7090636bed6f4bad5b99f28f6872c645 inherit pub_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabb190a60f7a5d4ded43cae16ab8f59e inherit pub_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html">SingletonFunctionObject</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#aabb190a60f7a5d4ded43cae16ab8f59e">operator=</a> (const <a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html">SingletonFunctionObject</a>&lt; <a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html">GpgBasicOperator</a> &gt; &amp;)=delete</td></tr>
<tr class="memdesc:aabb190a60f7a5d4ded43cae16ab8f59e inherit pub_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">prohibit copy <a href="classGpgFrontend_1_1SingletonFunctionObject.html#aabb190a60f7a5d4ded43cae16ab8f59e">More...</a><br /></td></tr>
<tr class="separator:aabb190a60f7a5d4ded43cae16ab8f59e inherit pub_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
2022-05-08 22:01:23 +00:00
<tr class="memitem:a03ce3095a745ecbf5e6a032e7da4bc97 inherit pub_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memItemLeft" align="right" valign="top"><a id="a03ce3095a745ecbf5e6a032e7da4bc97"></a>
2022-05-08 19:59:26 +00:00
void&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html">GpgBasicOperator</a> &amp;)=delete</td></tr>
<tr class="separator:a03ce3095a745ecbf5e6a032e7da4bc97 inherit pub_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa99440b9177f5d0c18840f08a40d64b7 inherit pub_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#aa99440b9177f5d0c18840f08a40d64b7">GetChannel</a> () const</td></tr>
<tr class="memdesc:aa99440b9177f5d0c18840f08a40d64b7 inherit pub_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the Channel object. <a href="classGpgFrontend_1_1SingletonFunctionObject.html#aa99440b9177f5d0c18840f08a40d64b7">More...</a><br /></td></tr>
<tr class="separator:aa99440b9177f5d0c18840f08a40d64b7 inherit pub_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classGpgFrontend_1_1ChannelObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classGpgFrontend_1_1ChannelObject')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classGpgFrontend_1_1ChannelObject.html">GpgFrontend::ChannelObject</a></td></tr>
<tr class="memitem:aedbf32eddc701e521bd8e790ef208da0 inherit pub_methods_classGpgFrontend_1_1ChannelObject"><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 inherit pub_methods_classGpgFrontend_1_1ChannelObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new Default Channel Object object. <br /></td></tr>
<tr class="separator:aedbf32eddc701e521bd8e790ef208da0 inherit pub_methods_classGpgFrontend_1_1ChannelObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68ad2a19339e3cd50626fe0eaad17ccd inherit pub_methods_classGpgFrontend_1_1ChannelObject"><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 inherit pub_methods_classGpgFrontend_1_1ChannelObject"><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 inherit pub_methods_classGpgFrontend_1_1ChannelObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e13a4bff1cfb679f68a3a2590a3b1b8 inherit pub_methods_classGpgFrontend_1_1ChannelObject"><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 inherit pub_methods_classGpgFrontend_1_1ChannelObject"><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 inherit pub_methods_classGpgFrontend_1_1ChannelObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3b19cad6d873b314bba32a3dae85f09 inherit pub_methods_classGpgFrontend_1_1ChannelObject"><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 inherit pub_methods_classGpgFrontend_1_1ChannelObject"><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 inherit pub_methods_classGpgFrontend_1_1ChannelObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
2022-05-08 19:59:26 +00:00
</table><table class="memberdecls">
2022-05-08 22:01:23 +00:00
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
2022-05-08 19:59:26 +00:00
Private Attributes</h2></td></tr>
<tr class="memitem:afad990a43ab06a060a93db9948ebb740"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGpgFrontend_1_1GpgContext.html">GpgContext</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html#afad990a43ab06a060a93db9948ebb740">ctx_</a></td></tr>
<tr class="memdesc:afad990a43ab06a060a93db9948ebb740"><td class="mdescLeft">&#160;</td><td class="mdescRight">Corresponding context. <a href="classGpgFrontend_1_1GpgBasicOperator.html#afad990a43ab06a060a93db9948ebb740">More...</a><br /></td></tr>
<tr class="separator:afad990a43ab06a060a93db9948ebb740"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
2022-05-08 22:01:23 +00:00
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
2022-05-08 19:59:26 +00:00
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classGpgFrontend_1_1SingletonFunctionObject"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classGpgFrontend_1_1SingletonFunctionObject')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html">GpgFrontend::SingletonFunctionObject&lt; GpgBasicOperator &gt;</a></td></tr>
2022-05-08 22:01:23 +00:00
<tr class="memitem:a70484d7cfe9f9dcbcd5f8bb749250f36 inherit pub_static_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html">GpgBasicOperator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#a70484d7cfe9f9dcbcd5f8bb749250f36">GetInstance</a> (int channel=GpgFrontend::GPGFRONTEND_DEFAULT_CHANNEL)</td></tr>
<tr class="memdesc:a70484d7cfe9f9dcbcd5f8bb749250f36 inherit pub_static_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the Instance object. <a href="classGpgFrontend_1_1SingletonFunctionObject.html#a70484d7cfe9f9dcbcd5f8bb749250f36">More...</a><br /></td></tr>
<tr class="separator:a70484d7cfe9f9dcbcd5f8bb749250f36 inherit pub_static_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a083807ff8cec58dc0aa732844edaf518 inherit pub_static_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html">GpgBasicOperator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#a083807ff8cec58dc0aa732844edaf518">CreateInstance</a> (int channel, std::function&lt; std::unique_ptr&lt; <a class="el" href="classGpgFrontend_1_1ChannelObject.html">ChannelObject</a> &gt;(void)&gt; factory)</td></tr>
<tr class="memdesc:a083807ff8cec58dc0aa732844edaf518 inherit pub_static_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a Instance object. <a href="classGpgFrontend_1_1SingletonFunctionObject.html#a083807ff8cec58dc0aa732844edaf518">More...</a><br /></td></tr>
<tr class="separator:a083807ff8cec58dc0aa732844edaf518 inherit pub_static_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab49b1d50252e1934691a9483a6df2106 inherit pub_static_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#ab49b1d50252e1934691a9483a6df2106">ReleaseChannel</a> (int channel)</td></tr>
<tr class="separator:ab49b1d50252e1934691a9483a6df2106 inherit pub_static_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
2022-05-08 19:59:26 +00:00
<tr class="memitem:a50e2b3794d6553f4231eaec72d9d0a50 inherit pub_static_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#a50e2b3794d6553f4231eaec72d9d0a50">GetDefaultChannel</a> ()</td></tr>
<tr class="memdesc:a50e2b3794d6553f4231eaec72d9d0a50 inherit pub_static_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the Default Channel object. <a href="classGpgFrontend_1_1SingletonFunctionObject.html#a50e2b3794d6553f4231eaec72d9d0a50">More...</a><br /></td></tr>
<tr class="separator:a50e2b3794d6553f4231eaec72d9d0a50 inherit pub_static_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f2f0474871971f86ff91fb6a2408621 inherit pub_static_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memItemLeft" align="right" valign="top">static std::vector&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#a5f2f0474871971f86ff91fb6a2408621">GetAllChannelId</a> ()</td></tr>
<tr class="memdesc:a5f2f0474871971f86ff91fb6a2408621 inherit pub_static_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get all the channel ids. <a href="classGpgFrontend_1_1SingletonFunctionObject.html#a5f2f0474871971f86ff91fb6a2408621">More...</a><br /></td></tr>
<tr class="separator:a5f2f0474871971f86ff91fb6a2408621 inherit pub_static_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_static_methods_classGpgFrontend_1_1ChannelObject"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classGpgFrontend_1_1ChannelObject')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classGpgFrontend_1_1ChannelObject.html">GpgFrontend::ChannelObject</a></td></tr>
<tr class="memitem:aece9c525c49900734bc1bebf85b644ef inherit pub_static_methods_classGpgFrontend_1_1ChannelObject"><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 inherit pub_static_methods_classGpgFrontend_1_1ChannelObject"><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 inherit pub_static_methods_classGpgFrontend_1_1ChannelObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
2022-05-08 19:59:26 +00:00
<tr class="inherit_header pro_methods_classGpgFrontend_1_1SingletonFunctionObject"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classGpgFrontend_1_1SingletonFunctionObject')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html">GpgFrontend::SingletonFunctionObject&lt; GpgBasicOperator &gt;</a></td></tr>
<tr class="memitem:a02e76b42ab51d77588b01c7508bed258 inherit pro_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memItemLeft" align="right" valign="top"><a id="a02e76b42ab51d77588b01c7508bed258"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#a02e76b42ab51d77588b01c7508bed258">SingletonFunctionObject</a> ()=default</td></tr>
<tr class="memdesc:a02e76b42ab51d77588b01c7508bed258 inherit pro_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new Singleton Function Object object. <br /></td></tr>
2022-05-08 19:59:26 +00:00
<tr class="separator:a02e76b42ab51d77588b01c7508bed258 inherit pro_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4aa7f1eb1d3281bb1fccfcbb1b416251 inherit pro_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#a4aa7f1eb1d3281bb1fccfcbb1b416251">SingletonFunctionObject</a> (int channel)</td></tr>
<tr class="memdesc:a4aa7f1eb1d3281bb1fccfcbb1b416251 inherit pro_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new Singleton Function Object object. <a href="classGpgFrontend_1_1SingletonFunctionObject.html#a4aa7f1eb1d3281bb1fccfcbb1b416251">More...</a><br /></td></tr>
<tr class="separator:a4aa7f1eb1d3281bb1fccfcbb1b416251 inherit pro_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8296be8c449f88175285186831b995bc inherit pro_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memItemLeft" align="right" valign="top"><a id="a8296be8c449f88175285186831b995bc"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#a8296be8c449f88175285186831b995bc">~SingletonFunctionObject</a> ()=default</td></tr>
<tr class="memdesc:a8296be8c449f88175285186831b995bc inherit pro_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy the Singleton Function Object object. <br /></td></tr>
2022-05-08 19:59:26 +00:00
<tr class="separator:a8296be8c449f88175285186831b995bc inherit pro_methods_classGpgFrontend_1_1SingletonFunctionObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
2022-05-08 22:01:23 +00:00
<div class="textblock"><p>Basic operation collection. </p>
2022-05-08 19:59:26 +00:00
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
2022-05-08 22:01:23 +00:00
<a id="a139be86330f88e5f833aa24263a3b2ae"></a>
2022-05-08 19:59:26 +00:00
<h2 class="memtitle"><span class="permalink"><a href="#a139be86330f88e5f833aa24263a3b2ae">&#9670;&nbsp;</a></span>GpgBasicOperator()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">GpgFrontend::GpgBasicOperator::GpgBasicOperator </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>channel</em> = <code><a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#a50e2b3794d6553f4231eaec72d9d0a50">SingletonFunctionObject::GetDefaultChannel</a>()</code></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 Basic Operator object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">channel</td><td>Channel corresponding to the context</td></tr>
</table>
</dd>
</dl>
<p>Copyright (C) 2021 Saturneric</p>
2022-05-08 22:01:23 +00:00
<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>
2022-05-08 19:59:26 +00:00
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
2022-05-08 22:01:23 +00:00
<a id="a9ea9e81194917e08f46eb657281b7953"></a>
2022-05-08 19:59:26 +00:00
<h2 class="memtitle"><span class="permalink"><a href="#a9ea9e81194917e08f46eb657281b7953">&#9670;&nbsp;</a></span>Decrypt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GpgFrontend::GpgError GpgFrontend::GpgBasicOperator::Decrypt </td>
<td>(</td>
<td class="paramtype">BypeArrayRef&#160;</td>
<td class="paramname"><em>in_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GpgFrontend::ByteArrayPtr &amp;&#160;</td>
<td class="paramname"><em>out_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GpgFrontend::GpgDecrResult &amp;&#160;</td>
<td class="paramname"><em>result</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call the interface provided by gpgme for decryption operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">in_buffer</td><td>data that needs to be decrypted </td></tr>
<tr><td class="paramname">out_buffer</td><td>decrypted data </td></tr>
<tr><td class="paramname">result</td><td>the result of the operation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>error code </dd></dl>
<p class="reference">References <a class="el" href="namespaceGpgFrontend.html#a2a6566f59b4be29e453a1edd93f6a337">GpgFrontend::_new_result()</a>, <a class="el" href="namespaceGpgFrontend.html#afdad4e5f4c3ac891c09216e245c0f48e">GpgFrontend::check_gpg_error()</a>, and <a class="el" href="classGpgFrontend_1_1GpgData.html#ae382a34ec551561315deca84c71c19c1">GpgFrontend::GpgData::Read2Buffer()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classGpgFrontend_1_1GpgFileOpera.html#a74eb3ba532a236d8ad284b41265b0ccd">GpgFrontend::GpgFileOpera::DecryptFile()</a>, and <a class="el" href="classGpgFrontend_1_1UI_1_1MainWindow.html#ae2d89e2cc6c99ff0e16b396d2381f904">GpgFrontend::UI::MainWindow::slot_decrypt()</a>.</p>
</div>
</div>
2022-05-08 22:01:23 +00:00
<a id="a11845a9a3ea2941e14faa9130f0ac9ef"></a>
2022-05-08 19:59:26 +00:00
<h2 class="memtitle"><span class="permalink"><a href="#a11845a9a3ea2941e14faa9130f0ac9ef">&#9670;&nbsp;</a></span>DecryptVerify()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gpgme_error_t GpgFrontend::GpgBasicOperator::DecryptVerify </td>
<td>(</td>
<td class="paramtype">BypeArrayRef&#160;</td>
<td class="paramname"><em>in_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ByteArrayPtr &amp;&#160;</td>
<td class="paramname"><em>out_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GpgDecrResult &amp;&#160;</td>
<td class="paramname"><em>decrypt_result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GpgVerifyResult &amp;&#160;</td>
<td class="paramname"><em>verify_result</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call the interface provided by gpgme to perform decryption and verification operations at the same time. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">in_buffer</td><td>data to be manipulated </td></tr>
<tr><td class="paramname">out_buffer</td><td>data resulting from decryption operation </td></tr>
<tr><td class="paramname">decrypt_result</td><td>the result of the decrypting operation </td></tr>
<tr><td class="paramname">verify_result</td><td>the result of the verifying operation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>error code </dd></dl>
<p class="reference">References <a class="el" href="namespaceGpgFrontend.html#a2a6566f59b4be29e453a1edd93f6a337">GpgFrontend::_new_result()</a>, <a class="el" href="namespaceGpgFrontend.html#afdad4e5f4c3ac891c09216e245c0f48e">GpgFrontend::check_gpg_error()</a>, and <a class="el" href="classGpgFrontend_1_1GpgData.html#ae382a34ec551561315deca84c71c19c1">GpgFrontend::GpgData::Read2Buffer()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classGpgFrontend_1_1GpgFileOpera.html#a90949b4e9e6116784260cd0e416551db">GpgFrontend::GpgFileOpera::DecryptVerifyFile()</a>, and <a class="el" href="classGpgFrontend_1_1UI_1_1MainWindow.html#a1d61ea803e6c825bd54f42ba9ae85919">GpgFrontend::UI::MainWindow::slot_decrypt_verify()</a>.</p>
</div>
</div>
2022-05-08 22:01:23 +00:00
<a id="a32e1eac6bb0f322588ae75ae36a9884a"></a>
2022-05-08 19:59:26 +00:00
<h2 class="memtitle"><span class="permalink"><a href="#a32e1eac6bb0f322588ae75ae36a9884a">&#9670;&nbsp;</a></span>Encrypt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GpgFrontend::GpgError GpgFrontend::GpgBasicOperator::Encrypt </td>
<td>(</td>
<td class="paramtype">KeyListPtr&#160;</td>
<td class="paramname"><em>keys</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GpgFrontend::BypeArrayRef&#160;</td>
<td class="paramname"><em>in_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GpgFrontend::ByteArrayPtr &amp;&#160;</td>
<td class="paramname"><em>out_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GpgFrontend::GpgEncrResult &amp;&#160;</td>
<td class="paramname"><em>result</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call the interface provided by gpgme for encryption operation. </p>
2022-05-08 22:01:23 +00:00
<p>All incoming data pointers out_buffer will be replaced with new valid values</p>
2022-05-08 19:59:26 +00:00
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keys</td><td>list of public keys </td></tr>
<tr><td class="paramname">in_buffer</td><td>data that needs to be encrypted </td></tr>
<tr><td class="paramname">out_buffer</td><td>encrypted data </td></tr>
<tr><td class="paramname">result</td><td>the result of the operation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>error code </dd></dl>
<p class="reference">References <a class="el" href="namespaceGpgFrontend.html#a2a6566f59b4be29e453a1edd93f6a337">GpgFrontend::_new_result()</a>, <a class="el" href="namespaceGpgFrontend.html#afdad4e5f4c3ac891c09216e245c0f48e">GpgFrontend::check_gpg_error()</a>, and <a class="el" href="classGpgFrontend_1_1GpgData.html#ae382a34ec551561315deca84c71c19c1">GpgFrontend::GpgData::Read2Buffer()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classGpgFrontend_1_1GpgFileOpera.html#a234d939ae0b2c3f799dd01130fad9379">GpgFrontend::GpgFileOpera::EncryptFile()</a>, and <a class="el" href="classGpgFrontend_1_1UI_1_1MainWindow.html#ae11d01211c2914ecc148e13dd7de506e">GpgFrontend::UI::MainWindow::slot_encrypt()</a>.</p>
</div>
</div>
2022-05-08 22:01:23 +00:00
<a id="a08906cf2bc2ddad8489438610f388f8a"></a>
2022-05-08 19:59:26 +00:00
<h2 class="memtitle"><span class="permalink"><a href="#a08906cf2bc2ddad8489438610f388f8a">&#9670;&nbsp;</a></span>EncryptSign()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gpgme_error_t GpgFrontend::GpgBasicOperator::EncryptSign </td>
<td>(</td>
<td class="paramtype">KeyListPtr&#160;</td>
<td class="paramname"><em>keys</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">KeyListPtr&#160;</td>
<td class="paramname"><em>signers</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">BypeArrayRef&#160;</td>
<td class="paramname"><em>in_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ByteArrayPtr &amp;&#160;</td>
<td class="paramname"><em>out_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GpgEncrResult &amp;&#160;</td>
<td class="paramname"><em>encr_result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GpgSignResult &amp;&#160;</td>
<td class="paramname"><em>sign_result</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call the interface provided by gpgme to perform encryption and signature operations at the same time. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keys</td><td>List of public keys </td></tr>
<tr><td class="paramname">signers</td><td>Private key for signatures </td></tr>
<tr><td class="paramname">in_buffer</td><td>Data for operation </td></tr>
<tr><td class="paramname">out_buffer</td><td>Encrypted data </td></tr>
<tr><td class="paramname">encr_result</td><td>Encrypted results </td></tr>
<tr><td class="paramname">sign_result</td><td>Signature result </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<p class="reference">References <a class="el" href="namespaceGpgFrontend.html#a2a6566f59b4be29e453a1edd93f6a337">GpgFrontend::_new_result()</a>, <a class="el" href="namespaceGpgFrontend.html#afdad4e5f4c3ac891c09216e245c0f48e">GpgFrontend::check_gpg_error()</a>, and <a class="el" href="classGpgFrontend_1_1GpgData.html#ae382a34ec551561315deca84c71c19c1">GpgFrontend::GpgData::Read2Buffer()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classGpgFrontend_1_1GpgFileOpera.html#a6353e1688b113e5746aced6aa7f3876e">GpgFrontend::GpgFileOpera::EncryptSignFile()</a>, and <a class="el" href="classGpgFrontend_1_1UI_1_1MainWindow.html#a304efe91afa31b32725caa00c27475a4">GpgFrontend::UI::MainWindow::slot_encrypt_sign()</a>.</p>
</div>
</div>
2022-05-08 22:01:23 +00:00
<a id="a8f4ef57e941a066ad9d070eee51e2073"></a>
2022-05-08 19:59:26 +00:00
<h2 class="memtitle"><span class="permalink"><a href="#a8f4ef57e941a066ad9d070eee51e2073">&#9670;&nbsp;</a></span>EncryptSymmetric()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gpg_error_t GpgFrontend::GpgBasicOperator::EncryptSymmetric </td>
<td>(</td>
<td class="paramtype">BypeArrayRef&#160;</td>
<td class="paramname"><em>in_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ByteArrayPtr &amp;&#160;</td>
<td class="paramname"><em>out_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GpgEncrResult &amp;&#160;</td>
<td class="paramname"><em>result</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call the interface provided by GPGME to symmetrical encryption. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">in_buffer</td><td>Data for encryption </td></tr>
<tr><td class="paramname">out_buffer</td><td>Encrypted data </td></tr>
<tr><td class="paramname">result</td><td>Encrypted results </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>gpg_error_t </dd></dl>
<p class="reference">References <a class="el" href="namespaceGpgFrontend.html#a2a6566f59b4be29e453a1edd93f6a337">GpgFrontend::_new_result()</a>, <a class="el" href="namespaceGpgFrontend.html#afdad4e5f4c3ac891c09216e245c0f48e">GpgFrontend::check_gpg_error()</a>, and <a class="el" href="classGpgFrontend_1_1GpgData.html#ae382a34ec551561315deca84c71c19c1">GpgFrontend::GpgData::Read2Buffer()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classGpgFrontend_1_1GpgFileOpera.html#a826efca057afb07157453b3b9e267b0f">GpgFrontend::GpgFileOpera::EncryptFileSymmetric()</a>, and <a class="el" href="classGpgFrontend_1_1UI_1_1MainWindow.html#ae11d01211c2914ecc148e13dd7de506e">GpgFrontend::UI::MainWindow::slot_encrypt()</a>.</p>
</div>
</div>
2022-05-08 22:01:23 +00:00
<a id="a78f37b8d5afd6c0248665a4415f880cf"></a>
2022-05-08 19:59:26 +00:00
<h2 class="memtitle"><span class="permalink"><a href="#a78f37b8d5afd6c0248665a4415f880cf">&#9670;&nbsp;</a></span>GetSigners()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt; GpgFrontend::KeyArgsList &gt; GpgFrontend::GpgBasicOperator::GetSigners </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a global signature private keys that has been set. </p>
<dl class="section return"><dt>Returns</dt><dd>Intelligent pointer pointing to the private key list </dd></dl>
</div>
</div>
2022-05-08 22:01:23 +00:00
<a id="ad6ea3596ba7d7543fb1b8233d09996df"></a>
2022-05-08 19:59:26 +00:00
<h2 class="memtitle"><span class="permalink"><a href="#ad6ea3596ba7d7543fb1b8233d09996df">&#9670;&nbsp;</a></span>SetSigners()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GpgFrontend::GpgBasicOperator::SetSigners </td>
<td>(</td>
<td class="paramtype">KeyArgsList &amp;&#160;</td>
<td class="paramname"><em>signers</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the private key for signatures, this operation is a global operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keys</td><td></td></tr>
</table>
</dd>
</dl>
<p class="reference">References <a class="el" href="namespaceGpgFrontend.html#afdad4e5f4c3ac891c09216e245c0f48e">GpgFrontend::check_gpg_error()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classGpgFrontend_1_1GpgKeyManager.html#a12138780c53add7589f78f056019e5e0">GpgFrontend::GpgKeyManager::SignKey()</a>.</p>
</div>
</div>
2022-05-08 22:01:23 +00:00
<a id="a988d7e65e85fc7a578f26300332a65d3"></a>
2022-05-08 19:59:26 +00:00
<h2 class="memtitle"><span class="permalink"><a href="#a988d7e65e85fc7a578f26300332a65d3">&#9670;&nbsp;</a></span>Sign()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GpgFrontend::GpgError GpgFrontend::GpgBasicOperator::Sign </td>
<td>(</td>
<td class="paramtype">KeyListPtr&#160;</td>
<td class="paramname"><em>signers</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">BypeArrayRef&#160;</td>
<td class="paramname"><em>in_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ByteArrayPtr &amp;&#160;</td>
<td class="paramname"><em>out_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gpgme_sig_mode_t&#160;</td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GpgSignResult &amp;&#160;</td>
<td class="paramname"><em>result</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call the interface provided by gpgme for signing operation. </p>
2022-05-08 22:01:23 +00:00
<p>The signing modes are as follows: &lsquo;GPGME_SIG_MODE_NORMAL&rsquo; A normal signature is made, the output includes the plaintext and the signature. &lsquo;GPGME_SIG_MODE_DETACH&rsquo; A detached signature is made. &lsquo;GPGME_SIG_MODE_CLEAR&rsquo; A clear text signature is made. The ASCII armor and text mode settings of the context are ignored.</p>
2022-05-08 19:59:26 +00:00
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">signers</td><td>private keys for signing operations </td></tr>
<tr><td class="paramname">in_buffer</td><td>data that needs to be signed </td></tr>
<tr><td class="paramname">out_buffer</td><td>verified data </td></tr>
<tr><td class="paramname">mode</td><td>signing mode </td></tr>
<tr><td class="paramname">result</td><td>the result of the operation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>error code </dd></dl>
<p class="reference">References <a class="el" href="namespaceGpgFrontend.html#a2a6566f59b4be29e453a1edd93f6a337">GpgFrontend::_new_result()</a>, <a class="el" href="namespaceGpgFrontend.html#afdad4e5f4c3ac891c09216e245c0f48e">GpgFrontend::check_gpg_error()</a>, and <a class="el" href="classGpgFrontend_1_1GpgData.html#ae382a34ec551561315deca84c71c19c1">GpgFrontend::GpgData::Read2Buffer()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classGpgFrontend_1_1GpgFileOpera.html#a350df1c07c054625c4755a78e6ca5ca8">GpgFrontend::GpgFileOpera::SignFile()</a>, and <a class="el" href="classGpgFrontend_1_1UI_1_1MainWindow.html#a3f3d03b0ec22385bee559fbd2aeb881b">GpgFrontend::UI::MainWindow::slot_sign()</a>.</p>
</div>
</div>
2022-05-08 22:01:23 +00:00
<a id="af0347cb28ff73b2250395ceaa9001509"></a>
2022-05-08 19:59:26 +00:00
<h2 class="memtitle"><span class="permalink"><a href="#af0347cb28ff73b2250395ceaa9001509">&#9670;&nbsp;</a></span>Verify()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GpgFrontend::GpgError GpgFrontend::GpgBasicOperator::Verify </td>
<td>(</td>
<td class="paramtype">BypeArrayRef&#160;</td>
<td class="paramname"><em>in_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ByteArrayPtr &amp;&#160;</td>
<td class="paramname"><em>sig_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GpgVerifyResult &amp;&#160;</td>
<td class="paramname"><em>result</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Call the interface provided by gpgme for verification operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">in_buffer</td><td>data that needs to be verified </td></tr>
<tr><td class="paramname">out_buffer</td><td>verified data </td></tr>
<tr><td class="paramname">result</td><td>the result of the operation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>error code </dd></dl>
<p class="reference">References <a class="el" href="namespaceGpgFrontend.html#a2a6566f59b4be29e453a1edd93f6a337">GpgFrontend::_new_result()</a>, and <a class="el" href="namespaceGpgFrontend.html#afdad4e5f4c3ac891c09216e245c0f48e">GpgFrontend::check_gpg_error()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classGpgFrontend_1_1UI_1_1MainWindow.html#aa9c986dd95984811479ea93230c74b5d">GpgFrontend::UI::MainWindow::slot_verify()</a>, and <a class="el" href="classGpgFrontend_1_1GpgFileOpera.html#a14cddfe822c9410cd9c301d08963b7e7">GpgFrontend::GpgFileOpera::VerifyFile()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
2022-05-08 22:01:23 +00:00
<a id="afad990a43ab06a060a93db9948ebb740"></a>
2022-05-08 19:59:26 +00:00
<h2 class="memtitle"><span class="permalink"><a href="#afad990a43ab06a060a93db9948ebb740">&#9670;&nbsp;</a></span>ctx_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGpgFrontend_1_1GpgContext.html">GpgContext</a>&amp; GpgFrontend::GpgBasicOperator::ctx_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2022-05-08 22:01:23 +00:00
<b>Initial value:</b><div class="fragment"><div class="line">= <a class="code" href="classGpgFrontend_1_1SingletonFunctionObject.html#a70484d7cfe9f9dcbcd5f8bb749250f36">GpgContext::GetInstance</a>(</div>
<div class="line"> <a class="code" href="classGpgFrontend_1_1SingletonFunctionObject.html#aa99440b9177f5d0c18840f08a40d64b7">SingletonFunctionObject::GetChannel</a>())</div>
<div class="ttc" id="aclassGpgFrontend_1_1SingletonFunctionObject_html_a70484d7cfe9f9dcbcd5f8bb749250f36"><div class="ttname"><a href="classGpgFrontend_1_1SingletonFunctionObject.html#a70484d7cfe9f9dcbcd5f8bb749250f36">GpgFrontend::SingletonFunctionObject&lt; GpgContext &gt;::GetInstance</a></div><div class="ttdeci">static GpgContext &amp; GetInstance(int channel=GpgFrontend::GPGFRONTEND_DEFAULT_CHANNEL)</div><div class="ttdoc">Get the Instance object.</div><div class="ttdef"><b>Definition:</b> GpgFunctionObject.h:172</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1SingletonFunctionObject_html_aa99440b9177f5d0c18840f08a40d64b7"><div class="ttname"><a href="classGpgFrontend_1_1SingletonFunctionObject.html#aa99440b9177f5d0c18840f08a40d64b7">GpgFrontend::SingletonFunctionObject::GetChannel</a></div><div class="ttdeci">int GetChannel() const</div><div class="ttdoc">Get the Channel object.</div><div class="ttdef"><b>Definition:</b> GpgFunctionObject.h:258</div></div>
2022-05-08 19:59:26 +00:00
</div><!-- fragment -->
<p>Corresponding context. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/core/function/gpg/<a class="el" href="GpgBasicOperator_8h_source.html">GpgBasicOperator.h</a></li>
<li>src/core/function/gpg/GpgBasicOperator.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_1GpgBasicOperator.html">GpgBasicOperator</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>
2022-05-08 19:59:26 +00:00
</ul>
</div>
</body>
</html>