summaryrefslogtreecommitdiff
path: root/doc/fl_text_editor.html
blob: a9468197f79edb198a6cca29f12498602504089a (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
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
<!DOCTYPE html>

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

  <body>


<h2>Fl_Text_Editor 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_Text_Editor</td>
    <td>FLTK.Widgets.Groups.Text_Displays.Text_Editors</td>
  </tr>

</table>



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

  <tr>
    <td>Fl_Text_Editor</td>
    <td>Text_Editor</td>
  </tr>

  <tr>
    <td>&nbsp;</td>
    <td>Text_Editor_Reference</td>
  </tr>

  <tr>
    <td>int</td>
    <td>Insert_Mode</td>
  </tr>

  <tr>
    <td>int</td>
    <td>Tab_Navigation</td>
  </tr>

  <tr>
    <td>Key_Func</td>
    <td>Key_Func</td>
  </tr>

  <tr>
    <td>Key_Func</td>
    <td>Default_Key_Func</td>
  </tr>

  <tr>
    <td>Key_Binding</td>
    <td>Key_Binding</td>
  </tr>

  <tr>
    <td>Key_Binding</td>
    <td>Key_Binding_Array</td>
  </tr>

  <tr>
    <td>Key_Binding</td>
    <td>Key_Binding_Vectors.Vector</td>
  </tr>

</table>



<table class="function">
  <tr><th colspan="2">Static Attributes</th></tr>

  <tr>
<td>Use the add_default_key_bindings function.</td>
<td><pre>
Default_Key_Bindings : constant Key_Binding_Array := ...
</pre></td>
  </tr>

</table>



<table class="function">
  <tr><th colspan="2">Static Protected Attributes</th></tr>

  <tr>
<td><pre>
static Key_Binding * global_key_bindings;
</pre></td>
<td><pre>
Global_Key_Bindings : Key_Binding_Vectors.Vector;
</pre></td>
  </tr>

</table>



<table class="function">
  <tr><th colspan="2">Constructors</th></tr>

  <tr>
<td><pre>
Fl_Text_Editor(int X, int Y, int W, int H, const char *L=0);
</pre></td>
<td><pre>
function Create
       (X, Y, W, H : in Integer;
        Text       : in String := "")
    return Text_Editor;
</pre></td>
  </tr>

  <tr>
<td>Rely on the automatic use of begin when a group is created, or use begin/end
explicitly, or add each widget to its intended parent group manually.</td>
<td><pre>
function Create
       (Parent     : in out Groups.Group'Class;
        X, Y, W, H : in     Integer;
        Text       : in     String := "")
    return Text_Editor;
</pre></td>
  </tr>

</table>



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

  <tr>
<td><pre>
static int kf_backspace(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Backspace
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_c_s_move(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Ctrl_Shift_Home
       (This : in out Text_Editor'Class);

procedure KF_Ctrl_Shift_End
       (This : in out Text_Editor'Class);

procedure KF_Ctrl_Shift_Page_Down
       (This : in out Text_Editor'Class);

procedure KF_Ctrl_Shift_Page_Up
       (This : in out Text_Editor'Class);

procedure KF_Ctrl_Shift_Down
       (This : in out Text_Editor'Class);

procedure KF_Ctrl_Shift_Left
       (This : in out Text_Editor'Class);

procedure KF_Ctrl_Shift_Right
       (This : in out Text_Editor'Class);

procedure KF_Ctrl_Shift_Up
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_copy(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Copy
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_ctrl_move(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Ctrl_Home
       (This : in out Text_Editor'Class);

procedure KF_Ctrl_End
       (This : in out Text_Editor'Class);

procedure KF_Ctrl_Page_Down
       (This : in out Text_Editor'Class);

procedure KF_Ctrl_Page_Up
       (This : in out Text_Editor'Class);

procedure KF_Ctrl_Down
       (This : in out Text_Editor'Class);

procedure KF_Ctrl_Left
       (This : in out Text_Editor'Class);

procedure KF_Ctrl_Right
       (This : in out Text_Editor'Class);

procedure KF_Ctrl_Up
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_cut(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Cut
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_default(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Default
       (This : in out Text_Editor'Class;
        Key  : in     Key_Combo);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_delete(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Delete
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_down(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Down
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_end(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_End
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_enter(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Enter
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_home(int, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Home
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_ignore(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Ignore
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_insert(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Insert
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_left(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Left
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_m_s_move(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Meta_Shift_Home
       (This : in out Text_Editor'Class);

procedure KF_Meta_Shift_End
       (This : in out Text_Editor'Class);

procedure KF_Meta_Shift_Page_Down
       (This : in out Text_Editor'Class);

procedure KF_Meta_Shift_Page_Up
       (This : in out Text_Editor'Class);

procedure KF_Meta_Shift_Down
       (This : in out Text_Editor'Class);

procedure KF_Meta_Shift_Left
       (This : in out Text_Editor'Class);

procedure KF_Meta_Shift_Right
       (This : in out Text_Editor'Class);

procedure KF_Meta_Shift_Up
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_meta_move(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Meta_Home
       (This : in out Text_Editor'Class);

procedure KF_Meta_End
       (This : in out Text_Editor'Class);

procedure KF_Meta_Page_Down
       (This : in out Text_Editor'Class);

procedure KF_Meta_Page_Up
       (This : in out Text_Editor'Class);

procedure KF_Meta_Down
       (This : in out Text_Editor'Class);

procedure KF_Meta_Left
       (This : in out Text_Editor'Class);

procedure KF_Meta_Right
       (This : in out Text_Editor'Class);

procedure KF_Meta_Up
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_move(int c, Fl_Text_Editor *e);
</pre></td>
<td>Already covered by KF_Home, KF_End, KF_Page_Down, KF_Page_Up,
KF_Down, KF_Left, KF_Right, KF_Up.</td>
  </tr>

  <tr>
<td><pre>
static int kf_page_down(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Page_Down
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_page_up(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Page_Up
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_paste(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Paste
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_right(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Right
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_select_all(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Select_All
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_shift_move(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Shift_Home
       (This : in out Text_Editor'Class);

procedure KF_Shift_End
       (This : in out Text_Editor'Class);

procedure KF_Shift_Page_Down
       (This : in out Text_Editor'Class);

procedure KF_Shift_Page_Up
       (This : in out Text_Editor'Class);

procedure KF_Shift_Down
       (This : in out Text_Editor'Class);

procedure KF_Shift_Left
       (This : in out Text_Editor'Class);

procedure KF_Shift_Right
       (This : in out Text_Editor'Class);

procedure KF_Shift_Up
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td>Write your own function to handle a tab press.</td>
<td><pre>
procedure KF_Tab
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_undo(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Undo
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
static int kf_up(int c, Fl_Text_Editor *e);
</pre></td>
<td><pre>
procedure KF_Up
       (This : in out Text_Editor'Class);
</pre></td>
  </tr>

</table>



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

  <tr>
<td><pre>
void add_default_key_bindings(Key_Binding **list);
</pre></td>
<td>Construct an array or populate a vector manually using the Default_Key_Bindings array.</td>
  </tr>

  <tr>
<td><pre>
void add_key_binding(int key, int state, Key_Func f);
</pre></td>
<td><pre>
procedure Add_Key_Binding
       (This : in out Text_Editor;
        Key  : in     Key_Combo;
        Func : in     Key_Func);

procedure Add_Key_Binding
       (This : in out Text_Editor;
        Bind : in     Key_Binding);
</pre></td>
  </tr>

  <tr>
<td><pre>
void add_key_binding(int key, int state, Key_Func f,
    Key_Binding **list);
</pre></td>
<td>Construct an array or populate a vector manually.</td>
  </tr>

  <tr>
<td>Add key bindings to an Fl_Text_Editor one by one.</td>
<td><pre>
procedure Add_Key_Bindings
       (This : in out Text_Editor;
        Bind : in     Key_Binding_Array);
</pre></td>
  </tr>

  <tr>
<td><pre>
Key_Func bound_key_function(int key, int state) const;
</pre></td>
<td><pre>
function Get_Bound_Key_Function
       (This : in Text_Editor;
        Key  : in Key_Combo)
    return Key_Func;
</pre></td>
  </tr>

  <tr>
<td>After adding a key binding to an editor there does not appear to
be a way to obtain a full accounting of what bindings exist afterwards.</td>
<td><pre>
function Get_All_Bound_Key_Functions
       (This : in Text_Editor)
    return Key_Binding_Array;
</pre></td>
  </tr>

  <tr>
<td><pre>
Key_Func bound_key_function(int key, int state,
    Key_Binding *list) const;
</pre></td>
<td>Search an array or vector using standard operations.</td>
  </tr>

  <tr>
<td><pre>
void default_key_function(Key_Func f);
</pre></td>
<td><pre>
procedure Set_Default_Key_Function
       (This : in out Text_Editor;
        Func : in     Default_Key_Func);
</pre></td>
  </tr>

  <tr>
<td>Keep track of what default key function you set manually.</td>
<td><pre>
function Get_Default_Key_Function
       (This : in Text_Editor)
    return Default_Key_Func;
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual int handle(int e);
</pre></td>
<td><pre>
function Handle
       (This  : in out Text_Editor;
        Event : in     Event_Kind)
    return Event_Outcome;
</pre></td>
  </tr>

  <tr>
<td><pre>
int insert_mode();
</pre></td>
<td><pre>
function Get_Insert_Mode
       (This : in Text_Editor)
    return Insert_Mode;
</pre></td>
  </tr>

  <tr>
<td><pre>
void insert_mode(int b);
</pre></td>
<td><pre>
procedure Set_Insert_Mode
       (This : in out Text_Editor;
        To   : in     Insert_Mode);
</pre></td>
  </tr>

  <tr>
<td><pre>
void remove_all_key_bindings();
</pre></td>
<td><pre>
procedure Remove_All_Key_Bindings
       (This : in out Text_Editor);
</pre></td>
  </tr>

  <tr>
<td><pre>
void remove_all_key_bindings(Key_Binding **list);
</pre></td>
<td>Use standard operations to manipulate an array or vector.</td>
  </tr>

  <tr>
<td><pre>
void remove_key_binding(int key, int state);
</pre></td>
<td><pre>
procedure Remove_Key_Binding
       (This : in out Text_Editor;
        Key  : in     Key_Combo);

procedure Remove_Key_Binding
       (This : in out Text_Editor;
        Bind : in     Key_Binding);
</pre></td>
  </tr>

  <tr>
<td><pre>
void remove_key_binding(int key, int state, Key_Binding **list);
</pre></td>
<td>Use standard operations to manipulate an array or vector.</td>
  </tr>

  <tr>
<td>Remove key bindings from an Fl_Text_Editor one by one.</td>
<td><pre>
procedure Remove_Key_Bindings
       (This : in out Text_Editor;
        Bind : in     Key_Binding_Array);
</pre></td>
  </tr>

  <tr>
<td><pre>
int tab_nav() const;
</pre></td>
<td><pre>
function Get_Tab_Mode
       (This : in Text_Editor)
    return Tab_Navigation;
</pre></td>
  </tr>

  <tr>
<td><pre>
void tab_nav(int val);
</pre></td>
<td><pre>
procedure Set_Tab_Mode
       (This : in out Text_Editor;
        To   : in     Tab_Navigation);
</pre></td>
  </tr>

</table>



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

  <tr>
<td><pre>
int handle_key();
</pre></td>
<td><pre>
function Handle_Key
       (This : in out Text_Editor)
    return Event_Outcome;
</pre></td>
  </tr>

  <tr>
<td><pre>
void maybe_do_callback();
</pre></td>
<td><pre>
procedure Maybe_Do_Callback
       (This : in out Text_Editor);
</pre></td>
  </tr>

</table>


  </body>
</html>