summaryrefslogtreecommitdiff
path: root/doc/fl_browser_.html
blob: d69d36852faf34f9ca103d68a3dab51e9a159770 (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

<!DOCTYPE html>

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

  <body>


<h2>Fl_Browser_ 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_Browser_</td>
    <td>FLTK.Widgets.Groups.Browsers</td>
  </tr>

</table>

<p><b>Note:</b><br /><br />
As the name suggests, you will likely never actually touch Abstract_Browser directly.
Only through using or creating types derived from it.</p>



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

  <tr>
    <td>Fl_Browser_</td>
    <td>Abstract_Browser</td>
  </tr>

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

  <tr>
    <td>enum mode</td>
    <td>Scrollbar_Mode</td>
  </tr>

  <tr>
    <td>void *</td>
    <td>Item_Cursor</td>
  </tr>

  <tr>
    <td>int flags</td>
    <td>Sort_Order</td>
  </tr>

</table>



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

  <tr>
<td><pre>
Fl_Scrollbar hscrollbar;
</pre></td>
<td><pre>
function H_Bar
       (This : in out Abstract_Browser)
    return Valuators.Sliders.Scrollbars.Scrollbar_Reference;
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Scrollbar scrollbar;
</pre></td>
<td><pre>
function V_Bar
       (This : in out Abstract_Browser)
    return Valuators.Sliders.Scrollbars.Scrollbar_Reference;
</pre></td>
  </tr>

</table>



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

  <tr>
<td><pre>
Fl_Browser_(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 Abstract_Browser;
</pre></td>
  </tr>

</table>



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

  <tr>
<td><pre>
int deselect(int docallbacks=0);
</pre></td>
<td><pre>
function Deselect
       (This         : in out Abstract_Browser;
        Do_Callbacks : in     Boolean := False)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
void display(void *item);
</pre></td>
<td><pre>
procedure Display
       (This : in out Abstract_Browser;
        Item : in     Item_Cursor);
</pre></td>
  </tr>

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

  <tr>
<td><pre>
uchar has_scrollbar() const;
</pre></td>
<td><pre>
function Get_Scrollbar_Mode
       (This : in Abstract_Browser)
    return Scrollbar_Mode;
</pre></td>
  </tr>

  <tr>
<td><pre>
void has_scrollbar(uchar mode);
</pre></td>
<td><pre>
procedure Set_Scrollbar_Mode
       (This : in out Abstract_Browser;
        Mode : in     Scrollbar_Mode);
</pre></td>
  </tr>

  <tr>
<td><pre>
int hposition() const;
</pre></td>
<td><pre>
function Get_H_Position
       (This : in Abstract_Browser)
    return Integer;
</pre></td>
  </tr>

  <tr>
<td><pre>
void hposition(int);
</pre></td>
<td><pre>
procedure Set_H_Position
       (This  : in out Abstract_Browser;
        Value : in     Integer);
</pre></td>
  </tr>

  <tr>
<td><pre>
int position() const;
</pre></td>
<td><pre>
function Get_V_Position
       (This : in Abstract_Browser)
    return Integer;
</pre></td>
  </tr>

  <tr>
<td><pre>
void position(int pos);
</pre></td>
<td><pre>
procedure Set_V_Position
       (This  : in out Abstract_Browser;
        Value : in     Integer);
</pre></td>
  </tr>

  <tr>
<td><pre>
void resize(int X, int Y, int W, int H);
</pre></td>
<td><pre>
procedure Resize
       (This       : in out Abstract_Browser;
        X, Y, W, H : in     Integer);
</pre></td>
  </tr>

  <tr>
<td><pre>
void scrollbar_left();
</pre></td>
<td><pre>
procedure Set_Vertical_Left
       (This : in out Abstract_Browser);
</pre></td>
  </tr>

  <tr>
<td><pre>
void scrollbar_right();
</pre></td>
<td><pre>
procedure Set_Vertical_Right
       (This : in out Abstract_Browser);
</pre></td>
  </tr>

  <tr>
<td><pre>
int scrollbar_size() const;
</pre></td>
<td><pre>
function Get_Scrollbar_Size
       (This : in Abstract_Browser)
    return Integer;
</pre></td>
  </tr>

  <tr>
<td><pre>
void scrollbar_size(int newSize);
</pre></td>
<td><pre>
procedure Set_Scrollbar_Size
       (This  : in out Abstract_Browser;
        Value : in     Integer);
</pre></td>
  </tr>

  <tr>
<td><pre>
int scrollbar_width() const;
</pre></td>
<td>Deprecated, see scrollbar_size</td>
  </tr>

  <tr>
<td><pre>
void scrollbar_width(int width);
</pre></td>
<td>Deprecated, see scrollbar_size</td>
  </tr>

  <tr>
<td><pre>
int select(void *item, int val=1, int docallbacks=0);
</pre></td>
<td><pre>
function Set_Select
       (This         : in out Abstract_Browser;
        Item         : in     Item_Cursor;
        State        : in     Boolean := True;
        Do_Callbacks : in     Boolean := False)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
int select_only(void *item, int docallbacks=0);
</pre></td>
<td><pre>
function Select_Only
       (This         : in out Abstract_Browser;
        Item         : in     Item_Cursor;
        Do_Callbacks : in     Boolean := False)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
void sort(int flags=0);
</pre></td>
<td><pre>
procedure Sort
       (This  : in out Abstract_Browser;
        Order : in     Sort_Order);
</pre></td>
  </tr>

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

  <tr>
<td><pre>
void textcolor(Fl_Color col);
</pre></td>
<td><pre>
procedure Set_Text_Color
       (This  : in out Abstract_Browser;
        Value : in     Color);
</pre></td>
  </tr>

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

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

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

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

</table>



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

  <tr>
<td><pre>
void bbox(int &X, int &Y, int &W, int &H) const;
</pre></td>
<td><pre>
procedure Bounding_Box
       (This       : in     Abstract_Browser;
        X, Y, W, H :    out Integer);
</pre></td>
  </tr>

  <tr>
<td><pre>
void deleting(void *item);
</pre></td>
<td><pre>
procedure Deleting
       (This : in out Abstract_Browser;
        Item : in     Item_Cursor);
</pre></td>
  </tr>

  <tr>
<td><pre>
int displayed(void *item) const;
</pre></td>
<td><pre>
function Is_Displayed
       (This : in Abstract_Browser;
        Item : in Item_Cursor)
    return Boolean;
</pre></td>
  </tr>

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

  <tr>
<td><pre>
void * find_item(int ypos);
</pre></td>
<td><pre>
function Find_Item
       (This  : in Abstract_Browser;
        Y_Pos : in Integer)
    return Item_Cursor;
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual int full_height() const;
</pre></td>
<td><pre>
function Full_List_Height
       (This : in Abstract_Browser)
    return Integer;
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual int full_width() const;
</pre></td>
<td><pre>
function Full_List_Width
       (This : in Abstract_Browser)
    return Integer;
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual int incr_height() const;
</pre></td>
<td><pre>
function Average_Item_Height
       (This : in Abstract_Browser)
    return Integer;
</pre></td>
  </tr>

  <tr>
<td><pre>
void inserting(void *a, void *b);
</pre></td>
<td><pre>
procedure Inserting
       (This : in out Abstract_Browser;
        A, B : in     Item_Cursor);
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual void * item_at(int index) const;
</pre></td>
<td><pre>
function Item_At
       (This  : in Abstract_Browser;
        Index : in Positive)
    return Item_Cursor;
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual void item_draw(void *item,
    int X, int Y, int W, int H) const =0;
</pre></td>
<td><pre>
procedure Item_Draw
       (This       : in Abstract_Browser;
        Item       : in Item_Cursor;
        X, Y, W, H : in Integer);
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual void * item_first() const =0;
</pre></td>
<td><pre>
function Item_First
       (This : in Abstract_Browser)
    return Item_Cursor;
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual int item_height(void *item) const =0;
</pre></td>
<td><pre>
function Item_Height
       (This : in Abstract_Browser;
        Item : in Item_Cursor)
    return Integer;
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual void * item_last() const;
</pre></td>
<td><pre>
function Item_Last
       (This : in Abstract_Browser)
    return Item_Cursor;
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual void * item_next(void *item) const =0;
</pre></td>
<td><pre>
function Item_Next
       (This : in Abstract_Browser;
        Item : in Item_Cursor)
    return Item_Cursor;
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual void * item_prev(void *item) const =0;
</pre></td>
<td><pre>
function Item_Previous
       (This : in Abstract_Browser;
        Item : in Item_Cursor)
    return Item_Cursor;
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual int item_quick_height(void *item) const;
</pre></td>
<td><pre>
function Item_Quick_Height
       (This : in Abstract_Browser;
        Item : in Item_Cursor)
    return Integer;
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual void item_select(void *item, int val=1);
</pre></td>
<td><pre>
procedure Item_Select
       (This  : in out Abstract_Browser;
        Item  : in     Item_Cursor;
        State : in     Boolean := True);
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual int item_selected(void *item) const;
</pre></td>
<td><pre>
function Item_Selected
       (This : in Abstract_Browser;
        Item : in Item_Cursor)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual void item_swap(void *a, void *b);
</pre></td>
<td><pre>
procedure Item_Swap
       (This : in out Abstract_Browser;
        A, B : in     Item_Cursor);
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual const char * item_text(void *item) const;
</pre></td>
<td><pre>
function Item_Text
       (This : in Abstract_Browser;
        Item : in Item_Cursor)
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
virtual int item_width(void *item) const =0;
</pre></td>
<td><pre>
function Item_Width
       (This : in Abstract_Browser;
        Item : in Item_Cursor)
    return Integer;
</pre></td>
  </tr>

  <tr>
<td><pre>
int leftedge() const;
</pre></td>
<td><pre>
function Left_Edge
       (This : in Abstract_Browser)
    return Integer;
</pre></td>
  </tr>

  <tr>
<td><pre>
void new_list();
</pre></td>
<td><pre>
procedure New_List
       (This : in out Abstract_Browser);
</pre></td>
  </tr>

  <tr>
<td><pre>
void redraw_line(void *item);
</pre></td>
<td><pre>
procedure Redraw_Line
       (This : in out Abstract_Browser;
        Item : in     Item_Cursor);
</pre></td>
  </tr>

  <tr>
<td><pre>
void redraw_lines();
</pre></td>
<td><pre>
procedure Redraw_List
       (This : in out Abstract_Browser);
</pre></td>
  </tr>

  <tr>
<td><pre>
void replacing(void *a, void *b);
</pre></td>
<td><pre>
procedure Replacing
       (This : in out Abstract_Browser;
        A, B : in     Item_Cursor);
</pre></td>
  </tr>

  <tr>
<td><pre>
void * selection() const;
</pre></td>
<td><pre>
function Current_Selection
       (This : in Abstract_Browser)
    return Item_Cursor;
</pre></td>
  </tr>

  <tr>
<td><pre>
void swapping(void *a, void *b);
</pre></td>
<td><pre>
procedure Swapping
       (This : in out Abstract_Browser;
        A, B : in     Item_Cursor);
</pre></td>
  </tr>

  <tr>
<td><pre>
void * top() const;
</pre></td>
<td><pre>
function Top_Item
       (This : in Abstract_Browser)
    return Item_Cursor;
</pre></td>
  </tr>

</table>



  </body>
</html>