X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5de76427c87d8289f5c343cef16e9375056fc49f..8e72b8b51770b59a83eb32f4d766b89f6c4dc615:/docs/latex/wx/treectrl.tex diff --git a/docs/latex/wx/treectrl.tex b/docs/latex/wx/treectrl.tex index fa68e77a32..fc720bd220 100644 --- a/docs/latex/wx/treectrl.tex +++ b/docs/latex/wx/treectrl.tex @@ -1,7 +1,7 @@ \section{\class{wxTreeCtrl}}\label{wxtreectrl} A tree control presents information as a hierarchy, with items that may be expanded -to show further items. Items in a tree control are referenced by long integer handles. +to show further items. Items in a tree control are referenced by wxTreeItemId handles. To intercept events from a tree control, use the event table macros described in \helpref{wxTreeEvent}{wxtreeevent}. @@ -12,14 +12,25 @@ To intercept events from a tree control, use the event table macros described in \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{Window styles} \twocolwidtha{5cm} \begin{twocollist}\itemsep=0pt \twocolitem{\windowstyle{wxTR\_HAS\_BUTTONS}}{Use this style to show + and - buttons to the -left of parent items.} +left of parent items. Win32 only. } +\twocolitem{\windowstyle{wxTR\_NO\_LINES}}{Use this style to hide vertical lines. +Win32 only. } +\twocolitem{\windowstyle{wxTR\_LINES\_AT\_ROOT}}{Use this style to show lines at the +tree root. Win32 only.} \twocolitem{\windowstyle{wxTR\_EDIT\_LABELS}}{Use this style if you wish the user to be able to edit labels in the tree control.} +\twocolitem{\windowstyle{wxTR\_MULTIPLE}}{Use this style to allow the user to +select more than one item in the control - by default, only one item may be +selected.} \end{twocollist} See also \helpref{window styles overview}{windowstyles}. @@ -33,23 +44,37 @@ functions that take a \helpref{wxTreeEvent}{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\_ACTIVATED(id, func)}}{The item has been activated, i.e. chosen by double clicking it with mouse or from keyboard} +\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}% \wxheading{See also} -\helpref{wxTreeCtrl overview}{wxtreectrloverview}, \helpref{wxListBox}{wxlistbox}, \helpref{wxListCtrl}{wxlistctrl},\rtfsp +\helpref{wxTreeItemData}{wxtreeitemdata}, \helpref{wxTreeCtrl overview}{wxtreectrloverview}, \helpref{wxListBox}{wxlistbox}, \helpref{wxListCtrl}{wxlistctrl},\rtfsp \helpref{wxImageList}{wximagelist}, \helpref{wxTreeEvent}{wxtreeevent} +\wxheading{Win32 notes} + +wxTreeCtrl class uses the standard common treeview control under Win32 +implemented in the system library {\tt comctl32.dll}. Some versions of this +library are known to have bugs with handling the tree control colours: the +usual symptom is that the expanded items leave black (or otherwise incorrectly +coloured) background behind them, especially for the controls using non +default background colour. The recommended solution is to upgrade the {\tt comctl32.dll} +to a newer version: see +\urlref{http://www.microsoft.com/msdownload/ieplatform/ie/comctrlx86.asp}{http://www.microsoft.com/msdownload/ieplatform/ie/comctrlx86.asp}. + \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxTreeCtrl::wxTreeCtrl}\label{wxtreectrlconstr} @@ -91,6 +116,57 @@ appropriately.} Destructor, destroying the list control. +\membersection{wxTreeCtrl::AddRoot}\label{wxtreectrladdroot} + +\func{wxTreeItemId}{AddRoot}{\param{const wxString\&}{ text}, + \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = NULL}} + +Adds the root node to the tree, returning the new item. + +If {\it image} > -1 and {\it selImage} is -1, the same image is used for +both selected and unselected items. + +\membersection{wxTreeCtrl::AppendItem}\label{wxtreectrlappenditem} + +\func{wxTreeItemId}{AppendItem}{\param{const wxTreeItemId\& }{parent}, \param{const wxString\&}{ text}, + \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = NULL}} + +Appends an item to the end of the branch identified by {\it parent}, return a new item id. + +If {\it image} > -1 and {\it selImage} is -1, the same image is used for +both selected and unselected items. + +\membersection{wxTreeCtrl::AssignImageList}\label{wxtreectrlassignimagelist} + +\func{void}{AssignImageList}{\param{wxImageList*}{ imageList}} + +Sets the normal image list. Image list assigned with this method will +be deleted by wxTreeCtrl's destructor (i.e. it takes ownership of it). + +See also \helpref{SetImageList}{wxtreectrlsetimagelist}. + +\membersection{wxTreeCtrl::AssignStateImageList}\label{wxtreectrlassignstateimagelist} + +\func{void}{AssignStateImageList}{\param{wxImageList*}{ imageList}} + +Sets the state image list. Image list assigned with this method will +be deleted by wxTreeCtrl's destructor (i.e. it takes ownership of it). + +See also \helpref{SetStateImageList}{wxtreectrlsetstateimagelist}. + + +\membersection{wxTreeCtrl::Collapse}\label{wxtreectrlcollapse} + +\func{void}{Collapse}{\param{const wxTreeItemId\&}{ item}} + +Collapses the given item. + +\membersection{wxTreeCtrl::CollapseAndReset}\label{wxtreectrlcollapseandreset} + +\func{void}{CollapseAndReset}{\param{const wxTreeItemId\&}{ item}} + +Collapses the given item and removes all children. + \membersection{wxTreeCtrl::Create}\label{wxtreectrlcreate} \func{bool}{wxTreeCtrl}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp @@ -99,51 +175,84 @@ Destructor, destroying the list control. Creates the tree control. See \helpref{wxTreeCtrl::wxTreeCtrl}{wxtreectrlconstr} for further details. +\membersection{wxTreeCtrl::Delete}\label{wxtreectrldelete} + +\func{void}{Delete}{\param{const wxTreeItemId\&}{ item}} + +Deletes the specified item. + \membersection{wxTreeCtrl::DeleteAllItems}\label{wxtreectrldeleteallitems} -\func{bool}{DeleteAllItems}{\void} +\func{void}{DeleteAllItems}{\void} Deletes all the items in the control. -\membersection{wxTreeCtrl::DeleteItem}\label{wxtreectrldeleteitem} +\membersection{wxTreeCtrl::EditLabel}\label{wxtreectrleditlabel} -\func{bool}{DeleteItem}{\param{long }{item}} +\func{void}{EditLabel}{\param{const wxTreeItemId\&}{ item}} -Deletes the specified item. +Starts editing the label of the given item. This function generates a +EVT\_TREE\_BEGIN\_LABEL\_EDIT event which can be vetoed so that no +text control will appear for in-place editing. + +If the user changed the label (i.e. s/he does not press ESC or leave +the text control without changes, a EVT\_TREE\_END\_LABEL\_EDIT event +will be sent which can be vetoed as well. + +\wxheading{See also} + +\helpref{wxTreeCtrl::EndEditLabel}{wxtreectrlendeditlabel}, +\helpref{wxTreeEvent}{wxtreeevent} -\membersection{wxTreeCtrl::Edit}\label{wxtreectrledit} +\membersection{wxTreeCtrl::EndEditLabel}\label{wxtreectrlendeditlabel} -\func{wxTextCtrl\&}{Edit}{\param{long }{item}} +\func{void}{EndEditLabel}{\param{bool }{cancelEdit}} -Starts editing the label of the given item, returning the text control that the tree control uses for editing. +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}} +\func{void}{EnsureVisible}{\param{const wxTreeItemId\&}{ item}} Scrolls and/or expands items to ensure that the given item is visible. -\membersection{wxTreeCtrl::ExpandItem}\label{wxtreectrlexpanditem} +\membersection{wxTreeCtrl::Expand}\label{wxtreectrlexpand} -\func{bool}{ExpandItem}{\param{long }{item}, \param{int }{action}} +\func{void}{Expand}{\param{const wxTreeItemId\&}{ item}} Expands the given item. -{\it action} may be one of: +\membersection{wxTreeCtrl::GetBoundingRect}\label{wxtreectrlgetitemrect} -\twocolwidtha{5cm} -\begin{twocollist}\itemsep=0pt -\twocolitem{\windowstyle{wxTREE\_EXPAND\_EXPAND}}{Expands the item.} -\twocolitem{\windowstyle{wxTREE\_EXPAND\_COLLAPSE}}{Collapses the item.} -\twocolitem{\windowstyle{wxTREE\_EXPAND\_COLLAPSE\_RESET}}{Collapses the item and removes the child items.} -\twocolitem{\windowstyle{wxTREE\_EXPAND\_TOGGLE}}{Expands if the item is collapsed, collapses if the item is expanded.} -\end{twocollist} +\constfunc{bool}{GetBoundingRect}{\param{const wxTreeItemId\&}{ item}, \param{wxRect\& }{rect}, \param{bool }{textOnly = FALSE}} -\membersection{wxTreeCtrl::GetChild}\label{wxtreectrlgetchild} +Retrieves the rectangle bounding the {\it item}. If {\it textOnly} is TRUE, +only the rectangle around the items label will be returned, otherwise the +items image is also taken into account. -\constfunc{long}{GetChild}{\param{long }{item}} +The return value is TRUE if the rectangle was successfully retrieved or FALSE +if it was not (in this case {\it rect} is not changed) - for example, if the +item is currently invisible. -Call this function to retrieve the tree view item that is the first child of the item specified by {\it item}. +\pythonnote{The wxPython version of this method requires only the +{\tt item} and {\tt textOnly} parameters. The return value is either a +{\tt wxRect} object or {\tt None}.} + +\perlnote{In wxPerl this method only takes the parameters {\tt item} and + {\tt textOnly}, and returns a Wx::Rect ( or undef ).} + +\membersection{wxTreeCtrl::GetChildrenCount}\label{wxtreectrlgetchildrencount} + +\constfunc{size\_t}{GetChildrenCount}{\param{const wxTreeItemId\&}{ item}, \param{bool}{ recursively = TRUE}} + +Returns the number of items in the branch. If {\it recursively} is TRUE, returns the total number +of descendants, otherwise only one level of children is counted. \membersection{wxTreeCtrl::GetCount}\label{wxtreectrlgetcount} @@ -157,24 +266,41 @@ Returns the number of items in the control. Returns the edit control used to edit a label. +\membersection{wxTreeCtrl::GetFirstChild}\label{wxtreectrlgetfirstchild} + +\constfunc{wxTreeItemId}{GetFirstChild}{\param{const wxTreeItemId\&}{ item}, \param{long\& }{cookie}} + +Returns the first child; call \helpref{wxTreeCtrl::GetNextChild}{wxtreectrlgetnextchild} for the next child. + +For this enumeration function you must pass in a `cookie' parameter +which is opaque for the application but is necessary for the library +to make these functions reentrant (i.e. allow more than one +enumeration on one and the same object simultaneously). The cookie passed to +GetFirstChild and GetNextChild should be the same. + +Returns an invalid tree item if there are no further children. + +\wxheading{See also} + +\helpref{wxTreeCtrl::GetNextChild}{wxtreectrlgetnextchild} + +\pythonnote{In wxPython the returned wxTreeItemId and the new cookie +value are both returned as a tuple containing the two values.} + +\perlnote{In wxPerl this method only takes the {\tt item} parameter, and + returns a 2-element list ( item, cookie ).} + \membersection{wxTreeCtrl::GetFirstVisibleItem}\label{wxtreectrlgetfirstvisibleitem} -\constfunc{long}{GetFirstVisibleItem}{\void} +\constfunc{wxTreeItemId}{GetFirstVisibleItem}{\void} Returns the first visible item. \membersection{wxTreeCtrl::GetImageList}\label{wxtreectrlgetimagelist} -\constfunc{wxImageList*}{GetImageList}{\param{int }{which = wxIMAGE\_LIST\_NORMAL}} +\constfunc{wxImageList*}{GetImageList}{\void} -Returns the specified image list. {\it which} may be one of: - -\twocolwidtha{5cm} -\begin{twocollist}\itemsep=0pt -\twocolitem{\windowstyle{wxIMAGE\_LIST\_NORMAL}}{The normal (large icon) image list.} -\twocolitem{\windowstyle{wxIMAGE\_LIST\_SMALL}}{The small icon image list.} -\twocolitem{\windowstyle{wxIMAGE\_LIST\_STATE}}{The user-defined state image list (unimplemented).} -\end{twocollist} +Returns the normal image list. \membersection{wxTreeCtrl::GetIndent}\label{wxtreectrlgetindent} @@ -182,91 +308,186 @@ Returns the specified image list. {\it which} may be one of: Returns the current tree control indentation. -\membersection{wxTreeCtrl::GetItem}\label{wxtreectrlgetitem} +\membersection{wxTreeCtrl::GetItemData}\label{wxtreectrlgetitemdata} -\constfunc{bool}{GetItem}{\param{wxTreeItem\& }{info}} +\constfunc{wxTreeItemData*}{GetItemData}{\param{const wxTreeItemId\&}{ item}} -Gets information about the item. See \helpref{wxTreeCtrl::SetItem}{wxtreectrlsetitem} for more -information. +Returns the tree item data associated with the item. -\membersection{wxTreeCtrl::GetItemData}\label{wxtreectrlgetitemdata} +\wxheading{See also} -\constfunc{long}{GetItemData}{\param{long }{item}} +\helpref{wxTreeItemData}{wxtreeitemdata} -Returns the client data associated with the item, if any. +\pythonnote{wxPython provides the following shortcut method: -\membersection{wxTreeCtrl::GetItemRect}\label{wxtreectrlgetitemrect} +\indented{2cm}{\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf GetPyData(item)}}{Returns the Python Object +associated with the wxTreeItemData for the given item Id.} +\end{twocollist}} +} -\constfunc{bool}{GetItemRect}{\param{long }{item}, \param{wxRect\& }{rect}, \param{bool }{textOnly = FALSE}} +\perlnote{wxPerl provides the following shortcut method: +\indented{2cm}{ +\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf GetPlData( item )}}{Returns the Perl data +associated with the Wx::TreeItemData ( it is just the same as +tree->GetItemData( item )->GetData(); ).} +\end{twocollist}} +} + +\membersection{wxTreeCtrl::GetItemImage}\label{wxtreectrlgetitemimage} + +\constfunc{int}{GetItemImage}{\param{const wxTreeItemId\& }{item}, + \param{wxTreeItemIcon }{which = wxTreeItemIcon\_Normal}} + +Gets the specified item image. The value of {\it which} may be: + +\begin{itemize}\itemsep=0pt +\item{wxTreeItemIcon\_Normal} to get the normal item image +\item{wxTreeItemIcon\_Selected} to get the selected item image (i.e. the image +which is shown when the item is currently selected) +\item{wxTreeItemIcon\_Expanded} to get the expanded image (this only +makes sense for items which have children - then this image is shown when the +item is expanded and the normal image is shown when it is collapsed) +\item{wxTreeItemIcon\_SelectedExpanded} to get the selected expanded image +(which is shown when an expanded item is currently selected) +\end{itemize} -Returns the position and size of the rectangle bounding the item. +\membersection{wxTreeCtrl::GetItemText}\label{wxtreectrlgetitemtext} -\membersection{wxTreeCtrl::GetItemState}\label{wxtreectrlgetitemstate} +\constfunc{wxString}{GetItemText}{\param{const wxTreeItemId\&}{ item}} -\constfunc{int}{GetItemState}{\param{long }{item}, \param{long }{stateMask}} +Returns the item label. -Gets the item state. For a list of state flags, see \helpref{wxTreeCtrl::SetItem}{wxtreectrlsetitem}. +\membersection{wxTreeCtrl::GetLastChild}\label{wxtreectrlgetlastchild} -\membersection{wxTreeCtrl::GetItemText}\label{wxtreectrlgetitemtext} +\constfunc{wxTreeItemId}{GetLastChild}{\param{const wxTreeItemId\&}{ item}} -\constfunc{wxString}{GetItemText}{\param{long }{item}} +Returns the last child of the item (or an invalid tree item if this item has no children). -Returns the item label. +\wxheading{See also} -\membersection{wxTreeCtrl::GetNextItem}\label{wxtreectrlgetnextitem} +\helpref{GetFirstChild}{wxtreectrlgetfirstchild}, +\helpref{GetLastChild}{wxtreectrlgetlastchild} -\constfunc{long}{GetNextItem}{\param{long }{item}, \param{int }{code}} +\membersection{wxTreeCtrl::GetNextChild}\label{wxtreectrlgetnextchild} -Searches for an item using the given criterion, starting from {\it item}. +\constfunc{wxTreeItemId}{GetNextChild}{\param{const wxTreeItemId\&}{ item}, \param{long\& }{cookie}} -Returns the item or 0 if unsuccessful. +Returns the next child; call \helpref{wxTreeCtrl::GetFirstChild}{wxtreectrlgetfirstchild} for the first child. -{\it code} can be one of: +For this enumeration function you must pass in a `cookie' parameter +which is opaque for the application but is necessary for the library +to make these functions reentrant (i.e. allow more than one +enumeration on one and the same object simultaneously). The cookie passed to +GetFirstChild and GetNextChild should be the same. -\twocolwidtha{5cm} -\begin{twocollist}\itemsep=0pt -\twocolitem{wxTREE\_NEXT\_CARET}{Retrieves the currently selected item.} -\twocolitem{wxTREE\_NEXT\_CHILD}{Retrieves the first child item. The hItem parameter must be NULL.} -\twocolitem{wxTREE\_NEXT\_DROPHILITE}{Retrieves the item that is the target of a drag-and-drop operation.} -\twocolitem{wxTREE\_NEXT\_FIRSTVISIBLE}{Retrieves the first visible item.} -\twocolitem{wxTREE\_NEXT\_NEXT}{Retrieves the next sibling item.} -\twocolitem{wxTREE\_NEXT\_NEXTVISIBLE}{Retrieves the next visible item that follows the specified item.} -\twocolitem{wxTREE\_NEXT\_PARENT}{Retrieves the parent of the specified item.} -\twocolitem{wxTREE\_NEXT\_PREVIOUS}{Retrieves the previous sibling item.} -\twocolitem{wxTREE\_NEXT\_PREVIOUSVISIBLE}{Retrieves the first visible item that precedes the specified item.} -\twocolitem{wxTREE\_NEXT\_ROOT}{Retrieves the first child item of the root item of which the specified item is a part.} -\end{twocollist} +Returns an invalid tree item if there are no further children. + +\wxheading{See also} + +\helpref{wxTreeCtrl::GetFirstChild}{wxtreectrlgetfirstchild} -\membersection{wxTreeCtrl::GetNextVisibleItem}\label{wxtreectrlgetnextvisibleitem} +\pythonnote{In wxPython the returned wxTreeItemId and the new cookie +value are both returned as a tuple containing the two values.} -\constfunc{long}{GetNextVisibleItem}{\param{long }{item}} +\perlnote{In wxPerl this method returns a 2-element list + ( item, cookie ), instead of modifying its parameters.} + +\membersection{wxTreeCtrl::GetNextSibling}\label{wxtreectrlgetnextsibling} + +\constfunc{wxTreeItemId}{GetNextSibling}{\param{const wxTreeItemId\&}{ item}} + +Returns the next sibling of the specified item; call \helpref{wxTreeCtrl::GetPrevSibling}{wxtreectrlgetprevsibling} for the previous sibling. + +Returns an invalid tree item if there are no further siblings. + +\wxheading{See also} + +\helpref{wxTreeCtrl::GetPrevSibling}{wxtreectrlgetprevsibling} + +\membersection{wxTreeCtrl::GetNextVisible}\label{wxtreectrlgetnextvisible} + +\constfunc{wxTreeItemId}{GetNextVisible}{\param{const wxTreeItemId\&}{ item}} Returns the next visible item. \membersection{wxTreeCtrl::GetParent}\label{wxtreectrlgetparent} -\constfunc{long}{GetParent}{\param{long }{item}} +\constfunc{wxTreeItemId}{GetParent}{\param{const wxTreeItemId\&}{ item}} Returns the item's parent. +\pythonnote{This method is named {\tt GetItemParent} to avoid a name +clash with wxWindow::GetParent.} + +\membersection{wxTreeCtrl::GetPrevSibling}\label{wxtreectrlgetprevsibling} + +\constfunc{wxTreeItemId}{GetPrevSibling}{\param{const wxTreeItemId\&}{ item}} + +Returns the previous sibling of the specified item; call \helpref{wxTreeCtrl::GetNextSibling}{wxtreectrlgetnextsibling} for the next sibling. + +Returns an invalid tree item if there are no further children. + +\wxheading{See also} + +\helpref{wxTreeCtrl::GetNextSibling}{wxtreectrlgetnextsibling} + +\membersection{wxTreeCtrl::GetPrevVisible}\label{wxtreectrlgetprevvisible} + +\constfunc{wxTreeItemId}{GetPrevVisible}{\param{const wxTreeItemId\&}{ item}} + +Returns the previous visible item. + \membersection{wxTreeCtrl::GetRootItem}\label{wxtreectrlgetrootitem} -\constfunc{long}{GetRootItem}{\void} +\constfunc{wxTreeItemId}{GetRootItem}{\void} Returns the root item for the tree control. +\membersection{wxTreeCtrl::GetItemSelectedImage}\label{wxtreectrlgetitemselectedimage} + +\constfunc{int}{GetItemSelectedImage}{\param{const wxTreeItemId\& }{item}} + +Gets the selected item image (this function is obsolete, use +{\tt GetItemImage(item, wxTreeItemIcon\_Selected}) instead). + \membersection{wxTreeCtrl::GetSelection}\label{wxtreectrlgetselection} -\constfunc{long}{GetSelection}{\void} +\constfunc{wxTreeItemId}{GetSelection}{\void} + +Returns the selection, or an invalid item if there is no selection. +This function only works with the controls without wxTR\_MULTIPLE style, use +\helpref{GetSelections}{wxtreectrlgetselections} for the controls which do have +this style. + +\membersection{wxTreeCtrl::GetSelections}\label{wxtreectrlgetselections} + +\constfunc{size\_t}{GetSelections}{\param{wxArrayTreeItemIds\& }{selection}} -Returns the selection, or 0 if there is no selection. +Fills the array of tree items passed in with the currently selected items. This +function can be called only if the control has the wxTR\_MULTIPLE style. + +Returns the number of selected items. + +\pythonnote{The wxPython version of this method accepts no parameters +and returns a Python list of {\tt wxTreeItemId}s.} + +\perlnote{In wxPerl this method takes no parameters and returns a list of + {\tt Wx::TreeItemId}s.} + +\membersection{wxTreeCtrl::GetStateImageList}\label{wxtreectrlgetstateimagelist} + +\constfunc{wxImageList*}{GetStateImageList}{\void} + +Returns the state image list (from which application-defined state images are taken). \membersection{wxTreeCtrl::HitTest}\label{wxtreectrlhittest} -\func{long}{HitTest}{\param{const wxPoint\& }{point}, \param{int\& }{flags}} +\func{wxTreeItemId}{HitTest}{\param{const wxPoint\& }{point}, \param{int\& }{flags}} -Calculates which (if any) item is under the given point, returning extra information -in {\it flags}. {\it flags} is a bitlist of the following: +Calculates which (if any) item is under the given point, returning the tree item +id at this point plus extra information {\it flags}. {\it flags} is a bitlist of the following: \twocolwidtha{5cm} \begin{twocollist}\itemsep=0pt @@ -283,34 +504,92 @@ in {\it flags}. {\it flags} is a bitlist of the following: \twocolitem{wxTREE\_HITTEST\_TORIGHT}{To the left of the client area.} \end{twocollist} -\membersection{wxTreeCtrl::InsertItem}\label{wxtreectrlinsertitem} +\pythonnote{in wxPython both the wxTreeItemId and the flags are +returned as a tuple.} -\func{long}{InsertItem}{\param{long }{parent}, \param{wxTreeItem\& }{info}, \param{long }{insertAfter = wxTREE\_INSERT\_LAST}} +\perlnote{In wxPerl this method only takes the {\tt point} parameter + and returns a 2-element list ( item, flags ).} -Inserts an item. For more information on {\it info}, see \helpref{wxTreeCtrl::SetItem}{wxtreectrlsetitem}. +\membersection{wxTreeCtrl::InsertItem}\label{wxtreectrlinsertitem} + +\func{wxTreeItemId}{InsertItem}{\param{const wxTreeItemId\& }{parent}, \param{const wxTreeItemId\& }{previous}, \param{const wxString\&}{ text}, + \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = NULL}} -\func{long}{InsertItem}{\param{long }{parent}, \param{const wxString\& }{label}, \param{int }{image = -1}, \param{int }{selImage = -1}, \param{long }{insertAfter = wxTREE\_INSERT\_LAST}} +\func{wxTreeItemId}{InsertItem}{\param{const wxTreeItemId\& }{parent}, \param{size\_t}{ before}, \param{const wxString\&}{ text}, + \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = NULL}} -Inserts an item. +Inserts an item after a given one ({\it previous}) or before one identified by its position ({\it before}). If {\it image} > -1 and {\it selImage} is -1, the same image is used for both selected and unselected items. +\pythonnote{The second form of this method is called +\tt{InsertItemBefore} in wxPython.} + +\membersection{wxTreeCtrl::IsBold}\label{wxtreectrlisbold} + +\constfunc{bool}{IsBold}{\param{const wxTreeItemId\& }{item}} + +Returns TRUE if the given item is in bold state. + +See also: \helpref{SetItemBold}{wxtreectrlsetitembold} + +\membersection{wxTreeCtrl::IsExpanded}\label{wxtreectrlisexpanded} + +\constfunc{bool}{IsExpanded}{\param{const wxTreeItemId\&}{ item}} + +Returns TRUE if the item is expanded (only makes sense if it has children). + +\membersection{wxTreeCtrl::IsSelected}\label{wxtreectrlisselected} + +\constfunc{bool}{IsSelected}{\param{const wxTreeItemId\&}{ item}} + +Returns TRUE if the item is selected. + +\membersection{wxTreeCtrl::IsVisible}\label{wxtreectrlisvisible} + +\constfunc{bool}{IsVisible}{\param{const wxTreeItemId\&}{ item}} + +Returns TRUE if the item is visible (it might be outside the view, or not expanded). + \membersection{wxTreeCtrl::ItemHasChildren}\label{wxtreectrlitemhaschildren} -\constfunc{bool}{ItemHasChildren}{\param{long }{item}} +\constfunc{bool}{ItemHasChildren}{\param{const wxTreeItemId\&}{ item}} Returns TRUE if the item has children. +\membersection{wxTreeCtrl::OnCompareItems}\label{wxtreectrloncompareitems} + +\func{int}{OnCompareItems}{\param{const wxTreeItemId\& }{item1}, \param{const wxTreeItemId\& }{item2}} + +Override this function in the derived class to change the sort order of the +items in the tree control. The function should return a negative, zero or +positive value if the first item is less than, equal to or greater than the +second one. + +The base class version compares items alphabetically. + +See also: \helpref{SortChildren}{wxtreectrlsortchildren} + +\membersection{wxTreeCtrl::PrependItem}\label{wxtreectrlprependitem} + +\func{wxTreeItemId}{PrependItem}{\param{const wxTreeItemId\& }{parent}, \param{const wxString\&}{ text}, + \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = NULL}} + +Appends an item as the first child of {\it parent}, return a new item id. + +If {\it image} > -1 and {\it selImage} is -1, the same image is used for +both selected and unselected items. + \membersection{wxTreeCtrl::ScrollTo}\label{wxtreectrlscrollto} -\func{bool}{ScrollTo}{\param{long }{item}} +\func{void}{ScrollTo}{\param{const wxTreeItemId\&}{ item}} -selects the specified item and scrolls the item into view, +Scrolls the specified item into view. \membersection{wxTreeCtrl::SelectItem}\label{wxtreectrlselectitem} -\func{bool}{SelectItem}{\param{long }{item}} +\func{bool}{SelectItem}{\param{const wxTreeItemId\&}{ item}} Selects the given item. @@ -322,87 +601,210 @@ Sets the indentation for the tree control. \membersection{wxTreeCtrl::SetImageList}\label{wxtreectrlsetimagelist} -\func{void}{SetImageList}{\param{wxImageList*}{ imageList}, \param{int }{which = wxIMAGE\_LIST\_NORMAL}} +\func{void}{SetImageList}{\param{wxImageList*}{ imageList}} -Sets the image list. {\it which} should be one of wxIMAGE\_LIST\_NORMAL, wxIMAGE\_LIST\_SMALL and -wxIMAGE\_LIST\_STATE. +Sets the normal image list. Image list assigned with this method will +{\bf not} be deleted by wxTreeCtrl's destructor, you must delete it yourself. -\membersection{wxTreeCtrl::SetItem}\label{wxtreectrlsetitem} +See also \helpref{AssignImageList}{wxtreectrlassignimagelist}. -\func{bool}{SetItem}{\param{wxTreeItem\& }{info}} -Sets the properties of the item. +\membersection{wxTreeCtrl::SetItemBackgroundColour}\label{wxtreectrlsetitembackgroundcolour} -The members of wxTreeItem are as follows: +\func{void}{SetItemBackgroundColour}{\param{const wxTreeItemId\&}{ item}, \param{const wxColour\& }{col}} -\twocolwidtha{5cm} -\begin{twocollist}\itemsep=0pt -\twocolitem{m\_mask}{A bitlist specifying the valid members. See below for mask flags.} -\twocolitem{m\_itemId}{The item identifier.} -\twocolitem{m\_state}{The item state. See below for state flags.} -\twocolitem{m\_stateMask}{A bitlist specifying the valid contents of {\it m\_state}. These flags -are taken from the same set of symbols as {\it m\_state}.} -\twocolitem{m\_text}{The item label.} -\twocolitem{m\_image}{The item image index (an index into the appropriate image list).} -\twocolitem{m\_selectedImage}{The item selected index (an index into the appropriate image list).} -\twocolitem{m\_children}{The number of child items that this item has.} -\twocolitem{m\_data}{The application-defined data associated with this item.} -\end{twocollist} +Sets the colour of the items background. -Valid mask flags are: +\membersection{wxTreeCtrl::SetItemBold}\label{wxtreectrlsetitembold} -\twocolwidtha{5cm} -\begin{twocollist}\itemsep=0pt -\twocolitem{wxTREE\_MASK\_HANDLE}{The {\it m\_itemId} member is valid.} -\twocolitem{wxTREE\_MASK\_STATE}{The {\it m\_state} member is valid.} -\twocolitem{wxTREE\_MASK\_TEXT}{The {\it m\_text} member is valid.} -\twocolitem{wxTREE\_MASK\_IMAGE}{The {\it m\_image} member is valid.} -\twocolitem{wxTREE\_MASK\_SELECTED\_IMAGE}{The {\it m\_selectedImage} member is valid.} -\twocolitem{wxTREE\_MASK\_CHILDREN}{The {\it m\_children} member is valid.} -\twocolitem{wxTREE\_MASK\_DATA}{The {\it m\_data} member is valid.} -\end{twocollist} +\func{void}{SetItemBold}{\param{const wxTreeItemId\& }{item}, \param{bool}{ bold = TRUE}} -Valid state and state mask flags are: +Makes item appear in bold font if {\it bold} parameter is TRUE or resets it to +the normal state. -\twocolwidtha{5cm} +See also: \helpref{IsBold}{wxtreectrlisbold} + +\membersection{wxTreeCtrl::SetItemData}\label{wxtreectrlsetitemdata} + +\func{void}{SetItemData}{\param{const wxTreeItemId\&}{ item}, \param{wxTreeItemData* }{data}} + +Sets the item client data. + +\pythonnote{wxPython provides the following shortcut method:\par +\indented{2cm}{\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf SetPyData(item, obj)}}{Associate the given Python +Object with the wxTreeItemData for the given item Id.} +\end{twocollist}} +} + +\perlnote{wxPerl provides the following shortcut method: +\indented{2cm}{ \begin{twocollist}\itemsep=0pt -\twocolitem{wxTREE\_STATE\_BOLD}{The label is emboldened.} -\twocolitem{wxTREE\_STATE\_DROPHILITED}{The item indicates it is a drop target.} -\twocolitem{wxTREE\_STATE\_EXPANDED}{The item is expanded.} -\twocolitem{wxTREE\_STATE\_EXPANDEDONCE}{The item's list of child items has been expanded at least once.} -\twocolitem{wxTREE\_STATE\_FOCUSED}{The item has the focus, so it is surrounded by a standard focus rectangle. -Only one item can have the focus.} -\twocolitem{wxTREE\_STATE\_SELECTED}{The item is selected.} -\twocolitem{wxTREE\_STATE\_CUT}{The item is selected as part of a cut and paste operation.} -\end{twocollist} +\twocolitem{{\bf SetPlData( item, data )}}{Sets the Perl data +associated with the Wx::TreeItemData ( it is just the same as +tree->GetItemData( item )->SetData( data ); ).} +\end{twocollist}} +} + +\membersection{wxTreeCtrl::SetItemFont}\label{wxtreectrlsetitemfont} + +\func{void}{SetItemFont}{\param{const wxTreeItemId\&}{ item}, \param{const wxFont\& }{font}} + +Sets the items font. All items in the tree should have the same height to avoid +text clipping, so the fonts height should be the same for all of them, +although font attributes may vary. + +\wxheading{See also} + +\helpref{SetItemBold}{wxtreectrlsetitembold} + +\membersection{wxTreeCtrl::SetItemHasChildren}\label{wxtreectrlsetitemhaschildren} + +\func{void}{SetItemHasChildren}{\param{const wxTreeItemId\&}{ item}, \param{bool }{hasChildren = TRUE}} + +Force appearance of the button next to the item. This is useful to +allow the user to expand the items which don't have any children now, +but instead adding them only when needed, thus minimizing memory +usage and loading time. \membersection{wxTreeCtrl::SetItemImage}\label{wxtreectrlsetitemimage} -\func{bool}{SetItemImage}{\param{long }{item}, \param{int }{image}, \param{int }{selImage}} +\func{void}{SetItemImage}{\param{const wxTreeItemId\&}{ item}, + \param{int }{image}, \param{wxTreeItemIcon }{which = wxTreeItemIcon\_Normal}} -Sets the item image and selected image. These are indices into the assciated image list. +Sets the specified item image. See \helpref{GetItemImage}{wxtreectrlgetitemimage} +for the description of the {\it which} parameter. -\membersection{wxTreeCtrl::SetItemState}\label{wxtreectrlsetitemstate} +\membersection{wxTreeCtrl::SetItemSelectedImage}\label{wxtreectrlsetitemselectedimage} -\func{bool}{SetItemState}{\param{long }{item}, \param{long }{state}, \param{long }{stateMask}} +\func{void}{SetItemSelectedImage}{\param{const wxTreeItemId\&}{ item}, \param{int }{selImage}} -Sets the item state. See \helpref{wxTreeCtrl::SetItem}{wxtreectrlsetitem} for valid state and state mask flags. +Sets the selected item image (this function is obsolete, use {\tt SetItemImage(item, wxTreeItemIcon\_Selected}) instead). \membersection{wxTreeCtrl::SetItemText}\label{wxtreectrlsetitemtext} -\func{void}{SetItemText}{\param{long }{item}, \param{const wxString\& }{text}} +\func{void}{SetItemText}{\param{const wxTreeItemId\&}{ item}, \param{const wxString\& }{text}} Sets the item label. -\membersection{wxTreeCtrl::SetItemData}\label{wxtreectrlsetitemdata} +\membersection{wxTreeCtrl::SetItemTextColour}\label{wxtreectrlsetitemtextcolour} -\func{bool}{SetItemData}{\param{long }{item}, \param{long }{data}} +\func{void}{SetItemTextColour}{\param{const wxTreeItemId\&}{ item}, \param{const wxColour\& }{col}} -Sets the item client data. +Sets the colour of the items text. + +\membersection{wxTreeCtrl::SetStateImageList}\label{wxtreectrlsetstateimagelist} + +\func{void}{SetStateImageList}{\param{wxImageList*}{ imageList}} + +Sets the state image list (from which application-defined state images are taken). +Image list assigned with this method will +{\bf not} be deleted by wxTreeCtrl's destructor, you must delete it yourself. + +See also \helpref{AssignStateImageList}{wxtreectrlassignstateimagelist}. \membersection{wxTreeCtrl::SortChildren}\label{wxtreectrlsortchildren} -\func{bool}{SortChildren}{\param{long }{item}} +\func{void}{SortChildren}{\param{const wxTreeItemId\&}{ item}} + +Sorts the children of the given item using +\helpref{OnCompareItems}{wxtreectrloncompareitems} method of wxTreeCtrl. You +should override that method to change the sort order (the default is ascending +alphabetical order). + +\wxheading{See also} + +\helpref{wxTreeItemData}{wxtreeitemdata}, \helpref{OnCompareItems}{wxtreectrloncompareitems} + +\membersection{wxTreeCtrl::Toggle}\label{wxtreectrltoggle} + +\func{void}{Toggle}{\param{const wxTreeItemId\&}{ item}} + +Toggles the given item between collapsed and expanded states. + +\membersection{wxTreeCtrl::Unselect}\label{wxtreectrlunselect} + +\func{void}{Unselect}{\void} + +Removes the selection from the currently selected item (if any). + +\membersection{wxTreeCtrl::UnselectAll}\label{wxtreectrlunselectall} + +\func{void}{UnselectAll}{\void} + +This function either behaves the same as \helpref{Unselect}{wxtreectrlunselect} +if the control doesn't have wxTR\_MULTIPLE style, or removes the selection from +all items if it does have this style. + +\section{\class{wxTreeItemData}}\label{wxtreeitemdata} + +wxTreeItemData is some (arbitrary) user class associated with some item. The +main advantage of having this class (compared to the old untyped interface) is +that wxTreeItemData's are destroyed automatically by the tree and, as this +class has virtual dtor, it means that the memory will be automatically +freed. We don't just use wxObject instead of wxTreeItemData because +the size of this class is critical: in any real application, each tree leaf +will have wxTreeItemData associated with it and number of leaves may be +quite big. + +Because the objects of this class are deleted by the tree, they should +always be allocated on the heap. + +\wxheading{Derived from} + +wxTreeItemId + +\wxheading{Include files} + + + +\wxheading{See also} + +\helpref{wxTreeCtrl}{wxtreectrl} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxTreeItemData::wxTreeItemData}\label{wxtreeitemdataconstr} + +\func{}{wxTreeItemData}{\void} + +Default constructor. + +\pythonnote{The wxPython version of this constructor optionally +accepts any Python object as a parameter. This object is then +associated with the tree item using the wxTreeItemData as a +container. + +In addition, the following methods are added in wxPython for accessing +the object: + +\indented{2cm}{\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf GetData()}}{Returns a reference to the Python Object} +\twocolitem{{\bf SetData(obj)}}{Associates a new Python Object with the +wxTreeItemData} +\end{twocollist}} +} + +\perlnote{In wxPerl the constructor accepts as parameter an optional scalar, + and stores it as client data. You may retrieve this data by calling + {\bf GetData()}, and set it by callling {\bf SetData( data ).} +} + +\membersection{wxTreeItemData::\destruct{wxTreeItemData}} + +\func{void}{\destruct{wxTreeItemData}}{\void} + +Virtual destructor. + +\membersection{wxTreeItemData::GetId}\label{wxtreeitemdatagetid} + +\func{const wxTreeItem\&}{GetId}{\void} + +Returns the item associated with this node. + +\membersection{wxTreeItemData::SetId}\label{wxtreeitemdatasetid} + +\func{void}{SetId}{\param{const wxTreeItemId\&}{ id}} -Sorts the children of the given item in ascending alphabetical order. +Sets the item associated with this node.