Allocation strategy¶

All menus must be created on the heap because all menus attached to a menubar or to another menu will be deleted by their parent when it is deleted. The only exception to this rule are the popup menus (i.e. menus used with wx.Window.PopupMenu ) as wxWidgets does not destroy them to allow reusing the same menu more than once. But the exception applies only to the menus themselves and not to any submenus of popup menus which are still destroyed by wxWidgets as usual and so must be heap-allocated. As the frame menubar is deleted by the frame itself, it means that normally all menus used are deleted automatically.

Event handling¶

Event handlers for the commands generated by the menu items can be connected directly to the menu object itself using wx.EvtHandler.Bind . If this menu is a submenu of another one, the events from its items can also be processed in the parent menu and so on, recursively. If the menu is part of a menu bar, then events can also be handled in wx.MenuBar object. Finally, menu events can also be handled in the associated window, which is either the wx.Frame associated with the menu bar this menu belongs to or the window for which wx.Window.PopupMenu was called for the popup menus. See Dynamic Event Handling for how to bind event handlers to the various objects.

Class Hierarchy¶

Inheritance diagram for class Menu:

Methods Summary¶

Properties Summary¶

Class API¶

class wx.Menu(EvtHandler)¶

Possible constructors:

Menu() -> None

Menu(style) -> None

Menu(title, style=0) -> None

A menu is a popup (or pull down) list of items, one of which may be selected before the menu goes away (clicking elsewhere dismisses the menu).

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

---

__init__ (self)

Constructs a wx.Menu object.

Return type:

None

---

__init__ (self, style)

Constructs a wx.Menu object.

Parameters:

style (long) – If set to wx.MENU_TEAROFF, the menu will be detachable (wxGTK and QT only).

Return type:

None

---

__init__ (self, title, style=0)

Constructs a wx.Menu object with a title.

Parameters:

• title (string) – Title at the top of the menu (not always supported).

• style (long) – If set to wx.MENU_TEAROFF, the menu will be detachable (wxGTK and QT only).

Return type:

None

---

---

Append(self, *args, **kw)¶

Overloaded Implementations:

---

Append (self, id, item=’’, helpString=’’, kind=ITEM_NORMAL)

Adds a menu item.

Parameters:

• id (int) – The menu command identifier. See Window IDs for more information about IDs (same considerations apply to both window and menu item IDs).

• item (string) – The string to appear on the menu item. See wx.MenuItem.SetItemLabel for more details.

• helpString (string) – An optional help string associated with the item. By default, the handler for the wxEVT_MENU_HIGHLIGHT event displays this string in the status line.

• kind (ItemKind) – May be ITEM_SEPARATOR , ITEM_NORMAL , ITEM_CHECK or ITEM_RADIO .

Return type:

wx.MenuItem

self.fileMenu.Append(ID_NEW_FILE, "&New file\tCTRL+N", "Creates a XYZ document")

or even better for stock menu items (see MenuItem.__init__ ):

self.fileMenu.Append(wx.ID_NEW, "", "Creates a XYZ document")

Note

This command can be used after the menu has been shown, as well as on initial creation of a menu or menubar.

See also

AppendSeparator , AppendCheckItem , AppendRadioItem , AppendSubMenu , Insert , SetLabel , GetHelpString , SetHelpString , wx.MenuItem

---

Append (self, id, item, subMenu, helpString=’’)

Adds a submenu.

Parameters:

• id (int) – The menu command identifier.

• item (string) – The string to appear on the menu item.

• subMenu (wx.Menu) – Pull-right submenu.

• helpString (string) – An optional help string associated with the item. By default, the handler for the wxEVT_MENU_HIGHLIGHT event displays this string in the status line.

Return type:

wx.MenuItem

Deprecated

This function is deprecated, use AppendSubMenu instead.

See also

AppendSeparator , AppendCheckItem , AppendRadioItem , AppendSubMenu , Insert , SetLabel , GetHelpString , SetHelpString , wx.MenuItem

---

Append (self, menuItem)

Adds a menu item object.

This is the most generic variant of Append method because it may be used for both items (including separators) and submenus and because you can also specify various extra properties of a menu item this way, such as bitmaps and fonts.

