1 \section{\class{wxTreeCtrl
}}\label{wxtreectrl
}
3 A tree control presents information as a hierarchy, with items that may be expanded
4 to show further items. Items in a tree control are referenced by wxTreeItemId handles.
6 To intercept events from a tree control, use the event table macros described in
\helpref{wxTreeEvent
}{wxtreeevent
}.
8 \wxheading{Derived from
}
10 \helpref{wxControl
}{wxcontrol
}\\
11 \helpref{wxWindow
}{wxwindow
}\\
12 \helpref{wxEvtHandler
}{wxevthandler
}\\
13 \helpref{wxObject
}{wxobject
}
15 \wxheading{Include files
}
19 \wxheading{Window styles
}
22 \begin{twocollist
}\itemsep=
0pt
23 \twocolitem{\windowstyle{wxTR
\_HAS\_BUTTONS}}{Use this style to show + and - buttons to the
24 left of parent items. Win32 only.
}
25 \twocolitem{\windowstyle{wxTR
\_NO\_LINES}}{Use this style to hide vertical lines.
27 \twocolitem{\windowstyle{wxTR
\_LINES\_AT\_ROOT}}{Use this style to show lines at the
28 tree root. Win32 only.
}
29 \twocolitem{\windowstyle{wxTR
\_EDIT\_LABELS}}{Use this style if you wish the user to be
30 able to edit labels in the tree control.
}
31 \twocolitem{\windowstyle{wxTR
\_MULTIPLE}}{Use this style to allow the user to
32 select more than one item in the control - by default, only one item may be
36 See also
\helpref{window styles overview
}{windowstyles
}.
38 \wxheading{Event handling
}
40 To process input from a tree control, use these event handler macros to direct input to member
41 functions that take a
\helpref{wxTreeEvent
}{wxtreeevent
} argument.
44 \begin{twocollist
}\itemsep=
0pt
45 \twocolitem{{\bf EVT
\_TREE\_BEGIN\_DRAG(id, func)
}}{Begin dragging with the left mouse button.
}
46 \twocolitem{{\bf EVT
\_TREE\_BEGIN\_RDRAG(id, func)
}}{Begin dragging with the right mouse button.
}
47 \twocolitem{{\bf EVT
\_TREE\_BEGIN\_LABEL\_EDIT(id, func)
}}{Begin editing a label. This can be prevented by calling
\helpref{Veto()
}{wxnotifyeventveto
}.
}
48 \twocolitem{{\bf EVT
\_TREE\_END\_LABEL\_EDIT(id, func)
}}{Finish editing a label. This can be prevented by calling
\helpref{Veto()
}{wxnotifyeventveto
}.
}
49 \twocolitem{{\bf EVT
\_TREE\_DELETE\_ITEM(id, func)
}}{Delete an item.
}
50 \twocolitem{{\bf EVT
\_TREE\_GET\_INFO(id, func)
}}{Request information from the application.
}
51 \twocolitem{{\bf EVT
\_TREE\_SET\_INFO(id, func)
}}{Information is being supplied.
}
52 \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
}
53 \twocolitem{{\bf EVT
\_TREE\_ITEM\_COLLAPSED(id, func)
}}{The item has been collapsed.
}
54 \twocolitem{{\bf EVT
\_TREE\_ITEM\_COLLAPSING(id, func)
}}{The item is being collapsed. This can be prevented by calling
\helpref{Veto()
}{wxnotifyeventveto
}.
}
55 \twocolitem{{\bf EVT
\_TREE\_ITEM\_EXPANDED(id, func)
}}{The item has been expanded.
}
56 \twocolitem{{\bf EVT
\_TREE\_ITEM\_EXPANDING(id, func)
}}{The item is being expanded. This can be prevented by calling
\helpref{Veto()
}{wxnotifyeventveto
}.
}
57 \twocolitem{{\bf EVT
\_TREE\_SEL\_CHANGED(id, func)
}}{Selection has changed.
}
58 \twocolitem{{\bf EVT
\_TREE\_SEL\_CHANGING(id, func)
}}{Selection is changing. This can be prevented by calling
\helpref{Veto()
}{wxnotifyeventveto
}.
}
59 \twocolitem{{\bf EVT
\_TREE\_KEY\_DOWN(id, func)
}}{A key has been pressed.
}
64 \helpref{wxTreeItemData
}{wxtreeitemdata
},
\helpref{wxTreeCtrl overview
}{wxtreectrloverview
},
\helpref{wxListBox
}{wxlistbox
},
\helpref{wxListCtrl
}{wxlistctrl
},
\rtfsp
65 \helpref{wxImageList
}{wximagelist
},
\helpref{wxTreeEvent
}{wxtreeevent
}
67 \wxheading{Win32 notes
}
69 wxTreeCtrl class uses the standard common treeview control under Win32
70 implemented in the system library
{\tt comctl32.dll
}. Some versions of this
71 library are known to have bugs with handling the tree control colours: the
72 usual symptom is that the expanded items leave black (or otherwise incorrectly
73 coloured) background behind them, especially for the controls using non
74 default background colour. The recommended solution is to upgrade the
{\tt comctl32.dll
}
75 to a newer version: see
76 \urlref{http://www.microsoft.com/msdownload/ieplatform/ie/comctrlx86.asp
}{http://www.microsoft.com/msdownload/ieplatform/ie/comctrlx86.asp
}.
78 \latexignore{\rtfignore{\wxheading{Members
}}}
80 \membersection{wxTreeCtrl::wxTreeCtrl
}\label{wxtreectrlconstr
}
82 \func{}{wxTreeCtrl
}{\void}
86 \func{}{wxTreeCtrl
}{\param{wxWindow*
}{ parent
},
\param{wxWindowID
}{ id
},
\rtfsp
87 \param{const wxPoint\&
}{ pos = wxDefaultPosition
},
\param{const wxSize\&
}{ size = wxDefaultSize
},
\rtfsp
88 \param{long
}{ style = wxTR
\_HAS\_BUTTONS},
\param{const wxValidator\&
}{validator = wxDefaultValidator
},
\param{const wxString\&
}{name = ``listCtrl"
}}
90 Constructor, creating and showing a tree control.
92 \wxheading{Parameters
}
94 \docparam{parent
}{Parent window. Must not be NULL.
}
96 \docparam{id
}{Window identifier. A value of -
1 indicates a default value.
}
98 \docparam{pos
}{Window position.
}
100 \docparam{size
}{Window size. If the default size (-
1, -
1) is specified then the window is sized
103 \docparam{style
}{Window style. See
\helpref{wxTreeCtrl
}{wxtreectrl
}.
}
105 \docparam{validator
}{Window validator.
}
107 \docparam{name
}{Window name.
}
111 \helpref{wxTreeCtrl::Create
}{wxtreectrlcreate
},
\helpref{wxValidator
}{wxvalidator
}
113 \membersection{wxTreeCtrl::
\destruct{wxTreeCtrl
}}
115 \func{void
}{\destruct{wxTreeCtrl
}}{\void}
117 Destructor, destroying the list control.
119 \membersection{wxTreeCtrl::AddRoot
}\label{wxtreectrladdroot
}
121 \func{wxTreeItemId
}{AddRoot
}{\param{const wxString\&
}{ text
},
122 \param{int
}{ image = -
1},
\param{int
}{ selImage = -
1},
\param{wxTreeItemData*
}{ data = NULL
}}
124 Adds the root node to the tree, returning the new item.
126 If
{\it image
} > -
1 and
{\it selImage
} is -
1, the same image is used for
127 both selected and unselected items.
129 \membersection{wxTreeCtrl::AppendItem
}\label{wxtreectrlappenditem
}
131 \func{wxTreeItemId
}{AppendItem
}{\param{const wxTreeItemId\&
}{parent
},
\param{const wxString\&
}{ text
},
132 \param{int
}{ image = -
1},
\param{int
}{ selImage = -
1},
\param{wxTreeItemData*
}{ data = NULL
}}
134 Appends an item to the end of the branch identified by
{\it parent
}, return a new item id.
136 If
{\it image
} > -
1 and
{\it selImage
} is -
1, the same image is used for
137 both selected and unselected items.
139 \membersection{wxTreeCtrl::AssignImageList
}\label{wxtreectrlassignimagelist
}
141 \func{void
}{AssignImageList
}{\param{wxImageList*
}{ imageList
}}
143 Sets the normal image list. Image list assigned with this method will
144 be deleted by wxTreeCtrl's destructor (i.e. it takes ownership of it).
146 See also
\helpref{SetImageList
}{wxtreectrlsetimagelist
}.
148 \membersection{wxTreeCtrl::AssignStateImageList
}\label{wxtreectrlassignstateimagelist
}
150 \func{void
}{AssignStateImageList
}{\param{wxImageList*
}{ imageList
}}
152 Sets the state image list. Image list assigned with this method will
153 be deleted by wxTreeCtrl's destructor (i.e. it takes ownership of it).
155 See also
\helpref{SetStateImageList
}{wxtreectrlsetstateimagelist
}.
158 \membersection{wxTreeCtrl::Collapse
}\label{wxtreectrlcollapse
}
160 \func{void
}{Collapse
}{\param{const wxTreeItemId\&
}{ item
}}
162 Collapses the given item.
164 \membersection{wxTreeCtrl::CollapseAndReset
}\label{wxtreectrlcollapseandreset
}
166 \func{void
}{CollapseAndReset
}{\param{const wxTreeItemId\&
}{ item
}}
168 Collapses the given item and removes all children.
170 \membersection{wxTreeCtrl::Create
}\label{wxtreectrlcreate
}
172 \func{bool
}{wxTreeCtrl
}{\param{wxWindow*
}{ parent
},
\param{wxWindowID
}{ id
},
\rtfsp
173 \param{const wxPoint\&
}{ pos = wxDefaultPosition
},
\param{const wxSize\&
}{ size = wxDefaultSize
},
\rtfsp
174 \param{long
}{ style = wxTR
\_HAS\_BUTTONS},
\param{const wxValidator\&
}{validator = wxDefaultValidator
},
\param{const wxString\&
}{name = ``listCtrl"
}}
176 Creates the tree control. See
\helpref{wxTreeCtrl::wxTreeCtrl
}{wxtreectrlconstr
} for further details.
178 \membersection{wxTreeCtrl::Delete
}\label{wxtreectrldelete
}
180 \func{void
}{Delete
}{\param{const wxTreeItemId\&
}{ item
}}
182 Deletes the specified item.
184 \membersection{wxTreeCtrl::DeleteAllItems
}\label{wxtreectrldeleteallitems
}
186 \func{void
}{DeleteAllItems
}{\void}
188 Deletes all the items in the control.
190 \membersection{wxTreeCtrl::EditLabel
}\label{wxtreectrleditlabel
}
192 \func{void
}{EditLabel
}{\param{const wxTreeItemId\&
}{ item
}}
194 Starts editing the label of the given item. This function generates a
195 EVT
\_TREE\_BEGIN\_LABEL\_EDIT event which can be vetoed so that no
196 text control will appear for in-place editing.
198 If the user changed the label (i.e. s/he does not press ESC or leave
199 the text control without changes, a EVT
\_TREE\_END\_LABEL\_EDIT event
200 will be sent which can be vetoed as well.
204 \helpref{wxTreeCtrl::EndEditLabel
}{wxtreectrlendeditlabel
},
205 \helpref{wxTreeEvent
}{wxtreeevent
}
207 \membersection{wxTreeCtrl::EndEditLabel
}\label{wxtreectrlendeditlabel
}
209 \func{void
}{EndEditLabel
}{\param{bool
}{cancelEdit
}}
211 Ends label editing. If
{\it cancelEdit
} is TRUE, the edit will be cancelled.
213 This function is currently supported under Windows only.
217 \helpref{wxTreeCtrl::EditLabel
}{wxtreectrleditlabel
}
219 \membersection{wxTreeCtrl::EnsureVisible
}\label{wxtreectrlensurevisible
}
221 \func{void
}{EnsureVisible
}{\param{const wxTreeItemId\&
}{ item
}}
223 Scrolls and/or expands items to ensure that the given item is visible.
225 \membersection{wxTreeCtrl::Expand
}\label{wxtreectrlexpand
}
227 \func{void
}{Expand
}{\param{const wxTreeItemId\&
}{ item
}}
229 Expands the given item.
231 \membersection{wxTreeCtrl::GetBoundingRect
}\label{wxtreectrlgetitemrect
}
233 \constfunc{bool
}{GetBoundingRect
}{\param{const wxTreeItemId\&
}{ item
},
\param{wxRect\&
}{rect
},
\param{bool
}{textOnly = FALSE
}}
235 Retrieves the rectangle bounding the
{\it item
}. If
{\it textOnly
} is TRUE,
236 only the rectangle around the items label will be returned, otherwise the
237 items image is also taken into account.
239 The return value is TRUE if the rectangle was successfully retrieved or FALSE
240 if it was not (in this case
{\it rect
} is not changed) - for example, if the
241 item is currently invisible.
243 \pythonnote{The wxPython version of this method requires only the
244 {\tt item
} and
{\tt textOnly
} parameters. The return value is either a
245 {\tt wxRect
} object or
{\tt None
}.
}
247 \membersection{wxTreeCtrl::GetChildrenCount
}\label{wxtreectrlgetchildrencount
}
249 \constfunc{size
\_t}{GetChildrenCount
}{\param{const wxTreeItemId\&
}{ item
},
\param{bool
}{ recursively = TRUE
}}
251 Returns the number of items in the branch. If
{\it recursively
} is TRUE, returns the total number
252 of descendants, otherwise only one level of children is counted.
254 \membersection{wxTreeCtrl::GetCount
}\label{wxtreectrlgetcount
}
256 \constfunc{int
}{GetCount
}{\void}
258 Returns the number of items in the control.
260 \membersection{wxTreeCtrl::GetEditControl
}\label{wxtreectrlgeteditcontrol
}
262 \constfunc{wxTextCtrl\&
}{GetEditControl
}{\void}
264 Returns the edit control used to edit a label.
266 \membersection{wxTreeCtrl::GetFirstChild
}\label{wxtreectrlgetfirstchild
}
268 \constfunc{wxTreeItemId
}{GetFirstChild
}{\param{const wxTreeItemId\&
}{ item
},
\param{long\&
}{cookie
}}
270 Returns the first child; call
\helpref{wxTreeCtrl::GetNextChild
}{wxtreectrlgetnextchild
} for the next child.
272 For this enumeration function you must pass in a `cookie' parameter
273 which is opaque for the application but is necessary for the library
274 to make these functions reentrant (i.e. allow more than one
275 enumeration on one and the same object simultaneously). The cookie passed to
276 GetFirstChild and GetNextChild should be the same.
278 Returns an invalid tree item if there are no further children.
282 \helpref{wxTreeCtrl::GetNextChild
}{wxtreectrlgetnextchild
}
284 \pythonnote{In wxPython the returned wxTreeItemId and the new cookie
285 value are both returned as a tuple containing the two values.
}
287 \membersection{wxTreeCtrl::GetFirstVisibleItem
}\label{wxtreectrlgetfirstvisibleitem
}
289 \constfunc{wxTreeItemId
}{GetFirstVisibleItem
}{\void}
291 Returns the first visible item.
293 \membersection{wxTreeCtrl::GetImageList
}\label{wxtreectrlgetimagelist
}
295 \constfunc{wxImageList*
}{GetImageList
}{\void}
297 Returns the normal image list.
299 \membersection{wxTreeCtrl::GetIndent
}\label{wxtreectrlgetindent
}
301 \constfunc{int
}{GetIndent
}{\void}
303 Returns the current tree control indentation.
305 \membersection{wxTreeCtrl::GetItemData
}\label{wxtreectrlgetitemdata
}
307 \constfunc{wxTreeItemData*
}{GetItemData
}{\param{const wxTreeItemId\&
}{ item
}}
309 Returns the tree item data associated with the item.
313 \helpref{wxTreeItemData
}{wxtreeitemdata
}
315 \pythonnote{wxPython provides the following shortcut method:
317 \indented{2cm
}{\begin{twocollist
}\itemsep=
0pt
318 \twocolitem{{\bf GetPyData(item)
}}{Returns the Python Object
319 associated with the wxTreeItemData for the given item Id.
}
323 \membersection{wxTreeCtrl::GetItemImage
}\label{wxtreectrlgetitemimage
}
325 \constfunc{int
}{GetItemImage
}{\param{const wxTreeItemId\&
}{item
},
326 \param{wxTreeItemIcon
}{which = wxTreeItemIcon
\_Normal}}
328 Gets the specified item image. The value of
{\it which
} may be:
330 \begin{itemize
}\itemsep=
0pt
331 \item{wxTreeItemIcon
\_Normal} to get the normal item image
332 \item{wxTreeItemIcon
\_Selected} to get the selected item image (i.e. the image
333 which is shown when the item is currently selected)
334 \item{wxTreeItemIcon
\_Expanded} to get the expanded image (this only
335 makes sense for items which have children - then this image is shown when the
336 item is expanded and the normal image is shown when it is collapsed)
337 \item{wxTreeItemIcon
\_SelectedExpanded} to get the selected expanded image
338 (which is shown when an expanded item is currently selected)
341 \membersection{wxTreeCtrl::GetItemText
}\label{wxtreectrlgetitemtext
}
343 \constfunc{wxString
}{GetItemText
}{\param{const wxTreeItemId\&
}{ item
}}
345 Returns the item label.
347 \membersection{wxTreeCtrl::GetLastChild
}\label{wxtreectrlgetlastchild
}
349 \constfunc{wxTreeItemId
}{GetLastChild
}{\param{const wxTreeItemId\&
}{ item
}}
351 Returns the last child of the item (or an invalid tree item if this item has no children).
355 \helpref{GetFirstChild
}{wxtreectrlgetfirstchild
},
356 \helpref{GetLastChild
}{wxtreectrlgetlastchild
}
358 \membersection{wxTreeCtrl::GetNextChild
}\label{wxtreectrlgetnextchild
}
360 \constfunc{wxTreeItemId
}{GetNextChild
}{\param{const wxTreeItemId\&
}{ item
},
\param{long\&
}{cookie
}}
362 Returns the next child; call
\helpref{wxTreeCtrl::GetFirstChild
}{wxtreectrlgetfirstchild
} for the first child.
364 For this enumeration function you must pass in a `cookie' parameter
365 which is opaque for the application but is necessary for the library
366 to make these functions reentrant (i.e. allow more than one
367 enumeration on one and the same object simultaneously). The cookie passed to
368 GetFirstChild and GetNextChild should be the same.
370 Returns an invalid tree item if there are no further children.
374 \helpref{wxTreeCtrl::GetFirstChild
}{wxtreectrlgetfirstchild
}
376 \pythonnote{In wxPython the returned wxTreeItemId and the new cookie
377 value are both returned as a tuple containing the two values.
}
379 \membersection{wxTreeCtrl::GetNextSibling
}\label{wxtreectrlgetnextsibling
}
381 \constfunc{wxTreeItemId
}{GetNextSibling
}{\param{const wxTreeItemId\&
}{ item
}}
383 Returns the next sibling of the specified item; call
\helpref{wxTreeCtrl::GetPrevSibling
}{wxtreectrlgetprevsibling
} for the previous sibling.
385 Returns an invalid tree item if there are no further siblings.
389 \helpref{wxTreeCtrl::GetPrevSibling
}{wxtreectrlgetprevsibling
}
391 \membersection{wxTreeCtrl::GetNextVisible
}\label{wxtreectrlgetnextvisible
}
393 \constfunc{wxTreeItemId
}{GetNextVisible
}{\param{const wxTreeItemId\&
}{ item
}}
395 Returns the next visible item.
397 \membersection{wxTreeCtrl::GetParent
}\label{wxtreectrlgetparent
}
399 \constfunc{wxTreeItemId
}{GetParent
}{\param{const wxTreeItemId\&
}{ item
}}
401 Returns the item's parent.
403 \pythonnote{This method is named
{\tt GetItemParent
} to avoid a name
404 clash with wxWindow::GetParent.
}
406 \membersection{wxTreeCtrl::GetPrevSibling
}\label{wxtreectrlgetprevsibling
}
408 \constfunc{wxTreeItemId
}{GetPrevSibling
}{\param{const wxTreeItemId\&
}{ item
}}
410 Returns the previous sibling of the specified item; call
\helpref{wxTreeCtrl::GetNextSibling
}{wxtreectrlgetnextsibling
} for the next sibling.
412 Returns an invalid tree item if there are no further children.
416 \helpref{wxTreeCtrl::GetNextSibling
}{wxtreectrlgetnextsibling
}
418 \membersection{wxTreeCtrl::GetPrevVisible
}\label{wxtreectrlgetprevvisible
}
420 \constfunc{wxTreeItemId
}{GetPrevVisible
}{\param{const wxTreeItemId\&
}{ item
}}
422 Returns the previous visible item.
424 \membersection{wxTreeCtrl::GetRootItem
}\label{wxtreectrlgetrootitem
}
426 \constfunc{wxTreeItemId
}{GetRootItem
}{\void}
428 Returns the root item for the tree control.
430 \membersection{wxTreeCtrl::GetItemSelectedImage
}\label{wxtreectrlgetitemselectedimage
}
432 \constfunc{int
}{GetItemSelectedImage
}{\param{const wxTreeItemId\&
}{item
}}
434 Gets the selected item image (this function is obsolete, use
435 {\tt GetItemImage(item, wxTreeItemIcon
\_Selected}) instead).
437 \membersection{wxTreeCtrl::GetSelection
}\label{wxtreectrlgetselection
}
439 \constfunc{wxTreeItemId
}{GetSelection
}{\void}
441 Returns the selection, or an invalid item if there is no selection.
442 This function only works with the controls without wxTR
\_MULTIPLE style, use
443 \helpref{GetSelections
}{wxtreectrlgetselections
} for the controls which do have
446 \membersection{wxTreeCtrl::GetSelections
}\label{wxtreectrlgetselections
}
448 \constfunc{size
\_t}{GetSelections
}{\param{wxArrayTreeItemIds\&
}{selection
}}
450 Fills the array of tree items passed in with the currently selected items. This
451 function can be called only if the control has the wxTR
\_MULTIPLE style.
453 Returns the number of selected items.
455 \pythonnote{The wxPython version of this method accepts no parameters
456 and returns a Python list of
{\tt wxTreeItemId
}s.
}
458 \membersection{wxTreeCtrl::GetStateImageList
}\label{wxtreectrlgetstateimagelist
}
460 \constfunc{wxImageList*
}{GetStateImageList
}{\void}
462 Returns the state image list (from which application-defined state images are taken).
464 \membersection{wxTreeCtrl::HitTest
}\label{wxtreectrlhittest
}
466 \func{wxTreeItemId
}{HitTest
}{\param{const wxPoint\&
}{point
},
\param{int\&
}{flags
}}
468 Calculates which (if any) item is under the given point, returning the tree item
469 id at this point plus extra information
{\it flags
}.
{\it flags
} is a bitlist of the following:
472 \begin{twocollist
}\itemsep=
0pt
473 \twocolitem{wxTREE
\_HITTEST\_ABOVE}{Above the client area.
}
474 \twocolitem{wxTREE
\_HITTEST\_BELOW}{Below the client area.
}
475 \twocolitem{wxTREE
\_HITTEST\_NOWHERE}{In the client area but below the last item.
}
476 \twocolitem{wxTREE
\_HITTEST\_ONITEMBUTTON}{On the button associated with an item.
}
477 \twocolitem{wxTREE
\_HITTEST\_ONITEMICON}{On the bitmap associated with an item.
}
478 \twocolitem{wxTREE
\_HITTEST\_ONITEMINDENT}{In the indentation associated with an item.
}
479 \twocolitem{wxTREE
\_HITTEST\_ONITEMLABEL}{On the label (string) associated with an item.
}
480 \twocolitem{wxTREE
\_HITTEST\_ONITEMRIGHT}{In the area to the right of an item.
}
481 \twocolitem{wxTREE
\_HITTEST\_ONITEMSTATEICON}{On the state icon for a tree view item that is in a user-defined state.
}
482 \twocolitem{wxTREE
\_HITTEST\_TOLEFT}{To the right of the client area.
}
483 \twocolitem{wxTREE
\_HITTEST\_TORIGHT}{To the left of the client area.
}
486 \pythonnote{in wxPython both the wxTreeItemId and the flags are
487 returned as a tuple.
}
489 \membersection{wxTreeCtrl::InsertItem
}\label{wxtreectrlinsertitem
}
491 \func{wxTreeItemId
}{InsertItem
}{\param{const wxTreeItemId\&
}{parent
},
\param{const wxTreeItemId\&
}{previous
},
\param{const wxString\&
}{ text
},
492 \param{int
}{ image = -
1},
\param{int
}{ selImage = -
1},
\param{wxTreeItemData*
}{ data = NULL
}}
494 \func{wxTreeItemId
}{InsertItem
}{\param{const wxTreeItemId\&
}{parent
},
\param{size
\_t}{ before
},
\param{const wxString\&
}{ text
},
495 \param{int
}{ image = -
1},
\param{int
}{ selImage = -
1},
\param{wxTreeItemData*
}{ data = NULL
}}
497 Inserts an item after a given one (
{\it previous
}) or before one identified by its position (
{\it before
}).
499 If
{\it image
} > -
1 and
{\it selImage
} is -
1, the same image is used for
500 both selected and unselected items.
502 \pythonnote{The second form of this method is called
503 \tt{InsertItemBefore
} in wxPython.
}
505 \membersection{wxTreeCtrl::IsBold
}\label{wxtreectrlisbold
}
507 \constfunc{bool
}{IsBold
}{\param{const wxTreeItemId\&
}{item
}}
509 Returns TRUE if the given item is in bold state.
511 See also:
\helpref{SetItemBold
}{wxtreectrlsetitembold
}
513 \membersection{wxTreeCtrl::IsExpanded
}\label{wxtreectrlisexpanded
}
515 \constfunc{bool
}{IsExpanded
}{\param{const wxTreeItemId\&
}{ item
}}
517 Returns TRUE if the item is expanded (only makes sense if it has children).
519 \membersection{wxTreeCtrl::IsSelected
}\label{wxtreectrlisselected
}
521 \constfunc{bool
}{IsSelected
}{\param{const wxTreeItemId\&
}{ item
}}
523 Returns TRUE if the item is selected.
525 \membersection{wxTreeCtrl::IsVisible
}\label{wxtreectrlisvisible
}
527 \constfunc{bool
}{IsVisible
}{\param{const wxTreeItemId\&
}{ item
}}
529 Returns TRUE if the item is visible (it might be outside the view, or not expanded).
531 \membersection{wxTreeCtrl::ItemHasChildren
}\label{wxtreectrlitemhaschildren
}
533 \constfunc{bool
}{ItemHasChildren
}{\param{const wxTreeItemId\&
}{ item
}}
535 Returns TRUE if the item has children.
537 \membersection{wxTreeCtrl::OnCompareItems
}\label{wxtreectrloncompareitems
}
539 \func{int
}{OnCompareItems
}{\param{const wxTreeItemId\&
}{item1
},
\param{const wxTreeItemId\&
}{item2
}}
541 Override this function in the derived class to change the sort order of the
542 items in the tree control. The function should return a negative, zero or
543 positive value if the first item is less than, equal to or greater than the
546 The base class version compares items alphabetically.
548 See also:
\helpref{SortChildren
}{wxtreectrlsortchildren
}
550 \membersection{wxTreeCtrl::PrependItem
}\label{wxtreectrlprependitem
}
552 \func{wxTreeItemId
}{PrependItem
}{\param{const wxTreeItemId\&
}{parent
},
\param{const wxString\&
}{ text
},
553 \param{int
}{ image = -
1},
\param{int
}{ selImage = -
1},
\param{wxTreeItemData*
}{ data = NULL
}}
555 Appends an item as the first child of
{\it parent
}, return a new item id.
557 If
{\it image
} > -
1 and
{\it selImage
} is -
1, the same image is used for
558 both selected and unselected items.
560 \membersection{wxTreeCtrl::ScrollTo
}\label{wxtreectrlscrollto
}
562 \func{void
}{ScrollTo
}{\param{const wxTreeItemId\&
}{ item
}}
564 Scrolls the specified item into view.
566 \membersection{wxTreeCtrl::SelectItem
}\label{wxtreectrlselectitem
}
568 \func{bool
}{SelectItem
}{\param{const wxTreeItemId\&
}{ item
}}
570 Selects the given item.
572 \membersection{wxTreeCtrl::SetIndent
}\label{wxtreectrlsetindent
}
574 \func{void
}{SetIndent
}{\param{int
}{indent
}}
576 Sets the indentation for the tree control.
578 \membersection{wxTreeCtrl::SetImageList
}\label{wxtreectrlsetimagelist
}
580 \func{void
}{SetImageList
}{\param{wxImageList*
}{ imageList
}}
582 Sets the normal image list. Image list assigned with this method will
583 {\bf not
} be deleted by wxTreeCtrl's destructor, you must delete it yourself.
585 See also
\helpref{AssignImageList
}{wxtreectrlassignimagelist
}.
588 \membersection{wxTreeCtrl::SetItemBackgroundColour
}\label{wxtreectrlsetitembackgroundcolour
}
590 \func{void
}{SetItemBackgroundColour
}{\param{const wxTreeItemId\&
}{ item
},
\param{const wxColour\&
}{col
}}
592 Sets the colour of the items background.
594 \membersection{wxTreeCtrl::SetItemBold
}\label{wxtreectrlsetitembold
}
596 \func{void
}{SetItemBold
}{\param{const wxTreeItemId\&
}{item
},
\param{bool
}{ bold = TRUE
}}
598 Makes item appear in bold font if
{\it bold
} parameter is TRUE or resets it to
601 See also:
\helpref{IsBold
}{wxtreectrlisbold
}
603 \membersection{wxTreeCtrl::SetItemData
}\label{wxtreectrlsetitemdata
}
605 \func{void
}{SetItemData
}{\param{const wxTreeItemId\&
}{ item
},
\param{wxTreeItemData*
}{data
}}
607 Sets the item client data.
609 \pythonnote{wxPython provides the following shortcut method:
\par
610 \indented{2cm
}{\begin{twocollist
}\itemsep=
0pt
611 \twocolitem{{\bf SetPyData(item, obj)
}}{Associate the given Python
612 Object with the wxTreeItemData for the given item Id.
}
616 \membersection{wxTreeCtrl::SetItemFont
}\label{wxtreectrlsetitemfont
}
618 \func{void
}{SetItemFont
}{\param{const wxTreeItemId\&
}{ item
},
\param{const wxFont\&
}{font
}}
620 Sets the items font. All items in the tree should have the same height to avoid
621 text clipping, so the fonts height should be the same for all of them,
622 although font attributes may vary.
626 \helpref{SetItemBold
}{wxtreectrlsetitembold
}
628 \membersection{wxTreeCtrl::SetItemHasChildren
}\label{wxtreectrlsetitemhaschildren
}
630 \func{void
}{SetItemHasChildren
}{\param{const wxTreeItemId\&
}{ item
},
\param{bool
}{hasChildren = TRUE
}}
632 Force appearance of the button next to the item. This is useful to
633 allow the user to expand the items which don't have any children now,
634 but instead adding them only when needed, thus minimizing memory
635 usage and loading time.
637 \membersection{wxTreeCtrl::SetItemImage
}\label{wxtreectrlsetitemimage
}
639 \func{void
}{SetItemImage
}{\param{const wxTreeItemId\&
}{ item
},
640 \param{int
}{image
},
\param{wxTreeItemIcon
}{which = wxTreeItemIcon
\_Normal}}
642 Sets the specified item image. See
\helpref{GetItemImage
}{wxtreectrlgetitemimage
}
643 for the description of the
{\it which
} parameter.
645 \membersection{wxTreeCtrl::SetItemSelectedImage
}\label{wxtreectrlsetitemselectedimage
}
647 \func{void
}{SetItemSelectedImage
}{\param{const wxTreeItemId\&
}{ item
},
\param{int
}{selImage
}}
649 Sets the selected item image (this function is obsolete, use
{\tt SetItemImage(item, wxTreeItemIcon
\_Selected}) instead).
651 \membersection{wxTreeCtrl::SetItemText
}\label{wxtreectrlsetitemtext
}
653 \func{void
}{SetItemText
}{\param{const wxTreeItemId\&
}{ item
},
\param{const wxString\&
}{text
}}
657 \membersection{wxTreeCtrl::SetItemTextColour
}\label{wxtreectrlsetitemtextcolour
}
659 \func{void
}{SetItemTextColour
}{\param{const wxTreeItemId\&
}{ item
},
\param{const wxColour\&
}{col
}}
661 Sets the colour of the items text.
663 \membersection{wxTreeCtrl::SetStateImageList
}\label{wxtreectrlsetstateimagelist
}
665 \func{void
}{SetStateImageList
}{\param{wxImageList*
}{ imageList
}}
667 Sets the state image list (from which application-defined state images are taken).
668 Image list assigned with this method will
669 {\bf not
} be deleted by wxTreeCtrl's destructor, you must delete it yourself.
671 See also
\helpref{AssignStateImageList
}{wxtreectrlassignstateimagelist
}.
673 \membersection{wxTreeCtrl::SortChildren
}\label{wxtreectrlsortchildren
}
675 \func{void
}{SortChildren
}{\param{const wxTreeItemId\&
}{ item
}}
677 Sorts the children of the given item using
678 \helpref{OnCompareItems
}{wxtreectrloncompareitems
} method of wxTreeCtrl. You
679 should override that method to change the sort order (the default is ascending
684 \helpref{wxTreeItemData
}{wxtreeitemdata
},
\helpref{OnCompareItems
}{wxtreectrloncompareitems
}
686 \membersection{wxTreeCtrl::Toggle
}\label{wxtreectrltoggle
}
688 \func{void
}{Toggle
}{\param{const wxTreeItemId\&
}{ item
}}
690 Toggles the given item between collapsed and expanded states.
692 \membersection{wxTreeCtrl::Unselect
}\label{wxtreectrlunselect
}
694 \func{void
}{Unselect
}{\void}
696 Removes the selection from the currently selected item (if any).
698 \membersection{wxTreeCtrl::UnselectAll
}\label{wxtreectrlunselectall
}
700 \func{void
}{UnselectAll
}{\void}
702 This function either behaves the same as
\helpref{Unselect
}{wxtreectrlunselect
}
703 if the control doesn't have wxTR
\_MULTIPLE style, or removes the selection from
704 all items if it does have this style.
706 \section{\class{wxTreeItemData
}}\label{wxtreeitemdata
}
708 wxTreeItemData is some (arbitrary) user class associated with some item. The
709 main advantage of having this class (compared to the old untyped interface) is
710 that wxTreeItemData's are destroyed automatically by the tree and, as this
711 class has virtual dtor, it means that the memory will be automatically
712 freed. We don't just use wxObject instead of wxTreeItemData because
713 the size of this class is critical: in any real application, each tree leaf
714 will have wxTreeItemData associated with it and number of leaves may be
717 Because the objects of this class are deleted by the tree, they should
718 always be allocated on the heap.
720 \wxheading{Derived from
}
724 \wxheading{Include files
}
730 \helpref{wxTreeCtrl
}{wxtreectrl
}
732 \latexignore{\rtfignore{\wxheading{Members
}}}
734 \membersection{wxTreeItemData::wxTreeItemData
}\label{wxtreeitemdataconstr
}
736 \func{}{wxTreeItemData
}{\void}
740 \pythonnote{The wxPython version of this constructor optionally
741 accepts any Python object as a parameter. This object is then
742 associated with the tree item using the wxTreeItemData as a
745 In addition, the following methods are added in wxPython for accessing
748 \indented{2cm
}{\begin{twocollist
}\itemsep=
0pt
749 \twocolitem{{\bf GetData()
}}{Returns a reference to the Python Object
}
750 \twocolitem{{\bf SetData(obj)
}}{Associates a new Python Object with the
756 \membersection{wxTreeItemData::
\destruct{wxTreeItemData
}}
758 \func{void
}{\destruct{wxTreeItemData
}}{\void}
762 \membersection{wxTreeItemData::GetId
}\label{wxtreeitemdatagetid
}
764 \func{const wxTreeItem\&
}{GetId
}{\void}
766 Returns the item associated with this node.
768 \membersection{wxTreeItemData::SetId
}\label{wxtreeitemdatasetid
}
770 \func{void
}{SetId
}{\param{const wxTreeItemId\&
}{ id
}}
772 Sets the item associated with this node.