GpgFrontend-Doxygen/docs/html/classGpgFrontend_1_1SingletonStorage.html

250 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::SingletonStorage 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_1SingletonStorage.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_1SingletonStorage-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">GpgFrontend::SingletonStorage Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for GpgFrontend::SingletonStorage:</div>
<div class="dyncontent">
<div class="center"><img src="classGpgFrontend_1_1SingletonStorage__coll__graph.png" border="0" usemap="#aGpgFrontend_1_1SingletonStorage_coll__map" alt="Collaboration graph"/></div>
<map name="aGpgFrontend_1_1SingletonStorage_coll__map" id="aGpgFrontend_1_1SingletonStorage_coll__map">
<area shape="rect" title=" " alt="" coords="5,5,229,156"/>
</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_1SingletonStorage_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:adb22cc80a1ab040b6e4bce962625edfd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonStorage.html#adb22cc80a1ab040b6e4bce962625edfd">ReleaseChannel</a> (int channel)</td></tr>
<tr class="separator:adb22cc80a1ab040b6e4bce962625edfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca3f30ca1bf528ac71351ca913b4f464"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonStorage.html#aca3f30ca1bf528ac71351ca913b4f464">FindObjectInChannel</a> (int channel) -&gt; <a class="el" href="classGpgFrontend_1_1ChannelObject.html">ChannelObject</a> *</td></tr>
<tr class="separator:aca3f30ca1bf528ac71351ca913b4f464"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5fd3f6f18f7c9435df0bb32707e3871"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonStorage.html#aa5fd3f6f18f7c9435df0bb32707e3871">GetAllChannelId</a> () -&gt; std::vector&lt; int &gt;</td></tr>
<tr class="memdesc:aa5fd3f6f18f7c9435df0bb32707e3871"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get all the channel ids. <a href="classGpgFrontend_1_1SingletonStorage.html#aa5fd3f6f18f7c9435df0bb32707e3871">More...</a><br /></td></tr>
<tr class="separator:aa5fd3f6f18f7c9435df0bb32707e3871"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8da5e914fe1469681a0caec2542428d8"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonStorage.html#a8da5e914fe1469681a0caec2542428d8">SetObjectInChannel</a> (int channel, ChannelObjectPtr p_obj) -&gt; <a class="el" href="classGpgFrontend_1_1ChannelObject.html">ChannelObject</a> *</td></tr>
<tr class="memdesc:a8da5e914fe1469681a0caec2542428d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a new object in channel object. <a href="classGpgFrontend_1_1SingletonStorage.html#a8da5e914fe1469681a0caec2542428d8">More...</a><br /></td></tr>
<tr class="separator:a8da5e914fe1469681a0caec2542428d8"><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:a92b2f81399b2bfc44705061fd67d738c"><td class="memItemLeft" align="right" valign="top"><a id="a92b2f81399b2bfc44705061fd67d738c"></a>
SecureUniquePtr&lt; <a class="el" href="classGpgFrontend_1_1SingletonStorage_1_1Impl.html">Impl</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>p_</b></td></tr>
<tr class="separator:a92b2f81399b2bfc44705061fd67d738c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aca3f30ca1bf528ac71351ca913b4f464"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca3f30ca1bf528ac71351ca913b4f464">&#9670;&nbsp;</a></span>FindObjectInChannel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">auto GpgFrontend::SingletonStorage::FindObjectInChannel </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>channel</em></td><td>)</td>
<td> -&gt; <a class="el" href="classGpgFrontend_1_1ChannelObject.html">ChannelObject</a>*</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">channel</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>T* </dd></dl>
</div>
</div>
<a id="aa5fd3f6f18f7c9435df0bb32707e3871"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5fd3f6f18f7c9435df0bb32707e3871">&#9670;&nbsp;</a></span>GetAllChannelId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">auto GpgFrontend::SingletonStorage::GetAllChannelId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> -&gt; std::vector&lt;int&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get all the channel ids. </p>
<dl class="section return"><dt>Returns</dt><dd>std::vector&lt;int&gt; </dd></dl>
</div>
</div>
<a id="adb22cc80a1ab040b6e4bce962625edfd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb22cc80a1ab040b6e4bce962625edfd">&#9670;&nbsp;</a></span>ReleaseChannel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GpgFrontend::SingletonStorage::ReleaseChannel </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>channel</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">channel</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8da5e914fe1469681a0caec2542428d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8da5e914fe1469681a0caec2542428d8">&#9670;&nbsp;</a></span>SetObjectInChannel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">auto GpgFrontend::SingletonStorage::SetObjectInChannel </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>channel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ChannelObjectPtr&#160;</td>
<td class="paramname"><em>p_obj</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> -&gt; <a class="el" href="classGpgFrontend_1_1ChannelObject.html">ChannelObject</a>*</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a new object in channel object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">channel</td><td></td></tr>
<tr><td class="paramname">p_obj</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>T* </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/core/function/basic/<a class="el" href="SingletonStorage_8h_source.html">SingletonStorage.h</a></li>
<li>src/core/function/basic/SingletonStorage.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_1SingletonStorage.html">SingletonStorage</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>