Imported Upstream version 2.99.2
[platform/upstream/libsigc++.git] / docs / reference / html / structsigc_1_1connection.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.9.1"/>
7 <title>libsigc++: sigc::connection Struct Reference</title>
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <script type="text/javascript" src="jquery.js"></script>
10 <script type="text/javascript" src="dynsections.js"></script>
11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
12 <link href="doxygen-extra.css" rel="stylesheet" type="text/css"/>
13 </head>
14 <body>
15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
16 <div id="titlearea">
17 <table cellspacing="0" cellpadding="0">
18  <tbody>
19  <tr style="height: 56px;">
20   <td style="padding-left: 0.5em;">
21    <div id="projectname">libsigc++
22    &#160;<span id="projectnumber">2.99.2</span>
23    </div>
24   </td>
25  </tr>
26  </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.8.9.1 -->
31   <div id="navrow1" class="tabs">
32     <ul class="tablist">
33       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
34       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
35       <li><a href="modules.html"><span>Modules</span></a></li>
36       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
37       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
38     </ul>
39   </div>
40   <div id="navrow2" class="tabs2">
41     <ul class="tablist">
42       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
43       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
44       <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
45       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
46     </ul>
47   </div>
48 <div id="nav-path" class="navpath">
49   <ul>
50 <li class="navelem"><a class="el" href="namespacesigc.html">sigc</a></li><li class="navelem"><a class="el" href="structsigc_1_1connection.html">connection</a></li>  </ul>
51 </div>
52 </div><!-- top -->
53 <div class="header">
54   <div class="summary">
55 <a href="#pub-methods">Public Member Functions</a> &#124;
56 <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
57 <a href="structsigc_1_1connection-members.html">List of all members</a>  </div>
58   <div class="headertitle">
59 <div class="title">sigc::connection Struct Reference<div class="ingroups"><a class="el" href="group__signal.html">Signals</a></div></div>  </div>
60 </div><!--header-->
61 <div class="contents">
62
63 <p>Convinience class for safe disconnection.  
64  <a href="structsigc_1_1connection.html#details">More...</a></p>
65
66 <p><code>#include &lt;sigc++/connection.h&gt;</code></p>
67 <div class="dynheader">
68 Inheritance diagram for sigc::connection:</div>
69 <div class="dyncontent">
70 <div class="center"><img src="structsigc_1_1connection__inherit__graph.png" border="0" usemap="#sigc_1_1connection_inherit__map" alt="Inheritance graph"/></div>
71 <map name="sigc_1_1connection_inherit__map" id="sigc_1_1connection_inherit__map">
72 <area shape="rect" id="node2" href="structsigc_1_1notifiable.html" title="sigc::notifiable" alt="" coords="11,5,125,32"/></map>
73 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
74 <table class="memberdecls">
75 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
76 Public Member Functions</h2></td></tr>
77 <tr class="memitem:a95f80dbbf10fde0b851d78ec12cc2629"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#a95f80dbbf10fde0b851d78ec12cc2629">connection</a> () noexcept</td></tr>
78 <tr class="memdesc:a95f80dbbf10fde0b851d78ec12cc2629"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an empty connection object.  <a href="#a95f80dbbf10fde0b851d78ec12cc2629">More...</a><br /></td></tr>
79 <tr class="separator:a95f80dbbf10fde0b851d78ec12cc2629"><td class="memSeparator" colspan="2">&#160;</td></tr>
80 <tr class="memitem:ad13d5e3331cc9b1494e0edb8fa37fdba"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#ad13d5e3331cc9b1494e0edb8fa37fdba">connection</a> (const <a class="el" href="structsigc_1_1connection.html">connection</a>&amp; c)</td></tr>
81 <tr class="memdesc:ad13d5e3331cc9b1494e0edb8fa37fdba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a connection object copying an existing one.  <a href="#ad13d5e3331cc9b1494e0edb8fa37fdba">More...</a><br /></td></tr>
82 <tr class="separator:ad13d5e3331cc9b1494e0edb8fa37fdba"><td class="memSeparator" colspan="2">&#160;</td></tr>
83 <tr class="memitem:ac8847ae94e0b05bed6c81f54f58deef3"><td class="memTemplParams" colspan="2">template&lt;typename T_slot &gt; </td></tr>
84 <tr class="memitem:ac8847ae94e0b05bed6c81f54f58deef3"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#ac8847ae94e0b05bed6c81f54f58deef3">connection</a> (const <a class="el" href="structsigc_1_1slot__iterator.html">slot_iterator</a>&lt; T_slot &gt;&amp; it)</td></tr>
85 <tr class="memdesc:ac8847ae94e0b05bed6c81f54f58deef3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a connection object from a slot list iterator.  <a href="#ac8847ae94e0b05bed6c81f54f58deef3">More...</a><br /></td></tr>
86 <tr class="separator:ac8847ae94e0b05bed6c81f54f58deef3"><td class="memSeparator" colspan="2">&#160;</td></tr>
87 <tr class="memitem:a124709de26781e5ffcf8bbb5dcd621ed"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#a124709de26781e5ffcf8bbb5dcd621ed">connection</a> (<a class="el" href="classsigc_1_1slot__base.html">slot_base</a>&amp; sl)</td></tr>
88 <tr class="memdesc:a124709de26781e5ffcf8bbb5dcd621ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a connection object from a slot object.  <a href="#a124709de26781e5ffcf8bbb5dcd621ed">More...</a><br /></td></tr>
89 <tr class="separator:a124709de26781e5ffcf8bbb5dcd621ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 <tr class="memitem:a99678ccb2be5c20719f37e469416578a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#a99678ccb2be5c20719f37e469416578a">~connection</a> ()</td></tr>
91 <tr class="separator:a99678ccb2be5c20719f37e469416578a"><td class="memSeparator" colspan="2">&#160;</td></tr>
92 <tr class="memitem:a581ae4f2b708cb6be7b081557864d6ec"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#a581ae4f2b708cb6be7b081557864d6ec">block</a> (bool should_block=true) noexcept</td></tr>
93 <tr class="memdesc:a581ae4f2b708cb6be7b081557864d6ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets or unsets the blocking state of this connection.  <a href="#a581ae4f2b708cb6be7b081557864d6ec">More...</a><br /></td></tr>
94 <tr class="separator:a581ae4f2b708cb6be7b081557864d6ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
95 <tr class="memitem:a7c86964aa4b0f339db5842e6c7e604f3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#a7c86964aa4b0f339db5842e6c7e604f3">blocked</a> () const noexcept</td></tr>
96 <tr class="memdesc:a7c86964aa4b0f339db5842e6c7e604f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the connection is blocked.  <a href="#a7c86964aa4b0f339db5842e6c7e604f3">More...</a><br /></td></tr>
97 <tr class="separator:a7c86964aa4b0f339db5842e6c7e604f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
98 <tr class="memitem:a307b5df56439539be66f92d6e39f0bce"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#a307b5df56439539be66f92d6e39f0bce">connected</a> () const noexcept</td></tr>
99 <tr class="memdesc:a307b5df56439539be66f92d6e39f0bce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the connection is still active.  <a href="#a307b5df56439539be66f92d6e39f0bce">More...</a><br /></td></tr>
100 <tr class="separator:a307b5df56439539be66f92d6e39f0bce"><td class="memSeparator" colspan="2">&#160;</td></tr>
101 <tr class="memitem:a0452bd182a61650d14a9664d6297ed1b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#a0452bd182a61650d14a9664d6297ed1b">disconnect</a> ()</td></tr>
102 <tr class="memdesc:a0452bd182a61650d14a9664d6297ed1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects the referred slot.  <a href="#a0452bd182a61650d14a9664d6297ed1b">More...</a><br /></td></tr>
103 <tr class="separator:a0452bd182a61650d14a9664d6297ed1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
104 <tr class="memitem:a810bdde9fbe7ad10bf9d578eebf929de"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#a810bdde9fbe7ad10bf9d578eebf929de">empty</a> () const noexcept</td></tr>
105 <tr class="memdesc:a810bdde9fbe7ad10bf9d578eebf929de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the connection is still active.  <a href="#a810bdde9fbe7ad10bf9d578eebf929de">More...</a><br /></td></tr>
106 <tr class="separator:a810bdde9fbe7ad10bf9d578eebf929de"><td class="memSeparator" colspan="2">&#160;</td></tr>
107 <tr class="memitem:a5419e6fc689df523283e0182189c33b0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#a5419e6fc689df523283e0182189c33b0">operator bool</a> () const noexcept</td></tr>
108 <tr class="memdesc:a5419e6fc689df523283e0182189c33b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the connection is still active.  <a href="#a5419e6fc689df523283e0182189c33b0">More...</a><br /></td></tr>
109 <tr class="separator:a5419e6fc689df523283e0182189c33b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
110 <tr class="memitem:a016094b53bafdc9ce593febb68cb00a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structsigc_1_1connection.html">connection</a>&amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#a016094b53bafdc9ce593febb68cb00a5">operator=</a> (const <a class="el" href="structsigc_1_1connection.html">connection</a>&amp; c)</td></tr>
111 <tr class="memdesc:a016094b53bafdc9ce593febb68cb00a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overrides this connection object copying another one.  <a href="#a016094b53bafdc9ce593febb68cb00a5">More...</a><br /></td></tr>
112 <tr class="separator:a016094b53bafdc9ce593febb68cb00a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
113 <tr class="memitem:adee4ffd4b1669b4726fd9afc36330c14"><td class="memTemplParams" colspan="2">template&lt;typename T_slot &gt; </td></tr>
114 <tr class="memitem:adee4ffd4b1669b4726fd9afc36330c14"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structsigc_1_1connection.html">connection</a>&amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#adee4ffd4b1669b4726fd9afc36330c14">operator=</a> (const <a class="el" href="structsigc_1_1slot__iterator.html">slot_iterator</a>&lt; T_slot &gt;&amp; it)</td></tr>
115 <tr class="memdesc:adee4ffd4b1669b4726fd9afc36330c14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overrides this connection object with another slot list iterator.  <a href="#adee4ffd4b1669b4726fd9afc36330c14">More...</a><br /></td></tr>
116 <tr class="separator:adee4ffd4b1669b4726fd9afc36330c14"><td class="memSeparator" colspan="2">&#160;</td></tr>
117 <tr class="memitem:a15abcbfa76f1e5d8601cf4ad4176ed50"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#a15abcbfa76f1e5d8601cf4ad4176ed50">unblock</a> () noexcept</td></tr>
118 <tr class="memdesc:a15abcbfa76f1e5d8601cf4ad4176ed50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsets the blocking state of this connection.  <a href="#a15abcbfa76f1e5d8601cf4ad4176ed50">More...</a><br /></td></tr>
119 <tr class="separator:a15abcbfa76f1e5d8601cf4ad4176ed50"><td class="memSeparator" colspan="2">&#160;</td></tr>
120 </table><table class="memberdecls">
121 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
122 Static Public Member Functions</h2></td></tr>
123 <tr class="memitem:a4b542c439e7f090f17eaf13e270824fb"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#a4b542c439e7f090f17eaf13e270824fb">notify</a> (<a class="el" href="structsigc_1_1notifiable.html">notifiable</a>* data)</td></tr>
124 <tr class="memdesc:a4b542c439e7f090f17eaf13e270824fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback that is executed when the referred slot is destroyed.  <a href="#a4b542c439e7f090f17eaf13e270824fb">More...</a><br /></td></tr>
125 <tr class="separator:a4b542c439e7f090f17eaf13e270824fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
126 </table><table class="memberdecls">
127 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
128 Additional Inherited Members</h2></td></tr>
129 <tr class="inherit_header pub_types_structsigc_1_1notifiable"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structsigc_1_1notifiable')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="structsigc_1_1notifiable.html">sigc::notifiable</a></td></tr>
130 <tr class="memitem:a71455cae4b10ff1277e68a1729e1b8c4 inherit pub_types_structsigc_1_1notifiable"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1notifiable.html#a71455cae4b10ff1277e68a1729e1b8c4">func_destroy_notify</a> = internal::func_destroy_notify</td></tr>
131 <tr class="separator:a71455cae4b10ff1277e68a1729e1b8c4 inherit pub_types_structsigc_1_1notifiable"><td class="memSeparator" colspan="2">&#160;</td></tr>
132 </table>
133 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
134 <div class="textblock"><p>Convinience class for safe disconnection. </p>
135 <p>Iterators must not be used beyond the lifetime of the list they work on. A connection object can be created from a slot list iterator and may safely be used to disconnect the referred slot at any time (<a class="el" href="structsigc_1_1connection.html#a0452bd182a61650d14a9664d6297ed1b" title="Disconnects the referred slot. ">disconnect()</a>). If the slot has already been destroyed, <a class="el" href="structsigc_1_1connection.html#a0452bd182a61650d14a9664d6297ed1b" title="Disconnects the referred slot. ">disconnect()</a> does nothing. <a class="el" href="structsigc_1_1connection.html#a810bdde9fbe7ad10bf9d578eebf929de" title="Returns whether the connection is still active. ">empty()</a> or operator bool() can be used to test whether the connection is still active. The connection can be blocked (<a class="el" href="structsigc_1_1connection.html#a581ae4f2b708cb6be7b081557864d6ec" title="Sets or unsets the blocking state of this connection. ">block()</a>, <a class="el" href="structsigc_1_1connection.html#a15abcbfa76f1e5d8601cf4ad4176ed50" title="Unsets the blocking state of this connection. ">unblock()</a>).</p>
136 <p>This is possible because the connection object gets notified when the referred slot dies (<a class="el" href="structsigc_1_1connection.html#a4b542c439e7f090f17eaf13e270824fb" title="Callback that is executed when the referred slot is destroyed. ">notify()</a>). </p>
137 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
138 <a class="anchor" id="a95f80dbbf10fde0b851d78ec12cc2629"></a>
139 <div class="memitem">
140 <div class="memproto">
141 <table class="mlabels">
142   <tr>
143   <td class="mlabels-left">
144       <table class="memname">
145         <tr>
146           <td class="memname">sigc::connection::connection </td>
147           <td>(</td>
148           <td class="paramname"></td><td>)</td>
149           <td></td>
150         </tr>
151       </table>
152   </td>
153   <td class="mlabels-right">
154 <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
155   </tr>
156 </table>
157 </div><div class="memdoc">
158
159 <p>Constructs an empty connection object. </p>
160
161 </div>
162 </div>
163 <a class="anchor" id="ad13d5e3331cc9b1494e0edb8fa37fdba"></a>
164 <div class="memitem">
165 <div class="memproto">
166       <table class="memname">
167         <tr>
168           <td class="memname">sigc::connection::connection </td>
169           <td>(</td>
170           <td class="paramtype">const <a class="el" href="structsigc_1_1connection.html">connection</a>&amp;&#160;</td>
171           <td class="paramname"><em>c</em></td><td>)</td>
172           <td></td>
173         </tr>
174       </table>
175 </div><div class="memdoc">
176
177 <p>Constructs a connection object copying an existing one. </p>
178 <dl class="params"><dt>Parameters</dt><dd>
179   <table class="params">
180     <tr><td class="paramname">c</td><td>The connection object to make a copy from. </td></tr>
181   </table>
182   </dd>
183 </dl>
184
185 </div>
186 </div>
187 <a class="anchor" id="ac8847ae94e0b05bed6c81f54f58deef3"></a>
188 <div class="memitem">
189 <div class="memproto">
190 <div class="memtemplate">
191 template &lt;typename T_slot &gt; </div>
192 <table class="mlabels">
193   <tr>
194   <td class="mlabels-left">
195       <table class="memname">
196         <tr>
197           <td class="memname">sigc::connection::connection </td>
198           <td>(</td>
199           <td class="paramtype">const <a class="el" href="structsigc_1_1slot__iterator.html">slot_iterator</a>&lt; T_slot &gt;&amp;&#160;</td>
200           <td class="paramname"><em>it</em></td><td>)</td>
201           <td></td>
202         </tr>
203       </table>
204   </td>
205   <td class="mlabels-right">
206 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
207   </tr>
208 </table>
209 </div><div class="memdoc">
210
211 <p>Constructs a connection object from a slot list iterator. </p>
212 <dl class="params"><dt>Parameters</dt><dd>
213   <table class="params">
214     <tr><td class="paramname">it</td><td>The slot list iterator to take the slot from. </td></tr>
215   </table>
216   </dd>
217 </dl>
218
219 </div>
220 </div>
221 <a class="anchor" id="a124709de26781e5ffcf8bbb5dcd621ed"></a>
222 <div class="memitem">
223 <div class="memproto">
224 <table class="mlabels">
225   <tr>
226   <td class="mlabels-left">
227       <table class="memname">
228         <tr>
229           <td class="memname">sigc::connection::connection </td>
230           <td>(</td>
231           <td class="paramtype"><a class="el" href="classsigc_1_1slot__base.html">slot_base</a>&amp;&#160;</td>
232           <td class="paramname"><em>sl</em></td><td>)</td>
233           <td></td>
234         </tr>
235       </table>
236   </td>
237   <td class="mlabels-right">
238 <span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
239   </tr>
240 </table>
241 </div><div class="memdoc">
242
243 <p>Constructs a connection object from a slot object. </p>
244 <p>This is only useful if you create your own slot list. </p><dl class="params"><dt>Parameters</dt><dd>
245   <table class="params">
246     <tr><td class="paramname">sl</td><td>The slot to operate on. </td></tr>
247   </table>
248   </dd>
249 </dl>
250
251 </div>
252 </div>
253 <a class="anchor" id="a99678ccb2be5c20719f37e469416578a"></a>
254 <div class="memitem">
255 <div class="memproto">
256       <table class="memname">
257         <tr>
258           <td class="memname">sigc::connection::~connection </td>
259           <td>(</td>
260           <td class="paramname"></td><td>)</td>
261           <td></td>
262         </tr>
263       </table>
264 </div><div class="memdoc">
265
266 </div>
267 </div>
268 <h2 class="groupheader">Member Function Documentation</h2>
269 <a class="anchor" id="a581ae4f2b708cb6be7b081557864d6ec"></a>
270 <div class="memitem">
271 <div class="memproto">
272 <table class="mlabels">
273   <tr>
274   <td class="mlabels-left">
275       <table class="memname">
276         <tr>
277           <td class="memname">bool sigc::connection::block </td>
278           <td>(</td>
279           <td class="paramtype">bool&#160;</td>
280           <td class="paramname"><em>should_block</em> = <code>true</code></td><td>)</td>
281           <td></td>
282         </tr>
283       </table>
284   </td>
285   <td class="mlabels-right">
286 <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
287   </tr>
288 </table>
289 </div><div class="memdoc">
290
291 <p>Sets or unsets the blocking state of this connection. </p>
292 <p>See <a class="el" href="classsigc_1_1slot__base.html#a657a8473164c963a5ca4828c88121bb9" title="Sets the blocking state. ">slot_base::block()</a> for details. </p><dl class="params"><dt>Parameters</dt><dd>
293   <table class="params">
294     <tr><td class="paramname">should_block</td><td>Indicates whether the blocking state should be set or unset. </td></tr>
295   </table>
296   </dd>
297 </dl>
298 <dl class="section return"><dt>Returns</dt><dd><code>true</code> if the connection has been in blocking state before. </dd></dl>
299
300 </div>
301 </div>
302 <a class="anchor" id="a7c86964aa4b0f339db5842e6c7e604f3"></a>
303 <div class="memitem">
304 <div class="memproto">
305 <table class="mlabels">
306   <tr>
307   <td class="mlabels-left">
308       <table class="memname">
309         <tr>
310           <td class="memname">bool sigc::connection::blocked </td>
311           <td>(</td>
312           <td class="paramname"></td><td>)</td>
313           <td> const</td>
314         </tr>
315       </table>
316   </td>
317   <td class="mlabels-right">
318 <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
319   </tr>
320 </table>
321 </div><div class="memdoc">
322
323 <p>Returns whether the connection is blocked. </p>
324 <dl class="section return"><dt>Returns</dt><dd><code>true</code> if the connection is blocked. </dd></dl>
325
326 </div>
327 </div>
328 <a class="anchor" id="a307b5df56439539be66f92d6e39f0bce"></a>
329 <div class="memitem">
330 <div class="memproto">
331 <table class="mlabels">
332   <tr>
333   <td class="mlabels-left">
334       <table class="memname">
335         <tr>
336           <td class="memname">bool sigc::connection::connected </td>
337           <td>(</td>
338           <td class="paramname"></td><td>)</td>
339           <td> const</td>
340         </tr>
341       </table>
342   </td>
343   <td class="mlabels-right">
344 <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
345   </tr>
346 </table>
347 </div><div class="memdoc">
348
349 <p>Returns whether the connection is still active. </p>
350 <dl class="section return"><dt>Returns</dt><dd><code>true</code> if the connection is still active. </dd></dl>
351
352 </div>
353 </div>
354 <a class="anchor" id="a0452bd182a61650d14a9664d6297ed1b"></a>
355 <div class="memitem">
356 <div class="memproto">
357       <table class="memname">
358         <tr>
359           <td class="memname">void sigc::connection::disconnect </td>
360           <td>(</td>
361           <td class="paramname"></td><td>)</td>
362           <td></td>
363         </tr>
364       </table>
365 </div><div class="memdoc">
366
367 <p>Disconnects the referred slot. </p>
368
369 </div>
370 </div>
371 <a class="anchor" id="a810bdde9fbe7ad10bf9d578eebf929de"></a>
372 <div class="memitem">
373 <div class="memproto">
374 <table class="mlabels">
375   <tr>
376   <td class="mlabels-left">
377       <table class="memname">
378         <tr>
379           <td class="memname">bool sigc::connection::empty </td>
380           <td>(</td>
381           <td class="paramname"></td><td>)</td>
382           <td> const</td>
383         </tr>
384       </table>
385   </td>
386   <td class="mlabels-right">
387 <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
388   </tr>
389 </table>
390 </div><div class="memdoc">
391
392 <p>Returns whether the connection is still active. </p>
393 <dl class="section return"><dt>Returns</dt><dd><code>false</code> if the connection is still active. </dd></dl>
394
395 </div>
396 </div>
397 <a class="anchor" id="a4b542c439e7f090f17eaf13e270824fb"></a>
398 <div class="memitem">
399 <div class="memproto">
400 <table class="mlabels">
401   <tr>
402   <td class="mlabels-left">
403       <table class="memname">
404         <tr>
405           <td class="memname">static void sigc::connection::notify </td>
406           <td>(</td>
407           <td class="paramtype"><a class="el" href="structsigc_1_1notifiable.html">notifiable</a>*&#160;</td>
408           <td class="paramname"><em>data</em></td><td>)</td>
409           <td></td>
410         </tr>
411       </table>
412   </td>
413   <td class="mlabels-right">
414 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
415   </tr>
416 </table>
417 </div><div class="memdoc">
418
419 <p>Callback that is executed when the referred slot is destroyed. </p>
420 <dl class="params"><dt>Parameters</dt><dd>
421   <table class="params">
422     <tr><td class="paramname">data</td><td>The connection object notified (<code>this</code>). </td></tr>
423   </table>
424   </dd>
425 </dl>
426
427 </div>
428 </div>
429 <a class="anchor" id="a5419e6fc689df523283e0182189c33b0"></a>
430 <div class="memitem">
431 <div class="memproto">
432 <table class="mlabels">
433   <tr>
434   <td class="mlabels-left">
435       <table class="memname">
436         <tr>
437           <td class="memname">sigc::connection::operator bool </td>
438           <td>(</td>
439           <td class="paramname"></td><td>)</td>
440           <td> const</td>
441         </tr>
442       </table>
443   </td>
444   <td class="mlabels-right">
445 <span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span>  </td>
446   </tr>
447 </table>
448 </div><div class="memdoc">
449
450 <p>Returns whether the connection is still active. </p>
451 <dl class="section return"><dt>Returns</dt><dd><code>true</code> if the connection is still active. </dd></dl>
452
453 </div>
454 </div>
455 <a class="anchor" id="a016094b53bafdc9ce593febb68cb00a5"></a>
456 <div class="memitem">
457 <div class="memproto">
458       <table class="memname">
459         <tr>
460           <td class="memname"><a class="el" href="structsigc_1_1connection.html">connection</a>&amp; sigc::connection::operator= </td>
461           <td>(</td>
462           <td class="paramtype">const <a class="el" href="structsigc_1_1connection.html">connection</a>&amp;&#160;</td>
463           <td class="paramname"><em>c</em></td><td>)</td>
464           <td></td>
465         </tr>
466       </table>
467 </div><div class="memdoc">
468
469 <p>Overrides this connection object copying another one. </p>
470 <dl class="params"><dt>Parameters</dt><dd>
471   <table class="params">
472     <tr><td class="paramname">c</td><td>The connection object to make a copy from. </td></tr>
473   </table>
474   </dd>
475 </dl>
476
477 </div>
478 </div>
479 <a class="anchor" id="adee4ffd4b1669b4726fd9afc36330c14"></a>
480 <div class="memitem">
481 <div class="memproto">
482 <div class="memtemplate">
483 template &lt;typename T_slot &gt; </div>
484 <table class="mlabels">
485   <tr>
486   <td class="mlabels-left">
487       <table class="memname">
488         <tr>
489           <td class="memname"><a class="el" href="structsigc_1_1connection.html">connection</a>&amp; sigc::connection::operator= </td>
490           <td>(</td>
491           <td class="paramtype">const <a class="el" href="structsigc_1_1slot__iterator.html">slot_iterator</a>&lt; T_slot &gt;&amp;&#160;</td>
492           <td class="paramname"><em>it</em></td><td>)</td>
493           <td></td>
494         </tr>
495       </table>
496   </td>
497   <td class="mlabels-right">
498 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
499   </tr>
500 </table>
501 </div><div class="memdoc">
502
503 <p>Overrides this connection object with another slot list iterator. </p>
504 <dl class="params"><dt>Parameters</dt><dd>
505   <table class="params">
506     <tr><td class="paramname">it</td><td>The new slot list iterator to take the slot from. </td></tr>
507   </table>
508   </dd>
509 </dl>
510
511 </div>
512 </div>
513 <a class="anchor" id="a15abcbfa76f1e5d8601cf4ad4176ed50"></a>
514 <div class="memitem">
515 <div class="memproto">
516 <table class="mlabels">
517   <tr>
518   <td class="mlabels-left">
519       <table class="memname">
520         <tr>
521           <td class="memname">bool sigc::connection::unblock </td>
522           <td>(</td>
523           <td class="paramname"></td><td>)</td>
524           <td></td>
525         </tr>
526       </table>
527   </td>
528   <td class="mlabels-right">
529 <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
530   </tr>
531 </table>
532 </div><div class="memdoc">
533
534 <p>Unsets the blocking state of this connection. </p>
535 <dl class="section return"><dt>Returns</dt><dd><code>true</code> if the connection has been in blocking state before. </dd></dl>
536
537 </div>
538 </div>
539 </div><!-- contents -->
540 <!-- start footer part -->
541 <hr class="footer"/><address class="footer"><small>
542 Generated on Wed Mar 16 2016 20:53:28 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
543 <img class="footer" src="doxygen.png" alt="doxygen"/>
544 </a> 1.8.9.1
545 </small></address>
546 </body>
547 </html>