X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/86f975a8588dff94739f25091ba7910b0763a316..8962e1d9383d615ea48979cd76bd53d5aa5b3026:/docs/latex/wx/treeevt.tex diff --git a/docs/latex/wx/treeevt.tex b/docs/latex/wx/treeevt.tex index 17c20a0206..666dfb1595 100644 --- a/docs/latex/wx/treeevt.tex +++ b/docs/latex/wx/treeevt.tex @@ -22,24 +22,20 @@ functions that take a wxTreeEvent argument. \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\_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.} +\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\_SEL\_CHANGED(id, func)}}{Selection has changed.} -\twocolitem{{\bf EVT\_TREE\_SEL\_CHANGING(id, func)}}{Selection is changing.} +\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}% -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} @@ -52,27 +48,41 @@ will not be changed. Constructor. -\membersection{wxTreeEvent::m\_code} +\membersection{wxTreeEvent::GetCode} + +\constfunc{int}{GetCode}{} + +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 he item (valid for all events). + +\membersection{wxTreeEvent::GetKeyEvent}\label{wxtreeeventgetkeyevent} -\member{int}{m\_code} +\constfunc{const wxKeyEvent\&}{GetKeyEvent}{} -Key code if the event is a keypress event. +Returns the key event for {\tt EVT\_TREE\_KEY\_DOWN} events. -\membersection{wxTreeEvent::m\_itemIndex} +\membersection{wxTreeEvent::GetLabel} -\member{wxTreeItem}{m\_item} +\constfunc{const wxString\&}{GetLabel}{} -The item (valid for all events). +Returns the label if the event was a begin or end edit label event. -\membersection{wxTreeEvent::m\_oldItem} +\membersection{wxTreeEvent::GetOldItem} -\member{long}{m\_oldItem} +\constfunc{wxTreeItemId}{GetOldItem}{} -The old item index (valid for EVT\_TREE\_ITEM\_CHANGING and CHANGED events) +Returns the old item index (valid for EVT\_TREE\_ITEM\_CHANGING and CHANGED events) -\membersection{wxTreeEvent::m\_pointDrag} +\membersection{wxTreeEvent::GetPoint()} -\member{wxPoint}{m\_pointDrag} +\constfunc{wxPoint}{GetPoint}{} -The position of the mouse pointer if the event is a drag event. +Returns the position of the mouse pointer if the event is a drag event.