Parameters:

menuItem (wx.MenuItem) – A menuitem object. It will be owned by the wx.Menu object after this function is called, so do not delete it yourself.

Return type:

wx.MenuItem

Note

See the remarks for the other Append overloads.

See also

AppendSeparator , AppendCheckItem , AppendRadioItem , AppendSubMenu , Insert , SetLabel , GetHelpString , SetHelpString , wx.MenuItem

---

---

AppendCheckItem(self, id, item, help='')¶

Adds a checkable item to the end of the menu.

Parameters:

• id (int)

• item (string)

• help (string)

Return type:

wx.MenuItem

See also

Append , InsertCheckItem

---

AppendRadioItem(self, id, item, help='')¶

Adds a radio item to the end of the menu.

All consequent radio items form a group and when an item in the group is checked, all the others are automatically unchecked.

Parameters:

• id (int)

• item (string)

• help (string)

Return type:

wx.MenuItem

See also

Append , InsertRadioItem

---

AppendSeparator(self)¶

Adds a separator to the end of the menu.

Return type:

wx.MenuItem

See also

Append , InsertSeparator

---

AppendSubMenu(self, submenu, text, help='')¶

Adds the given submenu to this menu.

text is the text shown in the menu for it and help is the help string shown in the status bar when the submenu item is selected.

Parameters:

• submenu (wx.Menu)

• text (string)

• help (string)

Return type:

wx.MenuItem

See also

Insert , Prepend

---

Attach(self, menubar)¶

Parameters:

menubar (wx.MenuBar)

Return type:

None

---

Break(self)¶

Inserts a break in a menu, causing the next appended item to appear in a new column.

This function only actually inserts a break in wxMSW and does nothing under the other platforms.

Return type:

None

---

Check(self, id, check)¶

Checks or unchecks the menu item.

Parameters:

• id (int) – The menu item identifier.

• check (bool) – If True, the item will be checked, otherwise it will be unchecked.

Return type:

None

See also

IsChecked

---

Delete(self, *args, **kw)¶

Overloaded Implementations:

---

Delete (self, id)

Deletes the menu item from the menu.

If the item is a submenu, it will not be deleted. Use Destroy if you want to delete a submenu.

Parameters:

id (int) – Id of the menu item to be deleted.

Return type:

bool

See also

FindItem , Destroy , Remove

---

Delete (self, item)

Deletes the menu item from the menu.

If the item is a submenu, it will not be deleted. Use Destroy if you want to delete a submenu.

Parameters:

item (wx.MenuItem) – Menu item to be deleted.

Return type:

bool

See also

FindItem , Destroy , Remove

---

---

DestroyItem(self, *args, **kw)¶

Overloaded Implementations:

---

DestroyItem (self, id)

Deletes the menu item from the menu.

If the item is a submenu, it will be deleted. Use Remove if you want to keep the submenu (for example, to reuse it later).

Parameters:

id (int) – Id of the menu item to be deleted.

Return type:

bool

See also

FindItem , Delete , Remove

---

DestroyItem (self, item)

Deletes the menu item from the menu.

If the item is a submenu, it will be deleted. Use Remove if you want to keep the submenu (for example, to reuse it later).

Parameters:

item (wx.MenuItem) – Menu item to be deleted.

Return type:

bool

See also

FindItem , Delete , Remove

---

---

Detach(self)¶

Return type:

None

---

Enable(self, id, enable)¶

Enables or disables (greys out) a menu item.

Parameters:

• id (int) – The menu item identifier.

• enable (bool) – True to enable the menu item, False to disable it.

Return type:

None

See also

IsEnabled

---

FindChildItem(self, id)¶

Finds the menu item object associated with the given menu item identifier and, optionally, the position of the item in the menu.

Unlike FindItem , this function doesn’t recurse but only looks at the direct children of this menu.

Parameters:

id (int) – The identifier of the menu item to find.

Return type:

Tuple[MenuItem, int]

Returns:

Menu item object or nullptr if not found.

---

FindItem(self, *args, **kw)¶

Overloaded Implementations:

---

FindItem (self, itemString)

Finds the menu id for a menu item string.

Parameters:

itemString (string) – Menu item string to find.

