]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/treeevt.tex
Changed version to 2.5.1
[wxWidgets.git] / docs / latex / wx / treeevt.tex
index dcb92fb2143dedd0fce66559e392aeb67dbe7462..d696179a2994627e833a4f00519558bcf2ce2f65 100644 (file)
@@ -20,8 +20,8 @@ functions that take a wxTreeEvent argument.
 
 \twocolwidtha{9cm}
 \begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf EVT\_TREE\_BEGIN\_DRAG(id, func)}}{The user has started dragging an item with the left mouse button.}
-\twocolitem{{\bf EVT\_TREE\_BEGIN\_RDRAG(id, func)}}{The user has started dragging an item with the right mouse button.}
+\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}.}
@@ -53,9 +53,9 @@ functions that take a wxTreeEvent argument.
 
 Constructor.
 
-\membersection{wxTreeEvent::GetCode}
+\membersection{wxTreeEvent::GetKeyCode}
 
-\constfunc{int}{GetCode}{}
+\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
@@ -91,3 +91,10 @@ Returns the old item index (valid for EVT\_TREE\_ITEM\_CHANGING and CHANGED even
 
 Returns the position of the mouse pointer if the event is a drag event.
 
+\membersection{wxTreeEvent::IsEditCancelled()}
+
+\constfunc{bool}{IsEditCancelled}{}
+
+Returns true if the label edit was cancelled. This should be
+called from within an EVT\_TREE\_END\_LABEL\_EDIT handler.
+