.. 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.grid.GridActivationSource: ========================================================================================================================================== |phoenix_title| **wx.grid.GridActivationSource** ========================================================================================================================================== Represents a source of cell activation, which may be either a user event (mouse or keyboard) or the program itself. An object of this class is passed to :meth:`wx.grid.GridCellEditor.TryActivate` by the library and the code overriding this method may use its :meth:`~wx.grid.GridActivationSource.GetOrigin` method to determine how exactly the cell is being activated. .. versionadded:: 4.1/wxWidgets-3.1.4 | |class_hierarchy| Class Hierarchy ================================= .. raw:: html
Inheritance diagram for class GridActivationSource:
| |method_summary| Methods Summary ================================ ================================================================================ ================================================================================ :meth:`~wx.grid.GridActivationSource.GetKeyEvent` Get the key event corresponding to the key press activating the cell. :meth:`~wx.grid.GridActivationSource.GetMouseEvent` Get the mouse event corresponding to the click activating the cell. :meth:`~wx.grid.GridActivationSource.GetOrigin` Get the origin of the activation. ================================================================================ ================================================================================ | |property_summary| Properties Summary ===================================== ================================================================================ ================================================================================ :attr:`~wx.grid.GridActivationSource.KeyEvent` See :meth:`~wx.grid.GridActivationSource.GetKeyEvent` :attr:`~wx.grid.GridActivationSource.MouseEvent` See :meth:`~wx.grid.GridActivationSource.GetMouseEvent` ================================================================================ ================================================================================ | |api| Class API =============== .. class:: wx.grid.GridActivationSource(object) Represents a source of cell activation, which may be either a user event (mouse or keyboard) or the program itself. .. method:: GetKeyEvent(self) Get the key event corresponding to the key press activating the cell. This method can be called for objects with Key origin only, use :meth:`GetOrigin` to check for this first. :rtype: `KeyEvent` .. method:: GetMouseEvent(self) Get the mouse event corresponding to the click activating the cell. This method can be called for objects with Mouse origin only, use :meth:`GetOrigin` to check for this first. :rtype: `MouseEvent` .. method:: GetOrigin(self) Get the origin of the activation. :rtype: :ref:`wx.grid.GridActivationSource.Origin` .. attribute:: KeyEvent See :meth:`~wx.grid.GridActivationSource.GetKeyEvent` .. attribute:: MouseEvent See :meth:`~wx.grid.GridActivationSource.GetMouseEvent` .. toctree:: :maxdepth: 1 :hidden: wx.grid.GridActivationSource.Origin.enumeration