Return type:

int

Returns:

Menu item identifier, or wx.NOT_FOUND if none is found.

Note

Any special menu codes are stripped out of source and target strings before matching.

---

FindItem (self, id)

Finds the menu item object associated with the given menu item identifier and, optionally, the (sub)menu it belongs to.

Parameters:

id (int) – Menu item identifier.

Return type:

Tuple[MenuItem, Menu]

Returns:

Menu item object or nullptr if none is found.

---

---

FindItemById(self, id)¶

FindItemById(id) . MenuItem

Finds the menu item object associated with the given menu item identifier.

Return type:

wx.MenuItem

---

FindItemByPosition(self, position)¶

Returns the wx.MenuItem given a position in the menu.

Parameters:

position (int)

Return type:

wx.MenuItem

---

GetHelpString(self, id)¶

Returns the help string associated with a menu item.

Parameters:

id (int) – The menu item identifier.

Return type:

str

Returns:

The help string, or the empty string if there is no help string or the item was not found.

See also

SetHelpString , Append

---

GetInvokingWindow(self)¶

Return type:

wx.Window

---

GetLabel(self, id)¶

Returns a menu item label.

Parameters:

id (int) – The menu item identifier.

Return type:

str

Returns:

The item label, or the empty string if the item was not found.

See also

GetLabelText , SetLabel

---

GetLabelText(self, id)¶

Returns a menu item label, without any of the original mnemonics and accelerators.

Parameters:

id (int) – The menu item identifier.

Return type:

str

Returns:

The item label, or the empty string if the item was not found.

See also

GetLabel , SetLabel

---

GetMenuItemCount(self)¶

Returns the number of items in the menu.

Return type:

int

---

GetMenuItems(self)¶

Returns the list of items in the menu.

MenuItemList is a pseudo-template list class containing wx.MenuItem pointers, see List.

Return type:

MenuItemList

---

GetParent(self)¶

Return type:

wx.Menu

---

GetStyle(self)¶

Return type:

int

---

GetTitle(self)¶

Returns the title of the menu.

Return type:

str

See also

SetTitle

---

GetWindow(self)¶

Return type:

wx.Window

---

Insert(self, *args, **kw)¶

Overloaded Implementations:

---

Insert (self, pos, menuItem)

Inserts the given item before the position pos.

Inserting the item at position GetMenuItemCount is the same as appending it.

Parameters:

• pos (int)

• menuItem (wx.MenuItem)

Return type:

wx.MenuItem

See also

Append , Prepend

---

Insert (self, pos, id, item=’’, helpString=’’, kind=ITEM_NORMAL)

Inserts the given item before the position pos.

Inserting the item at position GetMenuItemCount is the same as appending it.

Parameters:

• pos (int)

• id (int)

• item (string)

• helpString (string)

• kind (ItemKind)

Return type:

wx.MenuItem

See also

Append , Prepend

---

Insert (self, pos, id, text, submenu, help=’’)

Inserts the given submenu before the position pos.

text is the text shown in the menu for it and help is the help string shown in the status bar when the submenu item is selected.

Parameters:

• pos (int)

• id (int)

• text (string)

• submenu (wx.Menu)

• help (string)

Return type:

wx.MenuItem

See also

AppendSubMenu , Prepend

---

---

InsertCheckItem(self, pos, id, item, helpString='')¶

Inserts a checkable item at the given position.

Parameters:

• pos (int)

• id (int)

• item (string)

• helpString (string)

Return type:

wx.MenuItem

See also

Insert , AppendCheckItem

---

InsertRadioItem(self, pos, id, item, helpString='')¶

Inserts a radio item at the given position.

Parameters:

• pos (int)

• id (int)

• item (string)

• helpString (string)

Return type:

wx.MenuItem

See also

Insert , AppendRadioItem

---

InsertSeparator(self, pos)¶

Inserts a separator at the given position.

Parameters:

pos (int)

Return type:

wx.MenuItem

See also

Insert , AppendSeparator

---

IsAttached(self)¶

Return type:

bool

---

IsChecked(self, id)¶

Determines whether a menu item is checked.

Parameters:

id (int) – The menu item identifier.

Return type:

bool

Returns:

