Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
6fdc43199ce25a0cc26cf8f7f43274d84bb33014
entt/structentt_1_1scoped__connection.html
Michele Caini 6fdc43199c API reference v3.9.0
2021-12-21 13:20:51 +01:00

342 lines
19 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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::scoped_connection Struct 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.9.0</span>
</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>
<!-- 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="structentt_1_1scoped__connection.html">scoped_connection</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structentt_1_1scoped__connection-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">entt::scoped_connection Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Scoped connection class.
<a href="structentt_1_1scoped__connection.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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5675cd808dd54a6d9546037d282d3c6c"><td class="memItemLeft" align="right" valign="top"><a id="a5675cd808dd54a6d9546037d282d3c6c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1scoped__connection.html#a5675cd808dd54a6d9546037d282d3c6c">scoped_connection</a> ()=default</td></tr>
<tr class="memdesc:a5675cd808dd54a6d9546037d282d3c6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a5675cd808dd54a6d9546037d282d3c6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3c50842fea4014f8bf2e51ce4cfbc8a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1scoped__connection.html#ab3c50842fea4014f8bf2e51ce4cfbc8a">scoped_connection</a> (const <a class="el" href="classentt_1_1connection.html">connection</a> &amp;other)</td></tr>
<tr class="memdesc:ab3c50842fea4014f8bf2e51ce4cfbc8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a scoped connection from a basic connection. <a href="structentt_1_1scoped__connection.html#ab3c50842fea4014f8bf2e51ce4cfbc8a">More...</a><br /></td></tr>
<tr class="separator:ab3c50842fea4014f8bf2e51ce4cfbc8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad52da49cdabbfe1a4aada361f48fb9be"><td class="memItemLeft" align="right" valign="top"><a id="ad52da49cdabbfe1a4aada361f48fb9be"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1scoped__connection.html#ad52da49cdabbfe1a4aada361f48fb9be">scoped_connection</a> (const <a class="el" href="structentt_1_1scoped__connection.html">scoped_connection</a> &amp;)=delete</td></tr>
<tr class="memdesc:ad52da49cdabbfe1a4aada361f48fb9be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default copy constructor, deleted on purpose. <br /></td></tr>
<tr class="separator:ad52da49cdabbfe1a4aada361f48fb9be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82b3c022128eada5c6be2c5fc7d4bd2b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1scoped__connection.html#a82b3c022128eada5c6be2c5fc7d4bd2b">scoped_connection</a> (<a class="el" href="structentt_1_1scoped__connection.html">scoped_connection</a> &amp;&amp;other)</td></tr>
<tr class="memdesc:a82b3c022128eada5c6be2c5fc7d4bd2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move constructor. <a href="structentt_1_1scoped__connection.html#a82b3c022128eada5c6be2c5fc7d4bd2b">More...</a><br /></td></tr>
<tr class="separator:a82b3c022128eada5c6be2c5fc7d4bd2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bc8b8630e2ad076216b6aca416ce32c"><td class="memItemLeft" align="right" valign="top"><a id="a8bc8b8630e2ad076216b6aca416ce32c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1scoped__connection.html#a8bc8b8630e2ad076216b6aca416ce32c">~scoped_connection</a> ()</td></tr>
<tr class="memdesc:a8bc8b8630e2ad076216b6aca416ce32c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Automatically breaks the link on destruction. <br /></td></tr>
<tr class="separator:a8bc8b8630e2ad076216b6aca416ce32c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae079c45e0eb97f31ec1d5a4be76163fc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1scoped__connection.html">scoped_connection</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1scoped__connection.html#ae079c45e0eb97f31ec1d5a4be76163fc">operator=</a> (const <a class="el" href="structentt_1_1scoped__connection.html">scoped_connection</a> &amp;)=delete</td></tr>
<tr class="memdesc:ae079c45e0eb97f31ec1d5a4be76163fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default copy assignment operator, deleted on purpose. <a href="structentt_1_1scoped__connection.html#ae079c45e0eb97f31ec1d5a4be76163fc">More...</a><br /></td></tr>
<tr class="separator:ae079c45e0eb97f31ec1d5a4be76163fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe0ec74231b7bece430c6dd5ffdeddc2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1scoped__connection.html">scoped_connection</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1scoped__connection.html#abe0ec74231b7bece430c6dd5ffdeddc2">operator=</a> (<a class="el" href="structentt_1_1scoped__connection.html">scoped_connection</a> &amp;&amp;other)</td></tr>
<tr class="memdesc:abe0ec74231b7bece430c6dd5ffdeddc2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move assignment operator. <a href="structentt_1_1scoped__connection.html#abe0ec74231b7bece430c6dd5ffdeddc2">More...</a><br /></td></tr>
<tr class="separator:abe0ec74231b7bece430c6dd5ffdeddc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a900d499bf30a8f33beb19f41af9b93b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1scoped__connection.html">scoped_connection</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1scoped__connection.html#a900d499bf30a8f33beb19f41af9b93b3">operator=</a> (<a class="el" href="classentt_1_1connection.html">connection</a> other)</td></tr>
<tr class="memdesc:a900d499bf30a8f33beb19f41af9b93b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Acquires a connection. <a href="structentt_1_1scoped__connection.html#a900d499bf30a8f33beb19f41af9b93b3">More...</a><br /></td></tr>
<tr class="separator:a900d499bf30a8f33beb19f41af9b93b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b4e9958e0dbc1b1ba14a878531a475d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1scoped__connection.html#a0b4e9958e0dbc1b1ba14a878531a475d">operator bool</a> () const</td></tr>
<tr class="memdesc:a0b4e9958e0dbc1b1ba14a878531a475d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether a scoped connection is properly initialized. <a href="structentt_1_1scoped__connection.html#a0b4e9958e0dbc1b1ba14a878531a475d">More...</a><br /></td></tr>
<tr class="separator:a0b4e9958e0dbc1b1ba14a878531a475d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7bd2be785ba586664d8e8d039dc73ead"><td class="memItemLeft" align="right" valign="top"><a id="a7bd2be785ba586664d8e8d039dc73ead"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1scoped__connection.html#a7bd2be785ba586664d8e8d039dc73ead">release</a> ()</td></tr>
<tr class="memdesc:a7bd2be785ba586664d8e8d039dc73ead"><td class="mdescLeft">&#160;</td><td class="mdescRight">Breaks the connection. <br /></td></tr>
<tr class="separator:a7bd2be785ba586664d8e8d039dc73ead"><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>Scoped 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.<br />
A scoped connection automatically breaks the link between the two objects when it goes out of scope. </p>
<p class="definition">Definition at line <a class="el" href="sigh_8hpp_source.html#l00276">276</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="ab3c50842fea4014f8bf2e51ce4cfbc8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3c50842fea4014f8bf2e51ce4cfbc8a">&#9670;&nbsp;</a></span>scoped_connection() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">entt::scoped_connection::scoped_connection </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classentt_1_1connection.html">connection</a> &amp;&#160;</td>
<td class="paramname"><em>other</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>Constructs a scoped connection from a basic connection. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>A valid connection object. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="sigh_8hpp_source.html#l00284">284</a> of file <a class="el" href="sigh_8hpp_source.html">sigh.hpp</a>.</p>
</div>
</div>
<a id="a82b3c022128eada5c6be2c5fc7d4bd2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82b3c022128eada5c6be2c5fc7d4bd2b">&#9670;&nbsp;</a></span>scoped_connection() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">entt::scoped_connection::scoped_connection </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1scoped__connection.html">scoped_connection</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>other</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>Move constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The scoped connection to move from. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="sigh_8hpp_source.html#l00294">294</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="a0b4e9958e0dbc1b1ba14a878531a475d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b4e9958e0dbc1b1ba14a878531a475d">&#9670;&nbsp;</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::scoped_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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether a scoped 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#l00332">332</a> of file <a class="el" href="sigh_8hpp_source.html">sigh.hpp</a>.</p>
</div>
</div>
<a id="a900d499bf30a8f33beb19f41af9b93b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a900d499bf30a8f33beb19f41af9b93b3">&#9670;&nbsp;</a></span>operator=() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1scoped__connection.html">scoped_connection</a>&amp; entt::scoped_connection::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1connection.html">connection</a>&#160;</td>
<td class="paramname"><em>other</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>Acquires a connection. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The connection object to acquire. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This scoped connection. </dd></dl>
<p class="definition">Definition at line <a class="el" href="sigh_8hpp_source.html#l00323">323</a> of file <a class="el" href="sigh_8hpp_source.html">sigh.hpp</a>.</p>
</div>
</div>
<a id="ae079c45e0eb97f31ec1d5a4be76163fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae079c45e0eb97f31ec1d5a4be76163fc">&#9670;&nbsp;</a></span>operator=() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1scoped__connection.html">scoped_connection</a>&amp; entt::scoped_connection::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structentt_1_1scoped__connection.html">scoped_connection</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default copy assignment operator, deleted on purpose. </p>
<dl class="section return"><dt>Returns</dt><dd>This scoped connection. </dd></dl>
</div>
</div>
<a id="abe0ec74231b7bece430c6dd5ffdeddc2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe0ec74231b7bece430c6dd5ffdeddc2">&#9670;&nbsp;</a></span>operator=() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1scoped__connection.html">scoped_connection</a>&amp; entt::scoped_connection::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1scoped__connection.html">scoped_connection</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>other</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>Move assignment operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The scoped connection to move from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This scoped connection. </dd></dl>
<p class="definition">Definition at line <a class="el" href="sigh_8hpp_source.html#l00313">313</a> of file <a class="el" href="sigh_8hpp_source.html">sigh.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct 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.1
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink