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

<!DOCTYPE html>

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

  <body>


<h2>Fl_Menu_Item Binding Map</h2>


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

  <tr>
    <td>Fl_Menu_Item</td>
    <td>FLTK.Menu_Items</td>
  </tr>

</table>



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

  <tr>
    <td>Fl_Menu_Item</td>
    <td>Menu_Item</td>
  </tr>

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

</table>



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

  <tr>
<td>N/A due to being a struct, not a class</td>
<td><pre>
function Create
       (Text        : in String;
        Action      : in FLTK.Widgets.Widget_Callback := null;
        Shortcut    : in Key_Combo := No_Key;
        Flags       : in Menu_Flag := Flag_Normal)
    return Menu_Item;
</pre></td>
  </tr>

  <tr>
<td><pre>
void activate();
</pre></td>
<td><pre>
procedure Activate
       (Item : in out Menu_Item);
</pre></td>
  </tr>

  <tr>
<td><pre>
int active() const;
</pre></td>
<td><pre>
function Is_Active
       (Item : in Menu_Item)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
int activevisible() const;
</pre></td>
<td><pre>
function Is_Active_And_Visible
       (Item : in Menu_Item)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
int add(const char *, int shortcut, Fl_Callback *, void *=0, int=0);
</pre></td>
<td>See Add procedure in FLTK.Widgets.Menus</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>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
long argument() const;
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
void argument(long v);
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
Fl_Callback_p callback() const;
</pre></td>
<td><pre>
function Get_Callback
       (Item : in Menu_Item)
    return FLTK.Widgets.Widget_Callback;
</pre></td>
  </tr>

  <tr>
<td><pre>
void callback(Fl_Callback *c, void *p);
void callback(Fl_Callback *c);
void callback(Fl_Callback0 *c);
void callback(Fl_Callback1 *c, long p=0);
</pre></td>
<td><pre>
procedure Set_Callback
       (Item : in out Menu_Item;
        Func : in     FLTK.Widgets.Widget_Callback);
</pre></td>
  </tr>

  <tr>
<td><pre>
void check();
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
int checkbox() const;
</pre></td>
<td><pre>
function Has_Checkbox
       (Item : in Menu_Item)
    return Boolean;
</pre></td>
  </tr>

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

  <tr>
<td><pre>
void clear();
</pre></td>
<td><pre>
procedure Set_State
       (Item : in out Menu_Item;
        To   : in     Boolean);
</pre></td>
  </tr>

  <tr>
<td><pre>
void deactivate();
</pre></td>
<td><pre>
procedure Deactivate
       (Item : in out Menu_Item);
</pre></td>
  </tr>

  <tr>
