Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
7cf7699bab13f2e0414dd4dda6a29591dd8b5686
entt/classentt_1_1connection.html
Michele Caini 7cf7699bab API reference v3.12.0
2023-06-15 11:47:04 +02:00

242 lines
11 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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::connection 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="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-awesome.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 id="projectrow">
<td id="projectalign">
<div id="projectname">EnTT<span id="projectnumber">&#160;3.12.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</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_1connection.html">connection</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classentt_1_1connection-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">entt::connection Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Connection class.
<a href="classentt_1_1connection.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="sigh_8hpp_source.html">sigh.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6cee78e145a8b503654cb0d564848749"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1connection.html#a6cee78e145a8b503654cb0d564848749">connection</a> ()</td></tr>
<tr class="memdesc:a6cee78e145a8b503654cb0d564848749"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a6cee78e145a8b503654cb0d564848749"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a408ef4df083d255a92f708219c7dffc6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1connection.html#a408ef4df083d255a92f708219c7dffc6">operator bool</a> () const noexcept</td></tr>
<tr class="memdesc:a408ef4df083d255a92f708219c7dffc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether a connection is properly initialized. <br /></td></tr>
<tr class="separator:a408ef4df083d255a92f708219c7dffc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae564477ab623301169916c1992c970a8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1connection.html#ae564477ab623301169916c1992c970a8">release</a> ()</td></tr>
<tr class="memdesc:ae564477ab623301169916c1992c970a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Breaks the connection. <br /></td></tr>
<tr class="separator:ae564477ab623301169916c1992c970a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:afe2b37ace8306e708a0dc76c658a4b19"><td class="memTemplParams" colspan="2">template&lt;typename &gt; </td></tr>
<tr class="memitem:afe2b37ace8306e708a0dc76c658a4b19"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1connection.html#afe2b37ace8306e708a0dc76c658a4b19">sink</a></td></tr>
<tr class="memdesc:afe2b37ace8306e708a0dc76c658a4b19"><td class="mdescLeft">&#160;</td><td class="mdescRight">A sink is allowed to create connection objects. <br /></td></tr>
<tr class="separator:afe2b37ace8306e708a0dc76c658a4b19"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Connection class. </p>
<p>Opaque object the aim of which is to allow users to release an already estabilished connection without having to keep a reference to the signal or the sink that generated it. </p>
<p class="definition">Definition at line <a class="el" href="sigh_8hpp_source.html#l00227">227</a> of file <a class="el" href="sigh_8hpp_source.html">sigh.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a6cee78e145a8b503654cb0d564848749" name="a6cee78e145a8b503654cb0d564848749"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6cee78e145a8b503654cb0d564848749">&#9670;&#160;</a></span>connection()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">entt::connection::connection </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>Default constructor. </p>
<p class="definition">Definition at line <a class="el" href="sigh_8hpp_source.html#l00237">237</a> of file <a class="el" href="sigh_8hpp_source.html">sigh.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a408ef4df083d255a92f708219c7dffc6" name="a408ef4df083d255a92f708219c7dffc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a408ef4df083d255a92f708219c7dffc6">&#9670;&#160;</a></span>operator bool()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">entt::connection::operator bool </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 class="mlabel">explicit</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether a connection is properly initialized. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the connection is properly initialized, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="sigh_8hpp_source.html#l00245">245</a> of file <a class="el" href="sigh_8hpp_source.html">sigh.hpp</a>.</p>
</div>
</div>
<a id="ae564477ab623301169916c1992c970a8" name="ae564477ab623301169916c1992c970a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae564477ab623301169916c1992c970a8">&#9670;&#160;</a></span>release()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void entt::connection::release </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>Breaks the connection. </p>
<p class="definition">Definition at line <a class="el" href="sigh_8hpp_source.html#l00250">250</a> of file <a class="el" href="sigh_8hpp_source.html">sigh.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="afe2b37ace8306e708a0dc76c658a4b19" name="afe2b37ace8306e708a0dc76c658a4b19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe2b37ace8306e708a0dc76c658a4b19">&#9670;&#160;</a></span>sink</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classentt_1_1sink.html">sink</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A sink is allowed to create connection objects. </p>
<p class="definition">Definition at line <a class="el" href="sigh_8hpp_source.html#l00230">230</a> of file <a class="el" href="sigh_8hpp_source.html">sigh.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="sigh_8hpp_source.html">sigh.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink