## wxListEvent

A list event holds information about events associated with wxListCtrl objects.

Derived from

wxNotifyEvent
wxCommandEvent
wxEvent
wxObject

Include files

<wx/listctrl.h>

Event table macros

To process input from a list control, use these event handler macros to direct input to member functions that take a wxListEvent argument.

EVT_LIST_BEGIN_DRAG(id, func) | Begin dragging with the left mouse button.
EVT_LIST_BEGIN_RDRAG(id, func) | Begin dragging with the right mouse button.
EVT_LIST_BEGIN_LABEL_EDIT(id, func) | Begin editing a label. This can be prevented by calling Veto().
EVT_LIST_END_LABEL_EDIT(id, func) | Finish editing a label. This can be prevented by calling Veto().
EVT_LIST_DELETE_ITEM(id, func) | Delete an item.
EVT_LIST_DELETE_ALL_ITEMS(id, func) | Delete all items.
EVT_LIST_GET_INFO(id, func) | Request information from the application, usually the item text.
EVT_LIST_SET_INFO(id, func) | Information is being supplied (not implemented).
EVT_LIST_ITEM_SELECTED(id, func) | The item has been selected.
EVT_LIST_ITEM_DESELECTED(id, func) | The item has been deselected.
EVT_LIST_ITEM_ACTIVATED(id, func) | The item has been activated (ENTER or double click).
EVT_LIST_KEY_DOWN(id, func) | A key has been pressed.
EVT_LIST_INSERT_ITEM(id, func) | An item has been inserted.
EVT_LIST_COL_CLICK(id, func) | A column (m_col) has been left-clicked.

See also

wxListCtrl

Members

wxListEvent::wxListEvent
wxListEvent::GetCode
wxListEvent::GetIndex
wxListEvent::GetOldIndex
wxListEvent::GetColumn
wxListEvent::Cancelled
wxListEvent::GetPoint
wxListEvent::GetLabel
wxListEvent::GetText
wxListEvent::GetImage
wxListEvent::GetData
wxListEvent::GetMask
wxListEvent::GetItem

### wxListEvent::wxListEvent

wxListEvent(WXTYPE commandType = 0, int id = 0)

Constructor.

### wxListEvent::GetCode

int GetCode() const

Key code if the event is a keypress event.

### wxListEvent::GetIndex

long GetIndex() const

The item index.

### wxListEvent::GetOldIndex

long GetOldIndex() const

The old item index.

### wxListEvent::GetColumn

int GetColumn() const

The column position.

### wxListEvent::Cancelled

bool Cancelled() const

TRUE if this event is an end edit event and the user cancelled the edit.

### wxListEvent::GetPoint

wxPoint GetPoint() const

The position of the mouse pointer if the event is a drag event.

### wxListEvent::GetLabel

const wxString& GetLabel() const

The label.

### wxListEvent::GetText

const wxString& GetText() const

The text.

### wxListEvent::GetImage

int GetImage() const

The image.

### wxListEvent::GetData

long GetData() const

The data.

### wxListEvent::GetMask

long GetMask() const

The mask.

### wxListEvent::GetItem

const wxListItem& GetItem() const

An item object, used by some events. See also wxListCtrl::SetItem.