X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/605d715ddd84ddc3e78423e3f3ae5c27c8ff4d43..dae87f93abd93555095575886b8b1ef126f0a0da:/docs/latex/wx/treeevt.tex

diff --git a/docs/latex/wx/treeevt.tex b/docs/latex/wx/treeevt.tex
index 4338aa64ca..3b325f2d85 100644
--- a/docs/latex/wx/treeevt.tex
+++ b/docs/latex/wx/treeevt.tex
@@ -18,21 +18,31 @@ A tree event holds information about events associated with wxTreeCtrl objects.
 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\_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\_LABEL\_EDIT(id, func)}}{Finish editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
-\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. 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.}
+% they'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}.}
 \twocolitem{{\bf EVT\_TREE\_KEY\_DOWN(id, func)}}{A key has been pressed.}
-\end{twocollist}%
+\twocolitem{{\bf EVT\_TREE\_ITEM\_GETTOOLTIP(id, func)}}{The opportunity to set the item tooltip
+is being given to the application (call wxTreeEvent::SetToolTip). Windows only.}
+\end{twocollist}
 
 \wxheading{See also}
 
@@ -40,39 +50,61 @@ functions that take a wxTreeEvent argument.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxTreeEvent::wxTreeEvent}
+\membersection{wxTreeEvent::wxTreeEvent}\label{wxtreeeventctor}
 
 \func{}{wxTreeEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}}
 
 Constructor.
 
-\membersection{wxTreeEvent::GetItem}
+\membersection{wxTreeEvent::GetKeyCode}\label{wxtreeeventgetkeycode}
+
+\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}\label{wxtreeeventgetitem}
 
 \constfunc{wxTreeItemId}{GetItem}{}
 
-Returns he item (valid for all events).
+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::GetOldItem}
+\membersection{wxTreeEvent::GetLabel}\label{wxtreeeventgetlabel}
+
+\constfunc{const wxString\&}{GetLabel}{}
+
+Returns the label if the event was a begin or end edit label event.
+
+\membersection{wxTreeEvent::GetOldItem}\label{wxtreeeventgetolditem}
 
 \constfunc{wxTreeItemId}{GetOldItem}{}
 
 Returns the old item index (valid for EVT\_TREE\_ITEM\_CHANGING and CHANGED events)
 
-\membersection{wxTreeEvent::GetPoint()}
+\membersection{wxTreeEvent::GetPoint()}\label{wxtreeeventgetpoint}
 
 \constfunc{wxPoint}{GetPoint}{}
 
 Returns the position of the mouse pointer if the event is a drag event.
 
-\membersection{wxTreeEvent::GetCode}
+\membersection{wxTreeEvent::IsEditCancelled()}\label{wxtreeeventiseditcancelled}
 
-\constfunc{int}{GetCode}{}
+\constfunc{bool}{IsEditCancelled}{}
 
-The key code if the event was is a key event.
+Returns true if the label edit was cancelled. This should be
+called from within an EVT\_TREE\_END\_LABEL\_EDIT handler.
 
-\membersection{wxTreeEvent::GetLabel}
+\membersection{wxTreeEvent::SetToolTip}\label{wxtreeeventsettooltip}
 
-\constfunc{const wxString\&}{GetLabel}{}
+\func{void}{SetToolTip}{\param{const wxString\&}{ tooltip}}
 
-Returns the label if the event was a begin or end edit label event.
+Set the tooltip for the item (valid for EVT\_TREE\_ITEM\_GETTOOLTIP events).
+Windows only.