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\_COLLAPSED(id, func)}}{The item has been collapsed.}
  31 \twocolitem{{\bf EVT\_TREE\_ITEM\_COLLAPSING(id, func)}}{The item is being collapsed. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
  32 \twocolitem{{\bf EVT\_TREE\_ITEM\_EXPANDED(id, func)}}{The item has been expanded.}
  33 \twocolitem{{\bf EVT\_TREE\_ITEM\_EXPANDING(id, func)}}{The item is being expanded. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
  34 \twocolitem{{\bf EVT\_TREE\_SEL\_CHANGED(id, func)}}{Selection has changed.}
  35 \twocolitem{{\bf EVT\_TREE\_SEL\_CHANGING(id, func)}}{Selection is changing. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
  36 \twocolitem{{\bf EVT\_TREE\_KEY\_DOWN(id, func)}}{A key has been pressed.}
  37 \end{twocollist}%
  38
  39 \wxheading{See also}
  40
  41 \helpref{wxTreeCtrl}{wxtreectrl}
  42
  43 \latexignore{\rtfignore{\wxheading{Members}}}
  44
  45 \membersection{wxTreeEvent::wxTreeEvent}
  46
  47 \func{}{wxTreeEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}}
  48
  49 Constructor.
  50
  51 \membersection{wxTreeEvent::GetCode}
  52
  53 \constfunc{int}{GetCode}{}
  54
  55 Returns the key code if the event was is a key event. Use
  56 \helpref{GetKeyEvent}{wxtreeeventgetkeyevent} to get the values of the
  57 modifier keys for this event (i.e. Shift or Ctrl).
  58
  59 \membersection{wxTreeEvent::GetItem}
  60
  61 \constfunc{wxTreeItemId}{GetItem}{}
  62
  63 Returns he item (valid for all events).
  64
  65 \membersection{wxTreeEvent::GetKeyEvent}\label{wxtreeeventgetkeyevent}
  66
  67 \constfunc{const wxKeyEvent\&}{GetKeyEvent}{}
  68
  69 Returns the key event for {\tt EVT\_TREE\_KEY\_DOWN} events.
  70
  71 \membersection{wxTreeEvent::GetLabel}
  72
  73 \constfunc{const wxString\&}{GetLabel}{}
  74
  75 Returns the label if the event was a begin or end edit label event.
  76
  77 \membersection{wxTreeEvent::GetOldItem}
  78
  79 \constfunc{wxTreeItemId}{GetOldItem}{}
  80
  81 Returns the old item index (valid for EVT\_TREE\_ITEM\_CHANGING and CHANGED events)
  82
  83 \membersection{wxTreeEvent::GetPoint()}
  84
  85 \constfunc{wxPoint}{GetPoint}{}
  86
  87 Returns the position of the mouse pointer if the event is a drag event.
  88