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.}
  26 \twocolitem{{\bf EVT\_TREE\_END\_LABEL\_EDIT(id, func)}}{Finish editing a label.}
  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.}
  32 \twocolitem{{\bf EVT\_TREE\_SEL\_CHANGED(id, func)}}{Selection has changed.}
  33 \twocolitem{{\bf EVT\_TREE\_SEL\_CHANGING(id, func)}}{Selection is changing.}
  34 \twocolitem{{\bf EVT\_TREE\_KEY\_DOWN(id, func)}}{A key has been pressed.}
  35 \end{twocollist}%
  36
  37 For the EVT\_TREE\_BEGIN\_EDIT, EVT\_TREE\_END\_LABEL\_EDIT,
  38 EVT\_TREE\_ITEM\_EXPANDING and EVT\_TREE\_SEL\_CHANGING events you may call
  39 \helpref{Veto()}{wxnotifyeventveto} to prevent the given operation from
  40 happening except for EVT\_TREE\_END\_LABEL\_EDIT means that the items label
  41 will not be changed.
  42
  43 \wxheading{See also}
  44
  45 \helpref{wxTreeCtrl}{wxtreectrl}
  46
  47 \latexignore{\rtfignore{\wxheading{Members}}}
  48
  49 \membersection{wxTreeEvent::wxTreeEvent}
  50
  51 \func{}{wxTreeEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}}
  52
  53 Constructor.
  54
  55 \membersection{wxTreeEvent::m\_code}
  56
  57 \member{int}{m\_code}
  58
  59 Key code if the event is a keypress event.
  60
  61 \membersection{wxTreeEvent::m\_itemIndex}
  62
  63 \member{wxTreeItem}{m\_item}
  64
  65 The item (valid for all events).
  66
  67 \membersection{wxTreeEvent::m\_oldItem}
  68
  69 \member{long}{m\_oldItem}
  70
  71 The old item index (valid for EVT\_TREE\_ITEM\_CHANGING and CHANGED events)
  72
  73 \membersection{wxTreeEvent::m\_pointDrag}
  74
  75 \member{wxPoint}{m\_pointDrag}
  76
  77 The position of the mouse pointer if the event is a drag event.
  78