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