Phoenix Logo

phoenix_title wx.MenuEvent

This class is used for a variety of menu-related events.

Note that these do not include menu command events, which are handled using wx.CommandEvent objects.

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

events Events Emitted by this Class

Handlers bound for the following event types will receive a wx.MenuEvent parameter.

  • EVT_MENU_OPEN: 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: A menu has been just closed. Notice that this event is currently being sent before the menu selection ( wxEVT_MENU ) event, if any.
  • EVT_MENU_HIGHLIGHT: The menu item with the specified id has been highlighted: used to show help prompts in the status bar by wx.Frame
  • EVT_MENU_HIGHLIGHT_ALL: A menu item has been highlighted, i.e. the currently selected menu item has changed.

class_hierarchy Class Hierarchy

Inheritance diagram for class MenuEvent:

method_summary Methods Summary

__init__ Constructor.
GetMenu Returns the menu which is being opened or closed.
GetMenuId Returns the menu identifier associated with the event.
IsPopup Returns True if the menu which is being opened or closed is a popup menu, False if it is a normal one.

property_summary Properties Summary

Menu See GetMenu
MenuId See GetMenuId

api Class API



class wx.MenuEvent(Event)

Possible constructors:

MenuEvent(type=wxEVT_NULL, id=0, menu=None)

This class is used for a variety of menu-related events.


Methods



__init__(self, type=wxEVT_NULL, id=0, menu=None)

Constructor.

Parameters:
  • type (wx.EventType) –
  • id (int) –
  • menu (wx.Menu) –


GetMenu(self)

Returns the menu which is being opened or closed.

This method can only be used with the OPEN and CLOSE events.

The returned value is never None in the ports implementing this function, which currently includes all the major ones.

Return type: wx.Menu


GetMenuId(self)

Returns the menu identifier associated with the event.

This method should be only used with the HIGHLIGHT events.

Return type:int


IsPopup(self)

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.

Return type:bool

Properties



Menu

See GetMenu



MenuId

See GetMenuId