GpgFrontend-Doxygen/docs/html/classGpgFrontend_1_1Module_1_1Module.html

181 lines
12 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: GpgFrontend::Module::Module 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_1Module_1_1Module.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="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classGpgFrontend_1_1Module_1_1Module-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">GpgFrontend::Module::Module Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for GpgFrontend::Module::Module:</div>
<div class="dyncontent">
<div class="center"><img src="classGpgFrontend_1_1Module_1_1Module__inherit__graph.png" border="0" usemap="#aGpgFrontend_1_1Module_1_1Module_inherit__map" alt="Inheritance graph"/></div>
<map name="aGpgFrontend_1_1Module_1_1Module_inherit__map" id="aGpgFrontend_1_1Module_1_1Module_inherit__map">
<area shape="rect" title=" " alt="" coords="181,131,357,384"/>
<area shape="rect" href="classGpgFrontend_1_1Module_1_1Integrated_1_1GnuPGInfoGatheringModule_1_1GnuPGInfoGatheringModule.html" title="Use to record some info about gnupg." alt="" coords="5,439,264,619"/>
<area shape="rect" href="classGpgFrontend_1_1Module_1_1Integrated_1_1VersionCheckingModule_1_1VersionCheckingModule.html" title=" " alt="" coords="288,432,523,627"/>
<area shape="rect" title=" " alt="" coords="232,5,307,83"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for GpgFrontend::Module::Module:</div>
<div class="dyncontent">
<div class="center"><img src="classGpgFrontend_1_1Module_1_1Module__coll__graph.png" border="0" usemap="#aGpgFrontend_1_1Module_1_1Module_coll__map" alt="Collaboration graph"/></div>
<map name="aGpgFrontend_1_1Module_1_1Module_coll__map" id="aGpgFrontend_1_1Module_1_1Module_coll__map">
<area shape="rect" title=" " alt="" coords="5,131,181,384"/>
<area shape="rect" title=" " alt="" coords="56,5,131,83"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Module_1_1Module_1_1Impl.html">Impl</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:aca010db52c44b025a03e76de4e1f9088"><td class="memItemLeft" align="right" valign="top"><a id="aca010db52c44b025a03e76de4e1f9088"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Module</b> (ModuleIdentifier, ModuleVersion, const ModuleMetaData &amp;)</td></tr>
<tr class="separator:aca010db52c44b025a03e76de4e1f9088"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb243413314418ae4ae50f0e8aa44eb1"><td class="memItemLeft" align="right" valign="top"><a id="acb243413314418ae4ae50f0e8aa44eb1"></a>
virtual auto&#160;</td><td class="memItemRight" valign="bottom"><b>Register</b> () -&gt; bool=0</td></tr>
<tr class="separator:acb243413314418ae4ae50f0e8aa44eb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99a8330a469f34ab9278b5d4cce03b10"><td class="memItemLeft" align="right" valign="top"><a id="a99a8330a469f34ab9278b5d4cce03b10"></a>
virtual auto&#160;</td><td class="memItemRight" valign="bottom"><b>Active</b> () -&gt; bool=0</td></tr>
<tr class="separator:a99a8330a469f34ab9278b5d4cce03b10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a130e7bdd740c72f0f1b6c8b4d54b1363"><td class="memItemLeft" align="right" valign="top"><a id="a130e7bdd740c72f0f1b6c8b4d54b1363"></a>
virtual auto&#160;</td><td class="memItemRight" valign="bottom"><b>Exec</b> (EventRefrernce) -&gt; int=0</td></tr>
<tr class="separator:a130e7bdd740c72f0f1b6c8b4d54b1363"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83ea58fa0783d659ee7ed4ad17944379"><td class="memItemLeft" align="right" valign="top"><a id="a83ea58fa0783d659ee7ed4ad17944379"></a>
virtual auto&#160;</td><td class="memItemRight" valign="bottom"><b>Deactive</b> () -&gt; bool=0</td></tr>
<tr class="separator:a83ea58fa0783d659ee7ed4ad17944379"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82105c87c45f3d58736e106be271910f"><td class="memItemLeft" align="right" valign="top"><a id="a82105c87c45f3d58736e106be271910f"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>GetModuleIdentifier</b> () const -&gt; ModuleIdentifier</td></tr>
<tr class="separator:a82105c87c45f3d58736e106be271910f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0ff5afa799ff2e5d41fa35dd39694aa"><td class="memItemLeft" align="right" valign="top"><a id="ac0ff5afa799ff2e5d41fa35dd39694aa"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>SetGPC</b> (<a class="el" href="classGpgFrontend_1_1Module_1_1GlobalModuleContext.html">GlobalModuleContext</a> *)</td></tr>
<tr class="separator:ac0ff5afa799ff2e5d41fa35dd39694aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:af4a6decab6e9b05b5c456d62ca588e92"><td class="memItemLeft" align="right" valign="top"><a id="af4a6decab6e9b05b5c456d62ca588e92"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>getChannel</b> () -&gt; int</td></tr>
<tr class="separator:af4a6decab6e9b05b5c456d62ca588e92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab16513c547ee594ebb78c8d67ce8b447"><td class="memItemLeft" align="right" valign="top"><a id="ab16513c547ee594ebb78c8d67ce8b447"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>getDefaultChannel</b> () -&gt; int</td></tr>
<tr class="separator:ab16513c547ee594ebb78c8d67ce8b447"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87c631643d16a87fcf15895fbc0c53c7"><td class="memItemLeft" align="right" valign="top"><a id="a87c631643d16a87fcf15895fbc0c53c7"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>getTaskRunner</b> () -&gt; TaskRunnerPtr</td></tr>
<tr class="separator:a87c631643d16a87fcf15895fbc0c53c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6067f27d8dfa6731e1f38384d13085c"><td class="memItemLeft" align="right" valign="top"><a id="af6067f27d8dfa6731e1f38384d13085c"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>listenEvent</b> (EventIdentifier) -&gt; bool</td></tr>
<tr class="separator:af6067f27d8dfa6731e1f38384d13085c"><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:a4040e73a9e85ec739dbd48e27bd0c21b"><td class="memItemLeft" align="right" valign="top"><a id="a4040e73a9e85ec739dbd48e27bd0c21b"></a>
SecureUniquePtr&lt; <a class="el" href="classGpgFrontend_1_1Module_1_1Module_1_1Impl.html">Impl</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>p_</b></td></tr>
<tr class="separator:a4040e73a9e85ec739dbd48e27bd0c21b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/core/module/<a class="el" href="Module_8h_source.html">Module.h</a></li>
<li>src/core/module/Module.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="namespaceGpgFrontend_1_1Module.html">Module</a></li><li class="navelem"><a class="el" href="classGpgFrontend_1_1Module_1_1Module.html">Module</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>