diff options
Diffstat (limited to 'doc/html/boost/signals2/shared_connection_block.html')
| -rw-r--r-- | doc/html/boost/signals2/shared_connection_block.html | 66 |
1 files changed, 33 insertions, 33 deletions
diff --git a/doc/html/boost/signals2/shared_connection_block.html b/doc/html/boost/signals2/shared_connection_block.html index f5b00ff0c8..9b099b094c 100644 --- a/doc/html/boost/signals2/shared_connection_block.html +++ b/doc/html/boost/signals2/shared_connection_block.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../signals2/reference.html#header.boost.signals2.shared_connection_block_hpp" title="Header <boost/signals2/shared_connection_block.hpp>"> -<link rel="prev" href="optional_last_idp219889824.html" title="Class optional_last_value<void>"> +<link rel="prev" href="optional_idm45507099693904.html" title="Class optional_last_value<void>"> <link rel="next" href="signal.html" title="Class template signal"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="optional_last_idp219889824.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../signals2/reference.html#header.boost.signals2.shared_connection_block_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="signal.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="optional_idm45507099693904.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../signals2/reference.html#header.boost.signals2.shared_connection_block_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="signal.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.signals2.shared_connection_block"></a><div class="titlepage"></div> @@ -36,23 +36,23 @@ <span class="keyword">class</span> <a class="link" href="shared_connection_block.html" title="Class shared_connection_block">shared_connection_block</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="shared_connection_block.html#boost.signals2.shared_connection_blockconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="shared_connection_block.html#idp106408528-bb"><span class="identifier">shared_connection_block</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="connection.html" title="Class connection">boost::signals2::connection</a> <span class="special">&</span> <span class="special">=</span> <span class="identifier">connection</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> + <a class="link" href="shared_connection_block.html#idm45506986289328-bb"><span class="identifier">shared_connection_block</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="connection.html" title="Class connection">boost::signals2::connection</a> <span class="special">&</span> <span class="special">=</span> <span class="identifier">connection</span><span class="special">(</span><span class="special">)</span><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> - <a class="link" href="shared_connection_block.html#idp102520608-bb"><span class="identifier">shared_connection_block</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">signals2</span><span class="special">::</span><span class="identifier">shared_connection_block</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="shared_connection_block.html#idm45506986464032-bb"><span class="identifier">shared_connection_block</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">signals2</span><span class="special">::</span><span class="identifier">shared_connection_block</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> shared_connection_block& - <a class="link" href="shared_connection_block.html#idp109337904-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">signals2</span><span class="special">::</span><span class="identifier">shared_connection_block</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="shared_connection_block.html#idp218239616-bb"><span class="special">~</span><span class="identifier">shared_connection_block</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="shared_connection_block.html#idm45507137545216-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">signals2</span><span class="special">::</span><span class="identifier">shared_connection_block</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="shared_connection_block.html#idm45507102863488-bb"><span class="special">~</span><span class="identifier">shared_connection_block</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="shared_connection_block.html#idp104223424-bb">connection blocking</a></span> - <span class="keyword">void</span> <a class="link" href="shared_connection_block.html#idp104223952-bb"><span class="identifier">unblock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="shared_connection_block.html#idp162463232-bb"><span class="identifier">block</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="shared_connection_block.html#idp97407600-bb"><span class="identifier">blocking</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="shared_connection_block.html#idm45506999518480-bb">connection blocking</a></span> + <span class="keyword">void</span> <a class="link" href="shared_connection_block.html#idm45506984892576-bb"><span class="identifier">unblock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="shared_connection_block.html#idm45506993446496-bb"><span class="identifier">block</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="shared_connection_block.html#idm45506989164192-bb"><span class="identifier">blocking</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="shared_connection_block.html#idp106666608-bb">miscellaneous methods</a></span> - <a class="link" href="connection.html" title="Class connection">boost::signals2::connection</a> <a class="link" href="shared_connection_block.html#idp214695392-bb"><span class="identifier">connection</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="shared_connection_block.html#idm45506995499456-bb">miscellaneous methods</a></span> + <a class="link" href="connection.html" title="Class connection">boost::signals2::connection</a> <a class="link" href="shared_connection_block.html#idm45506976541568-bb"><span class="identifier">connection</span></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></pre></div> <div class="refsect1"> -<a name="idp428455440"></a><h2>Description</h2> +<a name="idm45555131219776"></a><h2>Description</h2> <p>A <code class="computeroutput">shared_connection_block</code> object blocks a connection, preventing the associated slot from executing when the associated signal is invoked. The connection will remain @@ -60,7 +60,7 @@ the connection releases its block. A <code class="computeroutput">shared_connection_block</code> releases its block when it is destroyed or its - <a class="link" href="shared_connection_block.html#idp104223952-bb">unblock</a> method is called.</p> + <a class="link" href="shared_connection_block.html#idm45506984892576-bb">unblock</a> method is called.</p> <p>A <code class="computeroutput">shared_connection_block</code> is safe to use even after the <a class="link" href="connection.html" title="Class connection">signals2::connection</a> object it was constructed from has been destroyed, or the connection it references has been @@ -77,13 +77,13 @@ connection. </p> <div class="refsect2"> -<a name="idp428462864"></a><h3> +<a name="idm45555131211776"></a><h3> <a name="boost.signals2.shared_connection_blockconstruct-copy-destruct"></a><code class="computeroutput">shared_connection_block</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp106408528-bb"></a><span class="identifier">shared_connection_block</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="connection.html" title="Class connection">boost::signals2::connection</a> <span class="special">&</span> conn <span class="special">=</span> <span class="identifier">connection</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> +<pre class="literallayout"><a name="idm45506986289328-bb"></a><span class="identifier">shared_connection_block</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="connection.html" title="Class connection">boost::signals2::connection</a> <span class="special">&</span> conn <span class="special">=</span> <span class="identifier">connection</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="keyword">bool</span> initially_blocking <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> @@ -99,7 +99,7 @@ will initially block the connection if and only if the <code class="computeroutput">initially_blocking</code> parameter is <code class="computeroutput">true</code>. The block on the connection may be released - by calling the <a class="link" href="shared_connection_block.html#idp104223952-bb">unblock</a> method, + by calling the <a class="link" href="shared_connection_block.html#idm45506984892576-bb">unblock</a> method, or destroying the <code class="computeroutput">shared_connection_block</code> object.</p> <p>Default construction of a <code class="computeroutput">shared_connection_block</code> results in a <code class="computeroutput">shared_connection_block</code> which references the NULL connection. @@ -117,7 +117,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp102520608-bb"></a><span class="identifier">shared_connection_block</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">signals2</span><span class="special">::</span><span class="identifier">shared_connection_block</span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idm45506986464032-bb"></a><span class="identifier">shared_connection_block</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">signals2</span><span class="special">::</span><span class="identifier">shared_connection_block</span> <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"> @@ -143,7 +143,7 @@ </li> <li class="listitem"> <pre class="literallayout">shared_connection_block& -<a name="idp109337904-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">signals2</span><span class="special">::</span><span class="identifier">shared_connection_block</span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> +<a name="idm45507137545216-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">signals2</span><span class="special">::</span><span class="identifier">shared_connection_block</span> <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"> @@ -171,7 +171,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp218239616-bb"></a><span class="special">~</span><span class="identifier">shared_connection_block</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idm45507102863488-bb"></a><span class="special">~</span><span class="identifier">shared_connection_block</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"> @@ -179,18 +179,18 @@ </colgroup> <tbody><tr> <td><p><span class="term">Effects:</span></p></td> -<td><p>If <a class="link" href="shared_connection_block.html#idp97407600-bb">blocking</a>() is true, releases the connection block.</p></td> +<td><p>If <a class="link" href="shared_connection_block.html#idm45506989164192-bb">blocking</a>() is true, releases the connection block.</p></td> </tr></tbody> </table></div> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp428520976"></a><h3> -<a name="idp104223424-bb"></a><code class="computeroutput">shared_connection_block</code> connection blocking</h3> +<a name="idm45555131153920"></a><h3> +<a name="idm45506999518480-bb"></a><code class="computeroutput">shared_connection_block</code> connection blocking</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp104223952-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="idm45506984892576-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"> @@ -199,7 +199,7 @@ <tbody> <tr> <td><p><span class="term">Effects:</span></p></td> -<td><p>If <a class="link" href="shared_connection_block.html#idp97407600-bb">blocking</a>() is true, releases the connection block. +<td><p>If <a class="link" href="shared_connection_block.html#idm45506989164192-bb">blocking</a>() is true, releases the connection block. Note, the connection may remain blocked due to other <code class="computeroutput">shared_connection_block</code> objects.</p></td> </tr> @@ -211,7 +211,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp162463232-bb"></a><span class="identifier">block</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idm45506993446496-bb"></a><span class="identifier">block</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"> @@ -220,7 +220,7 @@ <tbody> <tr> <td><p><span class="term">Effects:</span></p></td> -<td><p>If <a class="link" href="shared_connection_block.html#idp97407600-bb">blocking</a>() is false, reasserts a block on +<td><p>If <a class="link" href="shared_connection_block.html#idm45506989164192-bb">blocking</a>() is false, reasserts a block on the connection.</p></td> </tr> <tr> @@ -231,7 +231,7 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp97407600-bb"></a><span class="identifier">blocking</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="idm45506989164192-bb"></a><span class="identifier">blocking</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"> @@ -244,7 +244,7 @@ </tr> <tr> <td><p><span class="term">Notes:</span></p></td> -<td><p><code class="computeroutput">this->blocking() == true</code> implies <code class="computeroutput"><a class="link" href="connection.html#idp106655984-bb">connection::blocked</a>() == true</code> +<td><p><code class="computeroutput">this->blocking() == true</code> implies <code class="computeroutput"><a class="link" href="connection.html#idm45507104671744-bb">connection::blocked</a>() == true</code> for the connection. However, <code class="computeroutput">this->blocking() == false</code> does not necessarily imply <code class="computeroutput">connection::blocked() == false</code>, since the connection may be blocked by another <code class="computeroutput">shared_connection_block</code> object.</p></td> @@ -255,10 +255,10 @@ </ol></div> </div> <div class="refsect2"> -<a name="idp428552704"></a><h3> -<a name="idp106666608-bb"></a><code class="computeroutput">shared_connection_block</code> miscellaneous methods</h3> +<a name="idm45555131122192"></a><h3> +<a name="idm45506995499456-bb"></a><code class="computeroutput">shared_connection_block</code> miscellaneous methods</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><a class="link" href="connection.html" title="Class connection">boost::signals2::connection</a> <a name="idp214695392-bb"></a><span class="identifier">connection</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="connection.html" title="Class connection">boost::signals2::connection</a> <a name="idm45506976541568-bb"></a><span class="identifier">connection</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"> @@ -282,7 +282,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="optional_last_idp219889824.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../signals2/reference.html#header.boost.signals2.shared_connection_block_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="signal.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="optional_idm45507099693904.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../signals2/reference.html#header.boost.signals2.shared_connection_block_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="signal.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |