File: wx.MenuItem.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (1280 lines) | stat: -rw-r--r-- 30,540 bytes parent folder | download
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
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2018 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc



.. _wx.MenuItem:

==========================================================================================================================================
|phoenix_title|  **wx.MenuItem**
==========================================================================================================================================

A menu item represents an item in a menu.          

Note that you usually don't have to deal with it directly as :ref:`wx.Menu`  methods usually construct an object of this class for you. 

Also please note that the methods related to fonts and bitmaps are currently only implemented for Windows, Mac and GTK+. 







.. _MenuItem-events:

|events| Events Emitted by this Class
=====================================

Handlers bound for the following event types will receive one of the :ref:`wx.CommandEvent`:ref:`wx.MenuEvent` parameters.


- EVT_MENU: Process a  ``wxEVT_MENU``   command, which is generated by a menu item. This type of event is sent as  :ref:`wx.CommandEvent`.  
- EVT_MENU_RANGE: Process a  ``wxEVT_MENU``   command, which is generated by a range of menu items. This type of event is sent as  :ref:`wx.CommandEvent`.  
- EVT_MENU_OPEN: A menu is about to be opened. On Windows, this is only sent once for each navigation of the menubar (up until all menus have closed). This type of event is sent as :ref:`wx.MenuEvent`.  
- EVT_MENU_CLOSE: A menu has been just closed. This type of event is sent as :ref:`wx.MenuEvent`.  
- EVT_MENU_HIGHLIGHT: The menu item with the specified id has been highlighted: used to show help prompts in the status bar by :ref:`wx.Frame`  This type of event is sent as :ref:`wx.MenuEvent`.  
- EVT_MENU_HIGHLIGHT_ALL: A menu item has been highlighted, i.e. the currently selected menu item has changed. This type of event is sent as :ref:`wx.MenuEvent`.  








         



.. seealso:: :ref:`wx.MenuBar`, :ref:`wx.Menu`    







