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>Wt: Wt::WKeyEvent Class 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_1WKeyEvent.html">WKeyEvent</a>
</div>
</div>
<div class="contents">
<h1>Wt::WKeyEvent Class Reference<br>
<small>
[<a class="el" href="group__signalslot.html">Signal/slot system</a>]</small>
</h1><!-- doxytag: class="Wt::WKeyEvent" -->A class providing details for a keyboard event.
<a href="#_details">More...</a>
<p>
<code>#include <Wt/WEvent></code>
<p>
<p>
<a href="classWt_1_1WKeyEvent-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="93efdf1091659752a18f107f2c7612e8"></a><!-- doxytag: member="Wt::WKeyEvent::WKeyEvent" ref="93efdf1091659752a18f107f2c7612e8" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WKeyEvent.html#93efdf1091659752a18f107f2c7612e8">WKeyEvent</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__signalslot.html#g34e65660d30e69c56aa636a8856aa52d">Key</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WKeyEvent.html#1a1dd4cf1ac3cc427505c2660cbf069d">key</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the key code key that was pressed or released. <a href="#1a1dd4cf1ac3cc427505c2660cbf069d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">WFlags< <a class="el" href="group__signalslot.html#g50f91169486bada5931f3adc3a623091">KeyboardModifier</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WKeyEvent.html#56601dff9d7ed5ff5ff294f7025a6908">modifiers</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns keyboard modifiers. <a href="#56601dff9d7ed5ff5ff294f7025a6908"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WKeyEvent.html#be057e50123becd86400abeaea8b5e9e">charCode</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the unicode character code. <a href="#be057e50123becd86400abeaea8b5e9e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WKeyEvent.html#ef6d350c375bd06e7df8aae0898aa744">text</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The (unicode) text that this key generated. <a href="#ef6d350c375bd06e7df8aae0898aa744"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WKeyEvent.html#313eda54335c00c80827b39cdae15ef2">keyCode</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the raw key code (<b>deprecated</b>). <a href="#313eda54335c00c80827b39cdae15ef2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WKeyEvent.html#7d382409feb5545edb8bb0561a144006">altKey</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the alt key is pressed (<b>deprecated</b>). <a href="#7d382409feb5545edb8bb0561a144006"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WKeyEvent.html#fb60842e8e3797a8d0079cf774b81496">metaKey</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the meta key is pressed (<b>deprecated</b>). <a href="#fb60842e8e3797a8d0079cf774b81496"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WKeyEvent.html#334af6e260dda1c17e5876de7405851a">ctrlKey</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the control key is pressed (<b>deprecated</b>). <a href="#334af6e260dda1c17e5876de7405851a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WKeyEvent.html#ef80abe3417494c7ef95066859bbf4f3">shiftKey</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the shift key is pressed (<b>deprecated</b>). <a href="#ef80abe3417494c7ef95066859bbf4f3"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A class providing details for a keyboard event.
<p>
A key event is associated with the <a class="el" href="classWt_1_1WInteractWidget.html#8669f2d35aad5091837b97bd00f25223" title="Event signal emitted when a keyboard key is pushed down.">WInteractWidget::keyWentDown()</a>, <a class="el" href="classWt_1_1WInteractWidget.html#7602bfbe38090d4acca674afc02f15c8" title="Event signal emitted when a keyboard key is released.">WInteractWidget::keyWentUp()</a> and <a class="el" href="classWt_1_1WInteractWidget.html#6d4c957a92eb6ffec59a638dd384c6c9" title="Event signal emitted when a "character" was entered.">WInteractWidget::keyPressed()</a> signals. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1a1dd4cf1ac3cc427505c2660cbf069d"></a><!-- doxytag: member="Wt::WKeyEvent::key" ref="1a1dd4cf1ac3cc427505c2660cbf069d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__signalslot.html#g34e65660d30e69c56aa636a8856aa52d">Key</a> Wt::WKeyEvent::key </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the key code key that was pressed or released.
<p>
The key code corresponds to the actual key on the keyboard, rather than the generated character.<p>
All three types of key events provide this information.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WKeyEvent.html#56601dff9d7ed5ff5ff294f7025a6908" title="Returns keyboard modifiers.">modifiers()</a>, <a class="el" href="classWt_1_1WKeyEvent.html#be057e50123becd86400abeaea8b5e9e" title="Returns the unicode character code.">charCode()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="56601dff9d7ed5ff5ff294f7025a6908"></a><!-- doxytag: member="Wt::WKeyEvent::modifiers" ref="56601dff9d7ed5ff5ff294f7025a6908" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WFlags<<a class="el" href="group__signalslot.html#g50f91169486bada5931f3adc3a623091">KeyboardModifier</a>> Wt::WKeyEvent::modifiers </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns keyboard modifiers.
<p>
The result is a logical OR of <a class="el" href="group__signalslot.html#g50f91169486bada5931f3adc3a623091">KeyboardModifier</a> flags.<p>
All three types of key events provide this information.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WKeyEvent.html#1a1dd4cf1ac3cc427505c2660cbf069d" title="Returns the key code key that was pressed or released.">key()</a>, <a class="el" href="classWt_1_1WKeyEvent.html#be057e50123becd86400abeaea8b5e9e" title="Returns the unicode character code.">charCode()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="be057e50123becd86400abeaea8b5e9e"></a><!-- doxytag: member="Wt::WKeyEvent::charCode" ref="be057e50123becd86400abeaea8b5e9e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Wt::WKeyEvent::charCode </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the unicode character code.
<p>
This is only defined for a <a class="el" href="classWt_1_1WInteractWidget.html#6d4c957a92eb6ffec59a638dd384c6c9">keyPressed </a> event, and returns the unicode character code of a character that is entered.<p>
For the <a class="el" href="classWt_1_1WInteractWidget.html#8669f2d35aad5091837b97bd00f25223">keyWentDown </a> and <a class="el" href="classWt_1_1WInteractWidget.html#7602bfbe38090d4acca674afc02f15c8">keyWentUp </a> events, '0' is returned.<p>
The <a class="el" href="classWt_1_1WKeyEvent.html#be057e50123becd86400abeaea8b5e9e" title="Returns the unicode character code.">charCode()</a> may be different from <a class="el" href="classWt_1_1WKeyEvent.html#1a1dd4cf1ac3cc427505c2660cbf069d" title="Returns the key code key that was pressed or released.">key()</a>. For example, a <a class="el" href="group__signalslot.html#gg34e65660d30e69c56aa636a8856aa52d88915645dbc4db17dfe3308fb65e9127">Key_M</a> key may correspond to 'm' or 'M' character, depending on whether the shift key is pressed simultaneously.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WKeyEvent.html#1a1dd4cf1ac3cc427505c2660cbf069d" title="Returns the key code key that was pressed or released.">key()</a>, <a class="el" href="classWt_1_1WKeyEvent.html#ef6d350c375bd06e7df8aae0898aa744" title="The (unicode) text that this key generated.">text()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="ef6d350c375bd06e7df8aae0898aa744"></a><!-- doxytag: member="Wt::WKeyEvent::text" ref="ef6d350c375bd06e7df8aae0898aa744" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> Wt::WKeyEvent::text </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The (unicode) text that this key generated.
<p>
This is only defined for a <a class="el" href="classWt_1_1WInteractWidget.html#6d4c957a92eb6ffec59a638dd384c6c9">keyPressed </a> event, and returns a string that holds exactly one unicode character, which corresponds to <a class="el" href="classWt_1_1WKeyEvent.html#be057e50123becd86400abeaea8b5e9e" title="Returns the unicode character code.">charCode()</a>.<p>
For the <a class="el" href="classWt_1_1WInteractWidget.html#8669f2d35aad5091837b97bd00f25223">keyWentDown </a> and <a class="el" href="classWt_1_1WInteractWidget.html#7602bfbe38090d4acca674afc02f15c8">keyWentUp </a> events, an empty string is returned.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WKeyEvent.html#be057e50123becd86400abeaea8b5e9e" title="Returns the unicode character code.">charCode()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="313eda54335c00c80827b39cdae15ef2"></a><!-- doxytag: member="Wt::WKeyEvent::keyCode" ref="313eda54335c00c80827b39cdae15ef2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Wt::WKeyEvent::keyCode </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the raw key code (<b>deprecated</b>).
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000013">Deprecated:</a></b></dt><dd>The value returned is somewhat browser-specific, and it is therefore recommended to use the <a class="el" href="classWt_1_1WKeyEvent.html#1a1dd4cf1ac3cc427505c2660cbf069d" title="Returns the key code key that was pressed or released.">key()</a> method instead.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WKeyEvent.html#1a1dd4cf1ac3cc427505c2660cbf069d" title="Returns the key code key that was pressed or released.">key()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="7d382409feb5545edb8bb0561a144006"></a><!-- doxytag: member="Wt::WKeyEvent::altKey" ref="7d382409feb5545edb8bb0561a144006" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WKeyEvent::altKey </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns whether the alt key is pressed (<b>deprecated</b>).
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000014">Deprecated:</a></b></dt><dd>Use <a class="el" href="classWt_1_1WKeyEvent.html#56601dff9d7ed5ff5ff294f7025a6908" title="Returns keyboard modifiers.">modifiers()</a> instead. </dd></dl>
</div>
</div><p>
<a class="anchor" name="fb60842e8e3797a8d0079cf774b81496"></a><!-- doxytag: member="Wt::WKeyEvent::metaKey" ref="fb60842e8e3797a8d0079cf774b81496" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WKeyEvent::metaKey </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns whether the meta key is pressed (<b>deprecated</b>).
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000015">Deprecated:</a></b></dt><dd>Use <a class="el" href="classWt_1_1WKeyEvent.html#56601dff9d7ed5ff5ff294f7025a6908" title="Returns keyboard modifiers.">modifiers()</a> instead. </dd></dl>
</div>
</div><p>
<a class="anchor" name="334af6e260dda1c17e5876de7405851a"></a><!-- doxytag: member="Wt::WKeyEvent::ctrlKey" ref="334af6e260dda1c17e5876de7405851a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WKeyEvent::ctrlKey </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns whether the control key is pressed (<b>deprecated</b>).
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000016">Deprecated:</a></b></dt><dd>Use <a class="el" href="classWt_1_1WKeyEvent.html#56601dff9d7ed5ff5ff294f7025a6908" title="Returns keyboard modifiers.">modifiers()</a> instead. </dd></dl>
</div>
</div><p>
<a class="anchor" name="ef80abe3417494c7ef95066859bbf4f3"></a><!-- doxytag: member="Wt::WKeyEvent::shiftKey" ref="ef80abe3417494c7ef95066859bbf4f3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WKeyEvent::shiftKey </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns whether the shift key is pressed (<b>deprecated</b>).
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000017">Deprecated:</a></b></dt><dd>Use <a class="el" href="classWt_1_1WKeyEvent.html#56601dff9d7ed5ff5ff294f7025a6908" title="Returns keyboard modifiers.">modifiers()</a> instead. </dd></dl>
</div>
</div><p>
</div>
<hr size="1"><address style="align: right;"><small>
Generated on Fri Mar 26 17:12:06 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>
|
