zoriya/ComSquare
1
0
Fork 0
mirror of https://github.com/zoriya/ComSquare.git synced 2026-05-13 11:24:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
Documentation
ComSquare/classComSquare_1_1Callback.html
AnonymusRaccoon d33b0ab52d Deploying the doc
2021-07-13 21:32:24 +00:00

447 lines
21 KiB
HTML
Raw Permalink Blame 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.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ComSquare: ComSquare::Callback&lt; Types &gt; Class Template 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="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">ComSquare
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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');
/* @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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceComSquare.html">ComSquare</a></li><li class="navelem"><a class="el" href="classComSquare_1_1Callback.html">Callback</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classComSquare_1_1Callback-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ComSquare::Callback&lt; Types &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A callback where you can subscribe to and emit it.
<a href="classComSquare_1_1Callback.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Callback_8hpp_source.html">Callback.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ComSquare::Callback&lt; Types &gt;:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classComSquare_1_1Callback__coll__graph.svg" width="172" height="220"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<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:aa6b54f4835069d20c22b6fa1786c6a3c"><td class="memTemplParams" colspan="2">template&lt;typename Func &gt; </td></tr>
<tr class="memitem:aa6b54f4835069d20c22b6fa1786c6a3c"><td class="memTemplItemLeft" align="right" valign="top">int&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Callback.html#aa6b54f4835069d20c22b6fa1786c6a3c">addCallback</a> (Func callback)</td></tr>
<tr class="memdesc:aa6b54f4835069d20c22b6fa1786c6a3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a method to be called when this callback is invoked. <a href="classComSquare_1_1Callback.html#aa6b54f4835069d20c22b6fa1786c6a3c">More...</a><br /></td></tr>
<tr class="separator:aa6b54f4835069d20c22b6fa1786c6a3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5338ac89c68289c484b6a3e3c185963"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Callback.html#aa5338ac89c68289c484b6a3e3c185963">removeCallback</a> (int id)</td></tr>
<tr class="memdesc:aa5338ac89c68289c484b6a3e3c185963"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove a function from this callback. <a href="classComSquare_1_1Callback.html#aa5338ac89c68289c484b6a3e3c185963">More...</a><br /></td></tr>
<tr class="separator:aa5338ac89c68289c484b6a3e3c185963"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5cd6dba0f0e9ea54fb993a4015985058"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Callback.html#a5cd6dba0f0e9ea54fb993a4015985058">operator()</a> (Types ...args) const</td></tr>
<tr class="separator:a5cd6dba0f0e9ea54fb993a4015985058"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a764204f626c1699d806b6c67bb31fc39"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Callback.html#a764204f626c1699d806b6c67bb31fc39">Callback</a> ()=default</td></tr>
<tr class="memdesc:a764204f626c1699d806b6c67bb31fc39"><td class="mdescLeft">&#160;</td><td class="mdescRight">A default constructor. <a href="classComSquare_1_1Callback.html#a764204f626c1699d806b6c67bb31fc39">More...</a><br /></td></tr>
<tr class="separator:a764204f626c1699d806b6c67bb31fc39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab233a5401d403f89ac895b1e20203b43"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Callback.html#ab233a5401d403f89ac895b1e20203b43">Callback</a> (const <a class="el" href="classComSquare_1_1Callback.html">Callback</a> &amp;)=default</td></tr>
<tr class="memdesc:ab233a5401d403f89ac895b1e20203b43"><td class="mdescLeft">&#160;</td><td class="mdescRight">A default copy constructor. <a href="classComSquare_1_1Callback.html#ab233a5401d403f89ac895b1e20203b43">More...</a><br /></td></tr>
<tr class="separator:ab233a5401d403f89ac895b1e20203b43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ca3e9b366d64dbfb4cb31e397f608dc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Callback.html#a2ca3e9b366d64dbfb4cb31e397f608dc">~Callback</a> ()=default</td></tr>
<tr class="memdesc:a2ca3e9b366d64dbfb4cb31e397f608dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">A default destructor. <a href="classComSquare_1_1Callback.html#a2ca3e9b366d64dbfb4cb31e397f608dc">More...</a><br /></td></tr>
<tr class="separator:a2ca3e9b366d64dbfb4cb31e397f608dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5e4f33ce0525823e39310f7b1b99158"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classComSquare_1_1Callback.html">Callback</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Callback.html#ad5e4f33ce0525823e39310f7b1b99158">operator=</a> (const <a class="el" href="classComSquare_1_1Callback.html">Callback</a> &amp;)=default</td></tr>
<tr class="memdesc:ad5e4f33ce0525823e39310f7b1b99158"><td class="mdescLeft">&#160;</td><td class="mdescRight">A default assignment operator. <a href="classComSquare_1_1Callback.html#ad5e4f33ce0525823e39310f7b1b99158">More...</a><br /></td></tr>
<tr class="separator:ad5e4f33ce0525823e39310f7b1b99158"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae591813accffdb5fd37cb4ccb673d41d"><td class="memTemplParams" colspan="2">template&lt;typename Func &gt; </td></tr>
<tr class="memitem:ae591813accffdb5fd37cb4ccb673d41d"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Callback.html#ae591813accffdb5fd37cb4ccb673d41d">Callback</a> (Func callback)</td></tr>
<tr class="memdesc:ae591813accffdb5fd37cb4ccb673d41d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implicitly transform a callable into a callback. <a href="classComSquare_1_1Callback.html#ae591813accffdb5fd37cb4ccb673d41d">More...</a><br /></td></tr>
<tr class="separator:ae591813accffdb5fd37cb4ccb673d41d"><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:a744461787dcc2e16ee74b31d810785dd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Callback.html#a744461787dcc2e16ee74b31d810785dd">_nextID</a> = 0</td></tr>
<tr class="separator:a744461787dcc2e16ee74b31d810785dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a849a860cc7d4a1ba004a1c00af0e890f"><td class="memItemLeft" align="right" valign="top">std::unordered_map&lt; int, std::function&lt; void(Types...)&gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Callback.html#a849a860cc7d4a1ba004a1c00af0e890f">_functions</a> = {}</td></tr>
<tr class="memdesc:a849a860cc7d4a1ba004a1c00af0e890f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The list of functions to call. <a href="classComSquare_1_1Callback.html#a849a860cc7d4a1ba004a1c00af0e890f">More...</a><br /></td></tr>
<tr class="separator:a849a860cc7d4a1ba004a1c00af0e890f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename ... Types&gt;<br />
class ComSquare::Callback&lt; Types &gt;</h3>
<p>A callback where you can subscribe to and emit it. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a764204f626c1699d806b6c67bb31fc39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a764204f626c1699d806b6c67bb31fc39">&#9670;&nbsp;</a></span>Callback() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ... Types&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classComSquare_1_1Callback.html">ComSquare::Callback</a>&lt; Types &gt;::<a class="el" href="classComSquare_1_1Callback.html">Callback</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A default constructor. </p>
</div>
</div>
<a id="ab233a5401d403f89ac895b1e20203b43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab233a5401d403f89ac895b1e20203b43">&#9670;&nbsp;</a></span>Callback() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ... Types&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classComSquare_1_1Callback.html">ComSquare::Callback</a>&lt; Types &gt;::<a class="el" href="classComSquare_1_1Callback.html">Callback</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classComSquare_1_1Callback.html">Callback</a>&lt; Types &gt; &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A default copy constructor. </p>
</div>
</div>
<a id="a2ca3e9b366d64dbfb4cb31e397f608dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ca3e9b366d64dbfb4cb31e397f608dc">&#9670;&nbsp;</a></span>~Callback()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ... Types&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classComSquare_1_1Callback.html">ComSquare::Callback</a>&lt; Types &gt;::~<a class="el" href="classComSquare_1_1Callback.html">Callback</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A default destructor. </p>
</div>
</div>
<a id="ae591813accffdb5fd37cb4ccb673d41d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae591813accffdb5fd37cb4ccb673d41d">&#9670;&nbsp;</a></span>Callback() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ... Types&gt; </div>
<div class="memtemplate">
template&lt;typename Func &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classComSquare_1_1Callback.html">ComSquare::Callback</a>&lt; Types &gt;::<a class="el" href="classComSquare_1_1Callback.html">Callback</a> </td>
<td>(</td>
<td class="paramtype">Func&#160;</td>
<td class="paramname"><em>callback</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implicitly transform a callable into a callback. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa6b54f4835069d20c22b6fa1786c6a3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6b54f4835069d20c22b6fa1786c6a3c">&#9670;&nbsp;</a></span>addCallback()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ... Types&gt; </div>
<div class="memtemplate">
template&lt;typename Func &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classComSquare_1_1Callback.html">ComSquare::Callback</a>&lt; Types &gt;::addCallback </td>
<td>(</td>
<td class="paramtype">Func&#160;</td>
<td class="paramname"><em>callback</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a method to be called when this callback is invoked. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">callback</td><td>The list of arguments of the callback method </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A unique ID for this callback. That can be used to remove the callback later. </dd></dl>
</div>
</div>
<a id="a5cd6dba0f0e9ea54fb993a4015985058"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5cd6dba0f0e9ea54fb993a4015985058">&#9670;&nbsp;</a></span>operator()()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ... Types&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classComSquare_1_1Callback.html">ComSquare::Callback</a>&lt; Types &gt;::operator() </td>
<td>(</td>
<td class="paramtype">Types ...&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad5e4f33ce0525823e39310f7b1b99158"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5e4f33ce0525823e39310f7b1b99158">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ... Types&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classComSquare_1_1Callback.html">Callback</a>&amp; <a class="el" href="classComSquare_1_1Callback.html">ComSquare::Callback</a>&lt; Types &gt;::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classComSquare_1_1Callback.html">Callback</a>&lt; Types &gt; &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A default assignment operator. </p>
</div>
</div>
<a id="aa5338ac89c68289c484b6a3e3c185963"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5338ac89c68289c484b6a3e3c185963">&#9670;&nbsp;</a></span>removeCallback()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ... Types&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classComSquare_1_1Callback.html">ComSquare::Callback</a>&lt; Types &gt;::removeCallback </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove a function from this callback. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>The ID of the function. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a849a860cc7d4a1ba004a1c00af0e890f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a849a860cc7d4a1ba004a1c00af0e890f">&#9670;&nbsp;</a></span>_functions</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ... Types&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unordered_map&lt;int, std::function&lt;void (Types...)&gt; &gt; <a class="el" href="classComSquare_1_1Callback.html">ComSquare::Callback</a>&lt; Types &gt;::_functions = {}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The list of functions to call. </p>
</div>
</div>
<a id="a744461787dcc2e16ee74b31d810785dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a744461787dcc2e16ee74b31d810785dd">&#9670;&nbsp;</a></span>_nextID</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ... Types&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classComSquare_1_1Callback.html">ComSquare::Callback</a>&lt; Types &gt;::_nextID = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>sources/Models/<a class="el" href="Callback_8hpp_source.html">Callback.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink