]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/treeevt.tex
DECLARE_DYNAMIC_CLASS() requires a default ctor
[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{9cm}
22 \begin{twocollist}\itemsep=0pt
23 \twocolitem{{\bf EVT\_TREE\_BEGIN\_DRAG(id, func)}}{The user has started dragging an item with the left mouse button. The event handler must call {\bf wxTreeEvent::Allow()} for the drag operation to continue.}
24 \twocolitem{{\bf EVT\_TREE\_BEGIN\_RDRAG(id, func)}}{The user has started dragging an item with the right mouse button. The event handler must call {\bf wxTreeEvent::Allow()} for the drag operation to continue.}
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\_DRAG(id, func)}}{The user has released the mouse after dragging an item.}
27 \twocolitem{{\bf EVT\_TREE\_END\_LABEL\_EDIT(id, func)}}{The user has finished editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
28 \twocolitem{{\bf EVT\_TREE\_DELETE\_ITEM(id, func)}}{A tree item has been deleted.}
29 % they're not very (or at all) useful currently
30 %\twocolitem{{\bf EVT\_TREE\_GET\_INFO(id, func)}}{Request information from the application.}
31 %\twocolitem{{\bf EVT\_TREE\_SET\_INFO(id, func)}}{Information is being supplied.}
32 \twocolitem{{\bf EVT\_TREE\_ITEM\_ACTIVATED(id, func)}}{An item has been activated (e.g. double clicked).}
33 \twocolitem{{\bf EVT\_TREE\_ITEM\_COLLAPSED(id, func)}}{The item has been collapsed.}
34 \twocolitem{{\bf EVT\_TREE\_ITEM\_COLLAPSING(id, func)}}{The item is being collapsed. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
35 \twocolitem{{\bf EVT\_TREE\_ITEM\_EXPANDED(id, func)}}{The item has been expanded.}
36 \twocolitem{{\bf EVT\_TREE\_ITEM\_EXPANDING(id, func)}}{The item is being expanded. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
37 \twocolitem{{\bf EVT\_TREE\_ITEM\_RIGHT\_CLICK(id, func)}}{The user has clicked the item with the right mouse button.}
38 \twocolitem{{\bf EVT\_TREE\_ITEM\_MIDDLE\_CLICK(id, func)}}{The user has clicked the item with the middle mouse button.}
39 \twocolitem{{\bf EVT\_TREE\_KEY\_DOWN(id, func)}}{A key has been pressed.}
40 \twocolitem{{\bf EVT\_TREE\_SEL\_CHANGED(id, func)}}{Selection has changed.}
41 \twocolitem{{\bf EVT\_TREE\_SEL\_CHANGING(id, func)}}{Selection is changing. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
42 \twocolitem{{\bf EVT\_TREE\_KEY\_DOWN(id, func)}}{A key has been pressed.}
43 \twocolitem{{\bf EVT\_TREE\_ITEM\_GETTOOLTIP(id, func)}}{The opportunity to set the item tooltip
44 is being given to the application (call wxTreeEvent::SetToolTip). Windows only.}
45 \twocolitem{{\bf EVT\_TREE\_ITEM\_MENU(id, func)}}{The context menu for the selected item has been requested, either by a right click or by using the menu key.}
46 \end{twocollist}
47
48 \wxheading{See also}
49
50 \helpref{wxTreeCtrl}{wxtreectrl}
51
52 \latexignore{\rtfignore{\wxheading{Members}}}
53
54 \membersection{wxTreeEvent::wxTreeEvent}\label{wxtreeeventctor}
55
56 \func{}{wxTreeEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}}
57
58 Constructor.
59
60 \membersection{wxTreeEvent::GetKeyCode}\label{wxtreeeventgetkeycode}
61
62 \constfunc{int}{GetKeyCode}{}
63
64 Returns the key code if the event was is a key event. Use
65 \helpref{GetKeyEvent}{wxtreeeventgetkeyevent} to get the values of the
66 modifier keys for this event (i.e. Shift or Ctrl).
67
68 \membersection{wxTreeEvent::GetItem}\label{wxtreeeventgetitem}
69
70 \constfunc{wxTreeItemId}{GetItem}{}
71
72 Returns the item (valid for all events).
73
74 \membersection{wxTreeEvent::GetKeyEvent}\label{wxtreeeventgetkeyevent}
75
76 \constfunc{const wxKeyEvent\&}{GetKeyEvent}{}
77
78 Returns the key event for {\tt EVT\_TREE\_KEY\_DOWN} events.
79
80 \membersection{wxTreeEvent::GetLabel}\label{wxtreeeventgetlabel}
81
82 \constfunc{const wxString\&}{GetLabel}{}
83
84 Returns the label if the event was a begin or end edit label event.
85
86 \membersection{wxTreeEvent::GetOldItem}\label{wxtreeeventgetolditem}
87
88 \constfunc{wxTreeItemId}{GetOldItem}{}
89
90 Returns the old item index (valid for EVT\_TREE\_ITEM\_CHANGING and CHANGED events)
91
92 \membersection{wxTreeEvent::GetPoint()}\label{wxtreeeventgetpoint}
93
94 \constfunc{wxPoint}{GetPoint}{}
95
96 Returns the position of the mouse pointer if the event is a drag event.
97
98 \membersection{wxTreeEvent::IsEditCancelled()}\label{wxtreeeventiseditcancelled}
99
100 \constfunc{bool}{IsEditCancelled}{}
101
102 Returns true if the label edit was cancelled. This should be
103 called from within an EVT\_TREE\_END\_LABEL\_EDIT handler.
104
105 \membersection{wxTreeEvent::SetToolTip}\label{wxtreeeventsettooltip}
106
107 \func{void}{SetToolTip}{\param{const wxString\&}{ tooltip}}
108
109 Set the tooltip for the item (valid for EVT\_TREE\_ITEM\_GETTOOLTIP events).
110 Windows only.
111