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
|
<!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::WMouseEvent 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_1WMouseEvent.html">WMouseEvent</a>
</div>
</div>
<div class="contents">
<h1>Wt::WMouseEvent Class Reference<br>
<small>
[<a class="el" href="group__signalslot.html">Signal/slot system</a>]</small>
</h1><!-- doxytag: class="Wt::WMouseEvent" -->A class providing details for a mouse event.
<a href="#_details">More...</a>
<p>
<code>#include <Wt/WEvent></code>
<p>
<p>
<a href="classWt_1_1WMouseEvent-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WMouseEvent.html#67958762760e6aa6973109a7b3d46210">Button</a> { <a class="el" href="classWt_1_1WMouseEvent.html#67958762760e6aa6973109a7b3d46210fbce5dfa6d97366c49bd9a7aa1c2b7ce">LeftButton</a>,
<a class="el" href="classWt_1_1WMouseEvent.html#67958762760e6aa6973109a7b3d46210b4d71def93cd1b2482a748e576949758">MiddleButton</a>,
<a class="el" href="classWt_1_1WMouseEvent.html#67958762760e6aa6973109a7b3d462103680e4c90e452cb6b29a7d4df8c41c69">RightButton</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for the mouse button. <a href="classWt_1_1WMouseEvent.html#67958762760e6aa6973109a7b3d46210">More...</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="anchor" name="d99367bf6494aea5f92869d32aaecf1d"></a><!-- doxytag: member="Wt::WMouseEvent::WMouseEvent" ref="d99367bf6494aea5f92869d32aaecf1d" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WMouseEvent.html#d99367bf6494aea5f92869d32aaecf1d">WMouseEvent</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="anchor" name="3cb45d106522eaa8b597b2e274053e90"></a><!-- doxytag: member="Wt::WMouseEvent::button" ref="3cb45d106522eaa8b597b2e274053e90" args="() const " -->
<a class="el" href="classWt_1_1WMouseEvent.html#67958762760e6aa6973109a7b3d46210">Button</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WMouseEvent.html#3cb45d106522eaa8b597b2e274053e90">button</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the button. <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_1WMouseEvent.html#c84d28364a178e547d2bc417e3eb2423">modifiers</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns keyboard modifiers. <a href="#c84d28364a178e547d2bc417e3eb2423"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="76d0dffbee01451f043ff603eb133334"></a><!-- doxytag: member="Wt::WMouseEvent::document" ref="76d0dffbee01451f043ff603eb133334" args="() const " -->
<a class="el" href="structWt_1_1WMouseEvent_1_1Coordinates.html">Coordinates</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WMouseEvent.html#76d0dffbee01451f043ff603eb133334">document</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the mouse position relative to the document. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structWt_1_1WMouseEvent_1_1Coordinates.html">Coordinates</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WMouseEvent.html#eac308aadc18ee38d80e49d9357bdcea">window</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the mouse position relative to the window. <a href="#eac308aadc18ee38d80e49d9357bdcea"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3a6f116184b391a58bbf7bd2fccbacd0"></a><!-- doxytag: member="Wt::WMouseEvent::screen" ref="3a6f116184b391a58bbf7bd2fccbacd0" args="() const " -->
<a class="el" href="structWt_1_1WMouseEvent_1_1Coordinates.html">Coordinates</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WMouseEvent.html#3a6f116184b391a58bbf7bd2fccbacd0">screen</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the mouse position relative to the screen. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f875dd9a33e6a5dd7cf6aa9dd927e8ef"></a><!-- doxytag: member="Wt::WMouseEvent::widget" ref="f875dd9a33e6a5dd7cf6aa9dd927e8ef" args="() const " -->
<a class="el" href="structWt_1_1WMouseEvent_1_1Coordinates.html">Coordinates</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WMouseEvent.html#f875dd9a33e6a5dd7cf6aa9dd927e8ef">widget</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the mouse position relative to the widget. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structWt_1_1WMouseEvent_1_1Coordinates.html">Coordinates</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WMouseEvent.html#bc8cd49bcbf8244ee6f92a16eca7561b">dragDelta</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the distance over which the mouse has been dragged. <a href="#bc8cd49bcbf8244ee6f92a16eca7561b"></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_1WMouseEvent.html#322292eed48c4d640f172648c660ef49">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="#322292eed48c4d640f172648c660ef49"></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_1WMouseEvent.html#fca8f1bed7ec531f0b7b4c01173eb1cd">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="#fca8f1bed7ec531f0b7b4c01173eb1cd"></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_1WMouseEvent.html#8a25240a3b4a7b296d5c333c03a1fb75">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="#8a25240a3b4a7b296d5c333c03a1fb75"></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_1WMouseEvent.html#53962bfb61abd94b0a96568ed322a68d">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="#53962bfb61abd94b0a96568ed322a68d"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structWt_1_1WMouseEvent_1_1Coordinates.html">Coordinates</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A mouse coordinate. <a href="structWt_1_1WMouseEvent_1_1Coordinates.html#_details">More...</a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A class providing details for a mouse event.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WInteractWidget.html#e11e050cce0d4a8f742afa3ef92bfe8c" title="Event signal emitted when a mouse key was clicked on this widget.">WInteractWidget::clicked()</a>, <a class="el" href="classWt_1_1WInteractWidget.html#8865f4bb679e5c3ff2c946ef83248e19" title="Event signal emitted when a mouse key was double clicked on this widget.">WInteractWidget::doubleClicked()</a>, <a class="el" href="classWt_1_1WInteractWidget.html#d29946ac46183ca238229327479084ca" title="Event signal emitted when a mouse key was pushed down on this widget.">WInteractWidget::mouseWentDown()</a>, <a class="el" href="classWt_1_1WInteractWidget.html#318d761e35388a52eeb3406e6717b28f" title="Event signal emitted when a mouse key was released on this widget.">WInteractWidget::mouseWentUp()</a>, <a class="el" href="classWt_1_1WInteractWidget.html#89a46ebf7fbcea5a494c4dac13f1dc15" title="Event signal emitted when the mouse entered this widget.">WInteractWidget::mouseWentOver()</a>, <a class="el" href="classWt_1_1WInteractWidget.html#40c3643603fa861b1ec797eec794aa4c" title="Event signal emitted when the mouse moved over this widget.">WInteractWidget::mouseMoved()</a> </dd></dl>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="67958762760e6aa6973109a7b3d46210"></a><!-- doxytag: member="Wt::WMouseEvent::Button" ref="67958762760e6aa6973109a7b3d46210" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classWt_1_1WMouseEvent.html#67958762760e6aa6973109a7b3d46210">Wt::WMouseEvent::Button</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Enumeration for the mouse button.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="67958762760e6aa6973109a7b3d46210fbce5dfa6d97366c49bd9a7aa1c2b7ce"></a><!-- doxytag: member="LeftButton" ref="67958762760e6aa6973109a7b3d46210fbce5dfa6d97366c49bd9a7aa1c2b7ce" args="" -->LeftButton</em> </td><td>
Left button. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="67958762760e6aa6973109a7b3d46210b4d71def93cd1b2482a748e576949758"></a><!-- doxytag: member="MiddleButton" ref="67958762760e6aa6973109a7b3d46210b4d71def93cd1b2482a748e576949758" args="" -->MiddleButton</em> </td><td>
Middle button. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="67958762760e6aa6973109a7b3d462103680e4c90e452cb6b29a7d4df8c41c69"></a><!-- doxytag: member="RightButton" ref="67958762760e6aa6973109a7b3d462103680e4c90e452cb6b29a7d4df8c41c69" args="" -->RightButton</em> </td><td>
Right button. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c84d28364a178e547d2bc417e3eb2423"></a><!-- doxytag: member="Wt::WMouseEvent::modifiers" ref="c84d28364a178e547d2bc417e3eb2423" 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::WMouseEvent::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.
</div>
</div><p>
<a class="anchor" name="eac308aadc18ee38d80e49d9357bdcea"></a><!-- doxytag: member="Wt::WMouseEvent::window" ref="eac308aadc18ee38d80e49d9357bdcea" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structWt_1_1WMouseEvent_1_1Coordinates.html">Coordinates</a> Wt::WMouseEvent::window </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the mouse position relative to the window.
<p>
This differs from documentX() only through scrolling through the document.
</div>
</div><p>
<a class="anchor" name="bc8cd49bcbf8244ee6f92a16eca7561b"></a><!-- doxytag: member="Wt::WMouseEvent::dragDelta" ref="bc8cd49bcbf8244ee6f92a16eca7561b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structWt_1_1WMouseEvent_1_1Coordinates.html">Coordinates</a> Wt::WMouseEvent::dragDelta </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the distance over which the mouse has been dragged.
<p>
This is only defined for a <a class="el" href="classWt_1_1WInteractWidget.html#318d761e35388a52eeb3406e6717b28f" title="Event signal emitted when a mouse key was released on this widget.">WInteractWidget::mouseWentUp()</a> event.
</div>
</div><p>
<a class="anchor" name="322292eed48c4d640f172648c660ef49"></a><!-- doxytag: member="Wt::WMouseEvent::altKey" ref="322292eed48c4d640f172648c660ef49" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WMouseEvent::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#_deprecated000009">Deprecated:</a></b></dt><dd>Use <a class="el" href="classWt_1_1WMouseEvent.html#c84d28364a178e547d2bc417e3eb2423" title="Returns keyboard modifiers.">modifiers()</a> instead. </dd></dl>
</div>
</div><p>
<a class="anchor" name="fca8f1bed7ec531f0b7b4c01173eb1cd"></a><!-- doxytag: member="Wt::WMouseEvent::metaKey" ref="fca8f1bed7ec531f0b7b4c01173eb1cd" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WMouseEvent::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#_deprecated000010">Deprecated:</a></b></dt><dd>Use <a class="el" href="classWt_1_1WMouseEvent.html#c84d28364a178e547d2bc417e3eb2423" title="Returns keyboard modifiers.">modifiers()</a> instead. </dd></dl>
</div>
</div><p>
<a class="anchor" name="8a25240a3b4a7b296d5c333c03a1fb75"></a><!-- doxytag: member="Wt::WMouseEvent::ctrlKey" ref="8a25240a3b4a7b296d5c333c03a1fb75" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WMouseEvent::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#_deprecated000011">Deprecated:</a></b></dt><dd>Use <a class="el" href="classWt_1_1WMouseEvent.html#c84d28364a178e547d2bc417e3eb2423" title="Returns keyboard modifiers.">modifiers()</a> instead. </dd></dl>
</div>
</div><p>
<a class="anchor" name="53962bfb61abd94b0a96568ed322a68d"></a><!-- doxytag: member="Wt::WMouseEvent::shiftKey" ref="53962bfb61abd94b0a96568ed322a68d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WMouseEvent::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#_deprecated000012">Deprecated:</a></b></dt><dd>Use <a class="el" href="classWt_1_1WMouseEvent.html#c84d28364a178e547d2bc417e3eb2423" 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>
|
