Package wx :: Class MenuEvent
[frames | no frames]

Type MenuEvent

object --+        
         |        
    Object --+    
             |    
         Event --+
                 |
                MenuEvent


This class is used for a variety of menu-related events. Note that these do not include menu command events, which are handled by sending wx.CommandEvent objects.

The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help text in the first field of the status bar.

Events

wx.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).
wx.EVT_MENU_CLOSE A menu has been just closed.
wx.EVT_MENU_HIGHLIGHT Sent when the menu item with the specified id has been highlighted: used by default to show help prompts in the wx.Frame's status bar.
wx.EVT_MENU_HIGHLIGHT_ALL Can be used to catch the menu highlight event for all menu items.

Method Summary
MenuEvent __init__(self, type, winid, menu)
Constructor
  __repr__(self)
Menu GetMenu(self)
Returns the menu which is being opened or closed.
int GetMenuId(self)
Returns the menu identifier associated with the event.
bool IsPopup(self)
Returns True if the menu which is being opened or closed is a popup menu, False if it is a normal one.
    Inherited from Event
  __del__(self)
Event Clone(self)
Object GetEventObject(self)
Returns the object (usually a window) associated with the event, if any.
wxEventType GetEventType(self)
Returns the identifier of the given event type, such as wxEVT_COMMAND_BUTTON_CLICKED.
int GetId(self)
Returns the identifier associated with this event, such as a button command id.
bool GetSkipped(self)
Returns true if the event handler should be skipped, false otherwise.
long GetTimestamp(self)
bool IsCommandEvent(self)
Returns true if the event is or is derived from wx.CommandEvent else it returns false.
  ResumePropagation(self, propagationLevel)
Resume the event propagation by restoring the propagation level.
  SetEventObject(self, obj)
Sets the originating object, or in other words, obj is normally the object that is sending the event.
  SetEventType(self, typ)
Sets the specific type of the event.
  SetId(self, Id)
Set's the ID for the event.
  SetTimestamp(self, ts)
bool ShouldPropagate(self)
Test if this event should be propagated to the parent window or not, i.e.
  Skip(self, skip)
Called by an event handler, it controls whether additional event handlers bound to this event will be called after the current event handler returns.
int StopPropagation(self)
Stop the event from propagating to its parent window.
    Inherited from Object
  Destroy(self)
Deletes the C++ object this Python object is a proxy for.
String GetClassName(self)
Returns the class name of the C++ class using wxRTTI.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
Return hash(x)...
  __new__(T, S, ...)
Return a new object with type S, a subtype of T...
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
Return str(x)...

Method Details

__init__(self, type=wxEVT_NULL, winid=0, menu=None)
(Constructor)

Constructor

Parameters:
type
           (type=wxEventType)

winid
           (type=int)

menu
           (type=Menu)

Returns:
MenuEvent
Overrides:
wx.Event.__init__

GetMenu(self)

Returns the menu which is being opened or closed. This method should only be used with the OPEN and CLOSE events.

Returns:
Menu

GetMenuId(self)

Returns the menu identifier associated with the event. This method should be only used with the HIGHLIGHT events.

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

Returns:
bool

Generated by Epydoc 2.1.20050511.rpd on Sat Jun 16 16:45:28 2007 http://epydoc.sf.net