summaryrefslogtreecommitdiff
path: root/doc/fl_(fltk-events).html
blob: c9846fdeb07f62f330d2f0fb9fdaf552657e0bcf (plain)
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
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="utf-8">
    <title>Fl (FLTK.Events) Binding Map</title>
    <link href="map.css" rel="stylesheet">
  </head>

  <body>


<h2>Fl (FLTK.Events) Binding Map</h2>


<a href="index.html">Back to Index</a>


<table class="package">
  <tr><th colspan="2">Package name</th></tr>

  <tr>
    <td>Fl</td>
    <td>FLTK.Events</td>
  </tr>

</table>



<table class="type">
  <tr><th colspan="2">Types</th></tr>

  <tr>
    <td>Fl_Event_Handler</td>
    <td>Event_Handler</td>
  </tr>

  <tr>
    <td>Fl_Event_Dispatch</td>
    <td>Event_Dispatch</td>
  </tr>

</table>



<table class="function">
  <tr><th colspan="2">Static Functions and Procedures</th></tr>

  <tr>
<td><pre>
static void add_handler(Fl_Event_Handler h);
</pre></td>
<td><pre>
procedure Add_Handler
       (Func : in Event_Handler);
</pre></td>
  </tr>

  <tr>
<td><pre>
static Fl_Widget * belowmouse();
</pre></td>
<td><pre>
function Get_Below_Mouse
    return access FLTK.Widgets.Widget'Class;
</pre></td>
  </tr>

  <tr>
