wx.grid.GridEvent

Inheritance diagram for wx.grid.GridEvent:

Description

This event class contains information about various grid events.

Derived From

• wx.NotifyEvent
• wx.CommandEvent
• wx.Event
• wx.Object

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__
• AltDown
• CmdDown
• ControlDown
• GetCol
• GetPosition
• GetRow
• MetaDown
• Selecting
• ShiftDown

Properties Summary

• Col
• Position
• Row

Class API

Methods

__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)
• row (int)
• col (int)
• x (int)
• y (int)
• sel (bool)
• control (bool)
• shift (bool)
• alt (bool)
• meta (bool)

Returns:

wx.grid.GridEvent

---

AltDown()

Returns True if the Alt key was down at the time of the event.

Returns:

bool

---

CmdDown()

No docstrings available for this method.

---

ControlDown()

Returns True if the Control key was down at the time of the event.

Returns:

bool

---

GetCol()

Column at which the event occurred.

Returns:

int

---

GetPosition()

Position in pixels at which the event occurred.

Returns:

wx.Point

---

GetRow()

Row at which the event occurred.

Returns:

int

---

MetaDown()

Returns True if the Meta key was down at the time of the event.

Returns:

bool

---

Selecting()

Returns True if the user deselected a cell, False if the user deselected a cell.

Returns:

bool

---

ShiftDown()

Returns True if the Shift key was down at the time of the event.

Returns:

bool

---

Properties

Col

See GetCol

Position

See GetPosition

Row

See GetRow