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
290
291
292
293
294
295
296
297
298
|
<!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>Wt: Wt::EventSignal< E > Class Template Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceWt.html">Wt</a>::<a class="el" href="classWt_1_1EventSignal.html">EventSignal</a>
</div>
</div>
<div class="contents">
<h1>Wt::EventSignal< E > Class Template Reference<br>
<small>
[<a class="el" href="group__signalslot.html">Signal/slot system</a>]</small>
</h1><!-- doxytag: class="Wt::EventSignal" --><!-- doxytag: inherits="Wt::EventSignalBase" -->A signal that conveys user-interface events.
<a href="#_details">More...</a>
<p>
<code>#include <Wt/WSignal></code>
<p>
Inherits Wt::EventSignalBase.
<p>
<p>
<a href="classWt_1_1EventSignal-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></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="anchor" name="ba826d0b0c74751fed4ab8eb9b05732b"></a><!-- doxytag: member="Wt::EventSignal::isConnected" ref="ba826d0b0c74751fed4ab8eb9b05732b" args="() const " -->
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1EventSignal.html#ba826d0b0c74751fed4ab8eb9b05732b">isConnected</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the signal is connected. <br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template<class F> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">boost::signals::connection </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classWt_1_1EventSignal.html#6efcb92576b5aa846a3354dd26918a9f">connect</a> (const F &function)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connects to a function. <a href="#6efcb92576b5aa846a3354dd26918a9f"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template<class T, class V> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">boost::signals::connection </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classWt_1_1EventSignal.html#79396e66db668bd56de65943f83dacd2">connect</a> (T *target, void(V::*method)())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connects a slot that takes no arguments. <a href="#79396e66db668bd56de65943f83dacd2"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template<class T, class V> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">boost::signals::connection </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classWt_1_1EventSignal.html#60c4413956cb5484be2670982721202c">connect</a> (T *target, void(V::*method)(E))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connects a slot that takes one argument. <a href="#60c4413956cb5484be2670982721202c"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template<class T, class V> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">boost::signals::connection </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classWt_1_1EventSignal.html#9d1fd7a2f0b8421e170d5423b0df5c59">connect</a> (T *target, void(V::*method)(const E &))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connects a slot that takes a 'const argument&'. <a href="#9d1fd7a2f0b8421e170d5423b0df5c59"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1EventSignal.html#e026eaa8a8d978d83f46526ff58c6abc">connect</a> (<a class="el" href="classWt_1_1JSlot.html">JSlot</a> &slot)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connects a slot that is specified as JavaScript only. <a href="#e026eaa8a8d978d83f46526ff58c6abc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1EventSignal.html#ad084f1acc870559192c2ac0a280e3f1">emit</a> (E e=NoClass::none)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Emits the signal. <a href="#ad084f1acc870559192c2ac0a280e3f1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1EventSignal.html#b418b2377a1f01b6c13cb74c392b09d8">operator()</a> (E e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Emits the signal. <a href="#b418b2377a1f01b6c13cb74c392b09d8"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<typename E = NoClass><br>
class Wt::EventSignal< E ></h3>
A signal that conveys user-interface events.
<p>
An EventSignal is a special Signal that may be triggered by user interface events such as a mouse click, key press, or focus change. They are made available through the library in widgets like <a class="el" href="classWt_1_1WInteractWidget.html" title="An abstract widget that can receive user-interface interaction.">WInteractWidget</a>, and should not be instantiated directly.<p>
In addition to the behaviour of Signal, they are capable of both executing client-side and server-side slot code. They may learn JavaScript from C++ code, through stateless slot learning, when connected to a slot that has a stateless implementation, using <a class="el" href="classWt_1_1WObject.html#c00d775170f47e715894b24de6b869da" title="Declares a slot to be stateless and learn client-side behaviour on first invocation...">WObject::implementStateless()</a>. Or they may be connected to a <a class="el" href="classWt_1_1JSlot.html" title="A slot that is only implemented in client side JavaScript code.">JSlot</a> which provides manual JavaScript code.<p>
The typically relay UI event details, using event details objects like <a class="el" href="classWt_1_1WKeyEvent.html" title="A class providing details for a keyboard event.">WKeyEvent</a> or <a class="el" href="classWt_1_1WMouseEvent.html" title="A class providing details for a mouse event.">WMouseEvent</a>.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Signal.html" title="A signal that propagates events to listeners.">Signal</a>, <a class="el" href="classWt_1_1JSignal.html" title="A signal to relay JavaScript to C++ calls.">JSignal</a> </dd></dl>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6efcb92576b5aa846a3354dd26918a9f"></a><!-- doxytag: member="Wt::EventSignal::connect" ref="6efcb92576b5aa846a3354dd26918a9f" args="(const F &function)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename E> </div>
<div class="memtemplate">
template<class F> </div>
<table class="memname">
<tr>
<td class="memname">boost::signals::connection <a class="el" href="classWt_1_1EventSignal.html">Wt::EventSignal</a>< E >::connect </td>
<td>(</td>
<td class="paramtype">const F & </td>
<td class="paramname"> <em>function</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connects to a function.
<p>
This variant of the overloaded <a class="el" href="classWt_1_1EventSignal.html#6efcb92576b5aa846a3354dd26918a9f" title="Connects to a function.">connect()</a> method supports a template function object (which supports operator ()).<p>
When the receiver function is an object method, the signal will automatically be disconnected when the object is deleted, as long as the object inherits from <a class="el" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system.">WObject</a> or boost::signals::trackable.<p>
The function may leave 1 parameters unbound (e.g. using boost::bind placeholders _1) that may be bound to the event detail object passed by the signal.
</div>
</div><p>
<a class="anchor" name="79396e66db668bd56de65943f83dacd2"></a><!-- doxytag: member="Wt::EventSignal::connect" ref="79396e66db668bd56de65943f83dacd2" args="(T *target, void(V::*method)())" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename E> </div>
<div class="memtemplate">
template<class T, class V> </div>
<table class="memname">
<tr>
<td class="memname">boost::signals::connection <a class="el" href="classWt_1_1EventSignal.html">Wt::EventSignal</a>< E >::connect </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"> <em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void(V::*)() </td>
<td class="paramname"> <em>method</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connects a slot that takes no arguments.
<p>
If a stateless implementation is specified for the slot, then the visual behaviour will be learned in terms of JavaScript, and will be cached on the client side for instant feed-back, in addition running the slot on the server.<p>
The slot is as a <code>method</code> of an object <code>target</code> of class <code>T</code>, which equals class <code>V</code>, or is a base class of class <code>V</code>. In addition, to check for stateless implementations, class <code>T</code> must be also be a descendant of <a class="el" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system.">WObject</a>. Thus, the following statement must return a non-null pointer:<p>
<div class="fragment"><pre class="fragment"> WObject *o = <span class="keyword">dynamic_cast<</span>WObject *<span class="keyword">></span>(<span class="keyword">dynamic_cast<</span>V *<span class="keyword">></span>(target));
</pre></div>
</div>
</div><p>
<a class="anchor" name="60c4413956cb5484be2670982721202c"></a><!-- doxytag: member="Wt::EventSignal::connect" ref="60c4413956cb5484be2670982721202c" args="(T *target, void(V::*method)(E))" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename E> </div>
<div class="memtemplate">
template<class T, class V> </div>
<table class="memname">
<tr>
<td class="memname">boost::signals::connection <a class="el" href="classWt_1_1EventSignal.html">Wt::EventSignal</a>< E >::connect </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"> <em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void(V::*)(E) </td>
<td class="paramname"> <em>method</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connects a slot that takes one argument.
<p>
This is only possible for signals that take at least one argument.
</div>
</div><p>
<a class="anchor" name="9d1fd7a2f0b8421e170d5423b0df5c59"></a><!-- doxytag: member="Wt::EventSignal::connect" ref="9d1fd7a2f0b8421e170d5423b0df5c59" args="(T *target, void(V::*method)(const E &))" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename E> </div>
<div class="memtemplate">
template<class T, class V> </div>
<table class="memname">
<tr>
<td class="memname">boost::signals::connection <a class="el" href="classWt_1_1EventSignal.html">Wt::EventSignal</a>< E >::connect </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"> <em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void(V::*)(const E &) </td>
<td class="paramname"> <em>method</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connects a slot that takes a 'const argument&'.
<p>
This is only possible for signals that take at least one argument.
</div>
</div><p>
<a class="anchor" name="e026eaa8a8d978d83f46526ff58c6abc"></a><!-- doxytag: member="Wt::EventSignal::connect" ref="e026eaa8a8d978d83f46526ff58c6abc" args="(JSlot &slot)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename E> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classWt_1_1EventSignal.html">Wt::EventSignal</a>< E >::connect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1JSlot.html">JSlot</a> & </td>
<td class="paramname"> <em>slot</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connects a slot that is specified as JavaScript only.
<p>
This will provide a client-side connection between the event and some JavaScript code as implemented by the slot. Unlike other connects, this does not cause the event to propagated to the application, and thus the state changes caused by the JavaScript slot are not tracked client-side.
</div>
</div><p>
<a class="anchor" name="ad084f1acc870559192c2ac0a280e3f1"></a><!-- doxytag: member="Wt::EventSignal::emit" ref="ad084f1acc870559192c2ac0a280e3f1" args="(E e=NoClass::none)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename E> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classWt_1_1EventSignal.html">Wt::EventSignal</a>< E >::emit </td>
<td>(</td>
<td class="paramtype">E </td>
<td class="paramname"> <em>e</em> = <code>NoClass::none</code> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Emits the signal.
<p>
This will cause all connected slots to be triggered, with the given argument.
</div>
</div><p>
<a class="anchor" name="b418b2377a1f01b6c13cb74c392b09d8"></a><!-- doxytag: member="Wt::EventSignal::operator()" ref="b418b2377a1f01b6c13cb74c392b09d8" args="(E e)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename E> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classWt_1_1EventSignal.html">Wt::EventSignal</a>< E >::operator() </td>
<td>(</td>
<td class="paramtype">E </td>
<td class="paramname"> <em>e</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Emits the signal.
<p>
This is equivalent to <a class="el" href="classWt_1_1EventSignal.html#ad084f1acc870559192c2ac0a280e3f1" title="Emits the signal.">emit()</a>.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1EventSignal.html#ad084f1acc870559192c2ac0a280e3f1" title="Emits the signal.">emit()</a> </dd></dl>
</div>
</div><p>
</div>
<hr size="1"><address style="align: right;"><small>
Generated on Fri Mar 26 17:12:07 2010 for <a href="http://www.webtoolkit.eu/wt/">Wt</a> by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6</small></address>
</body>
</html>
|
