***************** wx.grid.GridEvent ***************** Inheritance diagram for `wx.grid.GridEvent`: | .. inheritance-diagram:: wx.grid.GridEvent | Description =========== This event class contains information about various grid events. Derived From ^^^^^^^^^^^^^ * `wx.NotifyEvent `_ * `wx.CommandEvent `_ * `wx.Event `_ * `wx.Object <../Widgets/wx.Object.html>`_ Event Handling ^^^^^^^^^^^^^^ The event handler for the following functions takes a `wx.grid.GridEvent` parameter. The ``..._CMD_...`` variants also take a window identifier. ================================================== ================================================== Event Name Description ================================================== ================================================== wx.grid.EVT_GRID_CELL_LEFT_CLICK(func) The user clicked a cell with the left mouse button. Processes a ``wx.grid.wxEVT_GRID_CELL_LEFT_CLICK``. wx.grid.EVT_GRID_CELL_RIGHT_CLICK(func) The user clicked a cell with the right mouse button. Processes a ``wx.grid.wxEVT_GRID_CELL_RIGHT_CLICK``. wx.grid.EVT_GRID_CELL_LEFT_DCLICK(func) The user double-clicked a cell with the left mouse button. Processes a ``wx.grid.wxEVT_GRID_CELL_LEFT_DCLICK``. wx.grid.EVT_GRID_CELL_RIGHT_DCLICK(func) The user double-clicked a cell with the right mouse button. Processes a ``wx.grid.wxEVT_GRID_CELL_RIGHT_DCLICK``. wx.grid.EVT_GRID_LABEL_LEFT_CLICK(func) The user clicked a label with the left mouse button. Processes a ``wx.grid.wxEVT_GRID_LABEL_LEFT_CLICK``. wx.grid.EVT_GRID_LABEL_RIGHT_CLICK(func) The user clicked a label with the right mouse button. Processes a ``wx.grid.wxEVT_GRID_LABEL_RIGHT_CLICK``. wx.grid.EVT_GRID_LABEL_LEFT_DCLICK(func) The user double-clicked a label with the left mouse button. Processes a ``wx.grid.wxEVT_GRID_LABEL_LEFT_DCLICK``. wx.grid.EVT_GRID_LABEL_RIGHT_DCLICK(func) The user double-clicked a label with the right mouse button. Processes a ``wx.grid.wxEVT_GRID_LABEL_RIGHT_DCLICK``. wx.grid.EVT_GRID_CELL_CHANGE(func) The user changed the data in a cell. Processes a ``wx.grid.wxEVT_GRID_CELL_CHANGE``. wx.grid.EVT_GRID_SELECT_CELL(func) The user moved to, and selected a cell. Processes a ``wx.grid.wxEVT_GRID_SELECT_CELL``. wx.grid.EVT_GRID_EDITOR_HIDDEN(func) The editor for a cell was hidden. Processes a ``wx.grid.wxEVT_GRID_EDITOR_HIDDEN``. wx.grid.EVT_GRID_EDITOR_SHOWN(func) The editor for a cell was shown. Processes a ``wx.grid.wxEVT_GRID_EDITOR_SHOWN``. wx.grid.EVT_GRID_CMD_CELL_LEFT_CLICK(id, func) The user clicked a cell with the left mouse button; variant taking a window identifier. Processes a ``wx.grid.wxEVT_GRID_CELL_LEFT_CLICK``. wx.grid.EVT_GRID_CMD_CELL_RIGHT_CLICK(id, func) The user clicked a cell with the right mouse button; variant taking a window identifier. Processes a ``wx.grid.wxEVT_GRID_CELL_RIGHT_CLICK``. wx.grid.EVT_GRID_CMD_CELL_LEFT_DCLICK(id, func) The user double-clicked a cell with the left mouse button; variant taking a window identifier. Processes a ``wx.grid.wxEVT_GRID_CELL_LEFT_DCLICK``. wx.grid.EVT_GRID_CMD_CELL_RIGHT_DCLICK(id, func) The user double-clicked a cell with the right mouse button; variant taking a window identifier. Processes a ``wx.grid.wxEVT_GRID_CELL_RIGHT_DCLICK``. wx.grid.EVT_GRID_CMD_LABEL_LEFT_CLICK(id, func) The user clicked a label with the left mouse button; variant taking a window identifier. Processes a ``wx.grid.wxEVT_GRID_LABEL_LEFT_CLICK``. wx.grid.EVT_GRID_CMD_LABEL_RIGHT_CLICK(id, func) The user clicked a label with the right mouse button; variant taking a window identifier. Processes a ``wx.grid.wxEVT_GRID_LABEL_RIGHT_CLICK``. wx.grid.EVT_GRID_CMD_LABEL_LEFT_DCLICK(id, func) The user double-clicked a label with the left mouse button; variant taking a window identifier. Processes a ``wx.grid.wxEVT_GRID_LABEL_LEFT_DCLICK``. wx.grid.EVT_GRID_CMD_LABEL_RIGHT_DCLICK(id, func) The user double-clicked a label with the right mouse button; variant taking a window identifier. Processes a ``wx.grid.wxEVT_GRID_LABEL_RIGHT_DCLICK``. wx.grid.EVT_GRID_CMD_CELL_CHANGE(id, func) The user changed the data in a cell; variant taking a window identifier. Processes a ``wx.grid.wxEVT_GRID_CELL_CHANGE``. wx.grid.EVT_GRID_CMD_SELECT_CELL(id, func) The user moved to, and selected a cell; variant taking a window identifier. Processes a ``wx.grid.wxEVT_GRID_SELECT_CELL``. wx.grid.EVT_GRID_CMD_EDITOR_HIDDEN(id, func) The editor for a cell was hidden; variant taking a window identifier. Processes a ``wx.grid.wxEVT_GRID_EDITOR_HIDDEN``. wx.grid.EVT_GRID_CMD_EDITOR_SHOWN(id, func) The editor for a cell was shown; variant taking a window identifier. Processes a ``wx.grid.wxEVT_GRID_EDITOR_SHOWN``. ================================================== ================================================== Methods Summary ^^^^^^^^^^^^^^^ * `__init__ <#__init__>`_ * `AltDown <#AltDown>`_ * `CmdDown <#CmdDown>`_ * `ControlDown <#ControlDown>`_ * `GetCol <#GetCol>`_ * `GetPosition <#GetPosition>`_ * `GetRow <#GetRow>`_ * `MetaDown <#MetaDown>`_ * `Selecting <#Selecting>`_ * `ShiftDown <#ShiftDown>`_ Properties Summary ^^^^^^^^^^^^^^^^^^ * `Col <#Col>`_ * `Position <#Position>`_ * `Row <#Row>`_ Class API ========= Methods ^^^^^^^ .. method:: __init__(id, type, obj, row=-1, col=-1, x=-1, y=-1, sel=True, control=False, shift=False, alt=False, meta=False) Constructor. An instance of this class (or one of its derived classes) is sent from a control when the control's state is being changed and the control allows that change to be prevented from happening. The event handler can call `Veto `_ or `Allow `_ to tell the control what to do. **Parameters:** * `id` (int) * `type` (eventtype) * `obj` (`wx.grid.Grid <../grid/wx.grid.Grid.html>`_) * `row` (int) * `col` (int) * `x` (int) * `y` (int) * `sel` (bool) * `control` (bool) * `shift` (bool) * `alt` (bool) * `meta` (bool) | **Returns:** `wx.grid.GridEvent `_ -------- .. method:: AltDown() Returns ``True`` if the ``Alt`` key was down at the time of the event. | **Returns:** `bool` -------- .. method:: CmdDown() `No docstrings available for this method.` -------- .. method:: ControlDown() Returns ``True`` if the ``Control`` key was down at the time of the event. | **Returns:** `bool` -------- .. method:: GetCol() Column at which the event occurred. | **Returns:** `int` -------- .. method:: GetPosition() Position in pixels at which the event occurred. | **Returns:** `wx.Point <../Widgets/wx.Point.html>`_ -------- .. method:: GetRow() Row at which the event occurred. | **Returns:** `int` -------- .. method:: MetaDown() Returns ``True`` if the ``Meta`` key was down at the time of the event. | **Returns:** `bool` -------- .. method:: Selecting() Returns ``True`` if the user deselected a cell, ``False`` if the user deselected a cell. | **Returns:** `bool` -------- .. method:: ShiftDown() Returns ``True`` if the ``Shift`` key was down at the time of the event. | **Returns:** `bool` -------- Properties ^^^^^^^^^^ .. attribute:: Col See `GetCol <#GetCol>`_ .. attribute:: Position See `GetPosition <#GetPosition>`_ .. attribute:: Row See `GetRow <#GetRow>`_