]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/listevt.tex
mask corrections
[wxWidgets.git] / docs / latex / wx / listevt.tex
... / ...
CommitLineData
1\section{\class{wxListEvent}}\label{wxlistevent}
2
3A list event holds information about events associated with wxListCtrl objects.
4
5\wxheading{Derived from}
6
7\helpref{wxNotifyEvent}{wxnotifyevent}\\
8\helpref{wxCommandEvent}{wxcommandevent}\\
9\helpref{wxEvent}{wxevent}\\
10\helpref{wxObject}{wxobject}
11
12\wxheading{Include files}
13
14<wx/listctrl.h>
15
16\wxheading{Event table macros}
17
18To process input from a list control, use these event handler macros to direct input to member
19functions 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.}
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}.}
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\_ITEM\_ACTIVATED(id, func)}}{The item has been activated (ENTER or double click).}
34\twocolitem{{\bf EVT\_LIST\_KEY\_DOWN(id, func)}}{A key has been pressed.}
35\twocolitem{{\bf EVT\_LIST\_INSERT\_ITEM(id, func)}}{An item has been inserted.}
36\twocolitem{{\bf EVT\_LIST\_COL\_CLICK(id, func)}}{A column ({\bf m\_col}) has been left-clicked.}
37\end{twocollist}%
38
39\wxheading{See also}
40
41\helpref{wxListCtrl}{wxlistctrl}
42
43\latexignore{\rtfignore{\wxheading{Members}}}
44
45\membersection{wxListEvent::wxListEvent}
46
47\func{}{wxListEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}}
48
49Constructor.
50
51\membersection{wxListEvent::m\_code}
52
53\member{int}{m\_code}
54
55Key code if the event is a keypress event.
56
57\membersection{wxListEvent::m\_itemIndex}
58
59\member{long}{m\_itemIndex}
60
61The item index.
62
63\membersection{wxListEvent::m\_oldItemIndex}
64
65\member{long}{m\_oldItemIndex}
66
67The old item index.
68
69\membersection{wxListEvent::m\_col}
70
71\member{int}{m\_col}
72
73The column position.
74
75\membersection{wxListEvent::m\_cancelled}
76
77\member{bool}{m\_cancelled}
78
79TRUE if this event is an end edit event and the user cancelled the edit.
80
81\membersection{wxListEvent::m\_pointDrag}
82
83\member{wxPoint}{m\_pointDrag}
84
85The position of the mouse pointer if the event is a drag event.
86
87\membersection{wxListEvent::m\_item}
88
89\member{wxListItem}{m\_item}
90
91An item object, used by some events. See also \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}.
92
93