Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/doc/html/boost/signals/scoped_connection.html @ 29

Last change on this file since 29 was 29, checked in by landauf, 17 years ago

updated boost from 1_33_1 to 1_34_1
File size: 7.0 KB
Line 
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4<title>Class scoped_connection</title>
5<link rel="stylesheet" href="../../boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
7<link rel="start" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
8<link rel="up" href="../../signals/reference.html#header.boost.signals.connection.hpp" title="Header &lt;boost/signals/connection.hpp&gt;">
9<link rel="prev" href="connection.html" title="Class connection">
10<link rel="next" href="../visit_each.html" title="Function template visit_each">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%">
14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
15<td align="center"><a href="../../../../index.htm">Home</a></td>
16<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="../../../../people/people.htm">People</a></td>
18<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
19<td align="center"><a href="../../../../more/index.htm">More</a></td>
20</table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="connection.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../signals/reference.html#header.boost.signals.connection.hpp"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../visit_each.html"><img src="../../images/next.png" alt="Next"></a>
24</div>
25<div class="refentry" lang="en">
26<a name="boost.signals.scoped_connection"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Class scoped_connection</span></h2>
29<p>boost::signals::scoped_connection &#8212; Limits a signal-slot connection lifetime to a particular scope.</p>
30</div>
31<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
32<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">
33<span class="bold"><strong>class</strong></span> scoped_connection : <span class="bold"><strong>private</strong></span> noncopyable   <span class="emphasis"><em>// Exposition only</em></span>
34{
35<span class="bold"><strong>public</strong></span>:
36  <span class="emphasis"><em>// <a href="scoped_connection.html#boost.signals.scoped_connectionconstruct-copy-destruct">construct/copy/destruct</a></em></span>
37  <a href="scoped_connection.html#id1217203-bb">scoped_connection</a>(<span class="bold"><strong>const</strong></span> <a href="connection.html" title="Class connection">connection</a>&amp;);
38  <a href="scoped_connection.html#id1217236-bb">~scoped_connection</a>();
39
40  <span class="emphasis"><em>// <a href="scoped_connection.html#id1217253-bb">connection management</a></em></span>
41  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="scoped_connection.html#id1217257-bb">disconnect</a>() <span class="bold"><strong>const</strong></span>;
42  <span class="type"><span class="bold"><strong>bool</strong></span></span> <a href="scoped_connection.html#id757831-bb">connected</a>() <span class="bold"><strong>const</strong></span>;
43};</pre></div>
44<div class="refsect1" lang="en">
45<a name="id1632619"></a><h2>Description</h2>
46<div class="refsect2" lang="en">
47<a name="id1632622"></a><h3>
48<a name="boost.signals.scoped_connectionconstruct-copy-destruct"></a><code class="computeroutput">scoped_connection</code> construct/copy/destruct</h3>
49<div class="orderedlist"><ol type="1">
50<li>
51<pre class="literallayout"><a name="id1217203-bb"></a>scoped_connection(<span class="bold"><strong>const</strong></span> <a href="connection.html" title="Class connection">connection</a>&amp; other);</pre>
52<div class="variablelist"><table border="0">
53<col align="left" valign="top">
54<tbody>
55<tr>
56<td>
57<span class="term">Effects:</span></td>
58<td><p><code class="computeroutput">this</code> references
59          the connection referenced by
60          <code class="computeroutput">other</code>.</p></td>
61</tr>
62<tr>
63<td>
64<span class="term">Throws:</span></td>
65<td><p>Will not throw.</p></td>
66</tr>
67</tbody>
68</table></div>
69</li>
70<li>
71<pre class="literallayout"><a name="id1217236-bb"></a>~scoped_connection();</pre>
72<div class="variablelist"><table border="0">
73<col align="left" valign="top">
74<tbody><tr>
75<td>
76<span class="term">Effects:</span></td>
77<td><p>If
78          <code class="computeroutput">this-&gt;<a href="scoped_connection.html#id757831-bb">connected</a>()</code>,
79          disconnects the signal-slot connection.</p></td>
80</tr></tbody>
81</table></div>
82</li>
83</ol></div>
84</div>
85<div class="refsect2" lang="en">
86<a name="id1632738"></a><h3>
87<a name="id1217253-bb"></a><code class="computeroutput">scoped_connection</code> connection management</h3>
88<div class="orderedlist"><ol type="1">
89<li>
90<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id1217257-bb"></a>disconnect() <span class="bold"><strong>const</strong></span>;</pre>
91<div class="variablelist"><table border="0">
92<col align="left" valign="top">
93<tbody>
94<tr>
95<td>
96<span class="term">Effects:</span></td>
97<td><p>If
98             <code class="computeroutput">this-&gt;<a href="scoped_connection.html#id757831-bb">connected</a>()</code>,
99             disconnects the signal and slot referenced by this;
100             otherwise, this operation is a no-op.</p></td>
101</tr>
102<tr>
103<td>
104<span class="term">Postconditions:</span></td>
105<td><p><code class="computeroutput">!this-&gt;<a href="scoped_connection.html#id757831-bb">connected</a>()</code>.</p></td>
106</tr>
107</tbody>
108</table></div>
109</li>
110<li>
111<pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id757831-bb"></a>connected() <span class="bold"><strong>const</strong></span>;</pre>
112<div class="variablelist"><table border="0">
113<col align="left" valign="top">
114<tbody>
115<tr>
116<td>
117<span class="term">Returns:</span></td>
118<td><p><code class="computeroutput">true</code> if this
119            references a non-NULL connection that is still active
120            (connected), and <code class="computeroutput">false</code>
121            otherwise.</p></td>
122</tr>
123<tr>
124<td>
125<span class="term">Throws:</span></td>
126<td><p>Will not throw.</p></td>
127</tr>
128</tbody>
129</table></div>
130</li>
131</ol></div>
132</div>
133</div>
134</div>
135<table width="100%"><tr>
136<td align="left"></td>
137<td align="right"><small>Copyright © 2001-2004 Douglas Gregor</small></td>
138</tr></table>
139<hr>
140<div class="spirit-nav">
141<a accesskey="p" href="connection.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../signals/reference.html#header.boost.signals.connection.hpp"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../visit_each.html"><img src="../../images/next.png" alt="Next"></a>
142</div>
143</body>
144</html>
Note: See TracBrowser for help on using the repository browser.