summaryrefslogtreecommitdiff
path: root/doc/fl_text_buffer.html
blob: 8fe431f39a829c7f24dc7115f294d3bb6e9fb12c (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
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881

<!DOCTYPE html>

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

  <body>


<h2>Fl_Text_Buffer Binding Map</h2>


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

  <tr>
    <td>Fl_Text_Buffer</td>
    <td>FLTK.Text_Buffers</td>
  </tr>

</table>



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

  <tr>
    <td>Fl_Text_Buffer</td>
    <td>Text_Buffer</td>
  </tr>

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

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

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

  <tr>
    <td>Fl_Text_Modify_Cb</td>
    <td>Modify_Callback</td>
  </tr>

  <tr>
    <td>Fl_Text_Predelete_Cb</td>
    <td>Predelete_Callback</td>
  </tr>

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

</table>



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

  <tr>
<td><pre>
Fl_Text_Buffer(int requestedSize=0, int preferredGapSize=1024);
</pre></td>
<td><pre>
function Create
       (Requested_Size     : in Natural := 0;
        Preferred_Gap_Size : in Natural := 1024)
    return Text_Buffer;
</pre></td>
  </tr>

  <tr>
<td><pre>
void add_modify_callback(Fl_Text_Modify_Cb bufModifiedCB, void *cbArg);
</pre></td>
<td><pre>
procedure Add_Modify_Callback
       (This : in out Text_Buffer;
        Func : in     Modify_Callback);
</pre></td>
  </tr>

  <tr>
<td><pre>
void add_predelete_callback(Fl_Text_Predelete_Cb bufPredelCB, void *cbArg);
</pre></td>
<td><pre>
procedure Add_Predelete_Callback
       (This : in out Text_Buffer;
        Func : in     Predelete_Callback);
</pre></td>
  </tr>

  <tr>
<td>&nbsp;</td>
<td><pre>
procedure Enable_Callbacks
       (This : in out Text_Buffer);
</pre></td>
  </tr>

  <tr>
<td>&nbsp;</td>
<td><pre>
procedure Disable_Callbacks
       (This : in out Text_Buffer);
</pre></td>
  </tr>

  <tr>
<td><pre>
const char * address(int pos) const;
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
char * address(int pos);
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
void append(const char *t);
</pre></td>
<td><pre>
procedure Append_Text
       (This : in out Text_Buffer;
        Text : in     String);
</pre></td>
  </tr>

  <tr>
<td><pre>
int appendFile(const char *file, int buflen=128*1024);
</pre></td>
<td><pre>
procedure Append_File
       (This   : in out Text_Buffer;
        Name   : in     String;
        Buffer : in     Natural := 128 * 1024);
</pre></td>
  </tr>

  <tr>
<td><pre>
char byte_at(int pos) const;
</pre></td>
<td><pre>
function Byte_At
       (This  : in Text_Buffer;
        Place : in Position)
    return Character;
</pre></td>
  </tr>

  <tr>
<td><pre>
void call_modify_callbacks();
</pre></td>
<td><pre>
procedure Call_Modify_Callbacks
       (This : in out Text_Buffer);
</pre></td>
  </tr>

  <tr>
<td><pre>
void call_predelete_callbacks();
</pre></td>
<td><pre>
procedure Call_Predelete_Callbacks
       (This : in out Text_Buffer);
</pre></td>
  </tr>

  <tr>
<td><pre>
void canUndo(char flag=1);
</pre></td>
<td><pre>
procedure Can_Undo
       (This : in out Text_Buffer;
        Flag : in     Boolean);
</pre></td>
  </tr>

  <tr>
<td><pre>
unsigned int char_at(int pos) const;
</pre></td>
<td><pre>
function Character_At
       (This  : in Text_Buffer;
        Place : in Position)
    return Character;
</pre></td>
  </tr>

  <tr>
<td><pre>
void copy(Fl_Text_Buffer *fromBuf, int fromStart, int fromEnd, int toPos);
</pre></td>
<td><pre>
procedure Copy
       (This          : in out Text_Buffer;
        From          : in     Text_Buffer;
        Start, Finish : in     Position;
        Insert_Pos    : in     Position);
</pre></td>
  </tr>

  <tr>
<td><pre>
int count_displayed_characters(int lineStartPos, int targetPos) const;
</pre></td>
<td><pre>
function Count_Displayed_Characters
       (This          : in Text_Buffer;
        Start, Finish : in Position)
    return Integer;
</pre></td>
  </tr>

  <tr>
<td><pre>
int count_lines(int startPos, int endPos) const;
</pre></td>
<td><pre>
function Count_Lines
       (This          : in Text_Buffer;
        Start, Finish : in Position)
    return Integer;
</pre></td>
  </tr>

  <tr>
<td><pre>
int findchar_backward(int startPos, unsigned int searchChar, int *foundPos) const;
</pre></td>
<td><pre>
function Findchar_Backward
       (This     : in     Text_Buffer;
        Start_At : in     Position;
        Item     : in     Character;
        Found_At :    out Position)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
int findchar_forward(int startPos, unsigned searchChar, int *foundPos) const;
</pre></td>
<td><pre>
function Findchar_Forward
       (This     : in     Text_Buffer;
        Start_At : in     Position;
        Item     : in     Character;
        Found_At :    out Position)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
void highlight(int start, int end);
</pre></td>
<td><pre>
procedure Set_Highlight
       (This          : in out Text_Buffer;
        Start, Finish : in     Position);
</pre></td>
  </tr>

  <tr>
<td>&nbsp;</td>
<td><pre>
procedure Get_Highlight
       (This          : in     Text_Buffer;
        Start, Finish :    out Position);
</pre></td>
  </tr>

  <tr>
<td><pre>
int highlight();
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
int highlight_position(int *start, int *end);
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
const Fl_Text_Selection * highlight_selection() const;
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
char * highlight_text();
</pre></td>
<td><pre>
function Get_Highlighted_Text
       (This : in Text_Buffer)
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
void insert(int pos, const char *text);
</pre></td>
<td><pre>
procedure Insert_Text
       (This  : in out Text_Buffer;
        Place : in     Position;
        Text  : in     String);
</pre></td>
  </tr>

  <tr>
<td><pre>
int insertfile(const char *file, int pos, int buflen=128*1024);
</pre></td>
<td><pre>
procedure Insert_File
       (This   : in out Text_Buffer;
        Name   : in     String;
        Place  : in     Position;
        Buffer : in     Natural := 128 * 1024);
</pre></td>
  </tr>

  <tr>
<td><pre>
int length() const;
</pre></td>
<td><pre>
function Length
       (This : in Text_Buffer)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
int line_end(int pos) const;
</pre></td>
<td><pre>
function Line_End
       (This  : in Text_Buffer;
        Place : in Position)
    return Position;
</pre></td>
  </tr>

  <tr>
<td><pre>
int line_start(int pos) const;
</pre></td>
<td><pre>
function Line_Start
       (This  : in Text_Buffer;
        Place : in Position)
    return Position;
</pre></td>
  </tr>

  <tr>
<td><pre>
char * line_text(int pos) const;
</pre></td>
<td><pre>
function Line_Text
       (This  : in Text_Buffer;
        Place : in Position)
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
int loadfile(const char *file, int buflen=128*1024);
</pre></td>
<td><pre>
procedure Load_File
       (This   : in out Text_Buffer;
        Name   : in     String;
        Buffer : in     Natural := 128 * 1024);
</pre></td>
  </tr>

  <tr>
<td><pre>
int next_char(int ix) const;
</pre></td>
<td><pre>
function Next_Char
       (This  : in Text_Buffer;
        Place : in Position)
    return Character;
</pre></td>
  </tr>

  <tr>
<td><pre>
int next_char_clipped(int ix) const;
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
int outputfile(const char *file, int start, int end, int buflen=128*1024);
</pre></td>
<td><pre>
procedure Output_File
       (This          : in Text_Buffer;
        Name          : in String;
        Start, Finish : in Position;
        Buffer        : in Natural := 128 * 1024);
</pre></td>
  </tr>

  <tr>
<td><pre>
int prev_char(int ix) const;
</pre></td>
<td><pre>
function Prev_Char
       (This  : in Text_Buffer;
        Place : in Position)
    return Character;
</pre></td>
  </tr>

  <tr>
<td><pre>
int prev_char_clipped(int ix) const;
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
const Fl_Text_Selection * primary_selection() const;
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
Fl_Text_Selection * primary_selection();
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
void remove(int start, int end);
</pre></td>
<td><pre>
procedure Remove_Text
       (This          : in out Text_Buffer;
        Start, Finish : in     Position);
</pre></td>
  </tr>

  <tr>
<td><pre>
void remove_modify_callback(Fl_Text_Modify_Cb bufModifiedCB, void *cbArg);
</pre></td>
<td><pre>
procedure Remove_Modify_Callback
       (This : in out Text_Buffer;
        Func : in     Modify_Callback);
</pre></td>
  </tr>

  <tr>
<td><pre>
void remove_predelete_callback(Fl_Text_Predelete_Cb predelCB, void *cbArg);
</pre></td>
<td><pre>
procedure Remove_Predelete_Callback
       (This : in out Text_Buffer;
        Func : in     Predelete_Callback);
</pre></td>
  </tr>

  <tr>
<td><pre>
void remove_secondary_selection();
</pre></td>
<td><pre>
procedure Remove_Secondary_Selection
       (This : in out Text_Buffer);
</pre></td>
  </tr>

  <tr>
<td><pre>
void remove_selection();
</pre></td>
<td><pre>
procedure Remove_Selection
       (This : in out Text_Buffer);
</pre></td>
  </tr>

  <tr>
<td><pre>
void replace(int start, int end, const char *text);
</pre></td>
<td><pre>
procedure Replace_Text
       (This          : in out Text_Buffer;
        Start, Finish : in     Position;
        Text          : in     String);
</pre></td>
  </tr>

  <tr>
<td><pre>
void replace_secondary_selection(const char *text);
</pre></td>
<td><pre>
procedure Replace_Secondary_Selection
       (This : in out Text_Buffer;
        Text : in     String);
</pre></td>
  </tr>

  <tr>
<td><pre>
void replace_selection(const char *text);
</pre></td>
<td><pre>
procedure Replace_Selection
       (This : in out Text_Buffer;
        Text : in     String);
</pre></td>
  </tr>

  <tr>
<td><pre>
int rewind_lines(int startPos, int nLines);
</pre></td>
<td><pre>
function Rewind_Lines
       (This  : in out Text_Buffer;
        Start : in     Position;
        Lines : in     Natural)
    return Position;
</pre></td>
  </tr>

  <tr>
<td><pre>
int savefile(const char *file, int buflen=128*1024);
</pre></td>
<td><pre>
procedure Save_File
       (This   : in Text_Buffer;
        Name   : in String;
        Buffer : in Natural := 128 * 1024);
</pre></td>
  </tr>

  <tr>
<td><pre>
int search_backward(int startPos, const char *searchString, int *foundPos, int matchCase=0) const;
</pre></td>
<td><pre>
function Search_Backward
       (This       : in     Text_Buffer;
        Start_At   : in     Position;
        Item       : in     String;
        Found_At   :    out Position;
        Match_Case : in     Boolean := False)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
int search_forward(int startPos, const char *searchString, int *foundPos, int matchCase=0) const;
</pre></td>
<td><pre>
function Search_Forward
       (This       : in     Text_Buffer;
        Start_At   : in     Position;
        Item       : in     String;
        Found_At   :    out Position;
        Match_Case : in     Boolean := False)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
void secondary_select(int start, int end);
</pre></td>
<td><pre>
procedure Set_Secondary_Selection
       (This          : in out Text_Buffer;
        Start, Finish : in     Position);
</pre></td>
  </tr>

  <tr>
<td><pre>
int secondary_selected();
</pre></td>
<td><pre>
function Has_Secondary_Selection
       (This : in Text_Buffer)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
const Fl_Text_Selection * secondary_selection() const;
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
int secondary_selection_position(int *start, int *end);
</pre></td>
<td><pre>
function Get_Secondary_Selection
       (This          : in     Text_Buffer;
        Start, Finish :    out Position)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
char * secondary_selection_text();
</pre></td>
<td><pre>
function Secondary_Selection_Text
       (This : in Text_Buffer)
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
void secondary_unselect();
</pre></td>
<td><pre>
procedure Secondary_Unselect
       (This : in out Text_Buffer);
</pre></td>
  </tr>

  <tr>
<td><pre>
void select(int start, int end);
</pre></td>
<td><pre>
procedure Set_Selection
       (This          : in out Text_Buffer;
        Start, Finish : in     Position);
</pre></td>
  </tr>

  <tr>
<td><pre>
int selected() const;
</pre></td>
<td><pre>
function Has_Selection
       (This : in Text_Buffer)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
int selection_position(int *start, int *end);
</pre></td>
<td><pre>
function Get_Selection
       (This          : in     Text_Buffer;
        Start, Finish :    out Position)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
char * selection_text();
</pre></td>
<td><pre>
function Selection_Text
       (This : in Text_Buffer)
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
int skip_displayed_characters(int lineStartPos, int nChars);
</pre></td>
<td><pre>
function Skip_Displayed_Characters
       (This  : in Text_Buffer;
        Start : in Position;
        Chars : in Natural)
    return Position;
</pre></td>
  </tr>

  <tr>
<td><pre>
int skip_lines(int startPos, int nLines);
</pre></td>
<td><pre>
function Skip_Lines
       (This  : in out Text_Buffer;
        Start : in     Position;
        Lines : in     Natural)
    return Position;
</pre></td>
  </tr>

  <tr>
<td><pre>
int tab_distance() const;
</pre></td>
<td><pre>
function Get_Tab_Width
       (This : in Text_Buffer)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
void tab_distance(int tabDist);
</pre></td>
<td><pre>
procedure Set_Tab_Width
       (This : in out Text_Buffer;
        To   : in     Natural);
</pre></td>
  </tr>

  <tr>
<td><pre>
char * text() const;
</pre></td>
<td><pre>
function Get_Entire_Text
       (This : in Text_Buffer)
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
void text(const char *text);
</pre></td>
<td><pre>
procedure Set_Entire_Text
       (This : in out Text_Buffer;
        Text : in     String);
</pre></td>
  </tr>

  <tr>
<td><pre>
char * text_range(int start, int end) const;
</pre></td>
<td><pre>
function Text_At
       (This          : in Text_Buffer;
        Start, Finish : in Position)
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
int undo(int *cp=0);
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
void unhighlight();
</pre></td>
<td><pre>
procedure Unhighlight
       (This : in out Text_Buffer);
</pre></td>
  </tr>

  <tr>
<td><pre>
void unselect();
</pre></td>
<td><pre>
procedure Unselect
       (This : in out Text_Buffer);
</pre></td>
  </tr>

  <tr>
<td><pre>
int utf8_align(int) const;
</pre></td>
<td><pre>
function UTF8_Align
       (This  : in Text_Buffer;
        Place : in Position)
    return Position;
</pre></td>
  </tr>

  <tr>
<td><pre>
int word_end(int pos) const;
</pre></td>
<td><pre>
function Word_End
       (This  : in Text_Buffer;
        Place : in Position)
    return Position;
</pre></td>
  </tr>

  <tr>
<td><pre>
int word_start(int pos) const;
</pre></td>
<td><pre>
function Word_Start
       (This  : in Text_Buffer;
        Place : in Position)
    return Position;
</pre></td>
  </tr>

</table>


  </body>
</html>