151 lines
8.0 KiB
HTML
151 lines
8.0 KiB
HTML
<!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::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.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
|
|
 <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&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&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_1connection.html">connection</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<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 <<a class="el" href="sigh_8hpp_source.html">sigh.hpp</a>></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:a1d11f6b9d00a3f0e5364111438a1cee5"><td class="memItemLeft" align="right" valign="top"><a id="a1d11f6b9d00a3f0e5364111438a1cee5"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1connection.html#a1d11f6b9d00a3f0e5364111438a1cee5">connection</a> ()=default</td></tr>
|
|
<tr class="memdesc:a1d11f6b9d00a3f0e5364111438a1cee5"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:a1d11f6b9d00a3f0e5364111438a1cee5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad912298fe40bd1b6aa5b8b950850bb70"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1connection.html#ad912298fe40bd1b6aa5b8b950850bb70">operator bool</a> () const</td></tr>
|
|
<tr class="memdesc:ad912298fe40bd1b6aa5b8b950850bb70"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether a connection is properly initialized. <a href="classentt_1_1connection.html#ad912298fe40bd1b6aa5b8b950850bb70">More...</a><br /></td></tr>
|
|
<tr class="separator:ad912298fe40bd1b6aa5b8b950850bb70"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae564477ab623301169916c1992c970a8"><td class="memItemLeft" align="right" valign="top"><a id="ae564477ab623301169916c1992c970a8"></a>
|
|
void </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"> </td><td class="mdescRight">Breaks the connection. <br /></td></tr>
|
|
<tr class="separator:ae564477ab623301169916c1992c970a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:afe2b37ace8306e708a0dc76c658a4b19"><td class="memTemplParams" colspan="2"><a id="afe2b37ace8306e708a0dc76c658a4b19"></a>
|
|
template<typename > </td></tr>
|
|
<tr class="memitem:afe2b37ace8306e708a0dc76c658a4b19"><td class="memTemplItemLeft" align="right" valign="top">class </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"> </td><td class="mdescRight">A sink is allowed to create connection objects. <br /></td></tr>
|
|
<tr class="separator:afe2b37ace8306e708a0dc76c658a4b19"><td class="memSeparator" colspan="2"> </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#l00234">234</a> of file <a class="el" href="sigh_8hpp_source.html">sigh.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ad912298fe40bd1b6aa5b8b950850bb70"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad912298fe40bd1b6aa5b8b950850bb70">◆ </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> </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#l00250">250</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 <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>
|