To process input from a tree control, use these event handler macros to direct input to member
functions that take a wxTreeEvent argument.
-\twocolwidtha{7cm}
+\twocolwidtha{9cm}
\begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf EVT\_TREE\_BEGIN\_DRAG(id, func)}}{Begin dragging with the left mouse button.}
-\twocolitem{{\bf EVT\_TREE\_BEGIN\_RDRAG(id, func)}}{Begin dragging with the right mouse button.}
-\twocolitem{{\bf EVT\_TREE\_BEGIN\_LABEL\_EDIT(id, func)}}{Begin editing a label.}
-\twocolitem{{\bf EVT\_TREE\_END\_LABEL\_EDIT(id, func)}}{Finish editing a label.}
-\twocolitem{{\bf EVT\_TREE\_DELETE\_ITEM(id, func)}}{Delete an item.}
-\twocolitem{{\bf EVT\_TREE\_GET\_INFO(id, func)}}{Request information from the application.}
-\twocolitem{{\bf EVT\_TREE\_SET\_INFO(id, func)}}{Information is being supplied.}
-\twocolitem{{\bf EVT\_TREE\_ITEM\_EXPANDED(id, func)}}{Parent has been expanded.}
-\twocolitem{{\bf EVT\_TREE\_ITEM\_EXPANDING(id, func)}}{Parent is being expanded.}
-\twocolitem{{\bf EVT\_TREE\_SEL\_CHANGED(id, func)}}{Selection has changed.}
-\twocolitem{{\bf EVT\_TREE\_SEL\_CHANGING(id, func)}}{Selection is changing.}
+\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.}
+\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.}
+\twocolitem{{\bf EVT\_TREE\_BEGIN\_LABEL\_EDIT(id, func)}}{Begin editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
+\twocolitem{{\bf EVT\_TREE\_END\_DRAG(id, func)}}{The user has released the mouse after dragging an item.}
+\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}.}
+\twocolitem{{\bf EVT\_TREE\_DELETE\_ITEM(id, func)}}{A tree item has been deleted.}
+% thy're not very (or at all) useful currently
+%\twocolitem{{\bf EVT\_TREE\_GET\_INFO(id, func)}}{Request information from the application.}
+%\twocolitem{{\bf EVT\_TREE\_SET\_INFO(id, func)}}{Information is being supplied.}
+\twocolitem{{\bf EVT\_TREE\_ITEM\_ACTIVATED(id, func)}}{An item has been activated (e.g. double clicked).}
+\twocolitem{{\bf EVT\_TREE\_ITEM\_COLLAPSED(id, func)}}{The item has been collapsed.}
+\twocolitem{{\bf EVT\_TREE\_ITEM\_COLLAPSING(id, func)}}{The item is being collapsed. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
+\twocolitem{{\bf EVT\_TREE\_ITEM\_EXPANDED(id, func)}}{The item has been expanded.}
+\twocolitem{{\bf EVT\_TREE\_ITEM\_EXPANDING(id, func)}}{The item is being expanded. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
+\twocolitem{{\bf EVT\_TREE\_ITEM\_RIGHT\_CLICK(id, func)}}{The user has clicked the item with the right mouse button.}
+\twocolitem{{\bf EVT\_TREE\_ITEM\_MIDDLE\_CLICK(id, func)}}{The user has clicked the item with the middle mouse button.}
\twocolitem{{\bf EVT\_TREE\_KEY\_DOWN(id, func)}}{A key has been pressed.}
+\twocolitem{{\bf EVT\_TREE\_SEL\_CHANGED(id, func)}}{Selection has changed.}
+\twocolitem{{\bf EVT\_TREE\_SEL\_CHANGING(id, func)}}{Selection is changing. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
\end{twocollist}%
-For the EVT\_TREE\_BEGIN\_EDIT, EVT\_TREE\_END\_LABEL\_EDIT,
-EVT\_TREE\_ITEM\_EXPANDING and EVT\_TREE\_SEL\_CHANGING events you may call
-\helpref{Veto()}{wxnotifyeventveto} to prevent the given operation from
-happening except for EVT\_TREE\_END\_LABEL\_EDIT means that the items label
-will not be changed.
-
\wxheading{See also}
\helpref{wxTreeCtrl}{wxtreectrl}
Constructor.
-\membersection{wxTreeEvent::m\_code}
+\membersection{wxTreeEvent::GetKeyCode}
+
+\constfunc{int}{GetKeyCode}{}
+
+Returns the key code if the event was is a key event. Use
+\helpref{GetKeyEvent}{wxtreeeventgetkeyevent} to get the values of the
+modifier keys for this event (i.e. Shift or Ctrl).
+
+\membersection{wxTreeEvent::GetItem}
+
+\constfunc{wxTreeItemId}{GetItem}{}
+
+Returns the item (valid for all events).
+
+\membersection{wxTreeEvent::GetKeyEvent}\label{wxtreeeventgetkeyevent}
+
+\constfunc{const wxKeyEvent\&}{GetKeyEvent}{}
+
+Returns the key event for {\tt EVT\_TREE\_KEY\_DOWN} events.
+
+\membersection{wxTreeEvent::GetLabel}
-\member{int}{m\_code}
+\constfunc{const wxString\&}{GetLabel}{}
-Key code if the event is a keypress event.
+Returns the label if the event was a begin or end edit label event.
-\membersection{wxTreeEvent::m\_itemIndex}
+\membersection{wxTreeEvent::GetOldItem}
-\member{wxTreeItem}{m\_item}
+\constfunc{wxTreeItemId}{GetOldItem}{}
-The item (valid for all events).
+Returns the old item index (valid for EVT\_TREE\_ITEM\_CHANGING and CHANGED events)
-\membersection{wxTreeEvent::m\_oldItem}
+\membersection{wxTreeEvent::GetPoint()}
-\member{long}{m\_oldItem}
+\constfunc{wxPoint}{GetPoint}{}
-The old item index (valid for EVT\_TREE\_ITEM\_CHANGING and CHANGED events)
+Returns the position of the mouse pointer if the event is a drag event.
-\membersection{wxTreeEvent::m\_pointDrag}
+\membersection{wxTreeEvent::IsEditCancelled()}
-\member{wxPoint}{m\_pointDrag}
+\constfunc{bool}{IsEditCancelled}{}
-The position of the mouse pointer if the event is a drag event.
+Returns true if the label edit was cancelled. This should be
+called from within an EVT\_TREE\_END\_LABEL\_EDIT handler.
projects / wxWidgets.git / blobdiff