]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/treeevt.tex
* Socket doc update.
[wxWidgets.git] / docs / latex / wx / treeevt.tex
1 \section{\class{wxTreeEvent}}\label{wxtreeevent}
2
3 A tree event holds information about events associated with wxTreeCtrl 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 tree control, use these event handler macros to direct input to member
14 functions that take a wxTreeEvent argument.
15
16 \twocolwidtha{7cm}
17 \begin{twocollist}\itemsep=0pt
18 \twocolitem{{\bf EVT\_TREE\_BEGIN\_DRAG(id, func)}}{Begin dragging with the left mouse button.}
19 \twocolitem{{\bf EVT\_TREE\_BEGIN\_RDRAG(id, func)}}{Begin dragging with the right mouse button.}
20 \twocolitem{{\bf EVT\_TREE\_BEGIN\_LABEL\_EDIT(id, func)}}{Begin editing a label.}
21 \twocolitem{{\bf EVT\_TREE\_END\_LABEL\_EDIT(id, func)}}{Finish editing a label.}
22 \twocolitem{{\bf EVT\_TREE\_DELETE\_ITEM(id, func)}}{Delete an item.}
23 \twocolitem{{\bf EVT\_TREE\_GET\_INFO(id, func)}}{Request information from the application.}
24 \twocolitem{{\bf EVT\_TREE\_SET\_INFO(id, func)}}{Information is being supplied.}
25 \twocolitem{{\bf EVT\_TREE\_ITEM\_EXPANDED(id, func)}}{Parent has been expanded.}
26 \twocolitem{{\bf EVT\_TREE\_ITEM\_EXPANDING(id, func)}}{Parent is being expanded.}
27 \twocolitem{{\bf EVT\_TREE\_SEL\_CHANGED(id, func)}}{Selection has changed.}
28 \twocolitem{{\bf EVT\_TREE\_SEL\_CHANGING(id, func)}}{Selection is changing.}
29 \twocolitem{{\bf EVT\_TREE\_KEY\_DOWN(id, func)}}{A key has been pressed.}
30 \end{twocollist}%
31
32 \wxheading{See also}
33
34 \helpref{wxTreeCtrl}{wxtreectrl}
35
36 \latexignore{\rtfignore{\wxheading{Members}}}
37
38 \membersection{wxTreeEvent::wxTreeEvent}
39
40 \func{}{wxTreeEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}}
41
42 Constructor.
43
44 \membersection{wxTreeEvent::m\_code}
45
46 \member{int}{m\_code}
47
48 Key code if the event is a keypress event.
49
50 \membersection{wxTreeEvent::m\_itemIndex}
51
52 \member{wxTreeItem}{m\_item}
53
54 The item.
55
56 \membersection{wxTreeEvent::m\_oldItem}
57
58 \member{long}{m\_oldItem}
59
60 The old item index.
61
62 \membersection{wxTreeEvent::m\_pointDrag}
63
64 \member{wxPoint}{m\_pointDrag}
65
66 The position of the mouse pointer if the event is a drag event.
67