]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/treeevt.tex
merged 2.2 branch
[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{wxNotifyEvent}{wxnotifyevent}\\
8 \helpref{wxCommandEvent}{wxcommandevent}\\
9 \helpref{wxEvent}{wxevent}\\
10 \helpref{wxObject}{wxobject}
11
12 \wxheading{Include files}
13
14 <wx/treectrl.h>
15
16 \wxheading{Event table macros}
17
18 To process input from a tree control, use these event handler macros to direct input to member
19 functions that take a wxTreeEvent argument.
20
21 \twocolwidtha{7cm}
22 \begin{twocollist}\itemsep=0pt
23 \twocolitem{{\bf EVT\_TREE\_BEGIN\_DRAG(id, func)}}{Begin dragging with the left mouse button.}
24 \twocolitem{{\bf EVT\_TREE\_BEGIN\_RDRAG(id, func)}}{Begin dragging with the right mouse button.}
25 \twocolitem{{\bf EVT\_TREE\_BEGIN\_LABEL\_EDIT(id, func)}}{Begin editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
26 \twocolitem{{\bf EVT\_TREE\_END\_LABEL\_EDIT(id, func)}}{Finish editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
27 \twocolitem{{\bf EVT\_TREE\_DELETE\_ITEM(id, func)}}{Delete an item.}
28 \twocolitem{{\bf EVT\_TREE\_GET\_INFO(id, func)}}{Request information from the application.}
29 \twocolitem{{\bf EVT\_TREE\_SET\_INFO(id, func)}}{Information is being supplied.}
30 \twocolitem{{\bf EVT\_TREE\_ITEM\_EXPANDED(id, func)}}{Parent has been expanded.}
31 \twocolitem{{\bf EVT\_TREE\_ITEM\_EXPANDING(id, func)}}{Parent is being expanded. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
32 \twocolitem{{\bf EVT\_TREE\_SEL\_CHANGED(id, func)}}{Selection has changed.}
33 \twocolitem{{\bf EVT\_TREE\_SEL\_CHANGING(id, func)}}{Selection is changing. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
34 \twocolitem{{\bf EVT\_TREE\_KEY\_DOWN(id, func)}}{A key has been pressed.}
35 \end{twocollist}%
36
37 \wxheading{See also}
38
39 \helpref{wxTreeCtrl}{wxtreectrl}
40
41 \latexignore{\rtfignore{\wxheading{Members}}}
42
43 \membersection{wxTreeEvent::wxTreeEvent}
44
45 \func{}{wxTreeEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}}
46
47 Constructor.
48
49 \membersection{wxTreeEvent::GetItem}
50
51 \constfunc{wxTreeItemId}{GetItem}{}
52
53 Returns he item (valid for all events).
54
55 \membersection{wxTreeEvent::GetOldItem}
56
57 \constfunc{wxTreeItemId}{GetOldItem}{}
58
59 Returns the old item index (valid for EVT\_TREE\_ITEM\_CHANGING and CHANGED events)
60
61 \membersection{wxTreeEvent::GetPoint()}
62
63 \constfunc{wxPoint}{GetPoint}{}
64
65 Returns the position of the mouse pointer if the event is a drag event.
66
67 \membersection{wxTreeEvent::GetCode}
68
69 \constfunc{int}{GetCode}{}
70
71 The key code if the event was is a key event.
72
73 \membersection{wxTreeEvent::GetLabel}
74
75 \constfunc{const wxString\&}{GetLabel}{}
76
77 Returns the label if the event was a begin or end edit label event.
78