File: a00017.html

package info (click to toggle)
scim 1.4.7-3
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 20,368 kB
  • ctags: 12,834
  • sloc: cpp: 51,239; sh: 22,370; ansic: 18,716; makefile: 1,258; xml: 641; yacc: 288
file content (289 lines) | stat: -rw-r--r-- 12,350 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>scim: scim::Connection Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.0 -->
<div class="tabs">
  <ul>
    <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li id="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul></div>
<div class="nav">
<a class="el" href="a00157.html">scim</a>::<a class="el" href="a00017.html">Connection</a></div>
<h1>scim::Connection Class Reference<br>
<small>
[<a class="el" href="a00159.html">SignalSlot</a>,&nbsp;<a class="el" href="a00159.html">SignalSlot</a>]</small>
</h1><!-- doxytag: class="scim::Connection" -->A signal connection class.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;scim_connection.h&gt;</code>
<p>
<a href="a00315.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Constructors</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00017.html#9b434f06b0635da7df5c09587fcd0210">Connection</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor.  <a href="#9b434f06b0635da7df5c09587fcd0210"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00017.html#2ecbb9f7506a3407f2f18abd006a7da7">Connection</a> (<a class="el" href="a00065.html">Node</a> *node)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00017.html#dcef04a87f7f51307dc1ee578d9213d9">Connection</a> (const <a class="el" href="a00017.html">Connection</a> &amp;src)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor.  <a href="#dcef04a87f7f51307dc1ee578d9213d9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00017.html#710625d0d2bad44491a89a48f9db0aed">~Connection</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor.  <a href="#710625d0d2bad44491a89a48f9db0aed"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00017.html">Connection</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00017.html#7f6a21e8565a3740b4245e2435b45e20">operator=</a> (const <a class="el" href="a00017.html">Connection</a> &amp;src)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assignment operator.  <a href="#7f6a21e8565a3740b4245e2435b45e20"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A signal connection class. 
<p>
A <a class="el" href="a00017.html">Connection</a> class is returned by value from a signal's connect() method. Using this class you can block, unblock and disconnect a signal connection. 
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="9b434f06b0635da7df5c09587fcd0210"></a><!-- doxytag: member="scim::Connection::Connection" ref="9b434f06b0635da7df5c09587fcd0210" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">scim::Connection::Connection           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Default constructor. 
<p>

</div>
</div><p>
<a class="anchor" name="2ecbb9f7506a3407f2f18abd006a7da7"></a><!-- doxytag: member="scim::Connection::Connection" ref="2ecbb9f7506a3407f2f18abd006a7da7" args="(Node *node)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">scim::Connection::Connection           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00065.html">Node</a> *&nbsp;</td>
          <td class="paramname"> <em>node</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Construct a connection object for node. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>node</em>&nbsp;</td><td>- a pointer to the <a class="el" href="a00065.html">Node</a> class for this connection. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="dcef04a87f7f51307dc1ee578d9213d9"></a><!-- doxytag: member="scim::Connection::Connection" ref="dcef04a87f7f51307dc1ee578d9213d9" args="(const Connection &amp;src)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">scim::Connection::Connection           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00017.html">Connection</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>src</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Copy constructor. 
<p>

</div>
</div><p>
<a class="anchor" name="710625d0d2bad44491a89a48f9db0aed"></a><!-- doxytag: member="scim::Connection::~Connection" ref="710625d0d2bad44491a89a48f9db0aed" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">scim::Connection::~Connection           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Destructor. 
<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7f6a21e8565a3740b4245e2435b45e20"></a><!-- doxytag: member="scim::Connection::operator=" ref="7f6a21e8565a3740b4245e2435b45e20" args="(const Connection &amp;src)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00017.html">Connection</a>&amp; scim::Connection::operator=           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00017.html">Connection</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>src</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Assignment operator. 
<p>

</div>
</div><p>
<a class="anchor" name="430b612cb228643be75e619ec9954697"></a><!-- doxytag: member="scim::Connection::block" ref="430b612cb228643be75e619ec9954697" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void scim::Connection::block           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Block signal transmission to a slot. The slot will not be called during any signal emissions unless it is unblocked again. 
</div>
</div><p>
<a class="anchor" name="c2d8e3a0c63ae30c7f9c38813beeeff6"></a><!-- doxytag: member="scim::Connection::unblock" ref="c2d8e3a0c63ae30c7f9c38813beeeff6" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void scim::Connection::unblock           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Unblock a previously blocked slot. A blocked slot is skipped during signal emissions and will not be invoked, unblocking it (for exactly the number of times it has been blocked before) reverts its "blocked" state, so the slot will be recognized by the signal system and is called upon future or currently ongoing signal emissions. 
</div>
</div><p>
<a class="anchor" name="71a8cd79ec637755ced226d3bac38b34"></a><!-- doxytag: member="scim::Connection::disconnect" ref="71a8cd79ec637755ced226d3bac38b34" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void scim::Connection::disconnect           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Disconnect a slot. The slot will not be called during any future or currently ongoing emissions of the signal it has been connected to. 
</div>
</div><p>
<a class="anchor" name="430b612cb228643be75e619ec9954697"></a><!-- doxytag: member="scim::Connection::block" ref="430b612cb228643be75e619ec9954697" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void scim::Connection::block           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Block signal transmission to a slot. The slot will not be called during any signal emissions unless it is unblocked again. 
</div>
</div><p>
<a class="anchor" name="c2d8e3a0c63ae30c7f9c38813beeeff6"></a><!-- doxytag: member="scim::Connection::unblock" ref="c2d8e3a0c63ae30c7f9c38813beeeff6" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void scim::Connection::unblock           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Unblock a previously blocked slot. A blocked slot is skipped during signal emissions and will not be invoked, unblocking it (for exactly the number of times it has been blocked before) reverts its "blocked" state, so the slot will be recognized by the signal system and is called upon future or currently ongoing signal emissions. 
</div>
</div><p>
<a class="anchor" name="71a8cd79ec637755ced226d3bac38b34"></a><!-- doxytag: member="scim::Connection::disconnect" ref="71a8cd79ec637755ced226d3bac38b34" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void scim::Connection::disconnect           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Disconnect a slot. The slot will not be called during any future or currently ongoing emissions of the signal it has been connected to. 
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00121.html">scim_connection.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jun 28 14:12:38 2007 for scim by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address>
</body>
</html>