True if the menu item is checked, False otherwise.

See also

Check

---

IsEnabled(self, id)¶

Determines whether a menu item is enabled.

Parameters:

id (int) – The menu item identifier.

Return type:

bool

Returns:

True if the menu item is enabled, False otherwise.

See also

Enable

---

Prepend(self, *args, **kw)¶

Overloaded Implementations:

---

Prepend (self, menuItem)

Inserts the given item at position 0, i.e. before all the other existing items.

Parameters:

menuItem (wx.MenuItem)

Return type:

wx.MenuItem

See also

Append , Insert

---

Prepend (self, id, item=’’, helpString=’’, kind=ITEM_NORMAL)

Inserts the given item at position 0, i.e. before all the other existing items.

Parameters:

• id (int)

• item (string)

• helpString (string)

• kind (ItemKind)

Return type:

wx.MenuItem

See also

Append , Insert

---

Prepend (self, id, text, subMenu, help=’’)

Inserts the given submenu at position 0.

Parameters:

• id (int)

• text (string)

• subMenu (wx.Menu)

• help (string)

Return type:

wx.MenuItem

See also

AppendSubMenu , Insert

---

---

PrependCheckItem(self, id, item, helpString='')¶

Inserts a checkable item at position 0.

Parameters:

• id (int)

• item (string)

• helpString (string)

Return type:

wx.MenuItem

See also

Prepend , AppendCheckItem

---

PrependRadioItem(self, id, item, helpString='')¶

Inserts a radio item at position 0.

Parameters:

• id (int)

• item (string)

• helpString (string)

Return type:

wx.MenuItem

See also

Prepend , AppendRadioItem

---

PrependSeparator(self)¶

Inserts a separator at position 0.

Return type:

wx.MenuItem

See also

Prepend , AppendSeparator

---

Remove(self, *args, **kw)¶

Overloaded Implementations:

---

Remove (self, id)

Removes the menu item from the menu but doesn’t delete the associated C++ object.

This allows you to reuse the same item later by adding it back to the menu (especially useful with submenus).

Parameters:

id (int) – The identifier of the menu item to remove.

Return type:

wx.MenuItem

Returns:

A pointer to the item which was detached from the menu.

---

Remove (self, item)

Removes the menu item from the menu but doesn’t delete the associated C++ object.

This allows you to reuse the same item later by adding it back to the menu (especially useful with submenus).

Parameters:

item (wx.MenuItem) – The menu item to remove.

Return type:

wx.MenuItem

Returns:

A pointer to the item which was detached from the menu.

---

---

SetHelpString(self, id, helpString)¶

Sets an item’s help string.

Parameters:

• id (int) – The menu item identifier.

• helpString (string) – The help string to set.

Return type:

None

See also

GetHelpString

---

SetInvokingWindow(self, win)¶

Parameters:

win (wx.Window)

Return type:

None

---

SetLabel(self, id, label)¶

Sets the label of a menu item.

Parameters:

• id (int) – The menu item identifier.

• label (string) – The menu item label to set.

Return type:

None

See also

Append , GetLabel

---

SetParent(self, parent)¶

Parameters:

parent (wx.Menu)

Return type:

None

---

SetTitle(self, title)¶

Sets the title of the menu.

Parameters:

title (string) – The title to set.

Return type:

None

Note

Notice that you can only call this method directly for the popup menus, to change the title of a menu that is part of a menu bar you need to use wx.MenuBar.SetMenuLabel .

See also

GetTitle

---

UpdateUI(self, source=None)¶

Update the state of all menu items, recursively, by generating wxEVT_UPDATE_UI events for them.

This is an internal wxWidgets function and shouldn’t normally be called from outside of the library. If it is called, source argument should not be used, it is deprecated and exists only for backwards compatibility.

Parameters:

source (wx.EvtHandler)

Return type:

None

Properties¶

InvokingWindow¶

See GetInvokingWindow and SetInvokingWindow

---

MenuItemCount¶

See GetMenuItemCount

---

MenuItems¶

See GetMenuItems

---

Parent¶

See GetParent and SetParent

---

Style¶

See GetStyle

---

Title¶

See GetTitle and SetTitle

---

Window¶

See GetWindow