diff options
Diffstat (limited to 'doc/html/boost/signals2/connection.html')
| -rw-r--r--[-rwxr-xr-x] | doc/html/boost/signals2/connection.html | 88 |
1 files changed, 44 insertions, 44 deletions
diff --git a/doc/html/boost/signals2/connection.html b/doc/html/boost/signals2/connection.html index 50212ef520..65e8e58904 100755..100644 --- a/doc/html/boost/signals2/connection.html +++ b/doc/html/boost/signals2/connection.html @@ -35,30 +35,30 @@ <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#id1379105-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#id1404076-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> - connection& <a class="link" href="connection.html#id823540-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> + <a class="link" href="connection.html#id1162210-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#id811089-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> + connection& <a class="link" href="connection.html#id808588-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> - <span class="comment">// <a class="link" href="connection.html#id821799-bb">connection management</a></span> - <span class="keyword">void</span> <a class="link" href="connection.html#id829021-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#id1289781-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#id1421458-bb">connection management</a></span> + <span class="keyword">void</span> <a class="link" href="connection.html#id1394678-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#id1308291-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#id1140285-bb">blocking</a></span> - <span class="keyword">bool</span> <a class="link" href="connection.html#id1284179-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#id825574-bb">blocking</a></span> + <span class="keyword">bool</span> <a class="link" href="connection.html#id825578-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#id1382266-bb">modifiers</a></span> - <span class="keyword">void</span> <a class="link" href="connection.html#id1402738-bb"><span class="identifier">swap</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> + <span class="comment">// <a class="link" href="connection.html#id808549-bb">modifiers</a></span> + <span class="keyword">void</span> <a class="link" href="connection.html#id1313936-bb"><span class="identifier">swap</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> - <span class="comment">// <a class="link" href="connection.html#id807372-bb">comparisons</a></span> - <span class="keyword">bool</span> <a class="link" href="connection.html#id1403968-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#id1360133-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#id1357227-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#id1389493-bb">comparisons</a></span> + <span class="keyword">bool</span> <a class="link" href="connection.html#id1329005-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#id1391541-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#id1308157-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#id1383580-bb">specialized algorithms</a></span> -<span class="keyword">void</span> <a class="link" href="connection.html#boost.signals2.connection.swap_id1383584"><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#id1396888-bb">specialized algorithms</a></span> +<span class="keyword">void</span> <a class="link" href="connection.html#boost.signals2.connection.swap_id1396892"><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="id3154263"></a><h2>Description</h2> +<a name="id3210397"></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 @@ -67,9 +67,9 @@ disconnect a connection.</p> <div class="section"> <div class="titlepage"><div><div><h6 class="title"> -<a name="id3154283"></a>Thread Safety</h6></div></div></div> +<a name="id3210417"></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#id1402738-bb">swap</a> and the assignment operator. A <code class="computeroutput">connection</code> object + of <a class="link" href="connection.html#id1313936-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 @@ -77,13 +77,13 @@ </p> </div> <div class="refsect2"> -<a name="id3154330"></a><h3> +<a name="id3210464"></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="id1379105-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="id1162210-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"> <col align="left" valign="top"> <tbody> @@ -94,7 +94,7 @@ </tr> <tr> <td><p><span class="term">Postconditions:</span></p></td> -<td><p><code class="computeroutput">!this-><a class="link" href="connection.html#id1289781-bb">connected</a>()</code>.</p></td> +<td><p><code class="computeroutput">!this-><a class="link" href="connection.html#id1308291-bb">connected</a>()</code>.</p></td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> @@ -104,7 +104,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><a name="id1404076-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="id811089-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"> <col align="left" valign="top"> <tbody> @@ -122,7 +122,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout">connection& <a name="id823540-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="special">;</span></pre> +<pre class="literallayout">connection& <a name="id808588-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="special">;</span></pre> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> @@ -142,30 +142,30 @@ </ol></div> </div> <div class="refsect2"> -<a name="id3154577"></a><h3> -<a name="id821799-bb"></a><code class="computeroutput">connection</code> connection management</h3> +<a name="id3210712"></a><h3> +<a name="id1421458-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="id829021-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="id1394678-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"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term">Effects:</span></p></td> <td><p>If - <code class="computeroutput">this-><a class="link" href="connection.html#id1289781-bb">connected</a>()</code>, + <code class="computeroutput">this-><a class="link" href="connection.html#id1308291-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#id1289781-bb">connected</a>()</code>.</p></td> +<td><p><code class="computeroutput">!this-><a class="link" href="connection.html#id1308291-bb">connected</a>()</code>.</p></td> </tr> </tbody> </table></div> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="id1289781-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="id1308291-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"> <col align="left" valign="top"> <tbody> @@ -186,10 +186,10 @@ </ol></div> </div> <div class="refsect2"> -<a name="id3154749"></a><h3> -<a name="id1140285-bb"></a><code class="computeroutput">connection</code> blocking</h3> +<a name="id3210884"></a><h3> +<a name="id825574-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="id1284179-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="id825578-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. @@ -210,10 +210,10 @@ </li></ol></div> </div> <div class="refsect2"> -<a name="id3154855"></a><h3> -<a name="id1382266-bb"></a><code class="computeroutput">connection</code> modifiers</h3> +<a name="id3210990"></a><h3> +<a name="id808549-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="id1402738-bb"></a><span class="identifier">swap</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"><span class="keyword">void</span> <a name="id1313936-bb"></a><span class="identifier">swap</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"> <col align="left" valign="top"> <tbody> @@ -232,11 +232,11 @@ </li></ol></div> </div> <div class="refsect2"> -<a name="id3154956"></a><h3> -<a name="id807372-bb"></a><code class="computeroutput">connection</code> comparisons</h3> +<a name="id3211092"></a><h3> +<a name="id1389493-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="id1403968-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="id1329005-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"> <col align="left" valign="top"> <tbody> @@ -257,7 +257,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="id1360133-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="id1391541-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"> <col align="left" valign="top"> <tbody> @@ -273,7 +273,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="id1357227-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="id1308157-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"> <col align="left" valign="top"> <tbody> @@ -298,10 +298,10 @@ </ol></div> </div> <div class="refsect2"> -<a name="id3155271"></a><h3> -<a name="id1383580-bb"></a><code class="computeroutput">connection</code> specialized algorithms</h3> +<a name="id3211406"></a><h3> +<a name="id1396888-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_id1383584"></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_id1396892"></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"> <col align="left" valign="top"> <tbody> |