X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4fabb57533169f2f75367e0d120c762518548890..ded4fa5b7a2a8177a6905b9b0fcda1d3dac2d0ff:/docs/latex/wx/treectrl.tex?ds=sidebyside diff --git a/docs/latex/wx/treectrl.tex b/docs/latex/wx/treectrl.tex index c831025d97..2792ac55df 100644 --- a/docs/latex/wx/treectrl.tex +++ b/docs/latex/wx/treectrl.tex @@ -12,14 +12,55 @@ 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.} -\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\_EDIT\_LABELS}}{Use this style +if you wish the user to be able to edit labels in the tree control.} +\twocolitem{\windowstyle{wxTR\_NO\_BUTTONS}}{For convenience +to document that no buttons are to be drawn.} +\twocolitem{\windowstyle{wxTR\_HAS\_BUTTONS}}{Use this style +to show + and - buttons to the left of parent items.} +\twocolitem{\windowstyle{wxTR\_TWIST\_BUTTONS}}{Use this style +to show Mac-style twister buttons to the left of parent items. +If both wxTR\_HAS\_BUTTONS and wxTR\_TWIST\_BUTTONS are given, +twister buttons are generated. Generic only.} +\twocolitem{\windowstyle{wxTR\_NO\_LINES}}{Use this style +to hide vertical level connectors.} +\twocolitem{\windowstyle{wxTR\_FULL\_ROW\_HIGHLIGHT}}{Use this style to have the background +colour and the selection highlight extend over the entire horizontal +row of the tree control window. (This flag is ignored under Windows unless you +specify wxTR\_NO\_LINES as well.) } +\twocolitem{\windowstyle{wxTR\_LINES\_AT\_ROOT}}{Use this style +to show lines between root nodes. +Only applicable if wxTR\_HIDE\_ROOT is set and wxTR\_NO\_LINES is not set.} +\twocolitem{\windowstyle{wxTR\_HIDE\_ROOT}}{Use this style +to suppress the display of the root node, +effectively causing the first-level nodes +to appear as a series of root nodes.} +\twocolitem{\windowstyle{wxTR\_ROW\_LINES}}{Use this style +to draw a contrasting border between displayed rows.} +\twocolitem{\windowstyle{wxTR\_HAS\_VARIABLE\_ROW\_HEIGHT}}{Use this style +to cause row heights to be just big enough to fit the content. +If not set, all rows use the largest row height. +The default is that this flag is unset. +Generic only.} +\twocolitem{\windowstyle{wxTR\_SINGLE}}{For convenience +to document that only one item may be selected at a time. +Selecting another item causes the current selection, if any, +to be deselected. This is the default.} +\twocolitem{\windowstyle{wxTR\_MULTIPLE}}{Use this style +to allow a range of items to be selected. +If a second range is selected, the current range, if any, is deselected.} +\twocolitem{\windowstyle{wxTR\_EXTENDED}}{Use this style +to allow disjoint items to be selected. (Only partially implemented; may not work in all cases.)} +\twocolitem{\windowstyle{wxTR\_DEFAULT\_STYLE}}{The set of flags that are +closest to the defaults for the native control for a particular toolkit.} \end{twocollist} See also \helpref{window styles overview}{windowstyles}. @@ -33,15 +74,18 @@ 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}% @@ -50,6 +94,17 @@ functions that take a \helpref{wxTreeEvent}{wxtreeevent} argument. \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} @@ -98,6 +153,9 @@ Destructor, destroying the list control. Adds the root node to the tree, returning the new item. +The {\it image} and {\it selImage} parameters are an index within +the normal image list specifying the image to use for unselected and +selected items, respectively. If {\it image} > -1 and {\it selImage} is -1, the same image is used for both selected and unselected items. @@ -108,9 +166,49 @@ both selected and unselected items. Appends an item to the end of the branch identified by {\it parent}, return a new item id. +The {\it image} and {\it selImage} parameters are an index within +the normal image list specifying the image to use for unselected and +selected items, respectively. If {\it image} > -1 and {\it selImage} is -1, the same image is used for both selected and unselected items. +\membersection{wxTreeCtrl::AssignButtonsImageList}\label{wxtreectrlassignbuttonsimagelist} + +\func{void}{AssignButtonsImageList}{\param{wxImageList*}{ imageList}} + +Sets the buttons image list. The button images assigned with this method will +be automatically deleted by wxTreeCtrl as appropriate +(i.e. it takes ownership of the list). + +Setting or assigning the button image list enables the display of image buttons. +Once enabled, the only way to disable the display of button images is to set +the button image list to NULL. + +This function is only available in the generic version. + +See also \helpref{SetButtonsImageList}{wxtreectrlsetbuttonsimagelist}. + +\membersection{wxTreeCtrl::AssignImageList}\label{wxtreectrlassignimagelist} + +\func{void}{AssignImageList}{\param{wxImageList*}{ imageList}} + +Sets the normal image list. Image list assigned with this method will +be automatically deleted by wxTreeCtrl as appropriate +(i.e. it takes ownership of the list). + +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 automatically deleted by wxTreeCtrl as appropriate +(i.e. it takes ownership of the list). + +See also \helpref{SetStateImageList}{wxtreectrlsetstateimagelist}. + + \membersection{wxTreeCtrl::Collapse}\label{wxtreectrlcollapse} \func{void}{Collapse}{\param{const wxTreeItemId\&}{ item}} @@ -145,20 +243,20 @@ Deletes all the items in the control. \membersection{wxTreeCtrl::EditLabel}\label{wxtreectrleditlabel} -\func{wxTextCtrl*}{EditLabel}{\param{const wxTreeItemId\&}{ 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}. +\func{void}{EditLabel}{\param{const wxTreeItemId\&}{ item}} -Do not delete the text control yourself. +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. -This function is currently supported under Windows only. +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{wxTreeCtrl::EndEditLabel}{wxtreectrlendeditlabel}, +\helpref{wxTreeEvent}{wxtreeevent} \membersection{wxTreeCtrl::EndEditLabel}\label{wxtreectrlendeditlabel} @@ -186,9 +284,30 @@ Expands the given item. \membersection{wxTreeCtrl::GetBoundingRect}\label{wxtreectrlgetitemrect} -\constfunc{void}{GetBoundingRect}{\param{const wxTreeItemId\&}{ item}, \param{wxRect\& }{rect}, \param{bool }{textOnly = FALSE}} +\constfunc{bool}{GetBoundingRect}{\param{const wxTreeItemId\&}{ item}, \param{wxRect\& }{rect}, \param{bool }{textOnly = FALSE}} + +Retrieves the rectangle bounding the {\it item}. If {\it textOnly} is TRUE, +only the rectangle around the item's label will be returned, otherwise the +item's image is also taken into account. + +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. + +\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}.} -Returns the position and size of the rectangle bounding the item. +\perlnote{In wxPerl this method only takes the parameters {\tt item} and + {\tt textOnly}, and returns a Wx::Rect ( or undef ).} + +\membersection{wxTreeCtrl::GetButtonsImageList}\label{wxtreectrlgetbuttonsimagelist} + +\constfunc{wxImageList*}{GetButtonsImageList}{\void} + +Returns the buttons image list (from which application-defined button images are taken). + +This function is only available in the generic version. \membersection{wxTreeCtrl::GetChildrenCount}\label{wxtreectrlgetchildrencount} @@ -221,12 +340,18 @@ 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 0 if there are no further children. +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 {\tt ( item, cookie )}.} + \membersection{wxTreeCtrl::GetFirstVisibleItem}\label{wxtreectrlgetfirstvisibleitem} \constfunc{wxTreeItemId}{GetFirstVisibleItem}{\void} @@ -235,16 +360,9 @@ 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} @@ -262,11 +380,40 @@ Returns the tree item data associated with the item. \helpref{wxTreeItemData}{wxtreeitemdata} +\pythonnote{wxPython provides the following shortcut method: + +\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}} +} + +\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}} +\constfunc{int}{GetItemImage}{\param{const wxTreeItemId\& }{item}, + \param{wxTreeItemIcon }{which = wxTreeItemIcon\_Normal}} -Gets the normal item image. +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} \membersection{wxTreeCtrl::GetItemText}\label{wxtreectrlgetitemtext} @@ -274,6 +421,17 @@ Gets the normal item image. Returns the item label. +\membersection{wxTreeCtrl::GetLastChild}\label{wxtreectrlgetlastchild} + +\constfunc{wxTreeItemId}{GetLastChild}{\param{const wxTreeItemId\&}{ item}} + +Returns the last child of the item (or an invalid tree item if this item has no children). + +\wxheading{See also} + +\helpref{GetFirstChild}{wxtreectrlgetfirstchild}, +\helpref{GetLastChild}{wxtreectrlgetlastchild} + \membersection{wxTreeCtrl::GetNextChild}\label{wxtreectrlgetnextchild} \constfunc{wxTreeItemId}{GetNextChild}{\param{const wxTreeItemId\&}{ item}, \param{long\& }{cookie}} @@ -286,19 +444,25 @@ 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 0 if there are no further children. +Returns an invalid tree item if there are no further children. \wxheading{See also} \helpref{wxTreeCtrl::GetFirstChild}{wxtreectrlgetfirstchild} +\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 returns a 2-element list + {\tt ( 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 0 if there are no further siblings. +Returns an invalid tree item if there are no further siblings. \wxheading{See also} @@ -316,13 +480,16 @@ Returns the next visible 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 0 if there are no further children. +Returns an invalid tree item if there are no further children. \wxheading{See also} @@ -340,24 +507,49 @@ Returns the previous visible item. Returns the root item for the tree control. -\membersection{wxTreeCtrl::GetSelectedItemImage}\label{wxtreectrlgetselecteditemimage} +\membersection{wxTreeCtrl::GetItemSelectedImage}\label{wxtreectrlgetitemselectedimage} -\constfunc{int}{GetSelectedItemImage}{\param{const wxTreeItemId\& }{item}} +\constfunc{int}{GetItemSelectedImage}{\param{const wxTreeItemId\& }{item}} -Gets the selected item image. +Gets the selected item image (this function is obsolete, use +{\tt GetItemImage(item, wxTreeItemIcon\_Selected}) instead). \membersection{wxTreeCtrl::GetSelection}\label{wxtreectrlgetselection} \constfunc{wxTreeItemId}{GetSelection}{\void} -Returns the selection, or 0 if there is no selection. +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}} + +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 @@ -374,16 +566,39 @@ in {\it flags}. {\it flags} is a bitlist of the following: \twocolitem{wxTREE\_HITTEST\_TORIGHT}{To the left of the client area.} \end{twocollist} +\pythonnote{in wxPython both the wxTreeItemId and the flags are +returned as a tuple.} + +\perlnote{In wxPerl this method only takes the {\tt point} parameter + and returns a 2-element list {\tt ( item, flags )}.} + \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}} -Inserts an item after a given one. +\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 after a given one ({\it previous}) or before one identified by its position ({\it before}). +The {\it image} and {\it selImage} parameters are an index within +the normal image list specifying the image to use for unselected and +selected items, respectively. 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}} @@ -408,6 +623,19 @@ Returns TRUE if the item is visible (it might be outside the view, or not expand 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}, @@ -415,6 +643,9 @@ Returns TRUE if the item has children. Appends an item as the first child of {\it parent}, return a new item id. +The {\it image} and {\it selImage} parameters are an index within +the normal image list specifying the image to use for unselected and +selected items, respectively. If {\it image} > -1 and {\it selImage} is -1, the same image is used for both selected and unselected items. @@ -430,6 +661,22 @@ Scrolls the specified item into view. Selects the given item. +\membersection{wxTreeCtrl::SetButtonsImageList}\label{wxtreectrlsetbuttonsimagelist} + +\func{void}{SetButtonsImageList}{\param{wxImageList*}{ imageList}} + +Sets the buttons image list (from which application-defined button images are taken). +The button images assigned with this method will +{\bf not} be deleted by wxTreeCtrl's destructor, you must delete it yourself. + +Setting or assigning the button image list enables the display of image buttons. +Once enabled, the only way to disable the display of button images is to set +the button image list to NULL. + +This function is only available in the generic version. + +See also \helpref{AssignButtonsImageList}{wxtreectrlassignbuttonsimagelist}. + \membersection{wxTreeCtrl::SetIndent}\label{wxtreectrlsetindent} \func{void}{SetIndent}{\param{int }{indent}} @@ -438,10 +685,28 @@ 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 normal image list. Image list assigned with this method will +{\bf not} be deleted by wxTreeCtrl's destructor, you must delete it yourself. -Sets the image list. {\it which} should be one of wxIMAGE\_LIST\_NORMAL, wxIMAGE\_LIST\_SMALL and -wxIMAGE\_LIST\_STATE. +See also \helpref{AssignImageList}{wxtreectrlassignimagelist}. + + +\membersection{wxTreeCtrl::SetItemBackgroundColour}\label{wxtreectrlsetitembackgroundcolour} + +\func{void}{SetItemBackgroundColour}{\param{const wxTreeItemId\&}{ item}, \param{const wxColour\& }{col}} + +Sets the colour of the item's background. + +\membersection{wxTreeCtrl::SetItemBold}\label{wxtreectrlsetitembold} + +\func{void}{SetItemBold}{\param{const wxTreeItemId\& }{item}, \param{bool}{ bold = TRUE}} + +Makes item appear in bold font if {\it bold} parameter is TRUE or resets it to +the normal state. + +See also: \helpref{IsBold}{wxtreectrlisbold} \membersection{wxTreeCtrl::SetItemData}\label{wxtreectrlsetitemdata} @@ -449,6 +714,34 @@ wxIMAGE\_LIST\_STATE. 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{{\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 item's 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}} @@ -460,15 +753,17 @@ usage and loading time. \membersection{wxTreeCtrl::SetItemImage}\label{wxtreectrlsetitemimage} -\func{void}{SetItemImage}{\param{const wxTreeItemId\&}{ item}, \param{int }{image}} +\func{void}{SetItemImage}{\param{const wxTreeItemId\&}{ item}, + \param{int }{image}, \param{wxTreeItemIcon }{which = wxTreeItemIcon\_Normal}} -Sets the normal item image. This is an index into the assciated image list. +Sets the specified item image. See \helpref{GetItemImage}{wxtreectrlgetitemimage} +for the description of the {\it which} parameter. \membersection{wxTreeCtrl::SetItemSelectedImage}\label{wxtreectrlsetitemselectedimage} \func{void}{SetItemSelectedImage}{\param{const wxTreeItemId\&}{ item}, \param{int }{selImage}} -Sets the item selected image. This is an index into the assciated image list. +Sets the selected item image (this function is obsolete, use {\tt SetItemImage(item, wxTreeItemIcon\_Selected}) instead). \membersection{wxTreeCtrl::SetItemText}\label{wxtreectrlsetitemtext} @@ -476,84 +771,58 @@ Sets the item selected image. This is an index into the assciated image list. Sets the item label. -\membersection{wxTreeCtrl::SortChildren}\label{wxtreectrlsortchildren} - -\func{void}{SortChildren}{\param{const wxTreeItemId\&}{ item}, \param{wxTreeItemCmpFunc*}{ cmpFunction = NULL}} - -Sorts the children of the given item. If {\it cmpFunction} is NULL, sorts in ascending alphabetical order; -otherwise the custom sort function is used, as follows: - -{\small -\begin{verbatim} -// a callback function used for sorting tree items, it should return -1 if the -// first item precedes the second, +1 if the second precedes the first or 0 if -// they're equivalent -class wxTreeItemData; -typedef int (*wxTreeItemCmpFunc)(wxTreeItemData *item1, wxTreeItemData *item2); -\end{verbatim} -} - -\wxheading{See also} - -\helpref{wxTreeItemData}{wxtreeitemdata} +\membersection{wxTreeCtrl::SetItemTextColour}\label{wxtreectrlsetitemtextcolour} -\membersection{wxTreeCtrl::Toggle}\label{wxtreectrltoggle} +\func{void}{SetItemTextColour}{\param{const wxTreeItemId\&}{ item}, \param{const wxColour\& }{col}} -\func{void}{Toggle}{\param{const wxTreeItemId\&}{ item}} +Sets the colour of the item's text. -Toggles the given item between collapsed and expanded states. +\membersection{wxTreeCtrl::SetStateImageList}\label{wxtreectrlsetstateimagelist} -\membersection{wxTreeCtrl::Unselect}\label{wxtreectrlunselect} +\func{void}{SetStateImageList}{\param{wxImageList*}{ imageList}} -\func{void}{Unselect}{\void} +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. -Removes the selection from the currently selected item (if any). +See also \helpref{AssignStateImageList}{wxtreectrlassignstateimagelist}. -\section{\class{wxTreeItemData}}\label{wxtreeitemdata} +\func{void}{SetWindowStyle}{\param{long}{styles}} -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. +Sets the mode flags associated with the display of the tree control. +The new mode takes effect immediately. +(Generic only; MSW ignores changes.) -Because the objects of this class are deleted by the tree, they should -always be allocated on the heap. +\membersection{wxTreeCtrl::SortChildren}\label{wxtreectrlsortchildren} -\wxheading{Derived from} +\func{void}{SortChildren}{\param{const wxTreeItemId\&}{ item}} -wxTreeItemId +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{wxTreeCtrl}{wxtreectrl} - -\latexignore{\rtfignore{\wxheading{Members}}} - -\membersection{wxTreeItemData::wxTreeItemData}\label{wxtreeitemdataconstr} - -\func{}{wxTreeItemData}{\void} +\helpref{wxTreeItemData}{wxtreeitemdata}, \helpref{OnCompareItems}{wxtreectrloncompareitems} -Default constructor. - -\membersection{wxTreeItemData::\destruct{wxTreeItemData}} +\membersection{wxTreeCtrl::Toggle}\label{wxtreectrltoggle} -\func{void}{\destruct{wxTreeItemData}}{\void} +\func{void}{Toggle}{\param{const wxTreeItemId\&}{ item}} -Virtual destructor. +Toggles the given item between collapsed and expanded states. -\membersection{wxTreeItemData::GetId}\label{wxtreeitemdatagetid} +\membersection{wxTreeCtrl::Unselect}\label{wxtreectrlunselect} -\func{const wxTreeItem\&}{GetId}{\void} +\func{void}{Unselect}{\void} -Returns the item associated with this node. +Removes the selection from the currently selected item (if any). -\membersection{wxTreeItemData::SetId}\label{wxtreeitemdatasetid} +\membersection{wxTreeCtrl::UnselectAll}\label{wxtreectrlunselectall} -\func{void}{SetId}{\param{const wxTreeItemId\&}{ id}} +\func{void}{UnselectAll}{\void} -Sets the item associated with this node. +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.