GpgFrontend-Doxygen/docs/html/classGpgFrontend_1_1Module_1_1GlobalModuleContext_1_1Impl.html

225 lines
17 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GpgFrontend Project: GpgFrontend::Module::GlobalModuleContext::Impl 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_1GlobalModuleContext_1_1Impl.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="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pri-types">Private Types</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classGpgFrontend_1_1Module_1_1GlobalModuleContext_1_1Impl-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">GpgFrontend::Module::GlobalModuleContext::Impl Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for GpgFrontend::Module::GlobalModuleContext::Impl:</div>
<div class="dyncontent">
<div class="center"><img src="classGpgFrontend_1_1Module_1_1GlobalModuleContext_1_1Impl__coll__graph.png" border="0" usemap="#aGpgFrontend_1_1Module_1_1GlobalModuleContext_1_1Impl_coll__map" alt="Collaboration graph"/></div>
<map name="aGpgFrontend_1_1Module_1_1GlobalModuleContext_1_1Impl_coll__map" id="aGpgFrontend_1_1Module_1_1GlobalModuleContext_1_1Impl_coll__map">
<area shape="rect" title=" " alt="" coords="473,687,681,999"/>
<area shape="rect" title=" " alt="" coords="165,510,464,602"/>
<area shape="rect" title=" " alt="" coords="158,285,317,377"/>
<area shape="rect" title=" " alt="" coords="197,145,379,223"/>
<area shape="rect" title=" " alt="" coords="375,5,414,83"/>
<area shape="rect" title=" " alt="" coords="367,293,502,370"/>
<area shape="rect" title=" " alt="" coords="55,145,164,223"/>
<area shape="rect" title=" " alt="" coords="861,285,1013,377"/>
<area shape="rect" title=" " alt="" coords="691,510,928,602"/>
<area shape="rect" title=" " alt="" coords="739,145,778,223"/>
<area shape="rect" title=" " alt="" coords="680,293,837,370"/>
<area shape="rect" title=" " alt="" coords="5,401,123,479"/>
<area shape="rect" title=" " alt="" coords="488,510,667,602"/>
<area shape="rect" title=" " alt="" coords="952,503,1139,609"/>
</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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGpgFrontend_1_1Module_1_1GlobalModuleContext_1_1Impl_1_1ModuleRegisterInfo.html">ModuleRegisterInfo</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:abba0e51c3af19398cfca723d15b27b58"><td class="memItemLeft" align="right" valign="top"><a id="abba0e51c3af19398cfca723d15b27b58"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>SearchModule</b> (ModuleIdentifier module_id) -&gt; ModulePtr</td></tr>
<tr class="separator:abba0e51c3af19398cfca723d15b27b58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3262026e43f2891f74da6dd5a7f38a0"><td class="memItemLeft" align="right" valign="top"><a id="ac3262026e43f2891f74da6dd5a7f38a0"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>GetChannel</b> (<a class="el" href="classGpgFrontend_1_1Module_1_1Module.html">ModuleRawPtr</a> module) -&gt; int</td></tr>
<tr class="separator:ac3262026e43f2891f74da6dd5a7f38a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90e5698590ebc999c67e4966a7835c5c"><td class="memItemLeft" align="right" valign="top"><a id="a90e5698590ebc999c67e4966a7835c5c"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>GetTaskRunner</b> (<a class="el" href="classGpgFrontend_1_1Module_1_1Module.html">ModuleRawPtr</a>) -&gt; std::optional&lt; TaskRunnerPtr &gt;</td></tr>
<tr class="separator:a90e5698590ebc999c67e4966a7835c5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1b61e3fb3bbd9c8f2c209751bd470d2"><td class="memItemLeft" align="right" valign="top"><a id="ab1b61e3fb3bbd9c8f2c209751bd470d2"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>GetTaskRunner</b> (ModuleIdentifier) -&gt; std::optional&lt; TaskRunnerPtr &gt;</td></tr>
<tr class="separator:ab1b61e3fb3bbd9c8f2c209751bd470d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07a95697a3653f22d5270708ede1f213"><td class="memItemLeft" align="right" valign="top"><a id="a07a95697a3653f22d5270708ede1f213"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>GetGlobalTaskRunner</b> () -&gt; std::optional&lt; TaskRunnerPtr &gt;</td></tr>
<tr class="separator:a07a95697a3653f22d5270708ede1f213"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc363ae2bc81fbfed0f08315023a2155"><td class="memItemLeft" align="right" valign="top"><a id="abc363ae2bc81fbfed0f08315023a2155"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>RegisterModule</b> (const ModulePtr &amp;module, bool integrated_module) -&gt; bool</td></tr>
<tr class="separator:abc363ae2bc81fbfed0f08315023a2155"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac66eb6ed5e8d5742a5d271647bf10f85"><td class="memItemLeft" align="right" valign="top"><a id="ac66eb6ed5e8d5742a5d271647bf10f85"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>ActiveModule</b> (ModuleIdentifier module_id) -&gt; bool</td></tr>
<tr class="separator:ac66eb6ed5e8d5742a5d271647bf10f85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4479bbccc6929a1c096f764d9c13c02f"><td class="memItemLeft" align="right" valign="top"><a id="a4479bbccc6929a1c096f764d9c13c02f"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>ListenEvent</b> (ModuleIdentifier module_id, EventIdentifier event) -&gt; bool</td></tr>
<tr class="separator:a4479bbccc6929a1c096f764d9c13c02f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab84d50a8d389015d29115d28ab8edbde"><td class="memItemLeft" align="right" valign="top"><a id="ab84d50a8d389015d29115d28ab8edbde"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>DeactivateModule</b> (ModuleIdentifier module_id) -&gt; bool</td></tr>
<tr class="separator:ab84d50a8d389015d29115d28ab8edbde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07acdf211b98d8e917abb19406e9507d"><td class="memItemLeft" align="right" valign="top"><a id="a07acdf211b98d8e917abb19406e9507d"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>TriggerEvent</b> (const EventReference &amp;event) -&gt; bool</td></tr>
<tr class="separator:a07acdf211b98d8e917abb19406e9507d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3f001188f83e173fd84f89e3973bef2"><td class="memItemLeft" align="right" valign="top"><a id="ae3f001188f83e173fd84f89e3973bef2"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>SearchEvent</b> (const EventTriggerIdentifier &amp;trigger_id) -&gt; std::optional&lt; EventReference &gt;</td></tr>
<tr class="separator:ae3f001188f83e173fd84f89e3973bef2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4262354dcf1d56bbd732afbac5b1e82"><td class="memItemLeft" align="right" valign="top"><a id="aa4262354dcf1d56bbd732afbac5b1e82"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>IsModuleActivated</b> (const ModuleIdentifier &amp;m_id) const -&gt; bool</td></tr>
<tr class="separator:aa4262354dcf1d56bbd732afbac5b1e82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b982badccf837f3efe10b1c7e2428b5"><td class="memItemLeft" align="right" valign="top"><a id="a4b982badccf837f3efe10b1c7e2428b5"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>IsIntegratedModule</b> (ModuleIdentifier m_id) -&gt; bool</td></tr>
<tr class="separator:a4b982badccf837f3efe10b1c7e2428b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66c9166ec3af4f15dd3af00e57ced049"><td class="memItemLeft" align="right" valign="top"><a id="a66c9166ec3af4f15dd3af00e57ced049"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>ListAllRegisteredModuleID</b> () -&gt; QList&lt; ModuleIdentifier &gt;</td></tr>
<tr class="separator:a66c9166ec3af4f15dd3af00e57ced049"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61e810f356cf0e5073dc5c83bbbbab84"><td class="memItemLeft" align="right" valign="top"><a id="a61e810f356cf0e5073dc5c83bbbbab84"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>GetModuleListening</b> (const ModuleIdentifier &amp;module_id) -&gt; QList&lt; EventIdentifier &gt;</td></tr>
<tr class="separator:a61e810f356cf0e5073dc5c83bbbbab84"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a0388268ec4a003a465f76cb9d3a85b13"><td class="memItemLeft" align="right" valign="top"><a id="a0388268ec4a003a465f76cb9d3a85b13"></a>
static auto&#160;</td><td class="memItemRight" valign="bottom"><b>GetDefaultChannel</b> (<a class="el" href="classGpgFrontend_1_1Module_1_1Module.html">ModuleRawPtr</a>) -&gt; int</td></tr>
<tr class="separator:a0388268ec4a003a465f76cb9d3a85b13"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:aad554eb8e681ed9c91fee58a255bbaca"><td class="memItemLeft" align="right" valign="top"><a id="aad554eb8e681ed9c91fee58a255bbaca"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>ModuleRegisterInfoPtr</b> = std::shared_ptr&lt; <a class="el" href="structGpgFrontend_1_1Module_1_1GlobalModuleContext_1_1Impl_1_1ModuleRegisterInfo.html">ModuleRegisterInfo</a> &gt;</td></tr>
<tr class="separator:aad554eb8e681ed9c91fee58a255bbaca"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:ae72741f7c324660c852930dbbdc2b031"><td class="memItemLeft" align="right" valign="top"><a id="ae72741f7c324660c852930dbbdc2b031"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>acquire_new_unique_channel</b> () -&gt; int</td></tr>
<tr class="separator:ae72741f7c324660c852930dbbdc2b031"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11dde09190cfa31bd19efad5dcacf214"><td class="memItemLeft" align="right" valign="top"><a id="a11dde09190cfa31bd19efad5dcacf214"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>search_module_register_table</b> (const ModuleIdentifier &amp;identifier) const -&gt; std::optional&lt; ModuleRegisterInfoPtr &gt;</td></tr>
<tr class="separator:a11dde09190cfa31bd19efad5dcacf214"><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:a8e3cd9ab8dc16a2f7431618bfbc09520"><td class="memItemLeft" align="right" valign="top"><a id="a8e3cd9ab8dc16a2f7431618bfbc09520"></a>
std::unordered_map&lt; ModuleIdentifier, ModuleRegisterInfoPtr &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>module_register_table_</b></td></tr>
<tr class="separator:a8e3cd9ab8dc16a2f7431618bfbc09520"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa6ec2fcc2569cd1b22f419feadaa568"><td class="memItemLeft" align="right" valign="top"><a id="aaa6ec2fcc2569cd1b22f419feadaa568"></a>
std::map&lt; EventIdentifier, std::unordered_set&lt; ModuleIdentifier &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>module_events_table_</b></td></tr>
<tr class="separator:aaa6ec2fcc2569cd1b22f419feadaa568"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b1169966c7200118373bb56d555a89c"><td class="memItemLeft" align="right" valign="top"><a id="a8b1169966c7200118373bb56d555a89c"></a>
std::map&lt; EventTriggerIdentifier, EventReference &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>module_on_triggering_events_table_</b></td></tr>
<tr class="separator:a8b1169966c7200118373bb56d555a89c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc10c7acd6244ef93e85ffb6c4ad267e"><td class="memItemLeft" align="right" valign="top"><a id="acc10c7acd6244ef93e85ffb6c4ad267e"></a>
std::set&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>acquired_channel_</b></td></tr>
<tr class="separator:acc10c7acd6244ef93e85ffb6c4ad267e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8285c96435bc2431481828ca943ce49"><td class="memItemLeft" align="right" valign="top"><a id="ad8285c96435bc2431481828ca943ce49"></a>
TaskRunnerPtr&#160;</td><td class="memItemRight" valign="bottom"><b>default_task_runner_</b></td></tr>
<tr class="separator:ad8285c96435bc2431481828ca943ce49"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/core/module/GlobalModuleContext.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_1GlobalModuleContext.html">GlobalModuleContext</a></li><li class="navelem"><a class="el" href="classGpgFrontend_1_1Module_1_1GlobalModuleContext_1_1Impl.html">Impl</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>