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

AUTHORS

569       <>
570
571
572
573                                    wx 1.9                           wxMenu(3)