summaryrefslogtreecommitdiff
path: root/doc/fl_menu_.html
blob: 5099d2eedee4106081514b43889c53e37d630425 (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
<!DOCTYPE html>

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

  <body>


<h2>Fl_Menu_ 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_Menu_</td>
    <td>FLTK.Widgets.Menus</td>
  </tr>

</table>

<p><b>Note:</b><br /><br />
This Menu type should really be abstract but cannot be for technical binding reasons.
If you try to use it directly you will get issues with the draw and handle methods.
Either extend it and override those subprograms or use types already extended from it.</p>



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

  <tr>
    <td>Fl_Menu_</td>
    <td>Menu</td>
  </tr>

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

  <tr>
    <td>int</td>
    <td>Index</td>
  </tr>

  <tr>
    <td>int</td>
    <td>Extended_Index</td>
  </tr>

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

</table>



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

  <tr>
<td>NULL</td>
<td>No_Reference_Error</td>
  </tr>

</table>



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

  <tr>
<td><pre>
uchar alloc;
</pre></td>
<td>Intentionally left unbound.</td>
  </tr>

  <tr>
<td><pre>
uchar down_box_;
</pre></td>
<td>Intentionally left unbound.</td>
  </tr>

  <tr>
<td><pre>
Fl_Color textcolor_;
</pre></td>
<td>Intentionally left unbound.</td>
  </tr>

  <tr>
<td><pre>
Fl_Font textfont_;
</pre></td>
<td>Intentionally left unbound.</td>
  </tr>

  <tr>
<td><pre>
Fl_Fontsize textsize_;
</pre></td>
<td>Intentionally left unbound.</td>
  </tr>

</table>



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

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

</table>



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

  <tr>
<td><pre>
int add(const char *);
</pre></td>
<td><pre>
procedure Add
       (This : in out Menu;
        Text : in     String);

function Add
       (This : in out Menu;
        Text : in     String)
    return Index;
</pre></td>
  </tr>

  <tr>
<td><pre>
int add(const char *, int shortcut, Fl_Callback *,
    void *=0, int=0);
</pre></td>
<td><pre>
procedure Add
       (This     : in out Menu;
        Text     : in     String;
        Action   : in     Widget_Callback := null;
        Shortcut : in     Key_Combo := No_Key;
        Flags    : in     Menu_Flag := Flag_Normal);

function Add
       (This     : in out Menu;
        Text     : in     String;
        Action   : in     Widget_Callback := null;
        Shortcut : in     Key_Combo := No_Key;
        Flags    : in     Menu_Flag := Flag_Normal)
    return Index;
</pre></td>
  </tr>

  <tr>
<td><pre>
int add(const char *a, const char *b, Fl_Callback *c,
    void *d=0, int e=0);
</pre></td>
<td><pre>
procedure Add
       (This     : in out Menu;
        Text     : in     String;
        Action   : in     Widget_Callback := null;
        Shortcut : in     String;
        Flags    : in     Menu_Flag := Flag_Normal);

function Add
       (This     : in out Menu;
        Text     : in     String;
        Action   : in     Widget_Callback := null;
        Shortcut : in     String;
        Flags    : in     Menu_Flag := Flag_Normal)
    return Index;
</pre></td>
  </tr>

  <tr>
<td><pre>
void clear();
</pre></td>
<td><pre>
procedure Clear
       (This : in out Menu);
</pre></td>
  </tr>

  <tr>
<td><pre>
int clear_submenu(int index);
</pre></td>
<td><pre>
procedure Clear_Submenu
       (This  : in out Menu;
        Place : in     Index);
</pre></td>
  </tr>

  <tr>
<td><pre>
void copy(const Fl_Menu_Item *m, void *user_data=0);
</pre></td>
<td><pre>
procedure Set_Items
       (This  : in out Menu;
        Items : in     FLTK.Menu_Items.Menu_Item_Array);
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Boxtype down_box() const;
</pre></td>
<td><pre>
function Get_Down_Box
       (This : in Menu)
    return Box_Kind;
</pre></td>
  </tr>

  <tr>
<td><pre>
void down_box(Fl_Boxtyep b);
</pre></td>
<td><pre>
procedure Set_Down_Box
       (This : in out Menu;
        To   : in     Box_Kind);
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Color down_color() const;
</pre></td>
<td>See selection_color / Get_Selection_Color from Fl_Widget.</td>
  </tr>

  <tr>
<td><pre>
void down_color(unsigned c);
</pre></td>
<td>See selection_color / Set_Selection_Color from Fl_Widget.</td>
  </tr>

  <tr>
<td>See draw method in Fl_Menu_Item.</td>
<td><pre>
procedure Draw_Item
       (This       : in out Menu;
        Item       : in     Index;
        X, Y, W, H : in     Integer;
        Selected   : in     Boolean := False);
</pre></td>
  </tr>

  <tr>
<td><pre>
int find_index(const char *name) const;
</pre></td>
<td><pre>
function Find_Index
       (This : in Menu;
        Name : in String)
    return Extended_Index;
</pre></td>
  </tr>

  <tr>
<td><pre>
int find_index(const Fl_Menu_Item *item) const;
</pre></td>
<td><pre>
function Find_Index
       (This : in Menu;
        Item : in FLTK.Menu_Items.Menu_Item)
    return Extended_Index;
</pre></td>
  </tr>

  <tr>
<td><pre>
int find_index(Fl_Callback *cb) const;
</pre></td>
<td><pre>
function Find_Index
       (This   : in Menu;
        Action : in Widget_Callback)
    return Extended_Index;
</pre></td>
  </tr>

  <tr>
<td><pre>
const Fl_Menu_Item * find_item(const char *name);
</pre></td>
<td><pre>
function Find_Item
       (This : in Menu;
        Name : in String)
    return FLTK.Menu_Items.Menu_Item_Reference;
</pre></td>
  </tr>

  <tr>
<td><pre>
const Fl_Menu_Item * find_item(Fl_Callback *);
</pre></td>
<td><pre>
function Find_Item
       (This   : in Menu;
        Action : in Widget_Callback)
    return FLTK.Menu_Items.Menu_Item_Reference;
</pre></td>
  </tr>

  <tr>
<td>See find_shortcut in Fl_Menu_Item.</td>
<td><pre>
function Find_Shortcut
       (This        : in Menu;
        Require_Alt : in Boolean := False)
    return access FLTK.Menu_Items.Menu_Item'Class;

function Find_Shortcut
       (This        : in     Menu;
        Place       :    out Extended_Index;
        Require_Alt : in     Boolean := False)
    return access FLTK.Menu_Items.Menu_Item'Class;
</pre></td>
  </tr>

  <tr>
<td><pre>
void global();
</pre></td>
<td><pre>
procedure Make_Global
       (This : in out Menu);
</pre></td>
  </tr>

  <tr>
<td>Check index values against the size method manually.</td>
<td><pre>
function Has_Item
       (This  : in Menu;
        Place : in Index)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td>&nbsp;</td>
<td><pre>
function Has_Item
       (Place : in Cursor)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
int insert(int index, const char *, int shortcut,
    Fl_Callback *, void *=0, int=0);
</pre></td>
<td><pre>
procedure Insert
       (This     : in out Menu;
        Place    : in     Index;
        Text     : in     String;
        Action   : in     Widget_Callback := null;
        Shortcut : in     Key_Combo := No_Key;
        Flags    : in     Menu_Flag := Flag_Normal);

function Insert
       (This     : in out Menu;
        Place    : in     Index;
        Text     : in     String;
        Action   : in     Widget_Callback := null;
        Shortcut : in     Key_Combo := No_Key;
        Flags    : in     Menu_Flag := Flag_Normal)
    return Index;
</pre></td>
  </tr>

  <tr>
<td><pre>
int insert(int index, const char *a, const char *b,
    Fl_Callback *c, void *d=0, int e=0);
</pre></td>
<td><pre>
procedure Insert
       (This     : in out Menu;
        Place    : in     Index;
        Text     : in     String;
        Action   : in     Widget_Callback := null;
        Shortcut : in     String;
        Flags    : in     Menu_Flag := Flag_Normal);

function Insert
       (This     : in out Menu;
        Place    : in     Index;
        Text     : in     String;
        Action   : in     Widget_Callback := null;
        Shortcut : in     String;
        Flags    : in     Menu_Flag := Flag_Normal)
    return Index;
</pre></td>
  </tr>

  <tr>
<td>Use the menu method to access the menu item array and index it directly.</td>
<td><pre>
function Item
       (This  : in Menu;
        Place : in Index)
    return FLTK.Menu_Items.Menu_Item_Reference;
</pre></td>
  </tr>

  <tr>
<td>&nbsp;</td>
<td><pre>
function Item
       (This  : in Menu;
        Place : in Cursor)
    return FLTK.Menu_Items.Menu_Item_Reference;
</pre></td>
  </tr>

  <tr>
<td><pre>
int item_pathname(char *name, int namelen,
    const Fl_Menu_Item *finditem=0) const;
</pre></td>
<td><pre>
function Item_Pathname
       (This : in Menu)
    return String;

function Item_Pathname
       (This : in Menu;
        Item : in FLTK.Menu_Items.Menu_Item)
    return String;
</pre></td>
  </tr>

  <tr>
<td>&nbsp;</td>
<td><pre>
function Iterate
       (This : in Menu)
    return Menu_Iterators.Reversible_Iterator'Class;
</pre></td>
  </tr>

  <tr>
<td>See measure method in Fl_Menu_Item.</td>
<td><pre>
procedure Measure_Item
       (This : in     Menu;
        Item : in     Index;
        W, H :    out Integer);
</pre></td>
  </tr>

  <tr>
<td><pre>
const Fl_Menu_Item * menu() const;
</pre></td>
<td>Use Item or Iterate as necessary to access specific items or walk the array.</td>
  </tr>

  <tr>
<td><pre>
void menu(const Fl_Menu_Item *m);
</pre></td>
<td><pre>
procedure Use_Same_Items
       (This  : in out Menu;
        Donor : in     Menu'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
int mode(int i) const;
</pre></td>
<td><pre>
function Get_Flags
       (This  : in Menu
        Place : in Index)
    return Menu_Flag;
</pre></td>
  </tr>

  <tr>
<td><pre>
void mode(int i, int fl);
</pre></td>
<td><pre>
procedure Set_Flags
       (This  : in out Menu;
        Place : in     Index;
        Flags : in     Menu_Flag);
</pre></td>
  </tr>

  <tr>
<td><pre>
const Fl_Menu_Item * mvalue() const;
</pre></td>
<td><pre>
function Chosen
       (This : in Menu)
    return FLTK.Menu_Items.Menu_Item_Reference;
</pre></td>
  </tr>

  <tr>
<td><pre>
const Fl_Menu_Item * picked(const Fl_Menu_Item *);
</pre></td>
<td><pre>
procedure Picked
       (This : in out Menu;
        Item : in out FLTK.Menu_Items.Menu_Item);
</pre></td>
  </tr>

  <tr>
<td>See popup method in Fl_Menu_Item.</td>
<td><pre>
function Popup
       (This    : in Menu;
        X, Y    : in Integer;
        Title   : in String := "";
        Initial : in Extended_Index := No_Index)
    return Extended_Index;
</pre></td>
  </tr>

  <tr>
<td>See pulldown method in Fl_Menu_Item.</td>
<td><pre>
function Pulldown
       (This       : in Menu;
        X, Y, W, H : in Integer;
        Initial    : in Extended_Index := No_Index)
    return Extended_Index;
</pre></td>
  </tr>

  <tr>
<td><pre>
void remove(int);
</pre></td>
<td><pre>
procedure Remove
       (This  : in out Menu;
        Place : in     Index);
</pre></td>
  </tr>

  <tr>
<td><pre>
void replace(int, const char *);
</pre></td>
<td><pre>
procedure Set_Label
       (This  : in out Menu;
        Place : in     Index;
        Text  : in     String);
</pre></td>
  </tr>

  <tr>
<td><pre>
void setonly(Fl_Menu_Item *item);
</pre></td>
<td><pre>
procedure Set_Only
       (This : in out Menu;
        Item : in out Menu_Item);
</pre></td>
  </tr>

  <tr>
<td><pre>
void shortcut(int i, int s);
</pre></td>
<td><pre>
procedure Set_Shortcut
       (This  : in out Menu;
        Place : in     Index;
        Press : in     Key_Combo);
</pre></td>
  </tr>

  <tr>
<td><pre>
int size() const;
</pre></td>
<td><pre>
function Number_Of_Items
       (This : in Menu)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
void size(int W, int H);
</pre></td>
<td><pre>
procedure Resize
       (This : in out Menu;
        W, H : in     Integer);
</pre></td>
  </tr>

  <tr>
<td><pre>
const Fl_Menu_Item * test_shortcut();
</pre></td>
<td><pre>
function Test_Shortcut
       (This : in out Menu)
    return access FLTK.Menu_Items.Menu_Item'Class;
</pre></td>
  </tr>

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

  <tr>
<td><pre>
const char * text(int i) const;
</pre></td>
<td><pre>
function Get_Label
       (This  : in Menu;
        Place : in Index)
    return String;
</pre></td>
  </tr>

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

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

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

  <tr>
<td><pre>
void textfont(Fl_Font c);
</pre></td>
<td><pre>
procedure Set_Text_Font
       (This : in out Menu;
        To   : in     Font_Kind);
</pre></td>
  </tr>

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

  <tr>
<td><pre>
void textsize(Fl_Fontsize c);
</pre></td>
<td><pre>
procedure Set_Text_Size
       (This : in out Menu;
        To   : in     Font_Size);
</pre></td>
  </tr>

  <tr>
<td><pre>
int value() const;
</pre></td>
<td><pre>
function Chosen_Index
       (This : in Menu)
    return Extended_Index;
</pre></td>
  </tr>

  <tr>
<td><pre>
int value(const Fl_Menu_Item *);
</pre></td>
<td><pre>
procedure Set_Chosen
       (This : in out Menu;
        Item : in     FLTK.Menu_Items.Menu_Item);

function Set_Chosen
       (This : in out Menu;
        Item : in     FLTK.Menu_Items.Menu_Item)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
int value(int i);
</pre></td>
<td><pre>
procedure Set_Chosen
       (This  : in out Menu;
        Place : in     Index);

function Set_Chosen
       (This  : in out Menu;
        Place : in     Index)
    return Boolean;
</pre></td>
  </tr>

</table>



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

  <tr>
<td><pre>
int item_pathname_(char *name, int namelen,
    const Fl_Menu_Item *finditem, const Fl_Menu_Item *menu=0) const;
</pre></td>
<td>Intentionally left unbound.</td>
  </tr>

</table>


  </body>
</html>