<td><pre>
static void belowmouse(Fl_Widget *);
</pre></td>
<td><pre>
procedure Set_Below_Mouse
       (To : in FLTK.Widgets.Widget'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int compose(int &del);
</pre></td>
<td><pre>
function Compose
       (Del : out Natural)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
static void compose_reset();
</pre></td>
<td><pre>
procedure Compose_Reset;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event();
</pre></td>
<td><pre>
function Last
    return Event_Kind;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_alt();
</pre></td>
<td><pre>
function Key_Alt
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_button();
</pre></td>
<td><pre>
function Last_Button
    return Mouse_Button;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_button1();
</pre></td>
<td><pre>
function Mouse_Left
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_button2();
</pre></td>
<td><pre>
function Mouse_Middle
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_button3();
</pre></td>
<td><pre>
function Mouse_Right
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_button4();
</pre></td>
<td><pre>
function Mouse_Back
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_button5();
</pre></td>
<td><pre>
function Mouse_Forward
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_buttons();
</pre></td>
<td><pre>
procedure Mouse_Buttons
       (Left, Middle, Right, Back, Forward : out Boolean);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_clicks();
</pre></td>
<td><pre>
function Is_Multi_Click
    return Boolean;

function Get_Clicks
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
static void event_clicks(int i);
</pre></td>
<td><pre>
procedure Set_Clicks
       (To : in Natural);
</pre></td>
  </tr>

  <tr>
<td><pre>
static void * event_clipboard();
</pre></td>
<td><pre>
function Clipboard_Text
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
static const char * event_clipboard_type();
</pre></td>
<td><pre>
function Clipboard_Kind
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_command();
</pre></td>
<td><pre>
function Key_Command
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_ctrl();
</pre></td>
<td><pre>
function Key_Ctrl
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
static Fl_Event_Dispatch event_dispatch();
</pre></td>
<td><pre>
function Get_Dispatch
    return Event_Dispatch;
</pre></td>
  </tr>

  <tr>
<td><pre>
static void event_dispatch(Fl_Event_Dispatch d);
</pre></td>
<td><pre>
procedure Set_Dispatch
       (Func : in Event_Dispatch);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_dx();
</pre></td>
<td><pre>
function Mouse_DX
    return Integer;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_dy();
</pre></td>
<td><pre>
function Mouse_DY
    return Integer;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_inside(const Fl_Widget *);
</pre></td>
<td><pre>
function Is_Inside
       (Child : in FLTK.Widgets.Widget'Class)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_inside(int, int, int, int);
</pre></td>
<td><pre>
function Is_Inside
       (X, Y, W, H : in Integer)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_is_click();
</pre></td>
<td><pre>
function Is_Click
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
static void event_is_click(int i);
</pre></td>
<td><pre>
procedure Clear_Click;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_key();
</pre></td>
<td><pre>
function Last_Key
    return Keypress;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_key(int key);
</pre></td>
<td><pre>
function Pressed_During
       (Key : in Keypress)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_length();
</pre></td>
<td><pre>
function Text_Length
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_original_key();
</pre></td>
<td><pre>
function Original_Last_Key
    return Keypress;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_shift();
</pre></td>
<td><pre>
function Key_Shift
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_state();
</pre></td>
<td><pre>
function Last_Modifier
    return Modifier;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_state(int mask);
</pre></td>
<td><pre>
function Last_Modifier
       (Had : in Modifier)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
static const char * event_text();
</pre></td>
<td><pre>
function Text
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_x();
</pre></td>
<td><pre>
function Mouse_X
    return Integer;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_x_root();
</pre></td>
<td><pre>
function Mouse_X_Root
    return Integer;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_y();
</pre></td>
<td><pre>
function Mouse_Y
    return Integer;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int event_y_root();
</pre></td>
<td><pre>
function Mouse_Y_Root
    return Integer;
</pre></td>
  </tr>

  <tr>
<td><pre>
static Fl_Widget * focus();
</pre></td>
<td><pre>
function Get_Focus
    return access FLTK.Widgets.Widget'Class;
</pre></td>
  </tr>

  <tr>
<td><pre>
static void focus(Fl_Widget *);
</pre></td>
<td><pre>
procedure Set_Focus
       (To : in FLTK.Widgets.Widget'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int get_key(int key);
</pre></td>
<td><pre>
function Key_Now
       (Key : in Keypress)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
static void get_mouse(int &, int &);
</pre></td>
<td><pre>
procedure Get_Mouse
       (X, Y : out Integer);
</pre></td>
  </tr>

  <tr>
<td><pre>
static Fl_Window * grab();
</pre></td>
<td><pre>
function Get_Grab
    return access FLTK.Widgets.Groups.Windows.Window'Class;
</pre></td>
  </tr>

  <tr>
<td><pre>
static void grab(Fl_Window *);

static void grab(Fl_Window &win);
</pre></td>
<td><pre>
procedure Set_Grab
       (To : in FLTK.Widgets.Groups.Windows.Window'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int handle(int, Fl_Window *);
</pre></td>
<td><pre>
function Handle_Dispatch
       (Event  : in     Event_Kind;
        Origin : in out FLTK.Widgets.Groups.Windows.Window'Class)
    return Event_Outcome;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int handle_(int, Fl_Window *);
</pre></td>
<td><pre>
function Handle
       (Event  : in     Event_Kind;
        Origin : in out FLTK.Widgets.Groups.Windows.Window'Class)
    return Event_Outcome;
</pre></td>
  </tr>

  <tr>
<td><pre>
static Fl_Widget * pushed();
</pre></td>
<td><pre>
function Get_Pushed
    return access FLTK.Widgets.Widget'Class;
</pre></td>
  </tr>

  <tr>
<td><pre>
static void pushed(Fl_Widget *);
</pre></td>
<td><pre>
procedure Set_Pushed
       (To : in FLTK.Widgets.Widget'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static void release();
</pre></td>
<td><pre>
procedure Release_Grab;
</pre></td>
  </tr>

  <tr>
<td><pre>
static void remove_handler(Fl_Event_Handler h);
</pre></td>
<td><pre>
procedure Remove_Handler
       (Func : in Event_Handler);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int test_shortcut(Fl_Shortcut);
</pre></td>
<td><pre>
function Test_Shortcut
       (Shortcut : in Key_Combo)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
static int visible_focus();
</pre></td>
<td><pre>
function Has_Visible_Focus
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
static void visible_focus(int v);
</pre></td>
<td><pre>
procedure Set_Visible_Focus
       (To : in Boolean);
</pre></td>
  </tr>

</table>


  </body>
</html>