|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>MenuItem</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.MenuItem_inheritance.png" alt="Inheritance diagram of MenuItem" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Object.html" title="wx.Object" alt="" coords="17,5,99,35"/> <area shape="rect" id="node2" href="wx.MenuItem.html" title="wx.MenuItem" alt="" coords="5,83,112,112"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.MenuItem.__init__`                                                    Constructs a :ref:`wx.MenuItem`  object.
:meth:`~wx.MenuItem.Check`                                                       Checks or unchecks the menu item.
:meth:`~wx.MenuItem.Enable`                                                      Enables or disables the menu item.
:meth:`~wx.MenuItem.GetAccel`                                                    Get our accelerator or ``None`` (caller must delete the pointer)
:meth:`~wx.MenuItem.GetBackgroundColour`                                         Returns the background colour associated with the menu item.
:meth:`~wx.MenuItem.GetBitmap`                                                   Returns the checked or unchecked bitmap.
:meth:`~wx.MenuItem.GetDisabledBitmap`                                           Returns the bitmap to be used for disabled items.
:meth:`~wx.MenuItem.GetFont`                                                     Returns the font associated with the menu item.
:meth:`~wx.MenuItem.GetHelp`                                                     Returns the help string associated with the menu item.
:meth:`~wx.MenuItem.GetId`                                                       Returns the menu item identifier.
:meth:`~wx.MenuItem.GetItemLabel`                                                Returns the text associated with the menu item including any accelerator characters that were passed to the constructor or :meth:`~MenuItem.SetItemLabel` .
:meth:`~wx.MenuItem.GetItemLabelText`                                            Returns the text associated with the menu item, without any accelerator characters.
:meth:`~wx.MenuItem.GetKind`                                                     Returns the item kind, one of  ``ITEM_SEPARATOR`` ,   ``ITEM_NORMAL`` ,   ``ITEM_CHECK``   or   ``ITEM_RADIO`` .
:meth:`~wx.MenuItem.GetLabel`                                                    Returns the text associated with the menu item without any accelerator characters it might contain.
:meth:`~wx.MenuItem.GetLabelFromText`                                            
:meth:`~wx.MenuItem.GetLabelText`                                                Strips all accelerator characters and mnemonics from the given `text`.
:meth:`~wx.MenuItem.GetMarginWidth`                                              Gets the width of the menu item checkmark bitmap.
:meth:`~wx.MenuItem.GetMenu`                                                     Returns the menu this menu item is in, or ``None`` if this menu item is not attached.
:meth:`~wx.MenuItem.GetName`                                                     Returns the text associated with the menu item.
:meth:`~wx.MenuItem.GetSubMenu`                                                  Returns the submenu associated with the menu item, or ``None`` if there isn't one.
:meth:`~wx.MenuItem.GetText`                                                     Returns the text associated with the menu item, such as it was passed to the :ref:`wx.MenuItem`  constructor, i.e.
:meth:`~wx.MenuItem.GetTextColour`                                               Returns the text colour associated with the menu item.
:meth:`~wx.MenuItem.IsCheck`                                                     Returns ``True`` if the item is a check item.
:meth:`~wx.MenuItem.IsCheckable`                                                 Returns ``True`` if the item is checkable.
:meth:`~wx.MenuItem.IsChecked`                                                   Returns ``True`` if the item is checked.
:meth:`~wx.MenuItem.IsEnabled`                                                   Returns ``True`` if the item is enabled.
:meth:`~wx.MenuItem.IsRadio`                                                     Returns ``True`` if the item is a radio button.
:meth:`~wx.MenuItem.IsSeparator`                                                 Returns ``True`` if the item is a separator.
:meth:`~wx.MenuItem.IsSubMenu`                                                   Returns ``True`` if the item is a submenu.
:meth:`~wx.MenuItem.SetAccel`                                                    Set the accel for this item - this may also be done indirectly with :meth:`~MenuItem.SetText`
:meth:`~wx.MenuItem.SetBackgroundColour`                                         Sets the background colour associated with the menu item.
:meth:`~wx.MenuItem.SetBitmap`                                                   Sets the bitmap for the menu item.
:meth:`~wx.MenuItem.SetBitmaps`                                                  Sets the checked/unchecked bitmaps for the menu item.
:meth:`~wx.MenuItem.SetDisabledBitmap`                                           Sets the to be used for disabled menu items.
:meth:`~wx.MenuItem.SetFont`                                                     Sets the font associated with the menu item.
:meth:`~wx.MenuItem.SetHelp`                                                     Sets the help string.
:meth:`~wx.MenuItem.SetItemLabel`                                                Sets the label associated with the menu item.
:meth:`~wx.MenuItem.SetMarginWidth`                                              Sets the width of the menu item checkmark bitmap.
:meth:`~wx.MenuItem.SetMenu`                                                     Sets the parent menu which will contain this menu item.
:meth:`~wx.MenuItem.SetSubMenu`                                                  Sets the submenu of this menu item.
:meth:`~wx.MenuItem.SetText`                                                     Sets the text associated with the menu item.
:meth:`~wx.MenuItem.SetTextColour`                                               Sets the text colour associated with the menu item.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.MenuItem.Accel`                                                       See :meth:`~wx.MenuItem.GetAccel` and :meth:`~wx.MenuItem.SetAccel`
:attr:`~wx.MenuItem.BackgroundColour`                                            See :meth:`~wx.MenuItem.GetBackgroundColour` and :meth:`~wx.MenuItem.SetBackgroundColour`
:attr:`~wx.MenuItem.Bitmap`                                                      See :meth:`~wx.MenuItem.GetBitmap` and :meth:`~wx.MenuItem.SetBitmap`
:attr:`~wx.MenuItem.DisabledBitmap`                                              See :meth:`~wx.MenuItem.GetDisabledBitmap` and :meth:`~wx.MenuItem.SetDisabledBitmap`
:attr:`~wx.MenuItem.Enabled`                                                     See :meth:`~wx.MenuItem.IsEnabled` and :meth:`~wx.MenuItem.Enable`
:attr:`~wx.MenuItem.Font`                                                        See :meth:`~wx.MenuItem.GetFont` and :meth:`~wx.MenuItem.SetFont`
:attr:`~wx.MenuItem.Help`                                                        See :meth:`~wx.MenuItem.GetHelp` and :meth:`~wx.MenuItem.SetHelp`
:attr:`~wx.MenuItem.Id`                                                          See :meth:`~wx.MenuItem.GetId`
:attr:`~wx.MenuItem.ItemLabel`                                                   See :meth:`~wx.MenuItem.GetItemLabel` and :meth:`~wx.MenuItem.SetItemLabel`
:attr:`~wx.MenuItem.ItemLabelText`                                               See :meth:`~wx.MenuItem.GetItemLabelText`
:attr:`~wx.MenuItem.Kind`                                                        See :meth:`~wx.MenuItem.GetKind`
:attr:`~wx.MenuItem.Label`                                                       See :meth:`~wx.MenuItem.GetLabel`
:attr:`~wx.MenuItem.MarginWidth`                                                 See :meth:`~wx.MenuItem.GetMarginWidth` and :meth:`~wx.MenuItem.SetMarginWidth`
:attr:`~wx.MenuItem.Menu`                                                        See :meth:`~wx.MenuItem.GetMenu` and :meth:`~wx.MenuItem.SetMenu`
:attr:`~wx.MenuItem.Name`                                                        See :meth:`~wx.MenuItem.GetName`
:attr:`~wx.MenuItem.SubMenu`                                                     See :meth:`~wx.MenuItem.GetSubMenu` and :meth:`~wx.MenuItem.SetSubMenu`
:attr:`~wx.MenuItem.Text`                                                        See :meth:`~wx.MenuItem.GetText` and :meth:`~wx.MenuItem.SetText`
:attr:`~wx.MenuItem.TextColour`                                                  See :meth:`~wx.MenuItem.GetTextColour` and :meth:`~wx.MenuItem.SetTextColour`
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.MenuItem(Object)

   **Possible constructors**::

       MenuItem(parentMenu=None, id=ID_SEPARATOR, text=EmptyString,
                helpString=EmptyString, kind=ITEM_NORMAL, subMenu=None)
       
   
   A menu item represents an item in a menu.



   .. method:: __init__(self, parentMenu=None, id=ID_SEPARATOR, text=EmptyString, helpString=EmptyString, kind=ITEM_NORMAL, subMenu=None)

      Constructs a :ref:`wx.MenuItem`  object.                  

      Menu items can be standard, or "stock menu items", or custom. For the standard menu items (such as commands to open a file, exit the program and so on, see :ref:`Stock Items <stock items>`  for the full list) it is enough to specify just the stock ``ID`` and leave `text`  and `helpString`  empty. Some platforms (currently wxGTK only, and see the remark in :meth:`SetBitmap`   documentation) will also show standard bitmaps for stock menu items. 

      Leaving at least `text`  empty for the stock menu items is actually strongly recommended as they will have appearance and keyboard interface (including standard accelerators) familiar to the user. 

      For the custom (non-stock) menu items, `text`  must be specified and while `helpString`  may be left empty, it's recommended to pass the item description (which is automatically shown by the library in the status bar when the menu item is selected) in this parameter. 

      Finally note that you can e.g. use a stock menu label without using its stock help string: 

      ::

                  # use all stock properties:
                  helpMenu.Append(wx.ID_ABOUT)

                  # use the stock label and the stock accelerator but not the stock help string:
                  helpMenu.Append(wx.ID_ABOUT, "", "My custom help string")

                  # use all stock properties except for the bitmap:
                  mymenu = wx.MenuItem(helpMenu, wx.ID_ABOUT)
                  mymenu.SetBitmap(wx.ArtProvider.GetBitmap(wx.ART_WARNING))
                  helpMenu.Append(mymenu)



      that is, stock properties are set independently one from the other. 




      :param `parentMenu`: Menu that the menu item belongs to. Can be ``None`` if the item is going to be added to the menu later.   
      :type `parentMenu`: wx.Menu
      :param `id`: Identifier for this menu item. May be  ``ID_SEPARATOR`` , in which case the given kind is ignored and taken to be   ``ITEM_SEPARATOR``   instead.    
      :type `id`: int
      :param `text`: Text for the menu item, as shown on the menu. See :meth:`SetItemLabel`   for more info.   
      :type `text`: string
      :param `helpString`: Optional help string that will be shown on the status bar.   
      :type `helpString`: string
      :param `kind`: May be  ``ITEM_SEPARATOR`` ,   ``ITEM_NORMAL`` ,   ``ITEM_CHECK``   or   ``ITEM_RADIO`` .    
      :type `kind`: wx.ItemKind
      :param `subMenu`: If non-NULL, indicates that the menu item is a submenu.   
      :type `subMenu`: wx.Menu














                  





   .. method:: Check(self, check=True)

      Checks or unchecks the menu item.                  

      Note that this only works when the item is already appended to a menu.                  


      :param `check`: 
      :type `check`: bool







   .. method:: Enable(self, enable=True)

      Enables or disables the menu item.                  


      :param `enable`: 
      :type `enable`: bool







   .. method:: GetAccel(self)

      Get our accelerator or ``None`` (caller must delete the pointer)                  

      :rtype: :ref:`wx.AcceleratorEntry`








   .. method:: GetBackgroundColour(self)

      Returns the background colour associated with the menu item.                  



      :rtype: :ref:`wx.Colour`







      .. availability:: Only available for MSW.  








   .. method:: GetBitmap(self, checked=True)

      Returns the checked or unchecked bitmap.                  




      :param `checked`: 
      :type `checked`: bool




      :rtype: :ref:`wx.Bitmap`







      .. availability:: Only available for MSW.  








   .. method:: GetDisabledBitmap(self)

      Returns the bitmap to be used for disabled items.                  



      :rtype: :ref:`wx.Bitmap`







      .. availability:: Only available for MSW.  








   .. method:: GetFont(self)

      Returns the font associated with the menu item.                  



      :rtype: :ref:`wx.Font`







      .. availability:: Only available for MSW.  








   .. method:: GetHelp(self)

      Returns the help string associated with the menu item.                  

      :rtype: `string`








   .. method:: GetId(self)

      Returns the menu item identifier.                  

      :rtype: `int`








   .. method:: GetItemLabel(self)

      Returns the text associated with the menu item including any accelerator characters that were passed to the constructor or :meth:`SetItemLabel` .                  

                

      :rtype: `string`







      .. seealso:: :meth:`GetItemLabelText` , :meth:`GetLabelText`     








   .. method:: GetItemLabelText(self)

      Returns the text associated with the menu item, without any accelerator characters.                  

                

      :rtype: `string`







      .. seealso:: :meth:`GetItemLabel` , :meth:`GetLabelText`     








   .. method:: GetKind(self)

      Returns the item kind, one of  ``ITEM_SEPARATOR`` ,   ``ITEM_NORMAL`` ,   ``ITEM_CHECK``   or   ``ITEM_RADIO`` .                   

      :rtype: :ref:`wx.ItemKind`








   .. method:: GetLabel(self)

      Returns the text associated with the menu item without any accelerator characters it might contain.                  



                

      :rtype: `string`







      .. wxdeprecated:: 
         This function is deprecated in favour of :meth:`GetItemLabelText` .   







      .. seealso:: :meth:`GetItemLabelText`     








   .. staticmethod:: GetLabelFromText(text)





                


      :param `text`: 
      :type `text`: string




      :rtype: `string`







      .. wxdeprecated:: 
         This function is deprecated; please use :meth:`GetLabelText`   instead.   







      .. seealso:: :meth:`GetLabelText`     








   .. staticmethod:: GetLabelText(text)

      Strips all accelerator characters and mnemonics from the given `text`.                  

      For example: 

      ::

                    wx.MenuItem.GetLabelfromText("&Hello\tCtrl-h")



      will return just  ``"Hello"`` . 

                


      :param `text`: 
      :type `text`: string




      :rtype: `string`







      .. seealso:: :meth:`GetItemLabelText` , :meth:`GetItemLabel`     








   .. method:: GetMarginWidth(self)

      Gets the width of the menu item checkmark bitmap.                  



      :rtype: `int`







      .. availability:: Only available for MSW.  








   .. method:: GetMenu(self)

      Returns the menu this menu item is in, or ``None`` if this menu item is not attached.                  

      :rtype: :ref:`wx.Menu`








   .. method:: GetName(self)

      Returns the text associated with the menu item.                  



                

      :rtype: `string`







      .. wxdeprecated:: 
         This function is deprecated. Please use :meth:`GetItemLabel`   or :meth:`GetItemLabelText`   instead.   







      .. seealso:: :meth:`GetItemLabel` , :meth:`GetItemLabelText`     








   .. method:: GetSubMenu(self)

      Returns the submenu associated with the menu item, or ``None`` if there isn't one.                  

      :rtype: :ref:`wx.Menu`








   .. method:: GetText(self)

      Returns the text associated with the menu item, such as it was passed to the :ref:`wx.MenuItem`  constructor, i.e.                  

      with any accelerator characters it may contain. 



                

      :rtype: `string`







      .. wxdeprecated:: 
         This function is deprecated in favour of :meth:`GetItemLabel` .   







      .. seealso:: :meth:`GetLabelFromText`     








   .. method:: GetTextColour(self)

      Returns the text colour associated with the menu item.                  



      :rtype: :ref:`wx.Colour`







      .. availability:: Only available for MSW.  








   .. method:: IsCheck(self)

      Returns ``True`` if the item is a check item.                  

      Unlike :meth:`IsCheckable`   this doesn't return ``True`` for the radio buttons. 

                

      :rtype: `bool`







      .. versionadded:: 2.9.5 
     








   .. method:: IsCheckable(self)

      Returns ``True`` if the item is checkable.                  

      Notice that the radio buttons are considered to be checkable as well, so this method returns ``True`` for them too. Use :meth:`IsCheck`   if you want to test for the check items only.                  

      :rtype: `bool`








   .. method:: IsChecked(self)

      Returns ``True`` if the item is checked.                  

      :rtype: `bool`








   .. method:: IsEnabled(self)

      Returns ``True`` if the item is enabled.                  

      :rtype: `bool`








   .. method:: IsRadio(self)

      Returns ``True`` if the item is a radio button.                  

                

      :rtype: `bool`







      .. versionadded:: 2.9.5 
     








   .. method:: IsSeparator(self)

      Returns ``True`` if the item is a separator.                  

      :rtype: `bool`








   .. method:: IsSubMenu(self)

      Returns ``True`` if the item is a submenu.                  

      :rtype: `bool`








   .. method:: SetAccel(self, accel)

      Set the accel for this item - this may also be done indirectly with :meth:`SetText`                    


      :param `accel`: 
      :type `accel`: wx.AcceleratorEntry







   .. method:: SetBackgroundColour(self, colour)

      Sets the background colour associated with the menu item.                  




      :param `colour`: 
      :type `colour`: wx.Colour






      .. availability:: Only available for MSW.  








   .. method:: SetBitmap(self, bmp, checked=True)

      Sets the bitmap for the menu item.                  

      It is equivalent to `MenuItem.SetBitmaps(bmp,` NullBitmap) if `checked`  is ``True`` (default value) or SetBitmaps(wxNullBitmap, bmp) otherwise. 

      :meth:`SetBitmap`   must be called before the item is appended to the menu, i.e. appending the item without a bitmap and setting one later is not guaranteed to work. But the bitmap can be changed or reset later if it had been set up initially. 

      Notice that GTK+ uses a global setting called  ``gtk-menu-images``   to determine if the images should be shown in the menus at all. If it is off (which is the case in e.g. Gnome 2.28 by default), no images will be shown, consistently with the native behaviour. 




      :param `bmp`: 
      :type `bmp`: wx.Bitmap
      :param `checked`: 
      :type `checked`: bool






      .. availability:: Only available for MSW, OSX, GTK.  








   .. method:: SetBitmaps(self, checked, unchecked=NullBitmap)

      Sets the checked/unchecked bitmaps for the menu item.                  

      The first bitmap is also used as the single bitmap for uncheckable menu items. 




      :param `checked`: 
      :type `checked`: wx.Bitmap
      :param `unchecked`: 
      :type `unchecked`: wx.Bitmap






      .. availability:: Only available for MSW.  








   .. method:: SetDisabledBitmap(self, disabled)

      Sets the to be used for disabled menu items.                  




      :param `disabled`: 
      :type `disabled`: wx.Bitmap






      .. availability:: Only available for MSW.  








   .. method:: SetFont(self, font)

      Sets the font associated with the menu item.                  




      :param `font`: 
      :type `font`: wx.Font






      .. availability:: Only available for MSW.  








   .. method:: SetHelp(self, helpString)

      Sets the help string.                  


      :param `helpString`: 
      :type `helpString`: string







   .. method:: SetItemLabel(self, label)

      Sets the label associated with the menu item.                  

      Note that if the ``ID`` of this menu item corresponds to a stock ``ID``, then it is not necessary to specify a label: wxWidgets will automatically use the stock item label associated with that ``ID``. See the :meth:`constructor`   for more info. 

      The label string for the normal menu items (not separators) may include the accelerator which can be used to activate the menu item from keyboard. An accelerator key can be specified using the ampersand  ``&``   character. In order to embed an ampersand character in the menu item text, the ampersand must be doubled. 

      Optionally you can specify also an accelerator string appending a tab character  ``\t``   followed by a valid key combination (e.g.   ``CTRL+V`` ). Its general syntax is any combination of   ``"CTRL"`` ,   ``"RAWCTRL"`` ,   ``"ALT"``   and   ``"SHIFT"``   strings (case doesn't matter) separated by either   ``'-'``   or   ``'+'``   characters and followed by the accelerator itself. Notice that   ``CTRL``   corresponds to the "Ctrl" key on most platforms but not under Mac OS where it is mapped to "Cmd" key on Mac keyboard. Usually this is exactly what you want in portable code but if you really need to use the (rarely used for this purpose) "Ctrl" key even under Mac, you may use   ``RAWCTRL``   to prevent this mapping. Under the other platforms   ``RAWCTRL``   is the same as plain   ``CTRL`` . 

      The accelerator may be any alphanumeric character, any function key (from ``F1`` to ``F12``) or one of the special characters listed in the table below (again, case doesn't matter):

      -  ``DEL``   or   ``DELETE:``   Delete key 
      -  ``BACK``   : Backspace key 
      -  ``INS``   or   ``INSERT:``   Insert key 
      -  ``ENTER``   or   ``RETURN:``   Enter key 
      -  ``PGUP:``   PageUp key 
      -  ``PGDN:``   PageDown key 
      -  ``LEFT:``   Left cursor arrow key 
      -  ``RIGHT:``   Right cursor arrow key 
      -  ``UP:``   Up cursor arrow key 
      -  ``DOWN:``   Down cursor arrow key 
      -  ``HOME:``   Home key 
      -  ``END:``   End key 
      -  ``SPACE:``   Space 
      -  ``TAB:``   Tab key 
      -  ``ESC``   or   ``ESCAPE:``   Escape key (Windows only) 




      Examples: 

      ::

                  self.myMenuItem.SetItemLabel("My &item\tCTRL+I")
                  self.myMenuItem2.SetItemLabel("Clean and build\tF7")
                  self.myMenuItem3.SetItemLabel("Simple item")
                  self.myMenuItem4.SetItemLabel("Item with &accelerator")



                


      :param `label`: 
      :type `label`: string






      .. note:: 

         In wxGTK using  ``"SHIFT"``   with non-alphabetic characters currently doesn't work, even in combination with other modifiers, due to GTK+ limitation. E.g.   ``Shift+Ctrl+A``   works but   ``Shift+Ctrl+1``   or   ``Shift+/``   do not, so avoid using accelerators of this form in portable code.  







      .. seealso:: :meth:`GetItemLabel` , :meth:`GetItemLabelText`     








   .. method:: SetMarginWidth(self, width)

      Sets the width of the menu item checkmark bitmap.                  




      :param `width`: 
      :type `width`: int






      .. availability:: Only available for MSW.  








   .. method:: SetMenu(self, menu)

      Sets the parent menu which will contain this menu item.                  


      :param `menu`: 
      :type `menu`: wx.Menu







   .. method:: SetSubMenu(self, menu)

      Sets the submenu of this menu item.                  


      :param `menu`: 
      :type `menu`: wx.Menu







   .. method:: SetText(self, text)

      Sets the text associated with the menu item.                  



                


      :param `text`: 
      :type `text`: string






      .. wxdeprecated:: 
         This function is deprecated in favour of :meth:`SetItemLabel` .   







      .. seealso:: :meth:`SetItemLabel` .   








   .. method:: SetTextColour(self, colour)

      Sets the text colour associated with the menu item.                  




      :param `colour`: 
      :type `colour`: wx.Colour






      .. availability:: Only available for MSW.  








   .. attribute:: Accel

      See :meth:`~wx.MenuItem.GetAccel` and :meth:`~wx.MenuItem.SetAccel`


   .. attribute:: BackgroundColour

      See :meth:`~wx.MenuItem.GetBackgroundColour` and :meth:`~wx.MenuItem.SetBackgroundColour`


   .. attribute:: Bitmap

      See :meth:`~wx.MenuItem.GetBitmap` and :meth:`~wx.MenuItem.SetBitmap`


   .. attribute:: DisabledBitmap

      See :meth:`~wx.MenuItem.GetDisabledBitmap` and :meth:`~wx.MenuItem.SetDisabledBitmap`


   .. attribute:: Enabled

      See :meth:`~wx.MenuItem.IsEnabled` and :meth:`~wx.MenuItem.Enable`


   .. attribute:: Font

      See :meth:`~wx.MenuItem.GetFont` and :meth:`~wx.MenuItem.SetFont`


   .. attribute:: Help

      See :meth:`~wx.MenuItem.GetHelp` and :meth:`~wx.MenuItem.SetHelp`


   .. attribute:: Id

      See :meth:`~wx.MenuItem.GetId`


   .. attribute:: ItemLabel

      See :meth:`~wx.MenuItem.GetItemLabel` and :meth:`~wx.MenuItem.SetItemLabel`


   .. attribute:: ItemLabelText

      See :meth:`~wx.MenuItem.GetItemLabelText`


   .. attribute:: Kind

      See :meth:`~wx.MenuItem.GetKind`


   .. attribute:: Label

      See :meth:`~wx.MenuItem.GetLabel`


   .. attribute:: MarginWidth

      See :meth:`~wx.MenuItem.GetMarginWidth` and :meth:`~wx.MenuItem.SetMarginWidth`


   .. attribute:: Menu

      See :meth:`~wx.MenuItem.GetMenu` and :meth:`~wx.MenuItem.SetMenu`


   .. attribute:: Name

      See :meth:`~wx.MenuItem.GetName`


   .. attribute:: SubMenu

      See :meth:`~wx.MenuItem.GetSubMenu` and :meth:`~wx.MenuItem.SetSubMenu`


   .. attribute:: Text

      See :meth:`~wx.MenuItem.GetText` and :meth:`~wx.MenuItem.SetText`


   .. attribute:: TextColour

      See :meth:`~wx.MenuItem.GetTextColour` and :meth:`~wx.MenuItem.SetTextColour`