wxmenuevent

this class is used for a variety of menu-related events. note that these do not include menu command events, which are handled using wxcommandevent objects.

the default handler for wxevt_menu_highlight displays help text in the first field of the status bar.

derived from

wxevent
wxobject

include files

event table macros

to process a menu event, use these event handler macros to direct input to member functions that take a wxmenuevent argument. they can only be processed by a menubar's frame.

evt_menu_open(func)	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).
evt_menu_close(func)	a menu has been just closed.
evt_menu_highlight(id, func)	the menu item with the specified id has been highlighted: used to show help prompts in the status bar by wxframe
evt_menu_highlight_all(func)	a menu item has been highlighted, i.e. the currently selected menu item has changed.

see also

command events,
event handling overview

members

wxmenuevent::wxmenuevent
wxmenuevent::getmenu
wxmenuevent::getmenuid
wxmenuevent::ispopup

wxmenuevent::wxmenuevent

wxmenuevent(wxtype id = 0, int id = 0, wxmenu* menu = null)

constructor.

wxmenuevent::getmenu

wxmenu * getmenu() const

returns the menu which is being opened or closed. this method should only be used with the open and close events and even for them the returned pointer may be null in some ports.

wxmenuevent::getmenuid

int getmenuid() const

returns the menu identifier associated with the event. this method should be only used with the highlight events.

wxmenuevent::ispopup

bool ispopup() const

returns true if the menu which is being opened or closed is a popup menu, false if it is a normal one.

this method should only be used with the open and close events.