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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Gdk::Device Class Reference</h1>A GdkDevice C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="input_8hh-source.html">gfc/gdk/input.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Gdk::Device:
<p><center><img src="classGFC_1_1Gdk_1_1Device.png" usemap="#GFC::Gdk::Device_map" border="0" alt=""></center>
<map name="GFC::Gdk::Device_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,134,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,134,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,134,24">
</map>
<a href="classGFC_1_1Gdk_1_1Device-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z171_0" doxytag="GFC::Gdk::Device::~Device" ></a>
virtual <a class="el" href="classGFC_1_1Gdk_1_1Device.html#z171_0">~Device</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z172_0" doxytag="GFC::Gdk::Device::gdk_device" ></a>
GdkDevice * <a class="el" href="classGFC_1_1Gdk_1_1Device.html#z172_0">gdk_device</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GdkDevice structure. <br></dl><li><a class="anchor" name="z172_1" doxytag="GFC::Gdk::Device::operator GdkDevice *" ></a>
<a class="el" href="classGFC_1_1Gdk_1_1Device.html#z172_1">operator GdkDevice *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Gdk_1_1Device.html">Device</a> to a GdkDevice pointer. <br></dl><li><a class="anchor" name="z172_2" doxytag="GFC::Gdk::Device::name" ></a>
<a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> <a class="el" href="classGFC_1_1Gdk_1_1Device.html#z172_2">name</a> () const
<dl class="el"><dd class="mdescRight">Returns the name of the device. <br></dl><li><a class="anchor" name="z172_3" doxytag="GFC::Gdk::Device::source" ></a>
<a class="el" href="namespaceGFC_1_1Gdk.html#a274">InputSource</a> <a class="el" href="classGFC_1_1Gdk_1_1Device.html#z172_3">source</a> () const
<dl class="el"><dd class="mdescRight">Returns the type of the device. <br></dl><li><a class="anchor" name="z172_4" doxytag="GFC::Gdk::Device::mode" ></a>
<a class="el" href="namespaceGFC_1_1Gdk.html#a275">InputMode</a> <a class="el" href="classGFC_1_1Gdk_1_1Device.html#z172_4">mode</a> () const
<dl class="el"><dd class="mdescRight">Returns the mode of the device. <br></dl><li><a class="anchor" name="z172_5" doxytag="GFC::Gdk::Device::has_cursor" ></a>
bool <a class="el" href="classGFC_1_1Gdk_1_1Device.html#z172_5">has_cursor</a> () const
<dl class="el"><dd class="mdescRight">Returns true if the X pointer follows device motion. <br></dl><li>void <a class="el" href="classGFC_1_1Gdk_1_1Device.html#z172_6">get_state</a> (<a class="el" href="classGFC_1_1Gdk_1_1Window.html">Window</a> &window, double *axes, <a class="el" href="namespaceGFC_1_1Gdk.html#a136">ModifierTypeField</a> *mask) const
<dl class="el"><dd class="mdescRight">Gets the current state of the device. <a href="#z172_6"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gdk_1_1Device.html#z172_7">get_history</a> (<a class="el" href="classGFC_1_1Gdk_1_1Window.html">Window</a> &window, unsigned long start, unsigned long stop, GdkTimeCoord ***events, int *n_events) const
<dl class="el"><dd class="mdescRight">Obtains the motion history for a device, given a starting and ending timestamp, and returns all events in the motion history for the given time range. <a href="#z172_7"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gdk_1_1Device.html#z172_8">get_axis</a> (double *axes, <a class="el" href="namespaceGFC_1_1Gdk.html#a278">AxisUse</a> use, double *value) const
<dl class="el"><dd class="mdescRight">Interprets an array of double as axis values for a given device, and locates the value in the array for a given axis use. <a href="#z172_8"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>void <a class="el" href="classGFC_1_1Gdk_1_1Device.html#z173_0">set_source</a> (<a class="el" href="namespaceGFC_1_1Gdk.html#a274">InputSource</a> source)
<dl class="el"><dd class="mdescRight">Sets the source type for the input device. <a href="#z173_0"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gdk_1_1Device.html#z173_1">set_mode</a> (<a class="el" href="namespaceGFC_1_1Gdk.html#a275">InputMode</a> mode)
<dl class="el"><dd class="mdescRight">Sets the mode of an input device. <a href="#z173_1"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gdk_1_1Device.html#z173_2">set_key</a> (unsigned int index, unsigned int keyval, <a class="el" href="namespaceGFC_1_1Gdk.html#a136">ModifierTypeField</a> modifiers)
<dl class="el"><dd class="mdescRight">Specifies the X key event to generate when a macro button of a device is pressed. <a href="#z173_2"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gdk_1_1Device.html#z173_3">set_axis_use</a> (unsigned int index, <a class="el" href="namespaceGFC_1_1Gdk.html#a278">AxisUse</a> use)
<dl class="el"><dd class="mdescRight">Specifies how an axis of a device is used. <a href="#z173_3"></a><br></dl></ul>
<h2>Static Public Member Functions</h2>
<ul>
<li>void <a class="el" href="classGFC_1_1Gdk_1_1Device.html#e0">free_history</a> (GdkTimeCoord **events, int n_events)
<dl class="el"><dd class="mdescRight">Frees the array of GdkTimeCoord that was returned by <a class="el" href="classGFC_1_1Gdk_1_1Device.html#z172_7">get_history()</a>. <a href="#e0"></a><br></dl><li><a class="el" href="classGFC_1_1Gdk_1_1Device.html">Device</a> * <a class="el" href="classGFC_1_1Gdk_1_1Device.html#e1">get_core_pointer</a> (const <a class="el" href="classGFC_1_1Gdk_1_1Display.html">Display</a> *display=0)
<dl class="el"><dd class="mdescRight">Returns the core pointer device for <em>display</em>. <a href="#e1"></a><br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Gdk_1_1Device.html#z170_0">Device</a> (GdkDevice *device, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html#z143_1">owns_reference</a>=true)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gdk_1_1Device.html">Device</a> from an existing GdkDevice. <a href="#z170_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GdkDevice C++ wrapper class.
<p>
In addition to the normal keyboard and mouse input devices, GTK+ also contains support for extended input devices. In particular, this support is targeted at graphics tablets. Graphics tablets typically return sub-pixel positioning information and possibly information about the pressure and tilt of the stylus. Under X, the support for extended devices is done through the XInput extension.<p>
Because handling extended input devices may involve considerable overhead, they need to be turned on for each <a class="el" href="classGFC_1_1Gdk_1_1Window.html">Gdk::Window</a> individually using set_extension_events(). (Or, more typically, for Gtk::Widgets, using <a class="el" href="classGFC_1_1Gtk_1_1Widget.html#z1053_59">Gtk::Widget::set_extension_events()</a>). As an additional complication, depending on the support from the windowing system, its possible that a normal mouse cursor will not be displayed for a particular extension device. If an application does not want to deal with displaying a cursor itself, it can ask only to get extension events from devices that will display a cursor, by passing the EXTENSION_EVENTS_CURSOR value to set_extension_events(). Otherwise, the application must retrieve the device information using list_devices(), check the <a class="el" href="classGFC_1_1Gdk_1_1Device.html#z172_5">has_cursor()</a> accessor, and, if it returns false, draw a cursor itself when it receives motion events.<p>
Each pointing device is assigned a unique integer ID; events from a particular device can be identified by the deviceid field in the event structure. The events generated by pointer devices have also been extended to contain pressure, xtilt and ytilt fields which contain the extended information reported as additional valuators from the device. The pressure field is a double value ranging from 0.0 to 1.0, while the tilt fields are double values ranging from -1.0 to 1.0. (With -1.0 representing the maximum tilt to the left or up, and 1.0 representing the maximum tilt to the right or down.)<p>
One additional field in each event is the source field, which contains an enumeration value describing the type of device; this currently can be one of SOURCE_MOUSE, SOURCE_PEN, SOURCE_ERASER, or SOURCE_CURSOR. This field is present to allow simple applications to (for instance) delete when they detect eraser devices without having to keep track of complicated per-device settings.<p>
Various aspects of each device may be configured. The easiest way of creating a GUI to allow the user to configure such a device is to use the GtkInputDialog widget in GTK+. <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC.html">GFC</a> doesn't wrap GtkInputDialog because it is considered too specialized and will eventually be moved out of GTK+. If you use this widget, application writers will need to directly query and set the configuration parameters in order to save the state between invocations of the application. The configuration of devices is queried using list_devices(). Each device must be activated using <a class="el" href="classGFC_1_1Gdk_1_1Device.html#z173_1">set_mode()</a>, which also controls whether the device's range is mapped to the entire screen or to a single window. The mapping of the valuators of the device onto the predefined valuator types is set using <a class="el" href="classGFC_1_1Gdk_1_1Device.html#z173_3">set_axis_use()</a>. And the source type for each device can be set with <a class="el" href="classGFC_1_1Gdk_1_1Device.html#z173_0">set_source()</a>.<p>
Devices may also have associated keys or macro buttons. Such keys can be globally set to map into normal X keyboard events. The mapping is set using <a class="el" href="classGFC_1_1Gdk_1_1Device.html#z173_2">set_key()</a>. The interfaces in this section will most likely be considerably modified in the future to accomodate devices that may have different sets of additional valuators than the pressure xtilt and ytilt.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z170_0" doxytag="GFC::Gdk::Device::Device" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GFC::Gdk::Device::Device </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GdkDevice * </td>
<td class="mdname" nowrap> <em>device</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>owns_reference</em> = <code>true</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [explicit, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new <a class="el" href="classGFC_1_1Gdk_1_1Device.html">Device</a> from an existing GdkDevice.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>device</em> </td><td>A pointer to a GdkDevice. </td></tr>
<tr><td></td><td valign=top><em>owns_reference</em> </td><td>Set false if the initial reference count is floating, set true if it's not.</td></tr>
</table>
</dl>
<br>
The <em>device</em> can be a newly created GdkDevice or an existing GdkDevice. (see <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z68_0">G::Object::Object</a>). </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e0" doxytag="GFC::Gdk::Device::free_history" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gdk::Device::free_history </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GdkTimeCoord ** </td>
<td class="mdname" nowrap> <em>events</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>n_events</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Frees the array of GdkTimeCoord that was returned by <a class="el" href="classGFC_1_1Gdk_1_1Device.html#z172_7">get_history()</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>events</em> </td><td>An array of GdkTimeCoord. </td></tr>
<tr><td></td><td valign=top><em>n_events</em> </td><td>The length of the array. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z172_8" doxytag="GFC::Gdk::Device::get_axis" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Gdk::Device::get_axis </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">double * </td>
<td class="mdname" nowrap> <em>axes</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceGFC_1_1Gdk.html#a278">AxisUse</a> </td>
<td class="mdname" nowrap> <em>use</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>double * </td>
<td class="mdname" nowrap> <em>value</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Interprets an array of double as axis values for a given device, and locates the value in the array for a given axis use.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>axes</em> </td><td>The pointer to an array of axes. </td></tr>
<tr><td></td><td valign=top><em>use</em> </td><td>The use to look for. </td></tr>
<tr><td></td><td valign=top><em>value</em> </td><td>The location to store the found value. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the given axis use was found, otherwise <em>false</em>. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="e1" doxytag="GFC::Gdk::Device::get_core_pointer" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classGFC_1_1Gdk_1_1Device.html">Device</a>* GFC::Gdk::Device::get_core_pointer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Gdk_1_1Display.html">Display</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>display</em> = <code>0</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the core pointer device for <em>display</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>display</em> </td><td>The <a class="el" href="classGFC_1_1Gdk_1_1Display.html">Display</a>, or null for the default display.</td></tr>
</table>
</dl>
<br>
This device is owned by the display and should not be unreferenced. </td>
</tr>
</table>
<a class="anchor" name="z172_7" doxytag="GFC::Gdk::Device::get_history" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Gdk::Device::get_history </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Gdk_1_1Window.html">Window</a> & </td>
<td class="mdname" nowrap> <em>window</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>unsigned long </td>
<td class="mdname" nowrap> <em>start</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>unsigned long </td>
<td class="mdname" nowrap> <em>stop</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>GdkTimeCoord *** </td>
<td class="mdname" nowrap> <em>events</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int * </td>
<td class="mdname" nowrap> <em>n_events</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Obtains the motion history for a device, given a starting and ending timestamp, and returns all events in the motion history for the given time range.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>window</em> </td><td>The window with respect to which which the event coordinates will be reported. </td></tr>
<tr><td></td><td valign=top><em>start</em> </td><td>The starting timestamp for range of events to return. </td></tr>
<tr><td></td><td valign=top><em>stop</em> </td><td>The ending timestamp for the range of events to return. </td></tr>
<tr><td></td><td valign=top><em>events</em> </td><td>The location to store a newly-allocated array of GdkTimeCoord, or null. </td></tr>
<tr><td></td><td valign=top><em>n_events</em> </td><td>The location to store the length of events, or null. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the windowing system supports motion history and at least one event was found.</dd></dl>
<br>
Some windowing systems do not support motion history, in which case, false will be returned. This is not distinguishable from the case where motion history is supported and no events were found. If successful, the vector contents must be freed by calling <a class="el" href="classGFC_1_1Gdk_1_1Device.html#e0">free_history()</a>; </td>
</tr>
</table>
<a class="anchor" name="z172_6" doxytag="GFC::Gdk::Device::get_state" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gdk::Device::get_state </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Gdk_1_1Window.html">Window</a> & </td>
<td class="mdname" nowrap> <em>window</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>double * </td>
<td class="mdname" nowrap> <em>axes</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceGFC_1_1Gdk.html#a136">ModifierTypeField</a> * </td>
<td class="mdname" nowrap> <em>mask</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the current state of the device.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>window</em> </td><td>A <a class="el" href="classGFC_1_1Gdk_1_1Window.html">Gdk::Window</a>. </td></tr>
<tr><td></td><td valign=top><em>axes</em> </td><td>An array of doubles to store the values of the axes of device in, or null. </td></tr>
<tr><td></td><td valign=top><em>mask</em> </td><td>The location to store the modifiers, or null. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z173_3" doxytag="GFC::Gdk::Device::set_axis_use" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gdk::Device::set_axis_use </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned int </td>
<td class="mdname" nowrap> <em>index</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceGFC_1_1Gdk.html#a278">AxisUse</a> </td>
<td class="mdname" nowrap> <em>use</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Specifies how an axis of a device is used.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>index</em> </td><td>The index of the axis. </td></tr>
<tr><td></td><td valign=top><em>use</em> </td><td>Specifies how the axis is used. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z173_2" doxytag="GFC::Gdk::Device::set_key" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gdk::Device::set_key </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned int </td>
<td class="mdname" nowrap> <em>index</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>unsigned int </td>
<td class="mdname" nowrap> <em>keyval</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceGFC_1_1Gdk.html#a136">ModifierTypeField</a> </td>
<td class="mdname" nowrap> <em>modifiers</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Specifies the X key event to generate when a macro button of a device is pressed.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>index</em> </td><td>The index of the macro button to set. </td></tr>
<tr><td></td><td valign=top><em>keyval</em> </td><td>The keyval to generate. </td></tr>
<tr><td></td><td valign=top><em>modifiers</em> </td><td>The modifiers to set. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z173_1" doxytag="GFC::Gdk::Device::set_mode" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Gdk::Device::set_mode </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Gdk.html#a275">InputMode</a> </td>
<td class="mdname1" valign="top" nowrap> <em>mode</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the mode of an input device.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>mode</em> </td><td>The input mode. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the mode was successfully changed.</dd></dl>
<br>
The mode controls if the device is active and whether the device's range is mapped to the entire screen or to a single window. </td>
</tr>
</table>
<a class="anchor" name="z173_0" doxytag="GFC::Gdk::Device::set_source" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gdk::Device::set_source </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Gdk.html#a274">InputSource</a> </td>
<td class="mdname1" valign="top" nowrap> <em>source</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the source type for the input device.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>source</em> </td><td>The source type. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="input_8hh-source.html">input.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:36 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
