wx.GridCtrl.Extended.GridCellSelectionChangingEvent Class Reference

Inheritance diagram for wx.GridCtrl.Extended.GridCellSelectionChangingEvent:

List of all members.

Public Member Functions
	GridCellSelectionChangingEvent (Grid ctrl, GridSelectionMode mode, Point cell, bool canVeto, bool stateChangingFromUnselectToSelect)
bool	Veto ()
Properties
bool	CanVeto [get]
bool	IsVetoed [get]

---

Detailed Description

An event that will be fired BEFORE the selection of cells change in a Grid. Event handler can veto this operation.

The cells becoming selected or unselected are described by the coordinates of a single cell. In cell selection mode (single- or multi-select), only the selection of this cell changed. In row selection mode (single- or multi-select), the row containing this cell changed its state, in column selection mode all cells in the column changed. If this event refers to a selection (the cells were unselected but are selected now), this cell is the new selected cell, that can open its editor.

---

Constructor & Destructor Documentation

wx.GridCtrl.Extended.GridCellSelectionChangingEvent.GridCellSelectionChangingEvent	(	Grid	ctrl,
		GridSelectionMode	mode,
		Point	cell,
		bool	canVeto,
		bool	stateChangingFromUnselectToSelect
	)

Creates an instance.

Parameters:

	ctrl	The control that originally sent the event.
	mode	The selection mode of the sending grid control at the time when the selection changed.
	cell	The cell describing the region in the grid that changed its state w.r.t. selection. In cell selection mode (single- or multi-select), only the selection of this cell changed. In row selection mode (single- or multi-select), the row containing this cell changed its state, in column selection mode all cells in the column changed. If this event refers to a selection (the cells were unselected but are selected now), this cell is the new selected cell, that can open its editor.
	canVeto	True if handlers of this event are allowed to veto the selection operation.
	stateChangingFromUnselectToSelect	True if the cells are changing their state from unselected to selected. False if the cells are becoming unselected.

---

Member Function Documentation

bool wx.GridCtrl.Extended.GridCellSelectionChangingEvent.Veto

(

)

Event handlers call this method to indicate that the selection shall be cancelled. Returns true on successful operation. The result will be false, if not CanVeto().

---

Property Documentation

bool wx.GridCtrl.Extended.GridCellSelectionChangingEvent.CanVeto [get]

True if event handlers are allowed to veto the selection operation.

Veto

bool wx.GridCtrl.Extended.GridCellSelectionChangingEvent.IsVetoed [get]

True iff this event has been cancelled.

---