summaryrefslogtreecommitdiff
path: root/doc/fl_file_chooser.html
blob: 15b138080ca6a9f1045d720128b3bf050f6f0980 (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_File_Chooser Binding Map</title>
    <link href="map.css" rel="stylesheet">
  </head>

  <body>


<h2>Fl_File_Chooser 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_File_Chooser</td>
    <td>FLTK.File_Choosers</td>
  </tr>

</table>

<p><b>Note:</b><br /><br />
See Fl_Ask for related symbols that are not members of the Fl_File_Chooser class.</p>



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

  <tr>
    <td>Fl_File_Chooser</td>
    <td>File_Chooser</td>
  </tr>

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

  <tr>
    <td>enum {SINGLE=0, MULTI=1, CREATE=2, DIRECTORY=4}</td>
    <td>Chooser_Kind</td>
  </tr>

  <tr>
    <td>void (*cb)(Fl_File_Chooser *, void *)</td>
    <td>Chooser_Callback</td>
  </tr>

  <tr>
    <td>uchar</td>
    <td>Icon_Size</td>
  </tr>

</table>



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

  <tr>
<td><pre>
static const char * add_favorites_label = "Add to Favorites";
</pre></td>
<td><pre>
function Get_Add_Favorites_Label
    return String;

procedure Set_Add_Favorites_Label
       (Value : in String);
</pre></td>
  </tr>

  <tr>
<td><pre>
static const char * all_files_label = "All Files (*)";
</pre></td>
<td><pre>
function Get_All_Files_Label
    return String;

procedure Set_All_Files_Label
       (Value : in String);
</pre></td>
  </tr>

  <tr>
<td><pre>
static const char * custom_filter_label = "Custom Filter";
</pre></td>
<td><pre>
function Get_Custom_Filter_Label
    return String;

procedure Set_Custom_Filter_Label
       (Value : in String);
</pre></td>
  </tr>

  <tr>
<td><pre>
static const char * existing_file_label =
    "Please choose an existing file!";
</pre></td>
<td><pre>
function Get_Existing_File_Label
    return String;

procedure Set_Existing_File_Label
       (Value : in String);
</pre></td>
  </tr>

  <tr>
<td><pre>
static const char * favorites_label = "Favorites";
</pre></td>
<td><pre>
function Get_Favorites_Label
    return String;

procedure Set_Favorites_Label
       (Value : in String);
</pre></td>
  </tr>

  <tr>
<td><pre>
static const char * filename_label = "Filename:";
</pre></td>
<td><pre>
function Get_Filename_Label
    return String;

procedure Set_Filename_Label
       (Value : in String);
</pre></td>
  </tr>

  <tr>
<td><pre>
static const char * filesystems_label = "File Systems";
</pre></td>
<td><pre>
function Get_Filesystems_Label
    return String;

procedure Set_Filesystems_Label
       (Value : in String);
</pre></td>
  </tr>

  <tr>
<td><pre>
static const char * hidden_label = "Show hidden files";
</pre></td>
<td><pre>
function Get_Hidden_Label
    return String;

procedure Set_Hidden_Label
       (Value : in String);
</pre></td>
  </tr>

  <tr>
<td><pre>
static const char * manage_favorites_label =
    "Manage Favorites";
</pre></td>
<td><pre>
function Get_Manage_Favorites_Label
    return String;

procedure Set_Manage_Favorites_Label
       (Value : in String);
</pre></td>
  </tr>

  <tr>
<td><pre>
static const char * new_directory_label = "New Directory?";
</pre></td>
<td><pre>
function Get_New_Directory_Label
    return String;

procedure Set_New_Directory_Label
       (Value : in String);
</pre></td>
  </tr>

  <tr>
<td><pre>
static const char * new_directory_tooltip =
    "Create a new directory.";
</pre></td>
<td><pre>
function Get_New_Directory_Tooltip
    return String;

procedure Set_New_Directory_Tooltip
       (Value : in String);
</pre></td>
  </tr>

  <tr>
<td><pre>
static const char * preview_label = "Preview";
</pre></td>
<td><pre>
function Get_Preview_Label
    return String;

procedure Set_Preview_Label
       (Value : in String);
</pre></td>
  </tr>

  <tr>
<td><pre>
static const char * save_label = "Save";
</pre></td>
<td><pre>
function Get_Save_Label
    return String;

procedure Set_Save_Label
       (Value : in String);
</pre></td>
  </tr>

  <tr>
<td><pre>
static const char * show_label = "Show:";
</pre></td>
<td><pre>
function Get_Show_Label
    return String;

procedure Set_Show_Label
       (Value : in String);
</pre></td>
  </tr>

  <tr>
<td><pre>
static Fl_File_Sort_F * sort = fl_numericsort;
</pre></td>
<td><pre>
Sort_Method : not null FLTK.Filenames.Compare_Function :=
    FLTK.Filenames.Numeric_Sort'Access;
</pre></td>
  </tr>

</table>



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

  <tr>
<td><pre>
Fl_Button * newButton;
</pre></td>
<td><pre>
function New_Button
       (This : in out File_Chooser)
    return FLTK.Widgets.Buttons.Button_Reference;
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Check_Button * previewButton;
</pre></td>
<td><pre>
function Preview_Button
       (This : in out File_Chooser)
    return FLTK.Widgets.Buttons.Light.Check.Check_Button_Reference;
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Check_Button * showHiddenButton;
</pre></td>
<td><pre>
function Show_Hidden_Button
       (This : in out File_Chooser)
    return FLTK.Widgets.Buttons.Light.Check.Check_Button_Reference;
</pre></td>
  </tr>

</table>



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

  <tr>
<td><pre>
Fl_File_Chooser(const char *d, const char *p, int t,
    const char *title);
</pre></td>
<td><pre>
function Create
       (Title    : in String;
        Pattern  : in String;
        Pathname : in String;
        Kind     : in Chooser_Kind := Single)
    return File_Chooser;
</pre></td>
  </tr>

</table>



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

  <tr>
<td><pre>
Fl_Widget * add_extra(Fl_Widget *gr);
</pre></td>
<td><pre>
procedure Add_Extra
       (This : in out File_Chooser;
        Item : in out Widgets.Widget'Class);

procedure Remove_Extra
       (This : in out File_Chooser);

function Eject_Extra
       (This : in out File_Chooser;
        Item : in out Widgets.Widget'Class)
    return access Widgets.Widget'Class;
</pre></td>
  </tr>

  <tr>
<td><pre>
void callback(void(*cb)(Fl_File_Chooser *, void *), void *d=0);
</pre></td>
<td><pre>
procedure Set_Callback
       (This : in out File_Chooser;
        Func : in     Chooser_Callback);
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Color color();
</pre></td>
<td><pre>
function Get_Background_Color
       (This : in File_Chooser)
    return Color;
</pre></td>
  </tr>

  <tr>
<td><pre>
void color(Fl_Color c);
</pre></td>
<td><pre>
procedure Set_Background_Color
       (This  : in out File_Chooser;
        Value : in     Color);
</pre></td>
  </tr>

  <tr>
<td><pre>
int count();
</pre></td>
<td><pre>
function Number_Selected
       (This : in File_Chooser)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
char * directory();
</pre></td>
<td><pre>
function Get_Directory
       (This : in File_Chooser)
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
void directory(const char *d);
</pre></td>
<td><pre>
procedure Set_Directory
       (This  : in out File_Chooser;
        Value : in     String);
</pre></td>
  </tr>

  <tr>
<td><pre>
const char * filter();
</pre></td>
<td><pre>
function Get_Filter
       (This : in File_Chooser)
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
void filter(const char *p);
</pre></td>
<td><pre>
procedure Set_Filter
       (This  : in out File_Chooser;
        Value : in     String);
</pre></td>
  </tr>

  <tr>
<td><pre>
int filter_value();
</pre></td>
<td><pre>
function Get_Filter_Index
       (This : in File_Chooser)
    return Positive;
</pre></td>
  </tr>

  <tr>
<td><pre>
void filter_value(int f);
</pre></td>
<td><pre>
procedure Set_Filter_Index
       (This  : in out File_Chooser;
        Value : in     Positive);
</pre></td>
  </tr>

  <tr>
<td><pre>
void hide();
</pre></td>
<td><pre>
procedure Hide
       (This : in out File_Chooser);
</pre></td>
  </tr>

  <tr>
<td><pre>
uchar iconsize();
</pre></td>
<td><pre>
function Get_Icon_Size
       (This : in File_Chooser)
    return Icon_Size;
</pre></td>
  </tr>

  <tr>
<td><pre>
void iconsize(uchar s);
</pre></td>
<td><pre>
procedure Set_Icon_Size
       (This  : in out File_Chooser;
        Value : in     Icon_Size);
</pre></td>
  </tr>

  <tr>
<td><pre>
const char * label();
</pre></td>
<td><pre>
function Get_Label
       (This : in File_Chooser)
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
void label(const char *l);
</pre></td>
<td><pre>
procedure Set_Label
       (This : in out File_Chooser;
        Text : in     String);
</pre></td>
  </tr>

  <tr>
<td><pre>
const char * ok_label();
</pre></td>
<td><pre>
function Get_OK_Label
       (This : in File_Chooser)
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
void ok_label(const char *l);
</pre></td>
<td><pre>
procedure Set_OK_Label
       (This : in out File_Chooser;
        Text : in     String);
</pre></td>
  </tr>

  <tr>
<td><pre>
int preview() const;
</pre></td>
<td><pre>
function Has_Preview
       (This : in File_Chooser)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
void preview(int e);
</pre></td>
<td><pre>
procedure Set_Preview
       (This  : in out File_Chooser;
        Value : in     Boolean);
</pre></td>
  </tr>

  <tr>
<td><pre>
void rescan();
</pre></td>
<td><pre>
procedure Rescan
       (This : in out File_Chooser);
</pre></td>
  </tr>

  <tr>
<td><pre>
void rescan_keep_filename();
</pre></td>
<td><pre>
procedure Rescan_Keep_Filename
       (This : in out File_Chooser);
</pre></td>
  </tr>

  <tr>
<td><pre>
void show();
</pre></td>
<td><pre>
procedure Show
       (This : in out File_Chooser);
</pre></td>
  </tr>

  <tr>
<td><pre>
int shown();
</pre></td>
<td><pre>
function Is_Shown
       (This : in File_Chooser)
    return Boolean;
</pre></td>
  </tr>

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

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

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

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

  <tr>
<td><pre>
Fl_Fontsize textsize();
</pre></td>
<td><pre>
function Get_Text_Size
       (This : in File_Chooser)
    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 File_Chooser;
        Size : in     Font_Size);
</pre></td>
  </tr>

  <tr>
<td><pre>
int type();
</pre></td>
<td><pre>
function Get_Chooser_Kind
       (This : in File_Chooser)
    return Chooser_Kind;
</pre></td>
  </tr>

  <tr>
<td><pre>
void type(int t);
</pre></td>
<td><pre>
procedure Set_Chooser_Kind
       (This : in out File_Chooser;
        Kind : in     Chooser_Kind);
</pre></td>
  </tr>

  <tr>
<td><pre>
void * user_data() const;
</pre></td>
<td>Not used in public API.</td>
  </tr>

  <tr>
<td><pre>
void user_data(void *d);
</pre></td>
<td>Not used in public API.</td>
  </tr>

  <tr>
<td><pre>
void value(const char *filename);
</pre></td>
<td><pre>
procedure Set_Selected
       (This  : in out File_Chooser;
        Value : in     String);
</pre></td>
  </tr>

  <tr>
<td><pre>
const char * value(int f=1);
</pre></td>
<td><pre>
function Get_Selected
       (This  : in File_Chooser;
        Index : in Positive := 1)
    return String
with Pre => Index <= This.Number_Selected;
</pre></td>
  </tr>

  <tr>
<td><pre>
int visible();
</pre></td>
<td><pre>
function Is_Visible
       (This : in File_Chooser)
    return Boolean;
</pre></td>
  </tr>

</table>


  </body>
</html>