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 0ea8f71d92..eb6bb29b97 100644 --- a/doc/html/boost/signals2/connection.html +++ b/doc/html/boost/signals2/connection.html @@ -36,32 +36,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#idp719416640-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#idp719419888-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#idp719424704-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#idp719430688-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#idp719435504-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#idp746109488-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#idp746112736-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#idp746117552-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#idp746123536-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#idp746128352-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#idp719441488-bb">connection management</a></span> - <span class="keyword">void</span> <a class="link" href="connection.html#idp719442048-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#idp719446912-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#idp746134336-bb">connection management</a></span> + <span class="keyword">void</span> <a class="link" href="connection.html#idp746134896-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#idp746139760-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#idp719451040-bb">blocking</a></span> - <span class="keyword">bool</span> <a class="link" href="connection.html#idp719451600-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#idp746143888-bb">blocking</a></span> + <span class="keyword">bool</span> <a class="link" href="connection.html#idp746144448-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#idp719456608-bb">modifiers</a></span> - <span class="keyword">void</span> <a class="link" href="connection.html#idp719457168-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#idp746149456-bb">modifiers</a></span> + <span class="keyword">void</span> <a class="link" href="connection.html#idp746150016-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#idp719462848-bb">comparisons</a></span> - <span class="keyword">bool</span> <a class="link" href="connection.html#idp719463408-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#idp719470688-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#idp719475568-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#idp746155696-bb">comparisons</a></span> + <span class="keyword">bool</span> <a class="link" href="connection.html#idp746156256-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#idp746163536-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#idp746168416-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#idp719483072-bb">specialized algorithms</a></span> -<span class="keyword">void</span> <a class="link" href="connection.html#boost.signals2.connection.swap_idp719483632"><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#idp746175920-bb">specialized algorithms</a></span> +<span class="keyword">void</span> <a class="link" href="connection.html#boost.signals2.connection.swap_idp746176480"><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="idp521998352"></a><h2>Description</h2> +<a name="idp505731040"></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 @@ -70,9 +70,9 @@ disconnect a connection.</p> <div class="section"> <div class="titlepage"><div><div><h6 class="title"> -<a name="idp522000480"></a>Thread Safety</h6></div></div></div> +<a name="idp505733168"></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#idp719457168-bb">swap</a> and the assignment operator. A <code class="computeroutput">connection</code> object + of <a class="link" href="connection.html#idp746150016-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 @@ -80,13 +80,13 @@ </p> </div> <div class="refsect2"> -<a name="idp522005728"></a><h3> +<a name="idp505738416"></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="idp719416640-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="idp746109488-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"> @@ -100,7 +100,7 @@ </tr> <tr> <td><p><span class="term">Postconditions:</span></p></td> -<td><p><code class="computeroutput">!this-><a class="link" href="connection.html#idp719446912-bb">connected</a>()</code>.</p></td> +<td><p><code class="computeroutput">!this-><a class="link" href="connection.html#idp746139760-bb">connected</a>()</code>.</p></td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> @@ -110,7 +110,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp719419888-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="idp746112736-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"> @@ -131,7 +131,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp719424704-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="idp746117552-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> @@ -154,7 +154,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout">connection& <a name="idp719430688-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="idp746123536-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"> @@ -175,7 +175,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout">connection& <a name="idp719435504-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="idp746128352-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> @@ -200,11 +200,11 @@ </ol></div> </div> <div class="refsect2"> -<a name="idp522055040"></a><h3> -<a name="idp719441488-bb"></a><code class="computeroutput">connection</code> connection management</h3> +<a name="idp505787728"></a><h3> +<a name="idp746134336-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="idp719442048-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="idp746134896-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"> @@ -214,19 +214,19 @@ <tr> <td><p><span class="term">Effects:</span></p></td> <td><p>If - <code class="computeroutput">this-><a class="link" href="connection.html#idp719446912-bb">connected</a>()</code>, + <code class="computeroutput">this-><a class="link" href="connection.html#idp746139760-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#idp719446912-bb">connected</a>()</code>.</p></td> +<td><p><code class="computeroutput">!this-><a class="link" href="connection.html#idp746139760-bb">connected</a>()</code>.</p></td> </tr> </tbody> </table></div> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp719446912-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="idp746139760-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"> @@ -250,10 +250,10 @@ </ol></div> </div> <div class="refsect2"> -<a name="idp522076064"></a><h3> -<a name="idp719451040-bb"></a><code class="computeroutput">connection</code> blocking</h3> +<a name="idp505808688"></a><h3> +<a name="idp746143888-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="idp719451600-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="idp746144448-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. @@ -277,10 +277,10 @@ </li></ol></div> </div> <div class="refsect2"> -<a name="idp522088528"></a><h3> -<a name="idp719456608-bb"></a><code class="computeroutput">connection</code> modifiers</h3> +<a name="idp505821152"></a><h3> +<a name="idp746149456-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="idp719457168-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="idp746150016-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"> @@ -302,11 +302,11 @@ </li></ol></div> </div> <div class="refsect2"> -<a name="idp522100160"></a><h3> -<a name="idp719462848-bb"></a><code class="computeroutput">connection</code> comparisons</h3> +<a name="idp505832720"></a><h3> +<a name="idp746155696-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="idp719463408-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="idp746156256-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"> @@ -330,7 +330,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp719470688-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="idp746163536-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"> @@ -349,7 +349,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp719475568-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="idp746168416-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"> @@ -377,10 +377,10 @@ </ol></div> </div> <div class="refsect2"> -<a name="idp522138016"></a><h3> -<a name="idp719483072-bb"></a><code class="computeroutput">connection</code> specialized algorithms</h3> +<a name="idp505870688"></a><h3> +<a name="idp746175920-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_idp719483632"></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_idp746176480"></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"> |