Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
ac9898a17454fee86ed74dc419e51da222ec0c3a
entt/classentt_1_1emitter.html
Michele Caini ac9898a174 API reference v3.3.0
2020-02-22 15:45:18 +01:00

551 lines
31 KiB
HTML
Raw 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.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::emitter&lt; Derived &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">EnTT
&#160;<span id="projectnumber">3.3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<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="namespaceentt.html">entt</a></li><li class="navelem"><a class="el" href="classentt_1_1emitter.html">emitter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classentt_1_1emitter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">entt::emitter&lt; Derived &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>General purpose event emitter.
<a href="classentt_1_1emitter.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>&gt;</code></p>
<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="structentt_1_1emitter_1_1connection.html">connection</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic connection type for events. <a href="structentt_1_1emitter_1_1connection.html#details">More...</a><br /></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-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a1200216d9abb1adb18db6035d99b60da"><td class="memTemplParams" colspan="2"><a id="a1200216d9abb1adb18db6035d99b60da"></a>
template&lt;typename Event &gt; </td></tr>
<tr class="memitem:a1200216d9abb1adb18db6035d99b60da"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#a1200216d9abb1adb18db6035d99b60da">listener</a> = typename pool_handler&lt; Event &gt;::listener_type</td></tr>
<tr class="memdesc:a1200216d9abb1adb18db6035d99b60da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of listeners accepted for the given event. <br /></td></tr>
<tr class="separator:a1200216d9abb1adb18db6035d99b60da"><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:af36907a2dc7cc0a6607533c67e072f92"><td class="memItemLeft" align="right" valign="top"><a id="af36907a2dc7cc0a6607533c67e072f92"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#af36907a2dc7cc0a6607533c67e072f92">emitter</a> ()=default</td></tr>
<tr class="memdesc:af36907a2dc7cc0a6607533c67e072f92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:af36907a2dc7cc0a6607533c67e072f92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3d352c547768be34f03f0fbfdd30b43"><td class="memItemLeft" align="right" valign="top"><a id="af3d352c547768be34f03f0fbfdd30b43"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#af3d352c547768be34f03f0fbfdd30b43">~emitter</a> ()</td></tr>
<tr class="memdesc:af3d352c547768be34f03f0fbfdd30b43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor. <br /></td></tr>
<tr class="separator:af3d352c547768be34f03f0fbfdd30b43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a842fef69b914a160b0bcc211bb77b27b"><td class="memItemLeft" align="right" valign="top"><a id="a842fef69b914a160b0bcc211bb77b27b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#a842fef69b914a160b0bcc211bb77b27b">emitter</a> (<a class="el" href="classentt_1_1emitter.html">emitter</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:a842fef69b914a160b0bcc211bb77b27b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default move constructor. <br /></td></tr>
<tr class="separator:a842fef69b914a160b0bcc211bb77b27b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab270d2c6d986621a781467e29e64629c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1emitter.html">emitter</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#ab270d2c6d986621a781467e29e64629c">operator=</a> (<a class="el" href="classentt_1_1emitter.html">emitter</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:ab270d2c6d986621a781467e29e64629c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default move assignment operator. <a href="classentt_1_1emitter.html#ab270d2c6d986621a781467e29e64629c">More...</a><br /></td></tr>
<tr class="separator:ab270d2c6d986621a781467e29e64629c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ece275ff8736bcdcfb4103087801ea2"><td class="memTemplParams" colspan="2">template&lt;typename Event , typename... Args&gt; </td></tr>
<tr class="memitem:a4ece275ff8736bcdcfb4103087801ea2"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#a4ece275ff8736bcdcfb4103087801ea2">publish</a> (Args &amp;&amp;... args)</td></tr>
<tr class="memdesc:a4ece275ff8736bcdcfb4103087801ea2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emits the given event. <a href="classentt_1_1emitter.html#a4ece275ff8736bcdcfb4103087801ea2">More...</a><br /></td></tr>
<tr class="separator:a4ece275ff8736bcdcfb4103087801ea2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b580005200bb810a4a3e94320efcd8a"><td class="memTemplParams" colspan="2">template&lt;typename Event &gt; </td></tr>
<tr class="memitem:a0b580005200bb810a4a3e94320efcd8a"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1emitter_1_1connection.html">connection</a>&lt; Event &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#a0b580005200bb810a4a3e94320efcd8a">on</a> (<a class="el" href="classentt_1_1emitter.html#a1200216d9abb1adb18db6035d99b60da">listener</a>&lt; Event &gt; instance)</td></tr>
<tr class="memdesc:a0b580005200bb810a4a3e94320efcd8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a long-lived listener with the event emitter. <a href="classentt_1_1emitter.html#a0b580005200bb810a4a3e94320efcd8a">More...</a><br /></td></tr>
<tr class="separator:a0b580005200bb810a4a3e94320efcd8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79834d452b0600ebe0e70c54f4a21fd6"><td class="memTemplParams" colspan="2">template&lt;typename Event &gt; </td></tr>
<tr class="memitem:a79834d452b0600ebe0e70c54f4a21fd6"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1emitter_1_1connection.html">connection</a>&lt; Event &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#a79834d452b0600ebe0e70c54f4a21fd6">once</a> (<a class="el" href="classentt_1_1emitter.html#a1200216d9abb1adb18db6035d99b60da">listener</a>&lt; Event &gt; instance)</td></tr>
<tr class="memdesc:a79834d452b0600ebe0e70c54f4a21fd6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a short-lived listener with the event emitter. <a href="classentt_1_1emitter.html#a79834d452b0600ebe0e70c54f4a21fd6">More...</a><br /></td></tr>
<tr class="separator:a79834d452b0600ebe0e70c54f4a21fd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9525364769b8daf55dd942599aa0a09c"><td class="memTemplParams" colspan="2">template&lt;typename Event &gt; </td></tr>
<tr class="memitem:a9525364769b8daf55dd942599aa0a09c"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#a9525364769b8daf55dd942599aa0a09c">erase</a> (<a class="el" href="structentt_1_1emitter_1_1connection.html">connection</a>&lt; Event &gt; conn)</td></tr>
<tr class="memdesc:a9525364769b8daf55dd942599aa0a09c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects a listener from the event emitter. <a href="classentt_1_1emitter.html#a9525364769b8daf55dd942599aa0a09c">More...</a><br /></td></tr>
<tr class="separator:a9525364769b8daf55dd942599aa0a09c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e4324c59afee760ca13772eb6d2d522"><td class="memTemplParams" colspan="2">template&lt;typename Event &gt; </td></tr>
<tr class="memitem:a4e4324c59afee760ca13772eb6d2d522"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#a4e4324c59afee760ca13772eb6d2d522">clear</a> ()</td></tr>
<tr class="memdesc:a4e4324c59afee760ca13772eb6d2d522"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects all the listeners for the given event type. <a href="classentt_1_1emitter.html#a4e4324c59afee760ca13772eb6d2d522">More...</a><br /></td></tr>
<tr class="separator:a4e4324c59afee760ca13772eb6d2d522"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acedafaefe2c9c91282c84e79aef26a35"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#acedafaefe2c9c91282c84e79aef26a35">clear</a> () ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:acedafaefe2c9c91282c84e79aef26a35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects all the listeners. <a href="classentt_1_1emitter.html#acedafaefe2c9c91282c84e79aef26a35">More...</a><br /></td></tr>
<tr class="separator:acedafaefe2c9c91282c84e79aef26a35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08c6111af231c9a82277069a3bf21b75"><td class="memTemplParams" colspan="2">template&lt;typename Event &gt; </td></tr>
<tr class="memitem:a08c6111af231c9a82277069a3bf21b75"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#a08c6111af231c9a82277069a3bf21b75">empty</a> () const</td></tr>
<tr class="memdesc:a08c6111af231c9a82277069a3bf21b75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if there are listeners registered for the specific event. <a href="classentt_1_1emitter.html#a08c6111af231c9a82277069a3bf21b75">More...</a><br /></td></tr>
<tr class="separator:a08c6111af231c9a82277069a3bf21b75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbac9d6fb49c28f06cb382715ed92ab9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#afbac9d6fb49c28f06cb382715ed92ab9">empty</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:afbac9d6fb49c28f06cb382715ed92ab9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if there are listeners registered with the event emitter. <a href="classentt_1_1emitter.html#afbac9d6fb49c28f06cb382715ed92ab9">More...</a><br /></td></tr>
<tr class="separator:afbac9d6fb49c28f06cb382715ed92ab9"><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 Derived&gt;<br />
class entt::emitter&lt; Derived &gt;</h3>
<p>General purpose event emitter. </p>
<p>The emitter class template follows the CRTP idiom. To create a custom emitter type, derived classes must inherit directly from the base class as:</p>
<div class="fragment"><div class="line"><span class="keyword">struct </span>my_emitter: <a class="code" href="classentt_1_1emitter.html#af36907a2dc7cc0a6607533c67e072f92">emitter</a>&lt;my_emitter&gt; {</div>
<div class="line"> <span class="comment">// ...</span></div>
<div class="line">}</div>
</div><!-- fragment --><p>Pools for the type of events are created internally on the fly. It's not required to specify in advance the full list of accepted types.<br />
Moreover, whenever an event is published, an emitter provides the listeners with a reference to itself along with a const reference to the event. Therefore listeners have an handy way to work with it without incurring in the need of capturing a reference to the emitter.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Derived</td><td>Actual type of emitter that extends the class template. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00042">42</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a4e4324c59afee760ca13772eb6d2d522"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e4324c59afee760ca13772eb6d2d522">&#9670;&nbsp;</a></span>clear() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
<div class="memtemplate">
template&lt;typename Event &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived &gt;::clear </td>
<td>(</td>
<td class="paramname"></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>Disconnects all the listeners for the given event type. </p>
<p>All the connections previously returned for the given event are invalidated. Using them results in undefined behavior.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Event</td><td>Type of event to reset. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00281">281</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="acedafaefe2c9c91282c84e79aef26a35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acedafaefe2c9c91282c84e79aef26a35">&#9670;&nbsp;</a></span>clear() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived &gt;::clear </td>
<td>(</td>
<td class="paramname"></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>Disconnects all the listeners. </p>
<p>All the connections previously returned are invalidated. Using them results in undefined behavior. </p>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00291">291</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="a08c6111af231c9a82277069a3bf21b75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08c6111af231c9a82277069a3bf21b75">&#9670;&nbsp;</a></span>empty() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
<div class="memtemplate">
template&lt;typename Event &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived &gt;::empty </td>
<td>(</td>
<td class="paramname"></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">
<p>Checks if there are listeners registered for the specific event. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Event</td><td>Type of event to test. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if there are no listeners registered, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00303">303</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="afbac9d6fb49c28f06cb382715ed92ab9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbac9d6fb49c28f06cb382715ed92ab9">&#9670;&nbsp;</a></span>empty() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived &gt;::empty </td>
<td>(</td>
<td class="paramname"></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">
<p>Checks if there are listeners registered with the event emitter. </p>
<dl class="section return"><dt>Returns</dt><dd>True if there are no listeners registered, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00311">311</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="a9525364769b8daf55dd942599aa0a09c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9525364769b8daf55dd942599aa0a09c">&#9670;&nbsp;</a></span>erase()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
<div class="memtemplate">
template&lt;typename Event &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived &gt;::erase </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1emitter_1_1connection.html">connection</a>&lt; Event &gt;&#160;</td>
<td class="paramname"><em>conn</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>Disconnects a listener from the event emitter. </p>
<p>Do not use twice the same connection to disconnect a listener, it results in undefined behavior. Once used, discard the connection object.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Event</td><td>Type of event of the connection. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">conn</td><td>A valid connection. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00268">268</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="a0b580005200bb810a4a3e94320efcd8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b580005200bb810a4a3e94320efcd8a">&#9670;&nbsp;</a></span>on()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
<div class="memtemplate">
template&lt;typename Event &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1emitter_1_1connection.html">connection</a>&lt;Event&gt; <a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived &gt;::on </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1emitter.html#a1200216d9abb1adb18db6035d99b60da">listener</a>&lt; Event &gt;&#160;</td>
<td class="paramname"><em>instance</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>Registers a long-lived listener with the event emitter. </p>
<p>This method can be used to register a listener designed to be invoked more than once for the given event type.<br />
The connection returned by the method can be freely discarded. It's meant to be used later to disconnect the listener if required.</p>
<p>The listener is as a callable object that can be moved and the type of which is <code>void(const Event &amp;, Derived &amp;)</code>.</p>
<dl class="section note"><dt>Note</dt><dd>Whenever an event is emitted, the emitter provides the listener with a reference to the derived class. Listeners don't have to capture those instances for later uses.</dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Event</td><td>Type of event to which to connect the listener. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">instance</td><td>The listener to register. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Connection object that can be used to disconnect the listener. </dd></dl>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00229">229</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="a79834d452b0600ebe0e70c54f4a21fd6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79834d452b0600ebe0e70c54f4a21fd6">&#9670;&nbsp;</a></span>once()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
<div class="memtemplate">
template&lt;typename Event &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1emitter_1_1connection.html">connection</a>&lt;Event&gt; <a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived &gt;::once </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1emitter.html#a1200216d9abb1adb18db6035d99b60da">listener</a>&lt; Event &gt;&#160;</td>
<td class="paramname"><em>instance</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>Registers a short-lived listener with the event emitter. </p>
<p>This method can be used to register a listener designed to be invoked only once for the given event type.<br />
The connection returned by the method can be freely discarded. It's meant to be used later to disconnect the listener if required.</p>
<p>The listener is as a callable object that can be moved and the type of which is <code>void(const Event &amp;, Derived &amp;)</code>.</p>
<dl class="section note"><dt>Note</dt><dd>Whenever an event is emitted, the emitter provides the listener with a reference to the derived class. Listeners don't have to capture those instances for later uses.</dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Event</td><td>Type of event to which to connect the listener. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">instance</td><td>The listener to register. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Connection object that can be used to disconnect the listener. </dd></dl>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00254">254</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="ab270d2c6d986621a781467e29e64629c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab270d2c6d986621a781467e29e64629c">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1emitter.html">emitter</a>&amp; <a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived &gt;::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1emitter.html">emitter</a>&lt; Derived &gt; &amp;&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>Default move assignment operator. </p>
<dl class="section return"><dt>Returns</dt><dd>This emitter. </dd></dl>
</div>
</div>
<a id="a4ece275ff8736bcdcfb4103087801ea2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ece275ff8736bcdcfb4103087801ea2">&#9670;&nbsp;</a></span>publish()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
<div class="memtemplate">
template&lt;typename Event , typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived &gt;::publish </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</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>Emits the given event. </p>
<p>All the listeners registered for the specific event type are invoked with the given event. The event type must either have a proper constructor for the arguments provided or be an aggregate type.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Event</td><td>Type of event to publish. </td></tr>
<tr><td class="paramname">Args</td><td>Types of arguments to use to construct the event. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>Parameters to use to initialize the event. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00204">204</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/entt/signal/<a class="el" href="emitter_8hpp_source.html">emitter.hpp</a></li>
</ul>
</div><!-- contents -->
<div class="ttc" id="aclassentt_1_1emitter_html_af36907a2dc7cc0a6607533c67e072f92"><div class="ttname"><a href="classentt_1_1emitter.html#af36907a2dc7cc0a6607533c67e072f92">entt::emitter::emitter</a></div><div class="ttdeci">emitter()=default</div><div class="ttdoc">Default constructor.</div></div>
<!-- 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.16
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink