File: a00082.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 (242 lines) | stat: -rw-r--r-- 12,405 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
<!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::Signal4&lt; R, P1, P2, P3, P4, Marshal &gt; Class Template 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="a00082.html">Signal4</a></div>
<h1>scim::Signal4&lt; R, P1, P2, P3, P4, Marshal &gt; Class Template 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::Signal4" --><!-- doxytag: inherits="scim::Signal" -->A template for a signal passing four arguments of type P1, P2, P3 and P4, and returning a value of type R.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;scim_signals.h&gt;</code>
<p>
Inheritance diagram for scim::Signal4&lt; R, P1, P2, P3, P4, Marshal &gt;:<p><center><img src="a00476.png" border="0" usemap="#a00477" alt="Inheritance graph"></center>
<map name="a00477">
<area href="a00073.html" shape="rect" coords="111,8,212,32" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for scim::Signal4&lt; R, P1, P2, P3, P4, Marshal &gt;:<p><center><img src="a00478.png" border="0" usemap="#a00479" alt="Collaboration graph"></center>
<map name="a00479">
<area href="a00073.html" shape="rect" coords="111,8,212,32" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="a00480.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="a00100.html">Slot4</a>&lt; R, P1, P2,<br>
 P3, P4 &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#a45743625cff25c8c53b4ad3c6d78ade">SlotType</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function signature for handlers connecting to the signal.  <a href="#a45743625cff25c8c53b4ad3c6d78ade"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00017.html">Connection</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#6ba3b560d34d7097edd2b6c08bf29b95">connect</a> (<a class="el" href="a00100.html">SlotType</a> *slot)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00100.html">SlotType</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#94bedf27a919569aea2b810db92bb1ff">slot</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">R&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#27aa94141d2f7188badb389d85e5c484">emit</a> (P1 p1, P2 p2, P3 p3, P4 p4)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">R&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#7d2c7b0f041e8db9f71a3907e915d30c">operator()</a> (P1 p1, P2 p2, P3 p3, P4 p4)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function operator; calls <a class="el" href="a00082.html#27aa94141d2f7188badb389d85e5c484">emit()</a>.  <a href="#7d2c7b0f041e8db9f71a3907e915d30c"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;typename R, typename P1, typename P2, typename P3, typename P4, typename Marshal = class DefaultMarshal&lt;R&gt;&gt;<br>
 class scim::Signal4&lt; R, P1, P2, P3, P4, Marshal &gt;</h3>

A template for a signal passing four arguments of type P1, P2, P3 and P4, and returning a value of type R. 
<p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="a45743625cff25c8c53b4ad3c6d78ade"></a><!-- doxytag: member="scim::Signal4::SlotType" ref="a45743625cff25c8c53b4ad3c6d78ade" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename R, typename P1, typename P2, typename P3, typename P4, typename Marshal = class DefaultMarshal&lt;R&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="a00100.html">Slot4</a>&lt;R, P1, P2, P3, P4&gt; <a class="el" href="a00082.html">scim::Signal4</a>&lt; R, P1, P2, P3, P4, Marshal &gt;::<a class="el" href="a00100.html">SlotType</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Function signature for handlers connecting to the signal. 
<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6ba3b560d34d7097edd2b6c08bf29b95"></a><!-- doxytag: member="scim::Signal4::connect" ref="6ba3b560d34d7097edd2b6c08bf29b95" args="(SlotType *slot)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename R, typename P1, typename P2, typename P3, typename P4, typename Marshal = class DefaultMarshal&lt;R&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00017.html">Connection</a> <a class="el" href="a00082.html">scim::Signal4</a>&lt; R, P1, P2, P3, P4, Marshal &gt;::connect           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00100.html">SlotType</a> *&nbsp;</td>
          <td class="paramname"> <em>slot</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Connect a slot to the signal. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>slot</em>&nbsp;</td><td>- a slot of type Slot4&lt;R, P1, P2, P3, P4&gt;. </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a connection object.</dd></dl>
<br>
The returned connection object can be used alter or change the connection. 
</div>
</div><p>
<a class="anchor" name="94bedf27a919569aea2b810db92bb1ff"></a><!-- doxytag: member="scim::Signal4::slot" ref="94bedf27a919569aea2b810db92bb1ff" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename R, typename P1, typename P2, typename P3, typename P4, typename Marshal = class DefaultMarshal&lt;R&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00100.html">SlotType</a>* <a class="el" href="a00082.html">scim::Signal4</a>&lt; R, P1, P2, P3, P4, Marshal &gt;::slot           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns a slot for this signal. <dl class="return" compact><dt><b>Returns:</b></dt><dd>a new slot of type Slot4&lt;R, P1, P2, P3, P4&gt;.</dd></dl>
<br>
The returned slot can be passed to another signal allowing the other signal to call this signal when it gets emitted. 
</div>
</div><p>
<a class="anchor" name="27aa94141d2f7188badb389d85e5c484"></a><!-- doxytag: member="scim::Signal4::emit" ref="27aa94141d2f7188badb389d85e5c484" args="(P1 p1, P2 p2, P3 p3, P4 p4)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename R, typename P1, typename P2, typename P3, typename P4, typename Marshal = class DefaultMarshal&lt;R&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">R <a class="el" href="a00082.html">scim::Signal4</a>&lt; R, P1, P2, P3, P4, Marshal &gt;::emit           </td>
          <td>(</td>
          <td class="paramtype">P1&nbsp;</td>
          <td class="paramname"> <em>p1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">P2&nbsp;</td>
          <td class="paramname"> <em>p2</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">P3&nbsp;</td>
          <td class="paramname"> <em>p3</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">P4&nbsp;</td>
          <td class="paramname"> <em>p4</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Emit the signal. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>p1</em>&nbsp;</td><td>- passes p1 to the signal handler. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>p2</em>&nbsp;</td><td>- passes p2 to the signal handler. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>p3</em>&nbsp;</td><td>- passes p3 to the signal handler. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>p4</em>&nbsp;</td><td>- passes p4 to the signal handler. </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the value returned by the signal handler.</dd></dl>
<br>
Calls every slot connected to this signal, in order of connection. 
</div>
</div><p>
<a class="anchor" name="7d2c7b0f041e8db9f71a3907e915d30c"></a><!-- doxytag: member="scim::Signal4::operator()" ref="7d2c7b0f041e8db9f71a3907e915d30c" args="(P1 p1, P2 p2, P3 p3, P4 p4)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename R, typename P1, typename P2, typename P3, typename P4, typename Marshal = class DefaultMarshal&lt;R&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">R <a class="el" href="a00082.html">scim::Signal4</a>&lt; R, P1, P2, P3, P4, Marshal &gt;::operator()           </td>
          <td>(</td>
          <td class="paramtype">P1&nbsp;</td>
          <td class="paramname"> <em>p1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">P2&nbsp;</td>
          <td class="paramname"> <em>p2</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">P3&nbsp;</td>
          <td class="paramname"> <em>p3</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">P4&nbsp;</td>
          <td class="paramname"> <em>p4</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Function operator; calls <a class="el" href="a00082.html#27aa94141d2f7188badb389d85e5c484">emit()</a>. 
<p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00149.html">scim_signals.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jun 28 14:12:43 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>