X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..94e2ed3b8db0220160c0b939782cd46914ec073a:/docs/latex/wx/treeevt.tex diff --git a/docs/latex/wx/treeevt.tex b/docs/latex/wx/treeevt.tex index f8cdc48c03..e62bc7da97 100644 --- a/docs/latex/wx/treeevt.tex +++ b/docs/latex/wx/treeevt.tex @@ -4,10 +4,15 @@ A tree event holds information about events associated with wxTreeCtrl objects. \wxheading{Derived from} +\helpref{wxNotifyEvent}{wxnotifyevent}\\ \helpref{wxCommandEvent}{wxcommandevent}\\ \helpref{wxEvent}{wxevent}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{Event table macros} To process input from a tree control, use these event handler macros to direct input to member @@ -17,15 +22,17 @@ 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}% @@ -41,27 +48,33 @@ functions that take a wxTreeEvent argument. Constructor. -\membersection{wxTreeEvent::m\_code} +\membersection{wxTreeEvent::GetItem} + +\constfunc{wxTreeItemId}{GetItem}{} + +Returns he item (valid for all events). + +\membersection{wxTreeEvent::GetOldItem} -\member{int}{m\_code} +\constfunc{wxTreeItemId}{GetOldItem}{} -Key code if the event is a keypress event. +Returns the old item index (valid for EVT\_TREE\_ITEM\_CHANGING and CHANGED events) -\membersection{wxTreeEvent::m\_itemIndex} +\membersection{wxTreeEvent::GetPoint()} -\member{wxTreeItem}{m\_item} +\constfunc{wxPoint}{GetPoint}{} -The item. +Returns the position of the mouse pointer if the event is a drag event. -\membersection{wxTreeEvent::m\_oldItem} +\membersection{wxTreeEvent::GetCode} -\member{long}{m\_oldItem} +\constfunc{int}{GetCode}{} -The old item index. +The key code if the event was is a key event. -\membersection{wxTreeEvent::m\_pointDrag} +\membersection{wxTreeEvent::GetLabel} -\member{wxPoint}{m\_pointDrag} +\constfunc{const wxString\&}{GetLabel}{} -The position of the mouse pointer if the event is a drag event. +Returns the label if the event was a begin or end edit label event.