diff options
Diffstat (limited to 'doc/html/boost/signals2/scoped_connection.html')
| -rw-r--r-- | doc/html/boost/signals2/scoped_connection.html | 223 |
1 files changed, 170 insertions, 53 deletions
diff --git a/doc/html/boost/signals2/scoped_connection.html b/doc/html/boost/signals2/scoped_connection.html index 028b4c6e56..a621b8df31 100644 --- a/doc/html/boost/signals2/scoped_connection.html +++ b/doc/html/boost/signals2/scoped_connection.html @@ -3,7 +3,7 @@ <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class scoped_connection</title> <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../signals2/reference.html#header.boost.signals2.connection_hpp" title="Header <boost/signals2/connection.hpp>"> <link rel="prev" href="connection.html" title="Class connection"> @@ -34,28 +34,32 @@ </span> <span class="keyword">class</span> <a class="link" href="scoped_connection.html" title="Class scoped_connection">scoped_connection</a> <span class="special">:</span> <span class="keyword">public</span> <a class="link" href="connection.html" title="Class connection">connection</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="scoped_connection.html#id831696-bbconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="scoped_connection.html#id1323992-bb"><span class="identifier">scoped_connection</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="scoped_connection.html#id1317381-bb"><span class="identifier">scoped_connection</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="connection.html" title="Class connection">connection</a><span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="scoped_connection.html#id1323231-bb"><span class="special">~</span><span class="identifier">scoped_connection</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="scoped_connection.html#idp152200720-bbconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="scoped_connection.html#idp206626336-bb"><span class="identifier">scoped_connection</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="scoped_connection.html#idp111438080-bb"><span class="identifier">scoped_connection</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="connection.html" title="Class connection">connection</a><span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="scoped_connection.html#idp146234128-bb"><span class="identifier">scoped_connection</span></a><span class="special">(</span><a class="link" href="scoped_connection.html" title="Class scoped_connection">scoped_connection</a><span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="scoped_connection.html#idp213054608-bb"><span class="identifier">scoped_connection</span></a><span class="special">(</span><a class="link" href="connection.html" title="Class connection">connection</a><span class="special">&&</span><span class="special">)</span><span class="special">;</span> + scoped_connection& <a class="link" href="scoped_connection.html#idp212906176-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="connection.html" title="Class connection">connection</a><span class="special">&</span><span class="special">)</span><span class="special">;</span> + scoped_connection& <a class="link" href="scoped_connection.html#idp42395728-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="scoped_connection.html" title="Class scoped_connection">scoped_connection</a><span class="special">&&</span><span class="special">)</span><span class="special">;</span> + scoped_connection& <a class="link" href="scoped_connection.html#idp160110832-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="connection.html" title="Class connection">connection</a><span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="scoped_connection.html#idp160037744-bb"><span class="special">~</span><span class="identifier">scoped_connection</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="scoped_connection.html#id1309475-bb">public methods</a></span> - <span class="identifier">scoped_connection</span> <span class="special">&</span> <a class="link" href="scoped_connection.html#id1418765-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">connection</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="connection.html" title="Class connection">connection</a> <a class="link" href="scoped_connection.html#id1161731-bb"><span class="identifier">release</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="scoped_connection.html#idp199682688-bb">public methods</a></span> + <a class="link" href="connection.html" title="Class connection">connection</a> <a class="link" href="scoped_connection.html#idp75060016-bb"><span class="identifier">release</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="keyword">private</span><span class="special">:</span> - <span class="comment">// <a class="link" href="scoped_connection.html#id1421862-bbconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="scoped_connection.html#id816616-bb"><span class="identifier">scoped_connection</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="scoped_connection.html" title="Class scoped_connection">scoped_connection</a><span class="special">&</span><span class="special">)</span><span class="special">;</span> - scoped_connection& <a class="link" href="scoped_connection.html#id1421623-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="scoped_connection.html" title="Class scoped_connection">scoped_connection</a><span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="scoped_connection.html#idp230034832-bbconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="scoped_connection.html#idp160800384-bb"><span class="identifier">scoped_connection</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="scoped_connection.html" title="Class scoped_connection">scoped_connection</a><span class="special">&</span><span class="special">)</span><span class="special">;</span> + scoped_connection& <a class="link" href="scoped_connection.html#idp160822800-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="scoped_connection.html" title="Class scoped_connection">scoped_connection</a><span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="id3211916"></a><h2>Description</h2> +<a name="idp427345360"></a><h2>Description</h2> <p>A <a class="link" href="connection.html" title="Class connection">connection</a> which automatically disconnects on destruction.</p> <div class="section"> <div class="titlepage"><div><div><h6 class="title"> -<a name="id3211932"></a>Thread Safety</h6></div></div></div> +<a name="idp427347184"></a>Thread Safety</h6></div></div></div> <p>The methods of the <code class="computeroutput">scoped_connection</code> class (including those inherited from its base <code class="computeroutput">connection</code> class) are thread-safe with the exception - of <a class="link" href="connection.html#id1313936-bb">signals2::connection::swap</a>, <a class="link" href="scoped_connection.html#id1161731-bb">release</a>, and + of <a class="link" href="connection.html#idp223597776-bb">signals2::connection::swap</a>, <a class="link" href="scoped_connection.html#idp75060016-bb">release</a>, and the assignment operator. A <code class="computeroutput">scoped_connection</code> object should not be accessed concurrently when any of these operations is in progress. However, it is always safe to access a different <code class="computeroutput">connection</code> object @@ -63,18 +67,21 @@ </p> </div> <div class="refsect2"> -<a name="id3211987"></a><h3> -<a name="id831696-bbconstruct-copy-destruct"></a><code class="computeroutput">scoped_connection</code> public construct/copy/destruct</h3> +<a name="idp427353248"></a><h3> +<a name="idp152200720-bbconstruct-copy-destruct"></a><code class="computeroutput">scoped_connection</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="id1323992-bb"></a><span class="identifier">scoped_connection</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp206626336-bb"></a><span class="identifier">scoped_connection</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Default constructs an empty scoped_connection.</p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term">Postconditions:</span></p></td> -<td><p><code class="computeroutput"><a class="link" href="connection.html#id1308291-bb">connected</a>() == false </code></p></td> +<td><p><code class="computeroutput"><a class="link" href="connection.html#idp228419264-bb">connected</a>() == false </code></p></td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> @@ -84,9 +91,12 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><a name="id1317381-bb"></a><span class="identifier">scoped_connection</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="connection.html" title="Class connection">connection</a><span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> -<div class="variablelist"><table border="0"> +<pre class="literallayout"><a name="idp111438080-bb"></a><span class="identifier">scoped_connection</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="connection.html" title="Class connection">connection</a><span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term">Effects:</span></p></td> @@ -96,7 +106,7 @@ </tr> <tr> <td><p><span class="term">Postconditions:</span></p></td> -<td><p><code class="computeroutput"><a class="link" href="connection.html#id1308291-bb">connected</a>() == other.connected()</code></p></td> +<td><p><code class="computeroutput"><a class="link" href="connection.html#idp228419264-bb">connected</a>() == other.connected()</code></p></td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> @@ -106,47 +116,153 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><a name="id1323231-bb"></a><span class="special">~</span><span class="identifier">scoped_connection</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> -<div class="variablelist"><table border="0"> +<pre class="literallayout"><a name="idp146234128-bb"></a><span class="identifier">scoped_connection</span><span class="special">(</span><a class="link" href="scoped_connection.html" title="Class scoped_connection">scoped_connection</a><span class="special">&&</span> other<span class="special">)</span><span class="special">;</span></pre> +<p>Move constructor.</p> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> <col align="left" valign="top"> -<tbody><tr> +<col> +</colgroup> +<tbody> +<tr> <td><p><span class="term">Effects:</span></p></td> -<td><p>If - <code class="computeroutput">this-><a class="link" href="connection.html#id1308291-bb">connected</a>()</code>, - disconnects the signal-slot connection.</p></td> -</tr></tbody> +<td><p><code class="computeroutput">this</code> references + the connection formerly referenced by + <code class="computeroutput">other</code>. The moved-from <code class="computeroutput">other</code> + no longer references any connection.</p></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td><p>Will not throw.</p></td> +</tr> +</tbody> </table></div> </li> -</ol></div> -</div> -<div class="refsect2"> -<a name="id3212218"></a><h3> -<a name="id1309475-bb"></a><code class="computeroutput">scoped_connection</code> public methods</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="identifier">scoped_connection</span> <span class="special">&</span> <a name="id1418765-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">connection</span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> -<div class="variablelist"><table border="0"> +<pre class="literallayout"><a name="idp213054608-bb"></a><span class="identifier">scoped_connection</span><span class="special">(</span><a class="link" href="connection.html" title="Class connection">connection</a><span class="special">&&</span> other<span class="special">)</span><span class="special">;</span></pre> +<p>Move constructor.</p> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term">Effects:</span></p></td> <td><p><code class="computeroutput">this</code> references - the connection referenced by - <code class="computeroutput">rhs</code>. If <code class="computeroutput">this</code> already references another - connection, the old connection will be disconnected first. - </p></td> + the connection formerly referenced by + <code class="computeroutput">other</code>. The moved-from <code class="computeroutput">other</code> + no longer references any connection.</p></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td><p>Will not throw.</p></td> +</tr> +</tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout">scoped_connection& <a name="idp212906176-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="connection.html" title="Class connection">connection</a><span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> +<p>Copy assignment from unscoped connection.</p> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term">Effects:</span></p></td> +<td><p><code class="computeroutput">this</code> references + the connection referenced by + <code class="computeroutput">rhs</code>. If <code class="computeroutput">this</code> already references another + connection, the old connection will be disconnected first.</p></td> </tr> <tr> <td><p><span class="term">Postconditions:</span></p></td> -<td><p><code class="computeroutput"><a class="link" href="connection.html#id1308291-bb">connected</a>() == rhs.connected()</code></p></td> +<td><p><code class="computeroutput"><a class="link" href="connection.html#idp228419264-bb">connected</a>() == other.connected()</code></p></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td><p>Will not throw.</p></td> </tr> </tbody> </table></div> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="connection.html" title="Class connection">connection</a> <a name="id1161731-bb"></a><span class="identifier">release</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> -<div class="variablelist"><table border="0"> +<pre class="literallayout">scoped_connection& <a name="idp42395728-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="scoped_connection.html" title="Class scoped_connection">scoped_connection</a><span class="special">&&</span> rhs<span class="special">)</span><span class="special">;</span></pre> +<p>Move assignment.</p> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term">Effects:</span></p></td> +<td><p><code class="computeroutput">this</code> references + the connection formerly referenced by + <code class="computeroutput">rhs</code>. The moved-from <code class="computeroutput">rhs</code> + no longer references any connection. If <code class="computeroutput">this</code> already references another + connection, the old connection will be disconnected first.</p></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td><p>Will not throw.</p></td> +</tr> +</tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout">scoped_connection& <a name="idp160110832-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="connection.html" title="Class connection">connection</a><span class="special">&&</span> rhs<span class="special">)</span><span class="special">;</span></pre> +<p>Move assignment.</p> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term">Effects:</span></p></td> +<td><p><code class="computeroutput">this</code> references + the connection formerly referenced by + <code class="computeroutput">rhs</code>. The moved-from <code class="computeroutput">rhs</code> + no longer references any connection. If <code class="computeroutput">this</code> already references another + connection, the old connection will be disconnected first.</p></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td><p>Will not throw.</p></td> +</tr> +</tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idp160037744-bb"></a><span class="special">~</span><span class="identifier">scoped_connection</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody><tr> +<td><p><span class="term">Effects:</span></p></td> +<td><p>If + <code class="computeroutput">this-><a class="link" href="connection.html#idp228419264-bb">connected</a>()</code>, + disconnects the signal-slot connection.</p></td> +</tr></tbody> +</table></div> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idp427435680"></a><h3> +<a name="idp199682688-bb"></a><code class="computeroutput">scoped_connection</code> public methods</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> +<pre class="literallayout"><a class="link" href="connection.html" title="Class connection">connection</a> <a name="idp75060016-bb"></a><span class="identifier">release</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term">Effects:</span></p></td> @@ -158,7 +274,7 @@ </tr> <tr> <td><p><span class="term">Postconditions:</span></p></td> -<td><p><code class="computeroutput"><a class="link" href="connection.html#id1308291-bb">connected</a>() == false</code></p></td> +<td><p><code class="computeroutput"><a class="link" href="connection.html#idp228419264-bb">connected</a>() == false</code></p></td> </tr> <tr> <td><p><span class="term">Returns:</span></p></td> @@ -168,20 +284,21 @@ </tr> </tbody> </table></div> -</li> -</ol></div> +</li></ol></div> </div> <div class="refsect2"> -<a name="id3212445"></a><h3> -<a name="id1421862-bbconstruct-copy-destruct"></a><code class="computeroutput">scoped_connection</code> private construct/copy/destruct</h3> +<a name="idp427449728"></a><h3> +<a name="idp230034832-bbconstruct-copy-destruct"></a><code class="computeroutput">scoped_connection</code> private construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="id816616-bb"></a><span class="identifier">scoped_connection</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="scoped_connection.html" title="Class scoped_connection">scoped_connection</a><span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> -<p>The scoped_connection class is not copyable. It may only be constructed from a <code class="computeroutput"><a class="link" href="connection.html" title="Class connection">connection</a></code> object.</p> +<pre class="literallayout"><a name="idp160800384-bb"></a><span class="identifier">scoped_connection</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="scoped_connection.html" title="Class scoped_connection">scoped_connection</a><span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<p>The scoped_connection class is not copyable. It may only be copy constructed from an unscoped + <code class="computeroutput"><a class="link" href="connection.html" title="Class connection">connection</a></code> object.</p> </li> <li class="listitem"> -<pre class="literallayout">scoped_connection& <a name="id1421623-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="scoped_connection.html" title="Class scoped_connection">scoped_connection</a><span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> -<p>The scoped_connection class is not copyable. It may only be assigned from a <code class="computeroutput"><a class="link" href="connection.html" title="Class connection">connection</a></code> object.</p> +<pre class="literallayout">scoped_connection& <a name="idp160822800-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="scoped_connection.html" title="Class scoped_connection">scoped_connection</a><span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> +<p>The scoped_connection class is not copyable. It may only be copy assigned from an unscoped + <code class="computeroutput"><a class="link" href="connection.html" title="Class connection">connection</a></code> object.</p> </li> </ol></div> </div> |