.. 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.ContextMenuEvent: ========================================================================================================================================== |phoenix_title| **wx.ContextMenuEvent** ========================================================================================================================================== This class is used for context menu events, sent to give the application a chance to show a context (popup) menu for a :ref:`wx.Window`. Note that if :meth:`wx.ContextMenuEvent.GetPosition` returns DefaultPosition, this means that the event originated from a keyboard context button event, and you should compute a suitable position yourself, for example by calling `wx.GetMousePosition` . Notice that the exact sequence of mouse events is different across the platforms. For example, under MSW the context menu event is generated after ``EVT_RIGHT_UP`` event and only if it was not handled but under GTK the context menu event is generated after ``EVT_RIGHT_DOWN`` event. This is correct in the sense that it ensures that the context menu is shown according to the current platform UI conventions and also means that you must not handle (or call :meth:`wx.Event.Skip` in your handler if you do have one) neither right mouse down nor right mouse up event if you plan on handling ``EVT_CONTEXT_MENU`` event. ^^ .. _ContextMenuEvent-events: |events| Events Emitted by this Class ===================================== Handlers bound for the following event types will receive a :ref:`wx.ContextMenuEvent` parameter. - EVT_CONTEXT_MENU: A right click (or other context menu command depending on platform) has been detected. ^^ .. seealso:: :ref:`wx.CommandEvent`, :ref:`Events and Event Handling ` | |class_hierarchy| Class Hierarchy ================================= .. raw:: html
Inheritance diagram for class ContextMenuEvent:
| |method_summary| Methods Summary ================================ ================================================================================ ================================================================================ :meth:`~wx.ContextMenuEvent.__init__` Constructor. :meth:`~wx.ContextMenuEvent.GetPosition` Returns the position in screen coordinates at which the menu should be shown. :meth:`~wx.ContextMenuEvent.SetPosition` Sets the position at which the menu should be shown. ================================================================================ ================================================================================ | |property_summary| Properties Summary ===================================== ================================================================================ ================================================================================ :attr:`~wx.ContextMenuEvent.Position` See :meth:`~wx.ContextMenuEvent.GetPosition` and :meth:`~wx.ContextMenuEvent.SetPosition` ================================================================================ ================================================================================ | |api| Class API =============== .. class:: wx.ContextMenuEvent(CommandEvent) **Possible constructors**:: ContextMenuEvent(type=wxEVT_NULL, id=0, pos=DefaultPosition) This class is used for context menu events, sent to give the application a chance to show a context (popup) menu for a Window. .. method:: __init__(self, type=wxEVT_NULL, id=0, pos=DefaultPosition) Constructor. :param `type`: :type `type`: wx.EventType :param `id`: :type `id`: int :param `pos`: :type `pos`: wx.Point .. method:: GetPosition(self) Returns the position in screen coordinates at which the menu should be shown. Use :meth:`wx.Window.ScreenToClient` to convert to client coordinates. You can also omit a position from :meth:`wx.Window.PopupMenu` in order to use the current mouse pointer position. If the event originated from a keyboard event, the value returned from this function will be DefaultPosition. :rtype: :ref:`wx.Point` .. method:: SetPosition(self, point) Sets the position at which the menu should be shown. :param `point`: :type `point`: wx.Point .. attribute:: Position See :meth:`~wx.ContextMenuEvent.GetPosition` and :meth:`~wx.ContextMenuEvent.SetPosition`