X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/eaaa6a06a25774c18d10bb8182cc1934ed0ed9aa..dfad0599246651d4994e348d868a3e65613c7379:/docs/latex/wx/treectrl.tex diff --git a/docs/latex/wx/treectrl.tex b/docs/latex/wx/treectrl.tex index 4dec667170..2c2ac8ac38 100644 --- a/docs/latex/wx/treectrl.tex +++ b/docs/latex/wx/treectrl.tex @@ -24,6 +24,27 @@ able to edit labels in the tree control.} See also \helpref{window styles overview}{windowstyles}. +\wxheading{Event handling} + +To process input from a tree control, use these event handler macros to direct input to member +functions that take a \helpref{wxTreeEvent}{wxtreeevent} argument. + +\twocolwidtha{7cm} +\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\_KEY\_DOWN(id, func)}}{A key has been pressed.} +\end{twocollist}% + \wxheading{See also} \helpref{wxTreeCtrl overview}{wxtreectrloverview}, \helpref{wxListBox}{wxlistbox}, \helpref{wxListCtrl}{wxlistctrl},\rtfsp @@ -90,12 +111,35 @@ Deletes all the items in the control. Deletes the specified item. -\membersection{wxTreeCtrl::Edit}\label{wxtreectrledit} +\membersection{wxTreeCtrl::EditLabel}\label{wxtreectrleditlabel} -\func{wxTextCtrl\&}{Edit}{\param{long }{item}} +\func{wxTextCtrl*}{EditLabel}{\param{long }{item}, \param{wxClassInfo*}{ textControlClass = CLASSINFO(wxTextCtrl)}} Starts editing the label of the given item, returning the text control that the tree control uses for editing. +Pass another {\it textControlClass} if a derived class is required. It usually will be, in order for +the application to detect when editing has finished and to call \helpref{wxTreeCtrl::EndEditLabel}{wxtreectrlendeditlabel}. + +Do not delete the text control yourself. + +This function is currently supported under Windows only. + +\wxheading{See also} + +\helpref{wxTreeCtrl::EndEditLabel}{wxtreectrlendeditlabel} + +\membersection{wxTreeCtrl::EndEditLabel}\label{wxtreectrlendeditlabel} + +\func{bool}{EndEditLabel}{\param{bool }{cancelEdit}} + +Ends label editing. If {\it cancelEdit} is TRUE, the edit will be cancelled. + +This function is currently supported under Windows only. + +\wxheading{See also} + +\helpref{wxTreeCtrl::EditLabel}{wxtreectrleditlabel} + \membersection{wxTreeCtrl::EnsureVisible}\label{wxtreectrlensurevisible} \func{bool}{EnsureVisible}{\param{long }{item}}