GpgFrontend-Doxygen/docs/html/classGpgFrontend_1_1GpgData.html

280 lines
16 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::GpgData 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_1GpgData.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="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classGpgFrontend_1_1GpgData-members.html">List of all members</a> </div>
2022-05-08 22:01:23 +00:00
<div class="headertitle">
<div class="title">GpgFrontend::GpgData Class Reference</div> </div>
2022-05-08 19:59:26 +00:00
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for GpgFrontend::GpgData:</div>
<div class="dyncontent">
<div class="center"><img src="classGpgFrontend_1_1GpgData__coll__graph.png" border="0" usemap="#aGpgFrontend_1_1GpgData_coll__map" alt="Collaboration graph"/></div>
<map name="aGpgFrontend_1_1GpgData_coll__map" id="aGpgFrontend_1_1GpgData_coll__map">
2022-05-08 22:01:23 +00:00
<area shape="rect" title=" " alt="" coords="18,484,217,605"/>
<area shape="rect" title=" " alt="" coords="5,315,229,421"/>
<area shape="rect" title=" " alt="" coords="39,145,196,223"/>
2022-05-08 22:01:23 +00:00
<area shape="rect" title=" " alt="" coords="98,5,137,83"/>
</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="nested-classes"></a>
2022-05-08 19:59:26 +00:00
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGpgFrontend_1_1GpgData_1_1__data__ref__deleter.html">_data_ref_deleter</a></td></tr>
<tr class="separator:"><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="pub-methods"></a>
2022-05-08 19:59:26 +00:00
Public Member Functions</h2></td></tr>
<tr class="memitem:ac3661a9365ad72b0883a2f62ef4647da"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1GpgData.html#ac3661a9365ad72b0883a2f62ef4647da">GpgData</a> ()</td></tr>
<tr class="memdesc:ac3661a9365ad72b0883a2f62ef4647da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new Gpg Data object. <a href="classGpgFrontend_1_1GpgData.html#ac3661a9365ad72b0883a2f62ef4647da">More...</a><br /></td></tr>
<tr class="separator:ac3661a9365ad72b0883a2f62ef4647da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e607c3bb69f998aaac761f400dd6440"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1GpgData.html#a5e607c3bb69f998aaac761f400dd6440">GpgData</a> (void *buffer, size_t size, bool copy=true)</td></tr>
<tr class="memdesc:a5e607c3bb69f998aaac761f400dd6440"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new Gpg Data object. <a href="classGpgFrontend_1_1GpgData.html#a5e607c3bb69f998aaac761f400dd6440">More...</a><br /></td></tr>
<tr class="separator:a5e607c3bb69f998aaac761f400dd6440"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afca7a03bd71436c8b3c4f6e8c2acd700"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1GpgData.html#afca7a03bd71436c8b3c4f6e8c2acd700">operator gpgme_data_t</a> ()</td></tr>
<tr class="separator:afca7a03bd71436c8b3c4f6e8c2acd700"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae382a34ec551561315deca84c71c19c1"><td class="memItemLeft" align="right" valign="top">ByteArrayPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1GpgData.html#ae382a34ec551561315deca84c71c19c1">Read2Buffer</a> ()</td></tr>
<tr class="separator:ae382a34ec551561315deca84c71c19c1"><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="pri-attribs"></a>
2022-05-08 19:59:26 +00:00
Private Attributes</h2></td></tr>
2022-05-08 22:01:23 +00:00
<tr class="memitem:a20e2c42db476247b544012ebe677a8e2"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; struct gpgme_data, <a class="el" href="structGpgFrontend_1_1GpgData_1_1__data__ref__deleter.html">_data_ref_deleter</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>data_ref_</b></td></tr>
2022-05-08 19:59:26 +00:00
<tr class="separator:a20e2c42db476247b544012ebe677a8e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
2022-05-08 22:01:23 +00:00
<a id="ac3661a9365ad72b0883a2f62ef4647da"></a>
2022-05-08 19:59:26 +00:00
<h2 class="memtitle"><span class="permalink"><a href="#ac3661a9365ad72b0883a2f62ef4647da">&#9670;&nbsp;</a></span>GpgData() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GpgFrontend::GpgData::GpgData </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a new Gpg Data object. </p>
2022-05-08 22:01:23 +00:00
<p>Copyright (C) 2021 Saturneric</p>
<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>
2022-05-08 22:01:23 +00:00
<a id="a5e607c3bb69f998aaac761f400dd6440"></a>
2022-05-08 19:59:26 +00:00
<h2 class="memtitle"><span class="permalink"><a href="#a5e607c3bb69f998aaac761f400dd6440">&#9670;&nbsp;</a></span>GpgData() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GpgFrontend::GpgData::GpgData </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>copy</em> = <code>true</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a new Gpg Data object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td></td></tr>
<tr><td class="paramname">size</td><td></td></tr>
<tr><td class="paramname">copy</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
2022-05-08 22:01:23 +00:00
<a id="afca7a03bd71436c8b3c4f6e8c2acd700"></a>
2022-05-08 19:59:26 +00:00
<h2 class="memtitle"><span class="permalink"><a href="#afca7a03bd71436c8b3c4f6e8c2acd700">&#9670;&nbsp;</a></span>operator gpgme_data_t()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GpgFrontend::GpgData::operator gpgme_data_t </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>gpgme_data_t </dd></dl>
</div>
</div>
2022-05-08 22:01:23 +00:00
<a id="ae382a34ec551561315deca84c71c19c1"></a>
2022-05-08 19:59:26 +00:00
<h2 class="memtitle"><span class="permalink"><a href="#ae382a34ec551561315deca84c71c19c1">&#9670;&nbsp;</a></span>Read2Buffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GpgFrontend::ByteArrayPtr GpgFrontend::GpgData::Read2Buffer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>ByteArrayPtr </dd></dl>
<p class="reference">Referenced by <a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html#a9ea9e81194917e08f46eb657281b7953">GpgFrontend::GpgBasicOperator::Decrypt()</a>, <a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html#a11845a9a3ea2941e14faa9130f0ac9ef">GpgFrontend::GpgBasicOperator::DecryptVerify()</a>, <a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html#a32e1eac6bb0f322588ae75ae36a9884a">GpgFrontend::GpgBasicOperator::Encrypt()</a>, <a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html#a08906cf2bc2ddad8489438610f388f8a">GpgFrontend::GpgBasicOperator::EncryptSign()</a>, <a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html#a8f4ef57e941a066ad9d070eee51e2073">GpgFrontend::GpgBasicOperator::EncryptSymmetric()</a>, <a class="el" href="classGpgFrontend_1_1GpgKeyImportExporter.html#a51cb18aa7302d7a48ccd1ee17f060391">GpgFrontend::GpgKeyImportExporter::ExportKey()</a>, <a class="el" href="classGpgFrontend_1_1GpgKeyImportExporter.html#aa0a73314ef94f397e2ef53d40abc9731">GpgFrontend::GpgKeyImportExporter::ExportKeyOpenSSH()</a>, <a class="el" href="classGpgFrontend_1_1GpgKeyImportExporter.html#aa9fbda8f6c3fa36a503075d7a124fa3f">GpgFrontend::GpgKeyImportExporter::ExportKeys()</a>, <a class="el" href="classGpgFrontend_1_1GpgKeyImportExporter.html#a6a5e8d642ac5a3e98799af6495ef590b">GpgFrontend::GpgKeyImportExporter::ExportSecretKey()</a>, <a class="el" href="classGpgFrontend_1_1GpgKeyImportExporter.html#abf7c0442549ae8602e1249cdf0da55df">GpgFrontend::GpgKeyImportExporter::ExportSecretKeyShortest()</a>, and <a class="el" href="classGpgFrontend_1_1GpgBasicOperator.html#a988d7e65e85fc7a578f26300332a65d3">GpgFrontend::GpgBasicOperator::Sign()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
2022-05-08 22:01:23 +00:00
<a id="a20e2c42db476247b544012ebe677a8e2"></a>
2022-05-08 19:59:26 +00:00
<h2 class="memtitle"><span class="permalink"><a href="#a20e2c42db476247b544012ebe677a8e2">&#9670;&nbsp;</a></span>data_ref_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt;struct gpgme_data, <a class="el" href="structGpgFrontend_1_1GpgData_1_1__data__ref__deleter.html">_data_ref_deleter</a>&gt; GpgFrontend::GpgData::data_ref_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">=</div>
<div class="line"> <span class="keyword">nullptr</span></div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/core/model/<a class="el" href="GpgData_8h_source.html">GpgData.h</a></li>
<li>src/core/model/GpgData.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_1GpgData.html">GpgData</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>