diff options
Diffstat (limited to 'doc/html/boost/signals2/connection.html')
| -rw-r--r-- | doc/html/boost/signals2/connection.html | 96 |
1 files changed, 48 insertions, 48 deletions
diff --git a/doc/html/boost/signals2/connection.html b/doc/html/boost/signals2/connection.html index 114703c82d..c07002181d 100644 --- a/doc/html/boost/signals2/connection.html +++ b/doc/html/boost/signals2/connection.html @@ -35,32 +35,32 @@ <span class="keyword">class</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="connection.html#boost.signals2.connectionconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="connection.html#idp159866048-bb"><span class="identifier">connection</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="connection.html#idp199571072-bb"><span class="identifier">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="connection.html#idp103168512-bb"><span class="identifier">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> - connection& <a class="link" href="connection.html#idp220294640-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> - connection& <a class="link" href="connection.html#idp41055392-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="connection.html#idp198196320-bb"><span class="identifier">connection</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="connection.html#idp94282304-bb"><span class="identifier">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="connection.html#idp85213056-bb"><span class="identifier">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> + connection& <a class="link" href="connection.html#idp107214432-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> + connection& <a class="link" href="connection.html#idp145024112-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> - <span class="comment">// <a class="link" href="connection.html#idp225161328-bb">connection management</a></span> - <span class="keyword">void</span> <a class="link" href="connection.html#idp157779648-bb"><span class="identifier">disconnect</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="connection.html#idp228419264-bb"><span class="identifier">connected</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="connection.html#idp146448368-bb">connection management</a></span> + <span class="keyword">void</span> <a class="link" href="connection.html#idp154688224-bb"><span class="identifier">disconnect</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="connection.html#idp66397168-bb"><span class="identifier">connected</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="comment">// <a class="link" href="connection.html#idp103596160-bb">blocking</a></span> - <span class="keyword">bool</span> <a class="link" href="connection.html#idp218885216-bb"><span class="identifier">blocked</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="connection.html#idp142735488-bb">blocking</a></span> + <span class="keyword">bool</span> <a class="link" href="connection.html#idp147603024-bb"><span class="identifier">blocked</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="comment">// <a class="link" href="connection.html#idp104912720-bb">modifiers</a></span> - <span class="keyword">void</span> <a class="link" href="connection.html#idp223597776-bb"><span class="identifier">swap</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> + <span class="comment">// <a class="link" href="connection.html#idp93176016-bb">modifiers</a></span> + <span class="keyword">void</span> <a class="link" href="connection.html#idp99868992-bb"><span class="identifier">swap</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> - <span class="comment">// <a class="link" href="connection.html#idp147412320-bb">comparisons</a></span> - <span class="keyword">bool</span> <a class="link" href="connection.html#idp97203408-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="keyword">const</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="connection.html#idp214462976-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="keyword">const</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="connection.html#idp211226368-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="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="connection.html#idp147616560-bb">comparisons</a></span> + <span class="keyword">bool</span> <a class="link" href="connection.html#idp214376048-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="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="connection.html#idp154724704-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="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="connection.html#idp95425520-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="keyword">const</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span> -<span class="comment">// <a class="link" href="connection.html#idp151059968-bb">specialized algorithms</a></span> -<span class="keyword">void</span> <a class="link" href="connection.html#boost.signals2.connection.swap_idp201272096"><span class="identifier">swap</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> <a class="link" href="connection.html" title="Class connection">connection</a><span class="special">&</span><span class="special">)</span><span class="special">;</span></pre></div> +<span class="comment">// <a class="link" href="connection.html#idp224037728-bb">specialized algorithms</a></span> +<span class="keyword">void</span> <a class="link" href="connection.html#boost.signals2.connection.swap_idp193888784"><span class="identifier">swap</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> <a class="link" href="connection.html" title="Class connection">connection</a><span class="special">&</span><span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp427128032"></a><h2>Description</h2> +<a name="idp421060752"></a><h2>Description</h2> <p>The <a class="link" href="connection.html" title="Class connection">signals2::connection</a> class represents a connection between a Signal and a Slot. It is a lightweight object that has the ability to query whether the @@ -69,9 +69,9 @@ disconnect a connection.</p> <div class="section"> <div class="titlepage"><div><div><h6 class="title"> -<a name="idp427130160"></a>Thread Safety</h6></div></div></div> +<a name="idp421062880"></a>Thread Safety</h6></div></div></div> <p>The methods of the <code class="computeroutput">connection</code> class are thread-safe with the exception - of <a class="link" href="connection.html#idp223597776-bb">swap</a> and the assignment operator. A <code class="computeroutput">connection</code> object + of <a class="link" href="connection.html#idp99868992-bb">swap</a> and the assignment operator. A <code class="computeroutput">connection</code> object should not be accessed concurrently when either of these operations is in progress. However, it is always safe to access a different <code class="computeroutput">connection</code> object in another thread, even if the two <code class="computeroutput">connection</code> objects are copies @@ -79,13 +79,13 @@ </p> </div> <div class="refsect2"> -<a name="idp427135408"></a><h3> +<a name="idp421068128"></a><h3> <a name="boost.signals2.connectionconstruct-copy-destruct"></a><code class="computeroutput">connection</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp159866048-bb"></a><span class="identifier">connection</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp198196320-bb"></a><span class="identifier">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"> @@ -99,7 +99,7 @@ </tr> <tr> <td><p><span class="term">Postconditions:</span></p></td> -<td><p><code class="computeroutput">!this-><a class="link" href="connection.html#idp228419264-bb">connected</a>()</code>.</p></td> +<td><p><code class="computeroutput">!this-><a class="link" href="connection.html#idp66397168-bb">connected</a>()</code>.</p></td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> @@ -109,7 +109,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp199571072-bb"></a><span class="identifier">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> +<pre class="literallayout"><a name="idp94282304-bb"></a><span class="identifier">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"> @@ -130,7 +130,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp103168512-bb"></a><span class="identifier">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> +<pre class="literallayout"><a name="idp85213056-bb"></a><span class="identifier">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> @@ -153,7 +153,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout">connection& <a name="idp220294640-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> +<pre class="literallayout">connection& <a name="idp107214432-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> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> @@ -174,7 +174,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout">connection& <a name="idp41055392-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> +<pre class="literallayout">connection& <a name="idp145024112-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> @@ -199,11 +199,11 @@ </ol></div> </div> <div class="refsect2"> -<a name="idp427184784"></a><h3> -<a name="idp225161328-bb"></a><code class="computeroutput">connection</code> connection management</h3> +<a name="idp421117632"></a><h3> +<a name="idp146448368-bb"></a><code class="computeroutput">connection</code> connection management</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp157779648-bb"></a><span class="identifier">disconnect</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp154688224-bb"></a><span class="identifier">disconnect</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> @@ -213,19 +213,19 @@ <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>, + <code class="computeroutput">this-><a class="link" href="connection.html#idp66397168-bb">connected</a>()</code>, disconnects the signal and slot referenced by this; otherwise, this operation is a no-op.</p></td> </tr> <tr> <td><p><span class="term">Postconditions:</span></p></td> -<td><p><code class="computeroutput">!this-><a class="link" href="connection.html#idp228419264-bb">connected</a>()</code>.</p></td> +<td><p><code class="computeroutput">!this-><a class="link" href="connection.html#idp66397168-bb">connected</a>()</code>.</p></td> </tr> </tbody> </table></div> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp228419264-bb"></a><span class="identifier">connected</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp66397168-bb"></a><span class="identifier">connected</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> @@ -249,10 +249,10 @@ </ol></div> </div> <div class="refsect2"> -<a name="idp427205744"></a><h3> -<a name="idp103596160-bb"></a><code class="computeroutput">connection</code> blocking</h3> +<a name="idp421138656"></a><h3> +<a name="idp142735488-bb"></a><code class="computeroutput">connection</code> blocking</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp218885216-bb"></a><span class="identifier">blocked</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp147603024-bb"></a><span class="identifier">blocked</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p> Queries if the connection is blocked. A connection may be blocked by creating a <code class="computeroutput"><a class="link" href="shared_connection_block.html" title="Class shared_connection_block">boost::signals2::shared_connection_block</a></code> object. @@ -276,10 +276,10 @@ </li></ol></div> </div> <div class="refsect2"> -<a name="idp427218144"></a><h3> -<a name="idp104912720-bb"></a><code class="computeroutput">connection</code> modifiers</h3> +<a name="idp421151056"></a><h3> +<a name="idp93176016-bb"></a><code class="computeroutput">connection</code> modifiers</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp223597776-bb"></a><span class="identifier">swap</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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp99868992-bb"></a><span class="identifier">swap</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> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> @@ -301,11 +301,11 @@ </li></ol></div> </div> <div class="refsect2"> -<a name="idp427229776"></a><h3> -<a name="idp147412320-bb"></a><code class="computeroutput">connection</code> comparisons</h3> +<a name="idp421162624"></a><h3> +<a name="idp147616560-bb"></a><code class="computeroutput">connection</code> comparisons</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp97203408-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> other<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp214376048-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> other<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> @@ -329,7 +329,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp214462976-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> other<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp154724704-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> other<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> @@ -348,7 +348,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp211226368-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> other<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp95425520-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> other<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> @@ -376,10 +376,10 @@ </ol></div> </div> <div class="refsect2"> -<a name="idp427267552"></a><h3> -<a name="idp151059968-bb"></a><code class="computeroutput">connection</code> specialized algorithms</h3> +<a name="idp421200592"></a><h3> +<a name="idp224037728-bb"></a><code class="computeroutput">connection</code> specialized algorithms</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="boost.signals2.connection.swap_idp201272096"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="connection.html" title="Class connection">connection</a><span class="special">&</span> x<span class="special">,</span> <a class="link" href="connection.html" title="Class connection">connection</a><span class="special">&</span> y<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="boost.signals2.connection.swap_idp193888784"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="connection.html" title="Class connection">connection</a><span class="special">&</span> x<span class="special">,</span> <a class="link" href="connection.html" title="Class connection">connection</a><span class="special">&</span> y<span class="special">)</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> |