summaryrefslogtreecommitdiff
path: root/doc/fl_text_display.html
blob: 062af1848b82f2ad3b0472bf7120682610486063 (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

<!DOCTYPE html>

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

  <body>


<h2>Fl_Text_Display 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_Display</td>
    <td>FLTK.Widgets.Groups.Text_Displays</td>
  </tr>

</table>



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

  <tr>
    <td>Fl_Text_Display</td>
    <td>Text_Display</td>
  </tr>

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

  <tr>
    <td>enum { NORMAL_CURSOR, CARET_CURSOR, DIM_CURSOR, BLOCK_CURSOR, HEAVY_CURSOR, SIMPLE_CURSOR }</td>
    <td>Cursor_Style</td>
  </tr>

  <tr>
    <td>enum { CURSOR_POS, CHARACTER_POS }</td>
    <td>&nbsp;</td>
  </tr>

  <tr>
    <td>enum { DRAG_NONE = -2, DRAG_START_DND = -1, DRAG_CHAR = 0, DRAG_WORD = 1, DRAG_LINE = 2 }</td>
    <td>&nbsp;</td>
  </tr>

  <tr>
    <td>enum { WRAP_NONE, WRAP_AT_COLUMN, WRAP_AT_PIXEL, WRAP_AT_BOUNDS }</td>
    <td>Wrap_Mode</td>
  </tr>

  <tr>
    <td>Unfinished_Style_Cb</td>
    <td>Unfinished_Style_Callback</td>
  </tr>

  <tr>
    <td>Style_Table_Entry</td>
    <td>Style_Entry</td>
  </tr>

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

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

</table>



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

  <tr>
<td><pre>
Fl_Text_Display(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_Display;
</pre></td>
  </tr>

  <tr>
<td><pre>
void buffer(Fl_Text_Buffer *buf);
void buffer(Fl_Text_Buffer &buf);
</pre></td>
<td><pre>
procedure Set_Buffer
       (This : in out Text_Display;
        Buff : in out FLTK.Text_Buffers.Text_Buffer);
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Text_Buffer * buffer() const;
</pre></td>
<td><pre>
function Get_Buffer
       (This : in Text_Display)
    return FLTK.Text_Buffers.Text_Buffer_Reference;
</pre></td>
  </tr>

  <tr>
<td><pre>
double col_to_x(double col) const;
</pre></td>
<td><pre>
function Col_To_X
       (This    : in Text_Display;
        Col_Num : in Integer)
    return Integer;
</pre></td>
  </tr>

  <tr>
<td><pre>
int count_lines(int start, int end, bool start_pos_is_line_start) const;
</pre></td>
<td><pre>
function Count_Lines
       (This                    : in Text_Display;
        Start, Finish           : in Natural;
        Start_Pos_Is_Line_Start : in Boolean := False)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Color cursor_color() const;
</pre></td>
<td><pre>
function Get_Cursor_Color
       (This : in Text_Display)
    return Color;
</pre></td>
  </tr>

  <tr>
<td><pre>
void cursor_color(Fl_Color n);
</pre></td>
<td><pre>
procedure Set_Cursor_Color
       (This : in out Text_Display;
        Col  : in     Color);
</pre></td>
  </tr>

  <tr>
<td><pre>
void cursor_style(int style);
</pre></td>
<td><pre>
procedure Set_Cursor_Style
       (This  : in out Text_Display;
        Style : in     Cursor_Style);
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual void draw();
</pre></td>
<td><pre>
procedure Draw
       (This : in out Text_Display);
</pre></td>
  </tr>

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

  <tr>
<td><pre>
void hide_cursor();
</pre></td>
<td><pre>
procedure Hide_Cursor
       (This : in out Text_Display);
</pre></td>
  </tr>

  <tr>
<td><pre>
void highlight_data
   (Fl_Text_Buffer *styleBuffer,
    const Style_Table_Entry *styleTable,
    int nStyles,
    char unfinishedStyle,
    Unfinished_Style_Cb unfinishedHighlightCB,
    void *cbArg);
</pre></td>
<td><pre>
procedure Highlight_Data
       (This  : in out Text_Display;
        Buff  : in out FLTK.Text_Buffers.Text_Buffer;
        Table : in     Styles.Style_Array);

procedure Highlight_Data
       (This       : in out Text_Display;
        Buff       : in out FLTK.Text_Buffers.Text_Buffer;
        Table      : in     Styles.Style_Array;
        Unfinished : in     Styles.Style_Index;
        Callback   : in     Styles.Unfinished_Style_Callback);
</pre></td>
  </tr>

  <tr>
<td><pre>
int in_selection(int x, int y) const;
</pre></td>
<td><pre>
function In_Selection
       (This : in Text_Display;
        X, Y : in Integer)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
void insert(const char *text);
</pre></td>
<td><pre>
procedure Insert_Text
       (This : in out Text_Display;
        Item : in     String);
</pre></td>
  </tr>

  <tr>
<td><pre>
void insert_position(int newPos);
</pre></td>
<td><pre>
procedure Set_Insert_Position
       (This : in out Text_Display;
        Pos  : in     Natural);
</pre></td>
  </tr>

  <tr>
<td><pre>
int insert_position() const;
</pre></td>
<td><pre>
function Get_Insert_Position
       (This : in Text_Display)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td>&nbsp;</td>
<td><pre>
function Item
       (Tint : in Color;
        Font : in Font_Kind;
        Size : in Font_Size)
    return Style_Entry;
</pre></td>
  </tr>

  <tr>
<td><pre>
int line_end(int startPos, bool startPosIsLineStart) const;
</pre></td>
<td><pre>
function Line_End
       (This                    : in Text_Display;
        Pos                     : in Natural;
        Start_Pos_Is_Line_Start : in Boolean := False)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
int line_start(int pos) const;
</pre></td>
<td><pre>
function Line_Start
       (This : in Text_Display;
        Pos  : in Natural)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
void linenumber_align(Fl_Align val);
</pre></td>
<td><pre>
procedure Set_Linenumber_Alignment
       (This : in out Text_Display;
        To   : in     Alignment);
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Align linenumber_align() const;
</pre></td>
<td><pre>
function Get_Linenumber_Alignment
       (This : in Text_Display)
    return Alignment;
</pre></td>
  </tr>

  <tr>
<td><pre>
void linenumber_bgcolor(Fl_Color val);
</pre></td>
<td><pre>
procedure Set_Linenumber_Back_Color
       (This : in out Text_Display;
        To   : in     Color);
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Color linenumber_bgcolor() const;
</pre></td>
<td><pre>
function Get_Linenumber_Back_Color
       (This : in Text_Display)
    return Color;
</pre></td>
  </tr>

  <tr>
<td><pre>
void linenumber_fgcolor(Fl_Color val);
</pre></td>
<td><pre>
procedure Set_Linenumber_Fore_Color
       (This : in out Text_Display;
        To   : in     Color);
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Color linenumber_fgcolor() const;
</pre></td>
<td><pre>
function Get_Linenumber_Fore_Color
       (This : in Text_Display)
    return Color;
</pre></td>
  </tr>

  <tr>
<td><pre>
void linenumber_font(Fl_Font val);
</pre></td>
<td><pre>
procedure Set_Linenumber_Font
       (This : in out Text_Display;
        To   : in     Font_Kind);
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Font linenumber_font() const;
</pre></td>
<td><pre>
function Get_Linenumber_Font
       (This : in Text_Display)
    return Font_Kind;
</pre></td>
  </tr>

  <tr>
<td><pre>
void linenumber_format(const char *val);
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
const char * linenumber_format() const;
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
void linenumber_size(Fl_Fontsize val);
</pre></td>
<td><pre>
procedure Set_Linenumber_Size
       (This : in out Text_Display;
        To   : in     Font_Size);
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Fontsize linenumber_size() const;
</pre></td>
<td><pre>
function Get_Linenumber_Size
       (This : in Text_Display)
    return Font_Size;
</pre></td>
  </tr>

  <tr>
<td><pre>
void linenumber_width(int width);
</pre></td>
<td><pre>
procedure Set_Linenumber_Width
       (This  : in out Text_Display;
        Width : in     Natural);
</pre></td>
  </tr>

  <tr>
<td><pre>
int linenumber_width() const;
</pre></td>
<td><pre>
function Get_Linenumber_Width
       (This : in Text_Display)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
int move_down();
</pre></td>
<td><pre>
procedure Move_Down
       (This : in out Text_Display);
</pre></td>
  </tr>

  <tr>
<td><pre>
int move_left();
</pre></td>
<td><pre>
procedure Move_Left
       (This : in out Text_Display);
</pre></td>
  </tr>

  <tr>
<td><pre>
int move_right();
</pre></td>
<td><pre>
procedure Move_Right
       (This : in out Text_Display);
</pre></td>
  </tr>

  <tr>
<td><pre>
int move_up();
</pre></td>
<td><pre>
procedure Move_Up
       (This : in out Text_Display);
</pre></td>
  </tr>

  <tr>
<td><pre>
void next_word(void);
</pre></td>
<td><pre>
procedure Next_Word
       (This : in out Text_Display);
</pre></td>
  </tr>

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

  <tr>
<td><pre>
int position_style(int lineStartPos, int lineLen, int lineIndex) const;
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
int position_to_xy(int pos, int *x, int *y) const;
</pre></td>
<td><pre>
procedure Position_To_XY
       (This     : in     Text_Display;
        Pos      : in     Integer;
        X, Y     :    out Integer;
        Vert_Out :    out Boolean);
</pre></td>
  </tr>

  <tr>
<td><pre>
void previous_word(void);
</pre></td>
<td><pre>
procedure Previous_Word
       (This : in out Text_Display);
</pre></td>
  </tr>

  <tr>
<td><pre>
void redisplay_range(int start, int end);
</pre></td>
<td><pre>
procedure Redisplay_Range
       (This          : in out Text_Display;
        Start, Finish : in     Natural);
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual void resize(int X, int Y, int W, int H);
</pre></td>
<td>&nbsp;</td>
  </tr>

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

  <tr>
<td><pre>
void scroll(int topLineNum, int horizOffset);
</pre></td>
<td><pre>
procedure Scroll_To
       (This : in out Text_Display;
        Line : in     Natural);
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Align scrollbar_align() const;
</pre></td>
<td><pre>
function Get_Scrollbar_Alignment
       (This : in Text_Display)
    return Alignment;
</pre></td>
  </tr>

  <tr>
<td><pre>
void scrollbar_align(Fl_Align a);
</pre></td>
<td><pre>
procedure Set_Scrollbar_Alignment
       (This  : in out Text_Display;
        Align : in     Alignment);
</pre></td>
  </tr>

  <tr>
<td><pre>
int scrollbar_width() const;
</pre></td>
<td><pre>
function Get_Scrollbar_Width
       (This : in Text_Display)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
void scrollbar_width(int W);
</pre></td>
<td><pre>
procedure Set_Scrollbar_Width
       (This  : in out Text_Display;
        Width : in     Natural);
</pre></td>
  </tr>

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

  <tr>
<td><pre>
void shortcut(int s);
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
void show_cursor(int b=1);
</pre></td>
<td><pre>
procedure Show_Cursor
       (This : in out Text_Display);
</pre></td>
  </tr>

  <tr>
<td><pre>
void show_insert_position();
</pre></td>
<td><pre>
procedure Show_Insert_Position
       (This : in out Text_Display);
</pre></td>
  </tr>

  <tr>
<td><pre>
int skip_lines(int startPos, int nLines, bool startPosIsLineStart);
</pre></td>
<td><pre>
function Skip_Lines
       (This                    : in Text_Display;
        Start, Lines            : in Natural;
        Start_Pos_Is_Line_Start : in Boolean := False)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Color textcolor() const;
</pre></td>
<td><pre>
function Get_Text_Color
       (This : in Text_Display)
    return Color;
</pre></td>
  </tr>

  <tr>
<td><pre>
void textcolor(Fl_Color n);
</pre></td>
<td><pre>
procedure Set_Text_Color
       (This : in out Text_Display;
        Col  : in     Color);
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Font textfont() const;
</pre></td>
<td><pre>
function Get_Text_Font
       (This : in Text_Display)
    return Font_Kind;
</pre></td>
  </tr>

  <tr>
<td><pre>
void textfont(Fl_Font s);
</pre></td>
<td><pre>
procedure Set_Text_Font
       (This : in out Text_Display;
        Font : in     Font_Kind);
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Fontsize textsize() const;
</pre></td>
<td><pre>
function Get_Text_Size
       (This : in Text_Display)
    return Font_Size;
</pre></td>
  </tr>

  <tr>
<td><pre>
void textsize(Fl_Fontsize s);
</pre></td>
<td><pre>
procedure Set_Text_Size
       (This : in out Text_Display;
        Size : in     Font_Size);
</pre></td>
  </tr>

  <tr>
<td><pre>
int word_end(int pos) const;
</pre></td>
<td><pre>
function Word_End
       (This : in out Text_Display;
        Pos  : in     Natural)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
int word_start(int pos) const;
</pre></td>
<td><pre>
function Word_Start
       (This : in out Text_Display;
        Pos  : in     Natural)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
void wrap_mode(int wrap, int wrap_margin);
</pre></td>
<td><pre>
procedure Set_Wrap_Mode
       (This   : in out Text_Display;
        Mode   : in     Wrap_Mode;
        Margin : in     Natural := 0);
</pre></td>
  </tr>

  <tr>
<td><pre>
int wrapped_column(int row, int column) const;
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
int wrapped_row(int row) const;
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
double x_to_col(double x) const;
</pre></td>
<td><pre>
function X_To_Col
       (This  : in Text_Display;
        X_Pos : in Integer)
    return Integer;
</pre></td>
  </tr>

</table>


  </body>
</html>