1wxMenu(3)                  Erlang Module Definition                  wxMenu(3)
2
3
4

NAME

6       wxMenu - See external documentation: wxMenu.
7

DESCRIPTION

9       See external documentation: wxMenu.
10
11       This class is derived (and can use functions) from:
12       wxEvtHandler
13

DATA TYPES

15         wxMenu():
16
17
18           An  object  reference,  The  representation  is internal and can be
19           changed without notice. It can't be used for comparsion  stored  on
20           disc or distributed for use on other nodes.
21

EXPORTS

23       new() -> wxMenu()
24
25              Equivalent to new([]).
26
27       new(Options::[Option]) -> wxMenu()
28
29              Types:
30
31                 Option = {style, integer()}
32
33              See external documentation.
34
35       new(Title, Options::[Option]) -> wxMenu()
36
37              Types:
38
39                 Title = unicode:chardata()
40                 Option = {style, integer()}
41
42              See external documentation.
43
44       append(This, Item) -> wxMenuItem:wxMenuItem()
45
46              Types:
47
48                 This = wxMenu()
49                 Item = wxMenuItem:wxMenuItem()
50
51              See external documentation.
52
53       append(This, Itemid, Text) -> wxMenuItem:wxMenuItem()
54
55              Types:
56
57                 This = wxMenu()
58                 Itemid = integer()
59                 Text = unicode:chardata()
60
61              Equivalent to append(This, Itemid, Text, []).
62
63       append(This, Itemid, Text, Submenu) -> wxMenuItem:wxMenuItem()
64       append(This,  Itemid,  Text,  Submenu::[Option])  -> wxMenuItem:wxMenu‐
65       Item()
66
67              Types:
68
69                 This = wxMenu()
70                 Itemid = integer()
71                 Text = unicode:chardata()
72                 Submenu = wxMenu()
73                 This = wxMenu()
74                 Itemid = integer()
75                 Text = unicode:chardata()
76                 Option = {help, unicode:chardata()} | {kind, wx:wx_enum()}
77
78              See external documentation.
79              Also:
80              append(This, Itemid, Text, [Option]) ->  wxMenuItem:wxMenuItem()
81              when
82              This::wxMenu(), Itemid::integer(), Text::unicode:chardata(),
83              Option :: {'help', unicode:chardata()}
84              | {'kind', wx:wx_enum()}.
85
86
87              Kind  =  ?wxITEM_SEPARATOR  |  ?wxITEM_NORMAL  | ?wxITEM_CHECK |
88              ?wxITEM_RADIO | ?wxITEM_MAX
89
90       append(This, Itemid, Text, Help, IsCheckable) -> ok
91       append(This, Itemid, Text, Submenu, IsCheckable::[Option])  ->  wxMenu‐
92       Item:wxMenuItem()
93
94              Types:
95
96                 This = wxMenu()
97                 Itemid = integer()
98                 Text = unicode:chardata()
99                 Help = unicode:chardata()
100                 IsCheckable = boolean()
101                 This = wxMenu()
102                 Itemid = integer()
103                 Text = unicode:chardata()
104                 Submenu = wxMenu()
105                 Option = {help, unicode:chardata()}
106
107              See external documentation.
108              Also:
109              append(This,   Itemid,   Text,  Submenu,  [Option])  ->  wxMenu‐
110              Item:wxMenuItem() when
111              This::wxMenu(),   Itemid::integer(),   Text::unicode:chardata(),
112              Submenu::wxMenu(),
113              Option :: {'help', unicode:chardata()}.
114
115
116       appendCheckItem(This, Itemid, Text) -> wxMenuItem:wxMenuItem()
117
118              Types:
119
120                 This = wxMenu()
121                 Itemid = integer()
122                 Text = unicode:chardata()
123
124              Equivalent to appendCheckItem(This, Itemid, Text, []).
125
126       appendCheckItem(This,   Itemid,  Text,  Options::[Option])  ->  wxMenu‐
127       Item:wxMenuItem()
128
129              Types:
130
131                 This = wxMenu()
132                 Itemid = integer()
133                 Text = unicode:chardata()
134                 Option = {help, unicode:chardata()}
135
136              See external documentation.
137
138       appendRadioItem(This, Itemid, Text) -> wxMenuItem:wxMenuItem()
139
140              Types:
141
142                 This = wxMenu()
143                 Itemid = integer()
144                 Text = unicode:chardata()
145
146              Equivalent to appendRadioItem(This, Itemid, Text, []).
147
148       appendRadioItem(This,  Itemid,  Text,  Options::[Option])  ->   wxMenu‐
149       Item:wxMenuItem()
150
151              Types:
152
153                 This = wxMenu()
154                 Itemid = integer()
155                 Text = unicode:chardata()
156                 Option = {help, unicode:chardata()}
157
158              See external documentation.
159
160       appendSeparator(This) -> wxMenuItem:wxMenuItem()
161
162              Types:
163
164                 This = wxMenu()
165
166              See external documentation.
167
168       break(This) -> ok
169
170              Types:
171
172                 This = wxMenu()
173
174              See external documentation.
175
176       check(This, Itemid, Check) -> ok
177
178              Types:
179
180                 This = wxMenu()
181                 Itemid = integer()
182                 Check = boolean()
183
184              See external documentation.
185
186       delete(This, Itemid) -> boolean()
187       delete(This, Item) -> boolean()
188
189              Types:
190
191                 This = wxMenu()
192                 Itemid = integer()
193                 This = wxMenu()
194                 Item = wxMenuItem:wxMenuItem()
195
196              See external documentation.
197              Also:
198              delete(This, Item) -> boolean() when
199              This::wxMenu(), Item::wxMenuItem:wxMenuItem().
200
201
202       Destroy(This, Itemid) -> boolean()
203       Destroy(This, Item) -> boolean()
204
205              Types:
206
207                 This = wxMenu()
208                 Itemid = integer()
209                 This = wxMenu()
210                 Item = wxMenuItem:wxMenuItem()
211
212              See external documentation.
213              Also:
214              'Destroy'(This, Item) -> boolean() when
215              This::wxMenu(), Item::wxMenuItem:wxMenuItem().
216
217
218       enable(This, Itemid, Enable) -> ok
219
220              Types:
221
222                 This = wxMenu()
223                 Itemid = integer()
224                 Enable = boolean()
225
226              See external documentation.
227
228       findItem(This, Itemid) -> wxMenuItem:wxMenuItem()
229       findItem(This, Item) -> integer()
230
231              Types:
232
233                 This = wxMenu()
234                 Itemid = integer()
235                 This = wxMenu()
236                 Item = unicode:chardata()
237
238              See external documentation.
239              Also:
240              findItem(This, Item) -> integer() when
241              This::wxMenu(), Item::unicode:chardata().
242
243
244       findItemByPosition(This, Position) -> wxMenuItem:wxMenuItem()
245
246              Types:
247
248                 This = wxMenu()
249                 Position = integer()
250
251              See external documentation.
252
253       getHelpString(This, Itemid) -> unicode:charlist()
254
255              Types:
256
257                 This = wxMenu()
258                 Itemid = integer()
259
260              See external documentation.
261
262       getLabel(This, Itemid) -> unicode:charlist()
263
264              Types:
265
266                 This = wxMenu()
267                 Itemid = integer()
268
269              See external documentation.
270
271       getMenuItemCount(This) -> integer()
272
273              Types:
274
275                 This = wxMenu()
276
277              See external documentation.
278
279       getMenuItems(This) -> [wxMenuItem:wxMenuItem()]
280
281              Types:
282
283                 This = wxMenu()
284
285              See external documentation.
286
287       getTitle(This) -> unicode:charlist()
288
289              Types:
290
291                 This = wxMenu()
292
293              See external documentation.
294
295       insert(This, Pos, Itemid) -> wxMenuItem:wxMenuItem()
296       insert(This, Pos, Item) -> wxMenuItem:wxMenuItem()
297
298              Types:
299
300                 This = wxMenu()
301                 Pos = integer()
302                 Itemid = integer()
303                 This = wxMenu()
304                 Pos = integer()
305                 Item = wxMenuItem:wxMenuItem()
306
307              See external documentation.
308              Also:
309              insert(This, Pos, Item) -> wxMenuItem:wxMenuItem() when
310              This::wxMenu(), Pos::integer(), Item::wxMenuItem:wxMenuItem().
311
312
313              Kind  =  ?wxITEM_SEPARATOR  |  ?wxITEM_NORMAL  | ?wxITEM_CHECK |
314              ?wxITEM_RADIO | ?wxITEM_MAX
315
316       insert(This, Pos, Itemid, Options::[Option]) -> wxMenuItem:wxMenuItem()
317
318              Types:
319
320                 This = wxMenu()
321                 Pos = integer()
322                 Itemid = integer()
323                 Option = {text, unicode:chardata()}  |  {help,  unicode:char‐
324                 data()} | {kind, wx:wx_enum()}
325
326              See external documentation.
327              Kind  =  ?wxITEM_SEPARATOR  |  ?wxITEM_NORMAL  | ?wxITEM_CHECK |
328              ?wxITEM_RADIO | ?wxITEM_MAX
329
330       insert(This, Pos, Itemid, Text, Submenu) -> wxMenuItem:wxMenuItem()
331
332              Types:
333
334                 This = wxMenu()
335                 Pos = integer()
336                 Itemid = integer()
337                 Text = unicode:chardata()
338                 Submenu = wxMenu()
339
340              Equivalent to insert(This, Pos, Itemid, Text, Submenu, []).
341
342       insert(This, Pos, Itemid, Text, Help, IsCheckable) -> ok
343       insert(This, Pos,  Itemid,  Text,  Submenu,  IsCheckable::[Option])  ->
344       wxMenuItem:wxMenuItem()
345
346              Types:
347
348                 This = wxMenu()
349                 Pos = integer()
350                 Itemid = integer()
351                 Text = unicode:chardata()
352                 Help = unicode:chardata()
353                 IsCheckable = boolean()
354                 This = wxMenu()
355                 Pos = integer()
356                 Itemid = integer()
357                 Text = unicode:chardata()
358                 Submenu = wxMenu()
359                 Option = {help, unicode:chardata()}
360
361              See external documentation.
362              Also:
363              insert(This,  Pos,  Itemid,  Text, Submenu, [Option]) -> wxMenu‐
364              Item:wxMenuItem() when
365              This::wxMenu(),  Pos::integer(),  Itemid::integer(),  Text::uni‐
366              code:chardata(), Submenu::wxMenu(),
367              Option :: {'help', unicode:chardata()}.
368
369
370       insertCheckItem(This, Pos, Itemid, Text) -> wxMenuItem:wxMenuItem()
371
372              Types:
373
374                 This = wxMenu()
375                 Pos = integer()
376                 Itemid = integer()
377                 Text = unicode:chardata()
378
379              Equivalent to insertCheckItem(This, Pos, Itemid, Text, []).
380
381       insertCheckItem(This,  Pos, Itemid, Text, Options::[Option]) -> wxMenu‐
382       Item:wxMenuItem()
383
384              Types:
385
386                 This = wxMenu()
387                 Pos = integer()
388                 Itemid = integer()
389                 Text = unicode:chardata()
390                 Option = {help, unicode:chardata()}
391
392              See external documentation.
393
394       insertRadioItem(This, Pos, Itemid, Text) -> wxMenuItem:wxMenuItem()
395
396              Types:
397
398                 This = wxMenu()
399                 Pos = integer()
400                 Itemid = integer()
401                 Text = unicode:chardata()
402
403              Equivalent to insertRadioItem(This, Pos, Itemid, Text, []).
404
405       insertRadioItem(This, Pos, Itemid, Text, Options::[Option]) ->  wxMenu‐
406       Item:wxMenuItem()
407
408              Types:
409
410                 This = wxMenu()
411                 Pos = integer()
412                 Itemid = integer()
413                 Text = unicode:chardata()
414                 Option = {help, unicode:chardata()}
415
416              See external documentation.
417
418       insertSeparator(This, Pos) -> wxMenuItem:wxMenuItem()
419
420              Types:
421
422                 This = wxMenu()
423                 Pos = integer()
424
425              See external documentation.
426
427       isChecked(This, Itemid) -> boolean()
428
429              Types:
430
431                 This = wxMenu()
432                 Itemid = integer()
433
434              See external documentation.
435
436       isEnabled(This, Itemid) -> boolean()
437
438              Types:
439
440                 This = wxMenu()
441                 Itemid = integer()
442
443              See external documentation.
444
445       prepend(This, Itemid) -> wxMenuItem:wxMenuItem()
446       prepend(This, Item) -> wxMenuItem:wxMenuItem()
447
448              Types:
449
450                 This = wxMenu()
451                 Itemid = integer()
452                 This = wxMenu()
453                 Item = wxMenuItem:wxMenuItem()
454
455              See external documentation.
456              Also:
457              prepend(This, Item) -> wxMenuItem:wxMenuItem() when
458              This::wxMenu(), Item::wxMenuItem:wxMenuItem().
459
460
461              Kind  =  ?wxITEM_SEPARATOR  |  ?wxITEM_NORMAL  | ?wxITEM_CHECK |
462              ?wxITEM_RADIO | ?wxITEM_MAX
463
464       prepend(This, Itemid, Options::[Option]) -> wxMenuItem:wxMenuItem()
465
466              Types:
467
468                 This = wxMenu()
469                 Itemid = integer()
470                 Option = {text, unicode:chardata()}  |  {help,  unicode:char‐
471                 data()} | {kind, wx:wx_enum()}
472
473              See external documentation.
474              Kind  =  ?wxITEM_SEPARATOR  |  ?wxITEM_NORMAL  | ?wxITEM_CHECK |
475              ?wxITEM_RADIO | ?wxITEM_MAX
476
477       prepend(This, Itemid, Text, Submenu) -> wxMenuItem:wxMenuItem()
478
479              Types:
480
481                 This = wxMenu()
482                 Itemid = integer()
483                 Text = unicode:chardata()
484                 Submenu = wxMenu()
485
486              Equivalent to prepend(This, Itemid, Text, Submenu, []).
487
488       prepend(This, Itemid, Text, Help, IsCheckable) -> ok
489       prepend(This, Itemid, Text, Submenu, IsCheckable::[Option]) ->  wxMenu‐
490       Item:wxMenuItem()
491
492              Types:
493
494                 This = wxMenu()
495                 Itemid = integer()
496                 Text = unicode:chardata()
497                 Help = unicode:chardata()
498                 IsCheckable = boolean()
499                 This = wxMenu()
500                 Itemid = integer()
501                 Text = unicode:chardata()
502                 Submenu = wxMenu()
503                 Option = {help, unicode:chardata()}
504
505              See external documentation.
506              Also:
507              prepend(This,   Itemid,  Text,  Submenu,  [Option])  ->  wxMenu‐
508              Item:wxMenuItem() when
509              This::wxMenu(),   Itemid::integer(),   Text::unicode:chardata(),
510              Submenu::wxMenu(),
511              Option :: {'help', unicode:chardata()}.
512
513
514       prependCheckItem(This, Itemid, Text) -> wxMenuItem:wxMenuItem()
515
516              Types:
517
518                 This = wxMenu()
519                 Itemid = integer()
520                 Text = unicode:chardata()
521
522              Equivalent to prependCheckItem(This, Itemid, Text, []).
523
524       prependCheckItem(This,  Itemid,  Text,  Options::[Option])  ->  wxMenu‐
525       Item:wxMenuItem()
526
527              Types:
528
529                 This = wxMenu()
530                 Itemid = integer()
531                 Text = unicode:chardata()
532                 Option = {help, unicode:chardata()}
533
534              See external documentation.
535
536       prependRadioItem(This, Itemid, Text) -> wxMenuItem:wxMenuItem()
537
538              Types:
539
540                 This = wxMenu()
541                 Itemid = integer()
542                 Text = unicode:chardata()
543
544              Equivalent to prependRadioItem(This, Itemid, Text, []).
545
546       prependRadioItem(This,  Itemid,  Text,  Options::[Option])  ->  wxMenu‐
547       Item:wxMenuItem()
548
549              Types:
550
551                 This = wxMenu()
552                 Itemid = integer()
553                 Text = unicode:chardata()
554                 Option = {help, unicode:chardata()}
555
556              See external documentation.
557
558       prependSeparator(This) -> wxMenuItem:wxMenuItem()
559
560              Types:
561
562                 This = wxMenu()
563
564              See external documentation.
565
566       remove(This, Itemid) -> wxMenuItem:wxMenuItem()
567       remove(This, Item) -> wxMenuItem:wxMenuItem()
568
569              Types:
570
571                 This = wxMenu()
572                 Itemid = integer()
573                 This = wxMenu()
574                 Item = wxMenuItem:wxMenuItem()
575
576              See external documentation.
577              Also:
578              remove(This, Item) -> wxMenuItem:wxMenuItem() when
579              This::wxMenu(), Item::wxMenuItem:wxMenuItem().
580
581
582       setHelpString(This, Itemid, HelpString) -> ok
583
584              Types:
585
586                 This = wxMenu()
587                 Itemid = integer()
588                 HelpString = unicode:chardata()
589
590              See external documentation.
591
592       setLabel(This, Itemid, Label) -> ok
593
594              Types:
595
596                 This = wxMenu()
597                 Itemid = integer()
598                 Label = unicode:chardata()
599
600              See external documentation.
601
602       setTitle(This, Title) -> ok
603
604              Types:
605
606                 This = wxMenu()
607                 Title = unicode:chardata()
608
609              See external documentation.
610
611       destroy(This::wxMenu()) -> ok
612
613              Destroys this object, do not use object again
614

AUTHORS

616       <>
617
618
619
620                                   wx 1.9.3                          wxMenu(3)