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