GpgFrontend-Doxygen/docs/html/classGpgFrontend_1_1Module_1_1GlobalModuleContext.html

194 lines
14 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 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.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-attribs">Private Attributes</a> &#124;
<a href="classGpgFrontend_1_1Module_1_1GlobalModuleContext-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">GpgFrontend::Module::GlobalModuleContext Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for GpgFrontend::Module::GlobalModuleContext:</div>
<div class="dyncontent">
<div class="center"><img src="classGpgFrontend_1_1Module_1_1GlobalModuleContext__inherit__graph.png" border="0" usemap="#aGpgFrontend_1_1Module_1_1GlobalModuleContext_inherit__map" alt="Inheritance graph"/></div>
<map name="aGpgFrontend_1_1Module_1_1GlobalModuleContext_inherit__map" id="aGpgFrontend_1_1Module_1_1GlobalModuleContext_inherit__map">
<area shape="rect" title=" " alt="" coords="5,131,204,384"/>
<area shape="rect" title=" " alt="" coords="67,5,142,83"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for GpgFrontend::Module::GlobalModuleContext:</div>
<div class="dyncontent">
<div class="center"><img src="classGpgFrontend_1_1Module_1_1GlobalModuleContext__coll__graph.png" border="0" usemap="#aGpgFrontend_1_1Module_1_1GlobalModuleContext_coll__map" alt="Collaboration graph"/></div>
<map name="aGpgFrontend_1_1Module_1_1GlobalModuleContext_coll__map" id="aGpgFrontend_1_1Module_1_1GlobalModuleContext_coll__map">
<area shape="rect" title=" " alt="" coords="5,131,204,384"/>
<area shape="rect" title=" " alt="" coords="67,5,142,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_1GlobalModuleContext_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:ac488a3f4e3cbd668fd9ce84b39078cbb"><td class="memItemLeft" align="right" valign="top"><a id="ac488a3f4e3cbd668fd9ce84b39078cbb"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>SearchModule</b> (ModuleIdentifier) -&gt; ModulePtr</td></tr>
<tr class="separator:ac488a3f4e3cbd668fd9ce84b39078cbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aadce2e61acda3c4191423f28628c56bf"><td class="memItemLeft" align="right" valign="top"><a id="aadce2e61acda3c4191423f28628c56bf"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>GetChannel</b> (<a class="el" href="classGpgFrontend_1_1Module_1_1Module.html">ModuleRawPtr</a>) -&gt; int</td></tr>
<tr class="separator:aadce2e61acda3c4191423f28628c56bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a264c8e3fff040efe97e66297c1007e93"><td class="memItemLeft" align="right" valign="top"><a id="a264c8e3fff040efe97e66297c1007e93"></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:a264c8e3fff040efe97e66297c1007e93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2e989ee80541129e050c86a48ed8f14"><td class="memItemLeft" align="right" valign="top"><a id="ae2e989ee80541129e050c86a48ed8f14"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>GetTaskRunner</b> (ModuleIdentifier) -&gt; std::optional&lt; TaskRunnerPtr &gt;</td></tr>
<tr class="separator:ae2e989ee80541129e050c86a48ed8f14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a446db76f3518eb46133e14366ff13a05"><td class="memItemLeft" align="right" valign="top"><a id="a446db76f3518eb46133e14366ff13a05"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>GetGlobalTaskRunner</b> () -&gt; std::optional&lt; TaskRunnerPtr &gt;</td></tr>
<tr class="separator:a446db76f3518eb46133e14366ff13a05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3834836325dab26902e9d66770ce895f"><td class="memItemLeft" align="right" valign="top"><a id="a3834836325dab26902e9d66770ce895f"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>RegisterModule</b> (ModulePtr, bool) -&gt; bool</td></tr>
<tr class="separator:a3834836325dab26902e9d66770ce895f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4de89b6132d184cf94444a94634a38d8"><td class="memItemLeft" align="right" valign="top"><a id="a4de89b6132d184cf94444a94634a38d8"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>ActiveModule</b> (ModuleIdentifier) -&gt; bool</td></tr>
<tr class="separator:a4de89b6132d184cf94444a94634a38d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73d55999acdcd0b7ac58fc99d61e232a"><td class="memItemLeft" align="right" valign="top"><a id="a73d55999acdcd0b7ac58fc99d61e232a"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>DeactivateModule</b> (ModuleIdentifier) -&gt; bool</td></tr>
<tr class="separator:a73d55999acdcd0b7ac58fc99d61e232a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f4335cab295542f49b78a8e15b6f456"><td class="memItemLeft" align="right" valign="top"><a id="a1f4335cab295542f49b78a8e15b6f456"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>ListenEvent</b> (ModuleIdentifier, EventIdentifier) -&gt; bool</td></tr>
<tr class="separator:a1f4335cab295542f49b78a8e15b6f456"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9c9b7ffc770046ff1e6486ef1fc4415"><td class="memItemLeft" align="right" valign="top"><a id="ad9c9b7ffc770046ff1e6486ef1fc4415"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>TriggerEvent</b> (EventReference) -&gt; bool</td></tr>
<tr class="separator:ad9c9b7ffc770046ff1e6486ef1fc4415"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c1d56338f4b4a8d594c4ecc8aac420d"><td class="memItemLeft" align="right" valign="top"><a id="a4c1d56338f4b4a8d594c4ecc8aac420d"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>SearchEvent</b> (EventTriggerIdentifier) -&gt; std::optional&lt; EventReference &gt;</td></tr>
<tr class="separator:a4c1d56338f4b4a8d594c4ecc8aac420d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec9f17c91c5cb6da83b3d1a5af800895"><td class="memItemLeft" align="right" valign="top"><a id="aec9f17c91c5cb6da83b3d1a5af800895"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>GetModuleListening</b> (ModuleIdentifier) -&gt; QList&lt; EventIdentifier &gt;</td></tr>
<tr class="separator:aec9f17c91c5cb6da83b3d1a5af800895"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99414d575c55ac1f61a44f077db06028"><td class="memItemLeft" align="right" valign="top"><a id="a99414d575c55ac1f61a44f077db06028"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>IsModuleActivated</b> (ModuleIdentifier) -&gt; bool</td></tr>
<tr class="separator:a99414d575c55ac1f61a44f077db06028"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a683639b9af7cf521bc9ffe4a5fc46cea"><td class="memItemLeft" align="right" valign="top"><a id="a683639b9af7cf521bc9ffe4a5fc46cea"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>IsIntegratedModule</b> (ModuleIdentifier) -&gt; bool</td></tr>
<tr class="separator:a683639b9af7cf521bc9ffe4a5fc46cea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d26d680dfb5036832852ccab2e31cd2"><td class="memItemLeft" align="right" valign="top"><a id="a3d26d680dfb5036832852ccab2e31cd2"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>ListAllRegisteredModuleID</b> () -&gt; QList&lt; ModuleIdentifier &gt;</td></tr>
<tr class="separator:a3d26d680dfb5036832852ccab2e31cd2"><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:a627cfb3a280954d43ed09aa16d982e08"><td class="memItemLeft" align="right" valign="top"><a id="a627cfb3a280954d43ed09aa16d982e08"></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:a627cfb3a280954d43ed09aa16d982e08"><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:a2e109678b81d92569b442aba617d86fe"><td class="memItemLeft" align="right" valign="top"><a id="a2e109678b81d92569b442aba617d86fe"></a>
SecureUniquePtr&lt; <a class="el" href="classGpgFrontend_1_1Module_1_1GlobalModuleContext_1_1Impl.html">Impl</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>p_</b></td></tr>
<tr class="separator:a2e109678b81d92569b442aba617d86fe"><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="GlobalModuleContext_8h_source.html">GlobalModuleContext.h</a></li>
<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="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>