Enter search terms or a module, class or function name.
A menu item represents an item in a menu.
Note that you usually don’t have to deal with it directly as 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+.
Handlers bound for the following event types will receive one of the CommandEvent MenuEvent parameters.
__init__ | Constructs a MenuItem object. |
Check | Checks or unchecks the menu item. |
Enable | Enables or disables the menu item. |
GetBackgroundColour | Returns the background colour associated with the menu item. |
GetBitmap | Returns the checked or unchecked bitmap. |
GetFont | Returns the font associated with the menu item. |
GetHelp | Returns the help string associated with the menu item. |
GetId | Returns the menu item identifier. |
GetItemLabel | Returns the text associated with the menu item including any accelerator characters that were passed to the constructor or SetItemLabel . |
GetItemLabelText | Returns the text associated with the menu item, without any accelerator characters. |
GetKind | Returns the item kind, one of ITEM_SEPARATOR , ITEM_NORMAL , ITEM_CHECK or ITEM_RADIO . |
GetLabel | Returns the text associated with the menu item without any accelerator characters it might contain. |
GetLabelFromText | |
GetLabelText | Strips all accelerator characters and mnemonics from the given text. |
GetMarginWidth | Gets the width of the menu item checkmark bitmap. |
GetMenu | Returns the menu this menu item is in, or None if this menu item is not attached. |
GetName | Returns the text associated with the menu item. |
GetSubMenu | Returns the submenu associated with the menu item, or None if there isn’t one. |
GetText | Returns the text associated with the menu item, such as it was passed to the MenuItem constructor, i.e. |
GetTextColour | Returns the text colour associated with the menu item. |
IsCheckable | Returns True if the item is checkable. |
IsChecked | Returns True if the item is checked. |
IsEnabled | Returns True if the item is enabled. |
IsSeparator | Returns True if the item is a separator. |
IsSubMenu | Returns True if the item is a submenu. |
SetBackgroundColour | Sets the background colour associated with the menu item. |
SetBitmap | Sets the bitmap for the menu item. |
SetBitmaps | Sets the checked/unchecked bitmaps for the menu item. |
SetFont | Sets the font associated with the menu item. |
SetHelp | Sets the help string. |
SetItemLabel | Sets the label associated with the menu item. |
SetMarginWidth | Sets the width of the menu item checkmark bitmap. |
SetMenu | Sets the parent menu which will contain this menu item. |
SetSubMenu | Sets the submenu of this menu item. |
SetText | Sets the text associated with the menu item. |
SetTextColour | Sets the text colour associated with the menu item. |
BackgroundColour | See GetBackgroundColour and SetBackgroundColour |
Bitmap | See GetBitmap and SetBitmap |
Font | See GetFont and SetFont |
Help | See GetHelp and SetHelp |
Id | See GetId |
ItemLabel | See GetItemLabel and SetItemLabel |
ItemLabelText | See GetItemLabelText |
Kind | See GetKind |
Label | See GetLabel |
MarginWidth | See GetMarginWidth and SetMarginWidth |
Menu | See GetMenu and SetMenu |
Name | See GetName |
SubMenu | See GetSubMenu and SetSubMenu |
Text | See GetText and SetText |
TextColour | See GetTextColour and SetTextColour |
A menu item represents an item in a menu.
Possible constructors:
MenuItem(parentMenu=None, id=ID_SEPARATOR, text='',
helpString='', kind=ITEM_NORMAL, subMenu=None)
Constructs a 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 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 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.
Parameters: |
|
---|
Checks or unchecks the menu item.
Note that this only works when the item is already appended to a menu.
Parameters: | check (bool) – |
---|
Enables or disables the menu item.
Parameters: | enable (bool) – |
---|
Returns the background colour associated with the menu item.
Return type: | Colour |
---|
Availability
Only available for MSW.
Returns the checked or unchecked bitmap.
Return type: | Bitmap |
---|
Availability
Only available for MSW.
Returns the font associated with the menu item.
Return type: | Font |
---|
Availability
Only available for MSW.
Returns the help string associated with the menu item.
Return type: | string |
---|
Returns the menu item identifier.
Return type: | int |
---|
Returns the text associated with the menu item including any accelerator characters that were passed to the constructor or SetItemLabel .
Return type: | string |
---|
See also
Returns the text associated with the menu item, without any accelerator characters.
Return type: | string |
---|
See also
Returns the item kind, one of ITEM_SEPARATOR , ITEM_NORMAL , ITEM_CHECK or ITEM_RADIO .
Return type: | ItemKind |
---|
Returns the text associated with the menu item without any accelerator characters it might contain.
Return type: | string |
---|
Deprecated since version 2.9.4: This function is deprecated in favour of GetItemLabelText .
See also
Parameters: | text (string) – |
---|---|
Return type: | string |
Deprecated since version 2.9.4: This function is deprecated; please use GetLabelText instead.
See also
Strips all accelerator characters and mnemonics from the given text.
For example:
wx.MenuItem.GetLabelfromText("&Hello\tCtrl-h")
will return just "Hello" .
Parameters: | text (string) – |
---|---|
Return type: | string |
See also
Gets the width of the menu item checkmark bitmap.
Return type: | int |
---|
Availability
Only available for MSW.
Returns the menu this menu item is in, or None if this menu item is not attached.
Return type: | Menu |
---|
Returns the text associated with the menu item.
Return type: | string |
---|
Deprecated since version 2.9.4: This function is deprecated. Please use GetItemLabel or GetItemLabelText instead.
See also
Returns the submenu associated with the menu item, or None if there isn’t one.
Return type: | Menu |
---|
Returns the text associated with the menu item, such as it was passed to the MenuItem constructor, i.e.
with any accelerator characters it may contain.
Return type: | string |
---|
Deprecated since version 2.9.4: This function is deprecated in favour of GetItemLabel .
See also
Returns the text colour associated with the menu item.
Return type: | Colour |
---|
Availability
Only available for MSW.
Returns True if the item is checkable.
Return type: | bool |
---|
Returns True if the item is checked.
Return type: | bool |
---|
Returns True if the item is enabled.
Return type: | bool |
---|
Returns True if the item is a separator.
Return type: | bool |
---|
Returns True if the item is a submenu.
Return type: | bool |
---|
Sets the background colour associated with the menu item.
Parameters: | colour (Colour) – |
---|
Availability
Only available for MSW.
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.
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.
Parameters: |
|
---|
Availability
Only available for MSW, OSX, GTK.
Sets the checked/unchecked bitmaps for the menu item.
The first bitmap is also used as the single bitmap for uncheckable menu items.
Parameters: |
---|
Availability
Only available for MSW.
Sets the font associated with the menu item.
Parameters: | font (Font) – |
---|
Availability
Only available for MSW.
Sets the help string.
Parameters: | helpString (string) – |
---|
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 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):
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")
Parameters: | label (string) – |
---|
See also
Sets the width of the menu item checkmark bitmap.
Parameters: | width (int) – |
---|
Availability
Only available for MSW.
Sets the parent menu which will contain this menu item.
Parameters: | menu (Menu) – |
---|
Sets the text associated with the menu item.
Parameters: | text (string) – |
---|
Deprecated since version 2.9.4: This function is deprecated in favour of SetItemLabel .
See also
Sets the text colour associated with the menu item.
Parameters: | colour (Colour) – |
---|
Availability
Only available for MSW.
See GetItemLabel and SetItemLabel
See GetItemLabelText
See GetMarginWidth and SetMarginWidth
See GetSubMenu and SetSubMenu
See GetTextColour and SetTextColour