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). Menus may be used to construct either menu bars or popup menus.
A menu item has an integer ID associated with it which can be used to identify the selection, or to change the menu item in some way.
Derived from
Include files
<wx/menu.h>
Event handling
If the menu is part of a menubar, then wxMenuBar event processing is used.
With a popup menu, there is a variety of ways to handle a menu selection event (wxEVT_COMMAND_MENU_SELECTED).
See also
wxMenuBar, wxWindow::PopupMenu, Event handling overview
Members
wxMenu::wxMenu
wxMenu::~wxMenu
wxMenu::Append
wxMenu::AppendSeparator
wxMenu::Break
wxMenu::Check
wxMenu::Delete
wxMenu::Destroy
wxMenu::Enable
wxMenu::FindItem
wxMenu::GetHelpString
wxMenu::GetLabel
wxMenu::GetMenuItemCount
wxMenu::GetMenuItems
wxMenu::GetTitle
wxMenu::Insert
wxMenu::IsChecked
wxMenu::IsEnabled
wxMenu::Remove
wxMenu::SetHelpString
wxMenu::SetLabel
wxMenu::SetTitle
wxMenu::UpdateUI
wxMenu(const wxString& title = "", long style = 0)
Constructs a wxMenu object.
Parameters
title
style
wxMenu(long style)
Constructs a wxMenu object.
Parameters
style
~wxMenu()
Destructor, destroying the menu.
Note: under Motif, a popup menu must have a valid parent (the window it was last popped up on) when being destroyed. Therefore, make sure you delete or re-use the popup menu before destroying the parent window. Re-use in this context means popping up the menu on a different window from last time, which causes an implicit destruction and recreation of internal data structures.
void Append(int id, const wxString& item, const wxString& helpString = "", const bool checkable = FALSE)
Adds a string item to the end of the menu.
void Append(int id, const wxString& item, wxMenu *subMenu, const wxString& helpString = "")
Adds a pull-right submenu to the end of the menu.
void Append(wxMenuItem* 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
id
item
menu
checkable
helpString
menuItem
Remarks
This command can be used after the menu has been shown, as well as on initial creation of a menu or menubar.
See also
wxMenu::AppendSeparator, wxMenu::Insert, wxMenu::SetLabel, wxMenu::GetHelpString, wxMenu::SetHelpString, wxMenuItem
wxPython note: In place of a single overloaded method name, wxPython implements the following methods:
Append(id, string, helpStr="", checkable=FALSE) | |
AppendMenu(id, string, aMenu, helpStr="") | |
AppendItem(aMenuItem) |
void AppendSeparator()
Adds a separator to the end of the menu.
See also
void Break()
Inserts a break in a menu, causing the next appended item to appear in a new column.
void Check(int id, const bool check)
Checks or unchecks the menu item.
Parameters
id
check
See also
void Delete(int id)
void Delete(wxMenuItem *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
id
item
See also
wxMenu::FindItem, wxMenu::Destroy, wxMenu::Remove
void Destroy(int id)
void Destroy(wxMenuItem *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
id
item
See also
wxMenu::FindItem, wxMenu::Deletes, wxMenu::Remove
void Enable(int id, const bool enable)
Enables or disables (greys out) a menu item.
Parameters
id
enable
See also
int FindItem(const wxString& itemString) const
Finds the menu item id for a menu item string.
wxMenuItem * FindItem(int id, wxMenu **menu = NULL) const
Finds the menu item object associated with the given menu item identifier and, optionally, the (sub)menu it belongs to.
Parameters
itemString
id
menu
Return value
First form: menu item identifier, or wxNOT_FOUND if none is found.
Second form: returns the menu item object, or NULL if it is not found.
Remarks
Any special menu codes are stripped out of source and target strings before matching.
wxPython note: The name of this method in wxPython is FindItemById and it does not support the second parameter.
wxString GetHelpString(int id) const
Returns the help string associated with a menu item.
Parameters
id
Return value
The help string, or the empty string if there is no help string or the item was not found.
See also
wxMenu::SetHelpString, wxMenu::Append
wxString GetLabel(int id) const
Returns a menu item label.
Parameters
id
Return value
The item label, or the empty string if the item was not found.
See also
size_t GetMenuItemCount() const
Returns the number of items in the menu.
wxMenuItemList& GetMenuItems() const
Returns the list of items in the menu. wxMenuItemList is a pseudo-template list class containing wxMenuItem pointers.
wxString GetTitle() const
Returns the title of the menu.
Remarks
This is relevant only to popup menus.
See also
bool Insert(size_t pos, wxMenuItem *item)
Inserts the given item before the position pos. Inserting the item at the position GetMenuItemCount is the same as appending it.
See also
bool IsChecked(int id) const
Determines whether a menu item is checked.
Parameters
id
Return value
TRUE if the menu item is checked, FALSE otherwise.
See also
bool IsEnabled(int id) const
Determines whether a menu item is enabled.
Parameters
id
Return value
TRUE if the menu item is enabled, FALSE otherwise.
See also
wxMenuItem * Remove(int id)
wxMenuItem * Remove(wxMenuItem *item)
Removes the menu item from the menu but doesn't delete the associated C++ object. This allows to reuse the same item later by adding it back to the menu (especially useful with submenus).
Parameters
id
item
Return value
The item which was detached from the menu.
void SetHelpString(int id, const wxString& helpString)
Sets an item's help string.
Parameters
id
helpString
See also
void SetLabel(int id, const wxString& label)
Sets the label of a menu item.
Parameters
id
label
See also
wxMenu::Append, wxMenu::GetLabel
void SetTitle(const wxString& title)
Sets the title of the menu.
Parameters
title
Remarks
This is relevant only to popup menus.
See also
void UpdateUI(wxEvtHandler* source = NULL) const
Sends events to source (or owning window if NULL) to update the menu UI. This is called just before the menu is popped up with wxWindow::PopupMenu, but the application may call it at other times if required.
See also