1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.MenuEvent:
==========================================================================================================================================
|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 :ref:`wx.CommandEvent` objects.
Events of this class are generated by both menus that are part of a :ref:`wx.MenuBar`, attached to :ref:`wx.Frame`, and popup menus shown by :meth:`wx.Window.PopupMenu` . They are sent to the following objects until one of them handles the event:
- The menu object itself, as returned by :meth:`~wx.MenuEvent.GetMenu`, if any.
- The :ref:`wx.MenuBar` to which this menu is attached, if any.
- The window associated with the menu, e.g. the one calling PopupMenu() for the popup menus.
- The top level parent of that window if it's different from the window itself.
This is similar to command events generated by the menu items, but, unlike them, :ref:`wx.MenuEvent` are only sent to the window itself and its top level parent but not any intermediate windows in the hierarchy.
The default handler for ``wxEVT_MENU_HIGHLIGHT`` in :ref:`wx.Frame` displays help text in the status bar, see :meth:`wx.Frame.SetStatusBarPane` .
^^
.. _MenuEvent-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.MenuEvent` parameter.
Event macros:
- 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 :ref:`wx.Frame`
- EVT_MENU_HIGHLIGHT_ALL: A menu item has been highlighted, i.e. the currently selected menu item has changed. ^^
.. seealso:: :ref:`wx.CommandEvent`, :ref:`Events and Event Handling <events and event handling>`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>MenuEvent</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.MenuEvent_inheritance.png" alt="Inheritance diagram of MenuEvent" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.MenuEvent.html" title="wx.MenuEvent" alt="" coords="5,160,123,189"/> <area shape="rect" id="node2" href="wx.Event.html" title="wx.Event" alt="" coords="23,83,105,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="21,5,107,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.MenuEvent.__init__` Constructor.
:meth:`~wx.MenuEvent.GetMenu` Returns the menu which is being opened or closed, or the menu containing the highlighted item.
:meth:`~wx.MenuEvent.GetMenuId` Returns the menu identifier associated with the event.
:meth:`~wx.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:`~wx.MenuEvent.Menu` See :meth:`~wx.MenuEvent.GetMenu`
:attr:`~wx.MenuEvent.MenuId` See :meth:`~wx.MenuEvent.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.
.. method:: __init__(self, type=wxEVT_NULL, id=0, menu=None)
Constructor.
:param `type`:
:type `type`: wx.EventType
:param `id`:
:type `id`: int
:param `menu`:
:type `menu`: wx.Menu
.. method:: GetMenu(self)
Returns the menu which is being opened or closed, or the menu containing the highlighted item.
Note that the returned value can be ``None`` if the menu being opened doesn't have a corresponding :ref:`wx.Menu`, e.g. this happens when opening the system menu in wxMSW port.
:rtype: :ref:`wx.Menu`
.. note::
Since 3.1.3 this function can be used with ``OPEN`` , ``CLOSE`` and ``HIGHLIGHT`` events. Before 3.1.3, this method can only be used with the ``OPEN`` and ``CLOSE`` events.
.. 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:`~wx.MenuEvent.GetMenu`
.. attribute:: MenuId
See :meth:`~wx.MenuEvent.GetMenuId`
|
