.. include:: headings.inc



.. _MenuEvent:

==========================================================================================================================================
|phoenix_title|  **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 :ref:`CommandEvent`  objects. 

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





.. _MenuEvent-events:

|events| Events Emitted by this Class
=====================================

Handlers bound for the following event types will receive a :ref:`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.  
- EVT_MENU_HIGHLIGHT: The menu item with the specified id has been highlighted: used to show help prompts in the status bar by :ref:`Frame`   
- EVT_MENU_HIGHLIGHT_ALL: A menu item has been highlighted, i.e. the currently selected menu item has changed.  








         



.. seealso:: :ref:`CommandEvent`, :ref:`Events and Event Handling <events and event handling>`    







|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **MenuEvent**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/MenuEvent_inheritance.png" alt="Inheritance diagram of MenuEvent" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="125,5,197,35"/> <area shape="rect" id="node4" href="MenuEvent.html" title="This class is used for a variety of menu-related events." alt="" coords="247,5,348,35"/> <area shape="rect" id="node2" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,77,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~MenuEvent.__init__`                                                      Constructor.
:meth:`~MenuEvent.GetMenu`                                                       Returns the menu which is being opened or closed.
:meth:`~MenuEvent.GetMenuId`                                                     Returns the menu identifier associated with the event.
:meth:`~MenuEvent.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
=====================================

================================================================================ ================================================================================
:attr:`~MenuEvent.Menu`                                                          See :meth:`~MenuEvent.GetMenu`
:attr:`~MenuEvent.MenuId`                                                        See :meth:`~MenuEvent.GetMenuId`
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: MenuEvent(Event)

   This class is used for a variety of menu-related events.
   
   **Possible constructors**::

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



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

      Constructor.                  


      :param `type`: 
      :type `type`: EventType
      :param `id`: 
      :type `id`: int
      :param `menu`: 
      :type `menu`: Menu







   .. method:: 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.                  

      :rtype: :ref:`Menu`








   .. method:: GetMenuId(self)

      Returns the menu identifier associated with the event.                  

      This method should be only used with the  ``HIGHLIGHT``   events.                   

      :rtype: `int`








   .. method:: 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.                   

      :rtype: `bool`








   .. attribute:: Menu

      See :meth:`~MenuEvent.GetMenu`


   .. attribute:: MenuId

      See :meth:`~MenuEvent.GetMenuId`