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. A menu item with a special identifier wxID_SEPARATOR is a separator item and doesn't have an associated command but just makes a separator line appear in the menu.
- Note
- Please note that wxID_ABOUT and wxID_EXIT are predefined by wxWidgets and have a special meaning since entries using these IDs will be taken out of the normal menus under macOS and will be inserted into the system menu (following the appropriate macOS interface guideline).
Menu items may be either normal items, check items or radio items. Normal items don't have any special properties while the check items have a boolean flag associated to them and they show a checkmark in the menu when the flag is set. wxWidgets automatically toggles the flag value when the item is clicked and its value may be retrieved using either wxMenu::IsChecked method of wxMenu or wxMenuBar itself or by using wxEvent::IsChecked when you get the menu notification for the item in question.
The radio items are similar to the check items except that all the other items in the same radio group are unchecked when a radio item is checked. The radio group is formed by a contiguous range of radio items, i.e. it starts at the first item of this kind and ends with the first item of a different kind (or the end of the menu). Notice that because the radio groups are defined in terms of the item positions inserting or removing the items in the menu containing the radio items risks to not work correctly.
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 wxWindow::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 wxEvtHandler::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 wxMenuBar object.
Finally, menu events can also be handled in the associated window, which is either the wxFrame associated with the menu bar this menu belongs to or the window for which wxWindow::PopupMenu() was called for the popup menus.
See Dynamic Event Handling for how to bind event handlers to the various objects.
- See also
- wxMenuBar, wxWindow::PopupMenu, Events and Event Handling, wxFileHistory (most recently used files menu)
|
| wxMenu () |
| Constructs a wxMenu object. More...
|
|
| wxMenu (long style) |
| Constructs a wxMenu object. More...
|
|
| wxMenu (const wxString &title, long style=0) |
| Constructs a wxMenu object with a title. More...
|
|
virtual | ~wxMenu () |
| Destructor, destroying the menu. More...
|
|
wxMenuItem * | Append (int id, const wxString &item=wxEmptyString, const wxString &helpString=wxEmptyString, wxItemKind kind=wxITEM_NORMAL) |
| Adds a menu item. More...
|
|
wxMenuItem * | Append (int id, const wxString &item, wxMenu *subMenu, const wxString &helpString=wxEmptyString) |
| Adds a submenu. More...
|
|
wxMenuItem * | Append (wxMenuItem *menuItem) |
| Adds a menu item object. More...
|
|
wxMenuItem * | AppendCheckItem (int id, const wxString &item, const wxString &help=wxEmptyString) |
| Adds a checkable item to the end of the menu. More...
|
|
wxMenuItem * | AppendRadioItem (int id, const wxString &item, const wxString &help=wxEmptyString) |
| Adds a radio item to the end of the menu. More...
|
|
wxMenuItem * | AppendSeparator () |
| Adds a separator to the end of the menu. More...
|
|
wxMenuItem * | AppendSubMenu (wxMenu *submenu, const wxString &text, const wxString &help=wxEmptyString) |
| Adds the given submenu to this menu. More...
|
|
virtual void | Break () |
| Inserts a break in a menu, causing the next appended item to appear in a new column. More...
|
|
void | Check (int id, bool check) |
| Checks or unchecks the menu item. More...
|
|
bool | Delete (int id) |
| Deletes the menu item from the menu. More...
|
|
bool | Delete (wxMenuItem *item) |
| Deletes the menu item from the menu. More...
|
|
bool | Destroy (int id) |
| Deletes the menu item from the menu. More...
|
|
bool | Destroy (wxMenuItem *item) |
| Deletes the menu item from the menu. More...
|
|
void | Enable (int id, bool enable) |
| Enables or disables (greys out) a menu item. More...
|
|
wxMenuItem * | FindChildItem (int id, size_t *pos=nullptr) const |
| Finds the menu item object associated with the given menu item identifier and, optionally, the position of the item in the menu. More...
|
|
virtual int | FindItem (const wxString &itemString) const |
| Finds the menu id for a menu item string. More...
|
|
wxMenuItem * | FindItem (int id, wxMenu **menu=nullptr) const |
| Finds the menu item object associated with the given menu item identifier and, optionally, the (sub)menu it belongs to. More...
|
|
wxMenuItem * | FindItemByPosition (size_t position) const |
| Returns the wxMenuItem given a position in the menu. More...
|
|
virtual wxString | GetHelpString (int id) const |
| Returns the help string associated with a menu item. More...
|
|
wxString | GetLabel (int id) const |
| Returns a menu item label. More...
|
|
wxString | GetLabelText (int id) const |
| Returns a menu item label, without any of the original mnemonics and accelerators. More...
|
|
size_t | GetMenuItemCount () const |
| Returns the number of items in the menu. More...
|
|
const wxString & | GetTitle () const |
| Returns the title of the menu. More...
|
|
wxMenuItem * | Insert (size_t pos, wxMenuItem *menuItem) |
| Inserts the given item before the position pos. More...
|
|
wxMenuItem * | Insert (size_t pos, int id, const wxString &item=wxEmptyString, const wxString &helpString=wxEmptyString, wxItemKind kind=wxITEM_NORMAL) |
| Inserts the given item before the position pos. More...
|
|
wxMenuItem * | Insert (size_t pos, int id, const wxString &text, wxMenu *submenu, const wxString &help=wxEmptyString) |
| Inserts the given submenu before the position pos. More...
|
|
wxMenuItem * | InsertCheckItem (size_t pos, int id, const wxString &item, const wxString &helpString=wxEmptyString) |
| Inserts a checkable item at the given position. More...
|
|
wxMenuItem * | InsertRadioItem (size_t pos, int id, const wxString &item, const wxString &helpString=wxEmptyString) |
| Inserts a radio item at the given position. More...
|
|
wxMenuItem * | InsertSeparator (size_t pos) |
| Inserts a separator at the given position. More...
|
|
bool | IsChecked (int id) const |
| Determines whether a menu item is checked. More...
|
|
bool | IsEnabled (int id) const |
| Determines whether a menu item is enabled. More...
|
|
virtual bool | MSWCommand (WXUINT param, WXWORD id) |
| Allows handling native MSW menu command messages. More...
|
|
wxMenuItem * | Prepend (wxMenuItem *item) |
| Inserts the given item at position 0, i.e. before all the other existing items. More...
|
|
wxMenuItem * | Prepend (int id, const wxString &item=wxEmptyString, const wxString &helpString=wxEmptyString, wxItemKind kind=wxITEM_NORMAL) |
| Inserts the given item at position 0, i.e. before all the other existing items. More...
|
|
wxMenuItem * | Prepend (int id, const wxString &text, wxMenu *submenu, const wxString &help=wxEmptyString) |
| Inserts the given submenu at position 0. More...
|
|
wxMenuItem * | PrependCheckItem (int id, const wxString &item, const wxString &helpString=wxEmptyString) |
| Inserts a checkable item at position 0. More...
|
|
wxMenuItem * | PrependRadioItem (int id, const wxString &item, const wxString &helpString=wxEmptyString) |
| Inserts a radio item at position 0. More...
|
|
wxMenuItem * | PrependSeparator () |
| Inserts a separator at position 0. More...
|
|
wxMenuItem * | Remove (int id) |
| Removes the menu item from the menu but doesn't delete the associated C++ object. More...
|
|
wxMenuItem * | Remove (wxMenuItem *item) |
| Removes the menu item from the menu but doesn't delete the associated C++ object. More...
|
|
virtual void | SetHelpString (int id, const wxString &helpString) |
| Sets an item's help string. More...
|
|
void | SetLabel (int id, const wxString &label) |
| Sets the label of a menu item. More...
|
|
virtual void | SetTitle (const wxString &title) |
| Sets the title of the menu. More...
|
|
void | UpdateUI (wxEvtHandler *source=nullptr) |
| Update the state of all menu items, recursively, by generating wxEVT_UPDATE_UI events for them. More...
|
|
void | SetInvokingWindow (wxWindow *win) |
|
wxWindow * | GetInvokingWindow () const |
|
wxWindow * | GetWindow () const |
|
long | GetStyle () const |
|
void | SetParent (wxMenu *parent) |
|
wxMenu * | GetParent () const |
|
virtual void | Attach (wxMenuBar *menubar) |
|
virtual void | Detach () |
|
bool | IsAttached () const |
|
|
wxMenuItemList & | GetMenuItems () |
| Returns the list of items in the menu. More...
|
|
const wxMenuItemList & | GetMenuItems () const |
| Returns the list of items in the menu. More...
|
|
Public Member Functions inherited from wxEvtHandler |
| wxEvtHandler () |
| Constructor. More...
|
|
virtual | ~wxEvtHandler () |
| Destructor. More...
|
|
virtual void | QueueEvent (wxEvent *event) |
| Queue event for a later processing. More...
|
|
virtual void | AddPendingEvent (const wxEvent &event) |
| Post an event to be processed later. More...
|
|
template<typename T , typename T1 , ... > |
void | CallAfter (void(T::*method)(T1,...), T1 x1,...) |
| Asynchronously call the given method. More...
|
|
template<typename T > |
void | CallAfter (const T &functor) |
| Asynchronously call the given functor. More...
|
|
virtual bool | ProcessEvent (wxEvent &event) |
| Processes an event, searching event tables and calling zero or more suitable event handler function(s). More...
|
|
bool | ProcessEventLocally (wxEvent &event) |
| Try to process the event in this handler and all those chained to it. More...
|
|
bool | SafelyProcessEvent (wxEvent &event) |
| Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process. More...
|
|
void | ProcessPendingEvents () |
| Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a wxCHECK will fail. More...
|
|
void | DeletePendingEvents () |
| Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent(). More...
|
|
void | Connect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function, wxObject *userData=nullptr, wxEvtHandler *eventSink=nullptr) |
| Connects the given function dynamically with the event handler, id and event type. More...
|
|
void | Connect (int id, wxEventType eventType, wxObjectEventFunction function, wxObject *userData=nullptr, wxEvtHandler *eventSink=nullptr) |
| See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. More...
|
|
void | Connect (wxEventType eventType, wxObjectEventFunction function, wxObject *userData=nullptr, wxEvtHandler *eventSink=nullptr) |
| See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. More...
|
|
bool | Disconnect (wxEventType eventType, wxObjectEventFunction function, wxObject *userData=nullptr, wxEvtHandler *eventSink=nullptr) |
| Disconnects the given function dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed. More...
|
|
bool | Disconnect (int id=wxID_ANY, wxEventType eventType=wxEVT_NULL, wxObjectEventFunction function=nullptr, wxObject *userData=nullptr, wxEvtHandler *eventSink=nullptr) |
| See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. More...
|
|
bool | Disconnect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function=nullptr, wxObject *userData=nullptr, wxEvtHandler *eventSink=nullptr) |
| See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. More...
|
|
template<typename EventTag , typename Functor > |
void | Bind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=nullptr) |
| Binds the given function, functor or method dynamically with the event. More...
|
|
template<typename EventTag , typename Class , typename EventArg , typename EventHandler > |
void | Bind (const EventTag &eventType, void(Class::*method)(EventArg &), EventHandler *handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=nullptr) |
| See the Bind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info. More...
|
|
template<typename EventTag , typename Functor > |
bool | Unbind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=nullptr) |
| Unbinds the given function, functor or method dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed. More...
|
|
template<typename EventTag , typename Class , typename EventArg , typename EventHandler > |
bool | Unbind (const EventTag &eventType, void(Class::*method)(EventArg &), EventHandler *handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=nullptr) |
| See the Unbind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info. More...
|
|
void * | GetClientData () const |
| Returns user-supplied client data. More...
|
|
wxClientData * | GetClientObject () const |
| Returns a pointer to the user-supplied client data object. More...
|
|
void | SetClientData (void *data) |
| Sets user-supplied client data. More...
|
|
void | SetClientObject (wxClientData *data) |
| Set the client data object. More...
|
|
bool | GetEvtHandlerEnabled () const |
| Returns true if the event handler is enabled, false otherwise. More...
|
|
wxEvtHandler * | GetNextHandler () const |
| Returns the pointer to the next handler in the chain. More...
|
|
wxEvtHandler * | GetPreviousHandler () const |
| Returns the pointer to the previous handler in the chain. More...
|
|
void | SetEvtHandlerEnabled (bool enabled) |
| Enables or disables the event handler. More...
|
|
virtual void | SetNextHandler (wxEvtHandler *handler) |
| Sets the pointer to the next handler. More...
|
|
virtual void | SetPreviousHandler (wxEvtHandler *handler) |
| Sets the pointer to the previous handler. More...
|
|
void | Unlink () |
| Unlinks this event handler from the chain it's part of (if any); then links the "previous" event handler to the "next" one (so that the chain won't be interrupted). More...
|
|
bool | IsUnlinked () const |
| Returns true if the next and the previous handler pointers of this event handler instance are nullptr. More...
|
|
| wxObject () |
| Default ctor; initializes to nullptr the internal reference data. More...
|
|
| wxObject (const wxObject &other) |
| Copy ctor. More...
|
|
virtual | ~wxObject () |
| Destructor. More...
|
|
virtual wxClassInfo * | GetClassInfo () const |
| This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
|
|
wxObjectRefData * | GetRefData () const |
| Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
|
|
bool | IsKindOf (const wxClassInfo *info) const |
| Determines whether this class is a subclass of (or the same class as) the given class. More...
|
|
bool | IsSameAs (const wxObject &obj) const |
| Returns true if this object has the same data pointer as obj. More...
|
|
void | Ref (const wxObject &clone) |
| Makes this object refer to the data in clone. More...
|
|
void | SetRefData (wxObjectRefData *data) |
| Sets the wxObject::m_refData pointer. More...
|
|
void | UnRef () |
| Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
|
|
void | UnShare () |
| This is the same of AllocExclusive() but this method is public. More...
|
|
void | operator delete (void *buf) |
| The delete operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. More...
|
|
void * | operator new (size_t size, const wxString &filename=nullptr, int lineNum=0) |
| The new operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. More...
|
|