diff options
Diffstat (limited to 'doc/html/boost/signals/connection.html')
| -rw-r--r-- | doc/html/boost/signals/connection.html | 89 |
1 files changed, 45 insertions, 44 deletions
diff --git a/doc/html/boost/signals/connection.html b/doc/html/boost/signals/connection.html index 71f759af47..119919ccae 100644 --- a/doc/html/boost/signals/connection.html +++ b/doc/html/boost/signals/connection.html @@ -1,3 +1,4 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> @@ -35,31 +36,31 @@ <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.signals.connectionconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="connection.html#idp93197632-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#idp153229008-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#idp144306032-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#idp201617184-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#idp160715392-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#idp100450176-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#idp106014976-bb">connection management</a></span> - <span class="keyword">void</span> <a class="link" href="connection.html#idp205515392-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#idp148223824-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#idp215978192-bb">connection management</a></span> + <span class="keyword">void</span> <a class="link" href="connection.html#idp155694304-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#idp99170432-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#idp202383488-bb">blocking</a></span> - <span class="keyword">void</span> <a class="link" href="connection.html#idp219437600-bb"><span class="identifier">block</span></a><span class="special">(</span><span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="connection.html#idp61895280-bb"><span class="identifier">unblock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="connection.html#idp97067024-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#idp157302608-bb">blocking</a></span> + <span class="keyword">void</span> <a class="link" href="connection.html#idp162917792-bb"><span class="identifier">block</span></a><span class="special">(</span><span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="connection.html#idp150538448-bb"><span class="identifier">unblock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="connection.html#idp213689072-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#idp144112816-bb">modifiers</a></span> - <span class="keyword">void</span> <a class="link" href="connection.html#idp144113376-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#idp109332224-bb">modifiers</a></span> + <span class="keyword">void</span> <a class="link" href="connection.html#idp109332784-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#idp148147824-bb">comparisons</a></span> - <span class="keyword">bool</span> <a class="link" href="connection.html#idp148148384-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#idp144616192-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#idp164478432-bb">comparisons</a></span> + <span class="keyword">bool</span> <a class="link" href="connection.html#idp164478992-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#idp162919760-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#idp94322784-bb">specialized algorithms</a></span> -<span class="keyword">void</span> <a class="link" href="connection.html#boost.signals.connection.swap_idp94323232"><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#idp209342672-bb">specialized algorithms</a></span> +<span class="keyword">void</span> <a class="link" href="connection.html#boost.signals.connection.swap_idp159879168"><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="idp420063808"></a><h2>Description</h2> +<a name="idp426380704"></a><h2>Description</h2> <p>The <a class="link" href="connection.html" title="Class connection">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,13 +68,13 @@ the signal and slot. It is always safe to query or disconnect a connection.</p> <div class="refsect2"> -<a name="idp420065888"></a><h3> +<a name="idp426382832"></a><h3> <a name="boost.signals.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="idp93197632-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="idp201617184-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"> @@ -87,7 +88,7 @@ </tr> <tr> <td><p><span class="term">Postconditions:</span></p></td> -<td><p><code class="computeroutput">!this-><a class="link" href="connection.html#idp148223824-bb">connected</a>()</code>.</p></td> +<td><p><code class="computeroutput">!this-><a class="link" href="connection.html#idp99170432-bb">connected</a>()</code>.</p></td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> @@ -97,7 +98,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp153229008-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="idp160715392-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"> @@ -118,7 +119,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout">connection& <a name="idp144306032-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="idp100450176-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" class="variablelist compact"> <colgroup> <col align="left" valign="top"> @@ -141,11 +142,11 @@ </ol></div> </div> <div class="refsect2"> -<a name="idp420095488"></a><h3> -<a name="idp106014976-bb"></a><code class="computeroutput">connection</code> connection management</h3> +<a name="idp426412256"></a><h3> +<a name="idp215978192-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="idp205515392-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="idp155694304-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"> @@ -155,19 +156,19 @@ <tr> <td><p><span class="term">Effects:</span></p></td> <td><p>If - <code class="computeroutput">this-><a class="link" href="connection.html#idp148223824-bb">connected</a>()</code>, + <code class="computeroutput">this-><a class="link" href="connection.html#idp99170432-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#idp148223824-bb">connected</a>()</code>.</p></td> +<td><p><code class="computeroutput">!this-><a class="link" href="connection.html#idp99170432-bb">connected</a>()</code>.</p></td> </tr> </tbody> </table></div> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp148223824-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="idp99170432-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"> @@ -191,11 +192,11 @@ </ol></div> </div> <div class="refsect2"> -<a name="idp420116448"></a><h3> -<a name="idp202383488-bb"></a><code class="computeroutput">connection</code> blocking</h3> +<a name="idp426433216"></a><h3> +<a name="idp157302608-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">void</span> <a name="idp219437600-bb"></a><span class="identifier">block</span><span class="special">(</span><span class="keyword">bool</span> should_block <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp162917792-bb"></a><span class="identifier">block</span><span class="special">(</span><span class="keyword">bool</span> should_block <span class="special">=</span> <span class="keyword">true</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"> @@ -218,7 +219,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp61895280-bb"></a><span class="identifier">unblock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp150538448-bb"></a><span class="identifier">unblock</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"> @@ -241,7 +242,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp97067024-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="idp213689072-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> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> @@ -263,10 +264,10 @@ </ol></div> </div> <div class="refsect2"> -<a name="idp420145504"></a><h3> -<a name="idp144112816-bb"></a><code class="computeroutput">connection</code> modifiers</h3> +<a name="idp426462208"></a><h3> +<a name="idp109332224-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="idp144113376-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="idp109332784-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" class="variablelist compact"> <colgroup> <col align="left" valign="top"> @@ -288,11 +289,11 @@ </li></ol></div> </div> <div class="refsect2"> -<a name="idp420157760"></a><h3> -<a name="idp148147824-bb"></a><code class="computeroutput">connection</code> comparisons</h3> +<a name="idp426474528"></a><h3> +<a name="idp164478432-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="idp148148384-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="idp164478992-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"> @@ -316,7 +317,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp144616192-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="idp162919760-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"> @@ -344,10 +345,10 @@ </ol></div> </div> <div class="refsect2"> -<a name="idp420185376"></a><h3> -<a name="idp94322784-bb"></a><code class="computeroutput">connection</code> specialized algorithms</h3> +<a name="idp426502144"></a><h3> +<a name="idp209342672-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.signals.connection.swap_idp94323232"></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.signals.connection.swap_idp159879168"></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"> |