<td><pre>
void do_callback(Fl_Widget *o) const;
void do_callback(Fl_Widget *o, void *arg) const;
void do_callback(Fl_Widget *o, long arg) const;
</pre></td>
<td><pre>
procedure Do_Callback
       (Item   : in out Menu_Item;
        Widget : in out FLTK.Widgets.Widget'Class);
</pre></td>
  </tr>

  <tr>
<td><pre>
void draw(int x, int y, int w, int h, const Fl_Menu_ *, int t=0) const;
</pre></td>
<td>See Draw_Item procedure in FLTK.Widgets.Menus</td>
  </tr>

  <tr>
<td><pre>
const Fl_Menu_Item * find_shortcut(int *ip=0, const bool require_alt=false) const;
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
const Fl_Menu_Item * first() const;
Fl_Menu_Item * first();
</pre></td>
<td>Use FLTK.Widgets.Menus iterators instead</td>
  </tr>

  <tr>
<td>See Fl_Menu_ int mode(int i) const;</td>
<td><pre>
function Get_Flags
       (Item : in Menu_Item)
    return Menu_Flag;
</pre></td>
  </tr>

  <tr>
<td>See Fl_Menu_ void mode(int i, int fl);</td>
<td><pre>
procedure Set_Flags
       (Item : in out Menu_Item;
        To   : in     Menu_Flag);
</pre></td>
  </tr>

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

  <tr>
<td><pre>
void image(Fl_Image *a);
void image(Fl_Image &a);
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
int insert(int, const char *, int, Fl_Callback *, void *=0, int=0);
</pre></td>
<td>See Insert procedure in FLTK.Widgets.Menus</td>
  </tr>

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

  <tr>
<td><pre>
void label(const char *a);
</pre></td>
<td><pre>
procedure Set_Label
       (Item : in out Menu_Item;
        Text : in     String);
</pre></td>
  </tr>

  <tr>
<td><pre>
void label(Fl_Labeltype a, const char *b);
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
Fl_Color labelcolor() const;
</pre></td>
<td><pre>
function Get_Label_Color
       (Item : in Menu_Item)
    return Color;
</pre></td>
  </tr>

  <tr>
<td><pre>
void labelcolor(Fl_Color a);
</pre></td>
<td><pre>
procedure Set_Label_Color
       (Item : in out Menu_Item;
        To   : in     Color);
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Font labelfont() const;
</pre></td>
<td><pre>
function Get_Label_Font
       (Item : in Menu_Item)
    return Font_Kind;
</pre></td>
  </tr>

  <tr>
<td><pre>
void labelfont(Fl_Font a);
</pre></td>
<td><pre>
procedure Set_Label_Font
       (Item : in out Menu_Item;
        To   : in     Font_Kind);
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Fontsize labelsize() const;
</pre></td>
<td><pre>
function Get_Label_Size
       (Item : in Menu_Item)
    return Font_Size;
</pre></td>
  </tr>

  <tr>
<td><pre>
void labelsize(Fl_Fontsize a);
</pre></td>
<td><pre>
procedure Set_Label_Size
       (Item : in out Menu_Item;
        To   : in     Font_Size);
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Labeltype labeltype() const;
</pre></td>
<td><pre>
function Get_Label_Type
       (Item : in Menu_Item)
    return Label_Kind;
</pre></td>
  </tr>

  <tr>
<td><pre>
void labeltype(Fl_Labeltype a);
</pre></td>
<td><pre>
procedure Set_Label_Type
       (Item : in out Menu_Item;
        To   : in     Label_Kind);
</pre></td>
  </tr>

  <tr>
<td><pre>
int measure(int *h, const Fl_Menu_ *) const;
</pre></td>
<td>See Measure_Item procedure in FLTK.Widgets.Menus</td>
  </tr>

  <tr>
<td><pre>
const Fl_Menu_Item * next(int=1) const;
Fl_Menu_Item * next(int i=1);
</pre></td>
<td>Use FLTK.Widgets.Menus iterators instead</td>
  </tr>

  <tr>
<td><pre>
const Fl_Menu_Item * popup
   (int X, int Y, const char *title=0,
    const Fl_Menu_Item *picked=0, const Fl_Menu_*=0) const;
</pre></td>
<td>See Popup function in FLTK.Widgets.Menus</td>
  </tr>

  <tr>
<td><pre>
const Fl_Menu_Item * pulldown
   (int X, int Y, int W, int H,
    const Fl_Menu_Item *picked=0, const Fl_Menu_*=0,
    const Fl_Menu_Item *title=0, int menubar=0) const;
</pre></td>
<td>See Pulldown function in FLTK.Widgets.Menus</td>
  </tr>

  <tr>
<td><pre>
int radio() const;
</pre></td>
<td><pre>
function Is_Radio
       (Item : in Menu_Item)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
void set();
</pre></td>
<td>See void clear();</td>
  </tr>

  <tr>
<td><pre>
void setonly();
</pre></td>
<td><pre>
procedure Set_Only
       (Item : in out Menu_Item);
</pre></td>
  </tr>

  <tr>
<td><pre>
int shortcut() const;
</pre></td>
<td><pre>
function Get_Shortcut
       (Item : in Menu_Item)
    return Key_Combo;
</pre></td>
  </tr>

  <tr>
<td><pre>
void shortcut(int s);
</pre></td>
<td><pre>
procedure Set_Shortcut
       (Item : in out Menu_Item;
        To   : in     Key_Combo);
</pre></td>
  </tr>

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

  <tr>
<td><pre>
int size() const;
</pre></td>
<td>See Number_Of_Items function in FLTK.Widgets.Menus</td>
  </tr>

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

  <tr>
<td><pre>
const Fl_Menu_Item * test_shortcut() const;
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
void uncheck();
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
void * user_data() const;
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
void user_data(void *v);
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
int value() const;
</pre></td>
<td><pre>
function Get_State
       (Item : in Menu_Item)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
int visible() const;
</pre></td>
<td><pre>
function Is_Visible
       (Item : in Menu_Item)
    return Boolean;
</pre></td>
  </tr>

</table>


  </body>
</html>