projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| a660d684 KB |
1 | \section{\class{wxListEvent}}\label{wxlistevent} |
| 2 | ||
| 3 | A list event holds information about events associated with wxListCtrl objects. | |
| 4 | ||
| 5 | \wxheading{Derived from} | |
| 6 | ||
| 86f975a8 | 7 | \helpref{wxNotifyEvent}{wxnotifyevent}\\ |
| a660d684 KB |
8 | \helpref{wxCommandEvent}{wxcommandevent}\\ |
| 9 | \helpref{wxEvent}{wxevent}\\ | |
| 10 | \helpref{wxObject}{wxobject} | |
| 11 | ||
| 954b8ae6 JS |
12 | \wxheading{Include files} |
| 13 | ||
| 14 | <wx/listctrl.h> | |
| 15 | ||
| a660d684 KB |
16 | \wxheading{Event table macros} |
| 17 | ||
| 18 | To process input from a list control, use these event handler macros to direct input to member | |
| 19 | functions that take a wxListEvent argument. | |
| 20 | ||
| 21 | \twocolwidtha{7cm} | |
| 22 | \begin{twocollist}\itemsep=0pt | |
| 23 | \twocolitem{{\bf EVT\_LIST\_BEGIN\_DRAG(id, func)}}{Begin dragging with the left mouse button.} | |
| 24 | \twocolitem{{\bf EVT\_LIST\_BEGIN\_RDRAG(id, func)}}{Begin dragging with the right mouse button.} | |
| fd128b0c RR |
25 | \twocolitem{{\bf EVT\_LIST\_BEGIN\_LABEL\_EDIT(id, func)}}{Begin editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.} |
| 26 | \twocolitem{{\bf EVT\_LIST\_END\_LABEL\_EDIT(id, func)}}{Finish editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.} | |
| a660d684 KB |
27 | \twocolitem{{\bf EVT\_LIST\_DELETE\_ITEM(id, func)}}{Delete an item.} |
| 28 | \twocolitem{{\bf EVT\_LIST\_DELETE\_ALL\_ITEMS(id, func)}}{Delete all items.} | |
| 29 | \twocolitem{{\bf EVT\_LIST\_GET\_INFO(id, func)}}{Request information from the application, usually the item text.} | |
| 30 | \twocolitem{{\bf EVT\_LIST\_SET\_INFO(id, func)}}{Information is being supplied (not implemented).} | |
| 31 | \twocolitem{{\bf EVT\_LIST\_ITEM\_SELECTED(id, func)}}{The item has been selected.} | |
| 32 | \twocolitem{{\bf EVT\_LIST\_ITEM\_DESELECTED(id, func)}}{The item has been deselected.} | |
| 33 | \twocolitem{{\bf EVT\_LIST\_KEY\_DOWN(id, func)}}{A key has been pressed.} | |
| 34 | \twocolitem{{\bf EVT\_LIST\_INSERT\_ITEM(id, func)}}{An item has been inserted.} | |
| 35 | \twocolitem{{\bf EVT\_LIST\_COL\_CLICK(id, func)}}{A column ({\bf m\_col}) has been left-clicked.} | |
| 36 | \end{twocollist}% | |
| 37 | ||
| 38 | \wxheading{See also} | |
| 39 | ||
| 40 | \helpref{wxListCtrl}{wxlistctrl} | |
| 41 | ||
| 42 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 43 | ||
| 44 | \membersection{wxListEvent::wxListEvent} | |
| 45 | ||
| 46 | \func{}{wxListEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}} | |
| 47 | ||
| 48 | Constructor. | |
| 49 | ||
| 50 | \membersection{wxListEvent::m\_code} | |
| 51 | ||
| 52 | \member{int}{m\_code} | |
| 53 | ||
| 54 | Key code if the event is a keypress event. | |
| 55 | ||
| 56 | \membersection{wxListEvent::m\_itemIndex} | |
| 57 | ||
| 58 | \member{long}{m\_itemIndex} | |
| 59 | ||
| 60 | The item index. | |
| 61 | ||
| 62 | \membersection{wxListEvent::m\_oldItemIndex} | |
| 63 | ||
| 64 | \member{long}{m\_oldItemIndex} | |
| 65 | ||
| 66 | The old item index. | |
| 67 | ||
| 68 | \membersection{wxListEvent::m\_col} | |
| 69 | ||
| 70 | \member{int}{m\_col} | |
| 71 | ||
| 72 | The column position. | |
| 73 | ||
| 74 | \membersection{wxListEvent::m\_cancelled} | |
| 75 | ||
| 76 | \member{bool}{m\_cancelled} | |
| 77 | ||
| 78 | TRUE if this event is an end edit event and the user cancelled the edit. | |
| 79 | ||
| 80 | \membersection{wxListEvent::m\_pointDrag} | |
| 81 | ||
| 82 | \member{wxPoint}{m\_pointDrag} | |
| 83 | ||
| 84 | The position of the mouse pointer if the event is a drag event. | |
| 85 | ||
| 86 | \membersection{wxListEvent::m\_item} | |
| 87 | ||
| 88 | \member{wxListItem}{m\_item} | |
| 89 | ||
| 90 | An item object, used by some events. See also \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}. | |
| 91 | ||
| 92 |