docs/latex/wx/treectrl.tex

   1 \section{\class{wxTreeCtrl}}\label{wxtreectrl}
   2
   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,
   5 which may be tested for validity by calling wxTreeItemId::IsOk.
   6
   7 To intercept events from a tree control, use the event table macros described in \helpref{wxTreeEvent}{wxtreeevent}.
   8
   9 \wxheading{Derived from}
  10
  11 \helpref{wxControl}{wxcontrol}\\
  12 \helpref{wxWindow}{wxwindow}\\
  13 \helpref{wxEvtHandler}{wxevthandler}\\
  14 \helpref{wxObject}{wxobject}
  15
  16 \wxheading{Include files}
  17
  18 <wx/treectrl.h>
  19
  20 \wxheading{Window styles}
  21
  22 \twocolwidtha{5cm}
  23 \begin{twocollist}\itemsep=0pt
  24 \twocolitem{\windowstyle{wxTR\_EDIT\_LABELS}}{Use this style
  25 if you wish the user to be able to edit labels in the tree control.}
  26 \twocolitem{\windowstyle{wxTR\_NO\_BUTTONS}}{For convenience
  27 to document that no buttons are to be drawn.}
  28 \twocolitem{\windowstyle{wxTR\_HAS\_BUTTONS}}{Use this style
  29 to show + and - buttons to the left of parent items.}
  30 \twocolitem{\windowstyle{wxTR\_TWIST\_BUTTONS}}{Use this style
  31 to show Mac-style twister buttons to the left of parent items.
  32 If both wxTR\_HAS\_BUTTONS and wxTR\_TWIST\_BUTTONS are given,
  33 twister buttons are generated.  Generic only.}
  34 \twocolitem{\windowstyle{wxTR\_NO\_LINES}}{Use this style
  35 to hide vertical level connectors.}
  36 \twocolitem{\windowstyle{wxTR\_FULL\_ROW\_HIGHLIGHT}}{Use this style to have the background
  37 colour and the selection highlight extend over the entire horizontal
  38 row of the tree control window. (This flag is ignored under Windows unless you
  39 specify wxTR\_NO\_LINES as well.) }
  40 \twocolitem{\windowstyle{wxTR\_LINES\_AT\_ROOT}}{Use this style
  41 to show lines between root nodes.
  42 Only applicable if wxTR\_HIDE\_ROOT is set and wxTR\_NO\_LINES is not set.}
  43 \twocolitem{\windowstyle{wxTR\_HIDE\_ROOT}}{Use this style
  44 to suppress the display of the root node,
  45 effectively causing the first-level nodes
  46 to appear as a series of root nodes.}
  47 \twocolitem{\windowstyle{wxTR\_ROW\_LINES}}{Use this style
  48 to draw a contrasting border between displayed rows.}
  49 \twocolitem{\windowstyle{wxTR\_HAS\_VARIABLE\_ROW\_HEIGHT}}{Use this style
  50 to cause row heights to be just big enough to fit the content.
  51 If not set, all rows use the largest row height.
  52 The default is that this flag is unset.
  53 Generic only.}
  54 \twocolitem{\windowstyle{wxTR\_SINGLE}}{For convenience
  55 to document that only one item may be selected at a time.
  56 Selecting another item causes the current selection, if any,
  57 to be deselected.  This is the default.}
  58 \twocolitem{\windowstyle{wxTR\_MULTIPLE}}{Use this style
  59 to allow a range of items to be selected.
  60 If a second range is selected, the current range, if any, is deselected.}
  61 \twocolitem{\windowstyle{wxTR\_EXTENDED}}{Use this style
  62 to allow disjoint items to be selected.  (Only partially implemented; may not work in all cases.)}
  63 \twocolitem{\windowstyle{wxTR\_DEFAULT\_STYLE}}{The set of flags that are
  64 closest to the defaults for the native control for a particular toolkit.}
  65 \end{twocollist}
  66
  67 See also \helpref{window styles overview}{windowstyles}.
  68
  69 \wxheading{Event handling}
  70
  71 To process input from a tree control, use these event handler macros to direct input to member
  72 functions that take a \helpref{wxTreeEvent}{wxtreeevent} argument.
  73
  74 \twocolwidtha{7cm}
  75 \begin{twocollist}\itemsep=0pt
  76 \twocolitem{{\bf EVT\_TREE\_BEGIN\_DRAG(id, func)}}{Begin dragging with the left mouse button.}
  77 \twocolitem{{\bf EVT\_TREE\_BEGIN\_RDRAG(id, func)}}{Begin dragging with the right mouse button.}
  78 \twocolitem{{\bf EVT\_TREE\_BEGIN\_LABEL\_EDIT(id, func)}}{Begin editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
  79 \twocolitem{{\bf EVT\_TREE\_END\_LABEL\_EDIT(id, func)}}{Finish editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
  80 \twocolitem{{\bf EVT\_TREE\_DELETE\_ITEM(id, func)}}{Delete an item.}
  81 \twocolitem{{\bf EVT\_TREE\_GET\_INFO(id, func)}}{Request information from the application.}
  82 \twocolitem{{\bf EVT\_TREE\_SET\_INFO(id, func)}}{Information is being supplied.}
  83 \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}
  84 \twocolitem{{\bf EVT\_TREE\_ITEM\_COLLAPSED(id, func)}}{The item has been collapsed.}
  85 \twocolitem{{\bf EVT\_TREE\_ITEM\_COLLAPSING(id, func)}}{The item is being collapsed. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
  86 \twocolitem{{\bf EVT\_TREE\_ITEM\_EXPANDED(id, func)}}{The item has been expanded.}
  87 \twocolitem{{\bf EVT\_TREE\_ITEM\_EXPANDING(id, func)}}{The item is being expanded. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
  88 \twocolitem{{\bf EVT\_TREE\_SEL\_CHANGED(id, func)}}{Selection has changed.}
  89 \twocolitem{{\bf EVT\_TREE\_SEL\_CHANGING(id, func)}}{Selection is changing. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
  90 \twocolitem{{\bf EVT\_TREE\_KEY\_DOWN(id, func)}}{A key has been pressed.}
  91 \end{twocollist}
  92
  93 \wxheading{See also}
  94
  95 \helpref{wxTreeItemData}{wxtreeitemdata}, \helpref{wxTreeCtrl overview}{wxtreectrloverview}, \helpref{wxListBox}{wxlistbox}, \helpref{wxListCtrl}{wxlistctrl},\rtfsp
  96 \helpref{wxImageList}{wximagelist}, \helpref{wxTreeEvent}{wxtreeevent}
  97
  98 \wxheading{Win32 notes}
  99
 100 wxTreeCtrl class uses the standard common treeview control under Win32
 101 implemented in the system library {\tt comctl32.dll}. Some versions of this
 102 library are known to have bugs with handling the tree control colours: the
 103 usual symptom is that the expanded items leave black (or otherwise incorrectly
 104 coloured) background behind them, especially for the controls using non
 105 default background colour. The recommended solution is to upgrade the {\tt comctl32.dll}
 106 to a newer version: see
 107 \urlref{http://www.microsoft.com/msdownload/ieplatform/ie/comctrlx86.asp}{http://www.microsoft.com/msdownload/ieplatform/ie/comctrlx86.asp}.
 108
 109 \latexignore{\rtfignore{\wxheading{Members}}}
 110
 111 \membersection{wxTreeCtrl::wxTreeCtrl}\label{wxtreectrlconstr}
 112
 113 \func{}{wxTreeCtrl}{\void}
 114
 115 Default constructor.
 116
 117 \func{}{wxTreeCtrl}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
 118 \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
 119 \param{long}{ style = wxTR\_HAS\_BUTTONS}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}}
 120
 121 Constructor, creating and showing a tree control.
 122
 123 \wxheading{Parameters}
 124
 125 \docparam{parent}{Parent window. Must not be {\tt NULL}.}
 126
 127 \docparam{id}{Window identifier. A value of -1 indicates a default value.}
 128
 129 \docparam{pos}{Window position.}
 130
 131 \docparam{size}{Window size. If the default size (-1, -1) is specified then the window is sized
 132 appropriately.}
 133
 134 \docparam{style}{Window style. See \helpref{wxTreeCtrl}{wxtreectrl}.}
 135
 136 \docparam{validator}{Window validator.}
 137
 138 \docparam{name}{Window name.}
 139
 140 \wxheading{See also}
 141
 142 \helpref{wxTreeCtrl::Create}{wxtreectrlcreate}, \helpref{wxValidator}{wxvalidator}
 143
 144 \membersection{wxTreeCtrl::\destruct{wxTreeCtrl}}
 145
 146 \func{void}{\destruct{wxTreeCtrl}}{\void}
 147
 148 Destructor, destroying the list control.
 149
 150 \membersection{wxTreeCtrl::AddRoot}\label{wxtreectrladdroot}
 151
 152 \func{wxTreeItemId}{AddRoot}{\param{const wxString\&}{ text},
 153  \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = {\tt NULL}}}
 154
 155 Adds the root node to the tree, returning the new item.
 156
 157 The {\it image} and {\it selImage} parameters are an index within
 158 the normal image list specifying the image to use for unselected and
 159 selected items, respectively.
 160 If {\it image} > -1 and {\it selImage} is -1, the same image is used for
 161 both selected and unselected items.
 162
 163 \membersection{wxTreeCtrl::AppendItem}\label{wxtreectrlappenditem}
 164
 165 \func{wxTreeItemId}{AppendItem}{\param{const wxTreeItemId\& }{parent}, \param{const wxString\&}{ text},
 166  \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = {\tt NULL}}}
 167
 168 Appends an item to the end of the branch identified by {\it parent}, return a new item id.
 169
 170 The {\it image} and {\it selImage} parameters are an index within
 171 the normal image list specifying the image to use for unselected and
 172 selected items, respectively.
 173 If {\it image} > -1 and {\it selImage} is -1, the same image is used for
 174 both selected and unselected items.
 175
 176 \membersection{wxTreeCtrl::AssignButtonsImageList}\label{wxtreectrlassignbuttonsimagelist}
 177
 178 \func{void}{AssignButtonsImageList}{\param{wxImageList*}{ imageList}}
 179
 180 Sets the buttons image list. The button images assigned with this method will
 181 be automatically deleted by wxTreeCtrl as appropriate
 182 (i.e. it takes ownership of the list).
 183
 184 Setting or assigning the button image list enables the display of image buttons.
 185 Once enabled, the only way to disable the display of button images is to set
 186 the button image list to {\tt NULL}.
 187
 188 This function is only available in the generic version.
 189
 190 See also \helpref{SetButtonsImageList}{wxtreectrlsetbuttonsimagelist}.
 191
 192 \membersection{wxTreeCtrl::AssignImageList}\label{wxtreectrlassignimagelist}
 193
 194 \func{void}{AssignImageList}{\param{wxImageList*}{ imageList}}
 195
 196 Sets the normal image list. Image list assigned with this method will
 197 be automatically deleted by wxTreeCtrl as appropriate
 198 (i.e. it takes ownership of the list).
 199
 200 See also \helpref{SetImageList}{wxtreectrlsetimagelist}.
 201
 202 \membersection{wxTreeCtrl::AssignStateImageList}\label{wxtreectrlassignstateimagelist}
 203
 204 \func{void}{AssignStateImageList}{\param{wxImageList*}{ imageList}}
 205
 206 Sets the state image list. Image list assigned with this method will
 207 be automatically deleted by wxTreeCtrl as appropriate
 208 (i.e. it takes ownership of the list).
 209
 210 See also \helpref{SetStateImageList}{wxtreectrlsetstateimagelist}.
 211
 212
 213 \membersection{wxTreeCtrl::Collapse}\label{wxtreectrlcollapse}
 214
 215 \func{void}{Collapse}{\param{const wxTreeItemId\&}{ item}}
 216
 217 Collapses the given item.
 218
 219 \membersection{wxTreeCtrl::CollapseAndReset}\label{wxtreectrlcollapseandreset}
 220
 221 \func{void}{CollapseAndReset}{\param{const wxTreeItemId\&}{ item}}
 222
 223 Collapses the given item and removes all children.
 224
 225 \membersection{wxTreeCtrl::Create}\label{wxtreectrlcreate}
 226
 227 \func{bool}{wxTreeCtrl}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
 228 \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
 229 \param{long}{ style = wxTR\_HAS\_BUTTONS}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}}
 230
 231 Creates the tree control. See \helpref{wxTreeCtrl::wxTreeCtrl}{wxtreectrlconstr} for further details.
 232
 233 \membersection{wxTreeCtrl::Delete}\label{wxtreectrldelete}
 234
 235 \func{void}{Delete}{\param{const wxTreeItemId\&}{ item}}
 236
 237 Deletes the specified item. A {\tt EVT\_TREE\_DELETE\_ITEM} event will be
 238 generated.
 239
 240 \membersection{wxTreeCtrl::DeleteAllItems}\label{wxtreectrldeleteallitems}
 241
 242 \func{void}{DeleteAllItems}{\void}
 243
 244 Deletes all the items in the control. Note that this may not generate
 245 {\tt EVT\_TREE\_DELETE\_ITEM} events under some Windows versions although
 246 normally such event is generated for each removed item.
 247
 248 \membersection{wxTreeCtrl::DeleteChildren}\label{wxtreectrldeletechildren}
 249
 250 \func{void}{DeleteChildren}{\param{const wxTreeItemId\& }{item}}
 251
 252 Deletes all children of the given item (but not the item itself). Note that
 253 this will {\bf not} generate any events unlike
 254 \helpref{Delete}{wxtreectrldelete} method.
 255
 256 \membersection{wxTreeCtrl::EditLabel}\label{wxtreectrleditlabel}
 257
 258 \func{void}{EditLabel}{\param{const wxTreeItemId\&}{ item}}
 259
 260 Starts editing the label of the given item. This function generates a
 261 EVT\_TREE\_BEGIN\_LABEL\_EDIT event which can be vetoed so that no
 262 text control will appear for in-place editing.
 263
 264 If the user changed the label (i.e. s/he does not press ESC or leave
 265 the text control without changes, a EVT\_TREE\_END\_LABEL\_EDIT event
 266 will be sent which can be vetoed as well.
 267
 268 \wxheading{See also}
 269
 270 \helpref{wxTreeCtrl::EndEditLabel}{wxtreectrlendeditlabel},
 271 \helpref{wxTreeEvent}{wxtreeevent}
 272
 273 \membersection{wxTreeCtrl::EndEditLabel}\label{wxtreectrlendeditlabel}
 274
 275 \func{void}{EndEditLabel}{\param{bool }{cancelEdit}}
 276
 277 Ends label editing. If {\it cancelEdit} is {\tt true}, the edit will be cancelled.
 278
 279 This function is currently supported under Windows only.
 280
 281 \wxheading{See also}
 282
 283 \helpref{wxTreeCtrl::EditLabel}{wxtreectrleditlabel}
 284
 285 \membersection{wxTreeCtrl::EnsureVisible}\label{wxtreectrlensurevisible}
 286
 287 \func{void}{EnsureVisible}{\param{const wxTreeItemId\&}{ item}}
 288
 289 Scrolls and/or expands items to ensure that the given item is visible.
 290
 291 \membersection{wxTreeCtrl::Expand}\label{wxtreectrlexpand}
 292
 293 \func{void}{Expand}{\param{const wxTreeItemId\&}{ item}}
 294
 295 Expands the given item.
 296
 297 \membersection{wxTreeCtrl::GetBoundingRect}\label{wxtreectrlgetitemrect}
 298
 299 \constfunc{bool}{GetBoundingRect}{\param{const wxTreeItemId\&}{ item}, \param{wxRect\& }{rect}, \param{bool }{textOnly = {\tt false}}}
 300
 301 Retrieves the rectangle bounding the {\it item}. If {\it textOnly} is {\tt true},
 302 only the rectangle around the item's label will be returned, otherwise the
 303 item's image is also taken into account.
 304
 305 The return value is {\tt true} if the rectangle was successfully retrieved or {\tt false}
 306 if it was not (in this case {\it rect} is not changed) - for example, if the
 307 item is currently invisible.
 308
 309 \pythonnote{The wxPython version of this method requires only the
 310 {\tt item} and {\tt textOnly} parameters.  The return value is either a
 311 {\tt wxRect} object or {\tt None}.}
 312
 313 \perlnote{In wxPerl this method only takes the parameters {\tt item} and
 314   {\tt textOnly}, and returns a Wx::Rect ( or undef ).}
 315
 316 \membersection{wxTreeCtrl::GetButtonsImageList}\label{wxtreectrlgetbuttonsimagelist}
 317
 318 \constfunc{wxImageList*}{GetButtonsImageList}{\void}
 319
 320 Returns the buttons image list (from which application-defined button images are taken).
 321
 322 This function is only available in the generic version.
 323
 324 \membersection{wxTreeCtrl::GetChildrenCount}\label{wxtreectrlgetchildrencount}
 325
 326 \constfunc{size\_t}{GetChildrenCount}{\param{const wxTreeItemId\&}{ item}, \param{bool}{ recursively = {\tt true}}}
 327
 328 Returns the number of items in the branch. If {\it recursively} is {\tt true}, returns the total number
 329 of descendants, otherwise only one level of children is counted.
 330
 331 \membersection{wxTreeCtrl::GetCount}\label{wxtreectrlgetcount}
 332
 333 \constfunc{int}{GetCount}{\void}
 334
 335 Returns the number of items in the control.
 336
 337 \membersection{wxTreeCtrl::GetEditControl}\label{wxtreectrlgeteditcontrol}
 338
 339 \constfunc{wxTextCtrl *}{GetEditControl}{\void}
 340
 341 Returns the edit control being currently used to edit a label. Returns {\tt NULL}
 342 if no label is being edited.
 343
 344 {\bf NB:} It is currently only implemented for wxMSW.
 345
 346 \membersection{wxTreeCtrl::GetFirstChild}\label{wxtreectrlgetfirstchild}
 347
 348 \constfunc{wxTreeItemId}{GetFirstChild}{\param{const wxTreeItemId\&}{ item}, \param{long\& }{cookie}}
 349
 350 Returns the first child; call \helpref{wxTreeCtrl::GetNextChild}{wxtreectrlgetnextchild} for the next child.
 351
 352 For this enumeration function you must pass in a `cookie' parameter
 353 which is opaque for the application but is necessary for the library
 354 to make these functions reentrant (i.e. allow more than one
 355 enumeration on one and the same object simultaneously). The cookie passed to
 356 GetFirstChild and GetNextChild should be the same variable.
 357
 358 Returns an invalid tree item if there are no further children.
 359
 360 \wxheading{See also}
 361
 362 \helpref{wxTreeCtrl::GetNextChild}{wxtreectrlgetnextchild},
 363 \helpref{wxTreeCtrl::GetNextSibling}{wxtreectrlgetnextsibling}
 364
 365 \pythonnote{In wxPython the returned wxTreeItemId and the new cookie
 366 value are both returned as a tuple containing the two values.}
 367
 368 \perlnote{In wxPerl this method only takes the {\tt item} parameter, and
 369   returns a 2-element list {\tt ( item, cookie )}.}
 370
 371 \membersection{wxTreeCtrl::GetFirstVisibleItem}\label{wxtreectrlgetfirstvisibleitem}
 372
 373 \constfunc{wxTreeItemId}{GetFirstVisibleItem}{\void}
 374
 375 Returns the first visible item.
 376
 377 \membersection{wxTreeCtrl::GetImageList}\label{wxtreectrlgetimagelist}
 378
 379 \constfunc{wxImageList*}{GetImageList}{\void}
 380
 381 Returns the normal image list.
 382
 383 \membersection{wxTreeCtrl::GetIndent}\label{wxtreectrlgetindent}
 384
 385 \constfunc{int}{GetIndent}{\void}
 386
 387 Returns the current tree control indentation.
 388
 389 \membersection{wxTreeCtrl::GetItemBackgroundColour}\label{wxtreectrlgetitembackgroundcolour}
 390
 391 \constfunc{wxColour}{GetItemBackgroundColour}{\param{const wxTreeItemId\&}{ item}}
 392
 393 Returns the background colour of the item.
 394
 395 \membersection{wxTreeCtrl::GetItemData}\label{wxtreectrlgetitemdata}
 396
 397 \constfunc{wxTreeItemData*}{GetItemData}{\param{const wxTreeItemId\&}{ item}}
 398
 399 Returns the tree item data associated with the item.
 400
 401 \wxheading{See also}
 402
 403 \helpref{wxTreeItemData}{wxtreeitemdata}
 404
 405 \pythonnote{wxPython provides the following shortcut method:
 406
 407 \indented{2cm}{\begin{twocollist}\itemsep=0pt
 408 \twocolitem{{\bf GetPyData(item)}}{Returns the Python Object
 409 associated with the wxTreeItemData for the given item Id.}
 410 \end{twocollist}}
 411 }
 412
 413 \perlnote{wxPerl provides the following shortcut method:
 414 \indented{2cm}{
 415 \begin{twocollist}\itemsep=0pt
 416 \twocolitem{{\bf GetPlData( item )}}{Returns the Perl data
 417 associated with the Wx::TreeItemData ( it is just the same as
 418 tree->GetItemData( item )->GetData(); ).}
 419 \end{twocollist}}
 420 }
 421
 422 \membersection{wxTreeCtrl::GetItemFont}\label{wxtreectrlgetitemfont}
 423
 424 \constfunc{wxFont}{GetItemFont}{\param{const wxTreeItemId\&}{ item}}
 425
 426 Returns the font of the item label.
 427
 428 \membersection{wxTreeCtrl::GetItemImage}\label{wxtreectrlgetitemimage}
 429
 430 \constfunc{int}{GetItemImage}{\param{const wxTreeItemId\& }{item},
 431  \param{wxTreeItemIcon }{which = wxTreeItemIcon\_Normal}}
 432
 433 Gets the specified item image. The value of {\it which} may be:
 434
 435 \begin{itemize}\itemsep=0pt
 436 \item{wxTreeItemIcon\_Normal} to get the normal item image
 437 \item{wxTreeItemIcon\_Selected} to get the selected item image (i.e. the image
 438 which is shown when the item is currently selected)
 439 \item{wxTreeItemIcon\_Expanded} to get the expanded image (this only
 440 makes sense for items which have children - then this image is shown when the
 441 item is expanded and the normal image is shown when it is collapsed)
 442 \item{wxTreeItemIcon\_SelectedExpanded} to get the selected expanded image
 443 (which is shown when an expanded item is currently selected)
 444 \end{itemize}
 445
 446 \membersection{wxTreeCtrl::GetItemText}\label{wxtreectrlgetitemtext}
 447
 448 \constfunc{wxString}{GetItemText}{\param{const wxTreeItemId\&}{ item}}
 449
 450 Returns the item label.
 451
 452 \membersection{wxTreeCtrl::GetItemTextColour}\label{wxtreectrlgetitemtextcolour}
 453
 454 \constfunc{wxColour}{GetItemTextColour}{\param{const wxTreeItemId\&}{ item}}
 455
 456 Returns the colour of the item label.
 457
 458 \membersection{wxTreeCtrl::GetLastChild}\label{wxtreectrlgetlastchild}
 459
 460 \constfunc{wxTreeItemId}{GetLastChild}{\param{const wxTreeItemId\&}{ item}}
 461
 462 Returns the last child of the item (or an invalid tree item if this item has no children).
 463
 464 \wxheading{See also}
 465
 466 \helpref{GetFirstChild}{wxtreectrlgetfirstchild},
 467 \helpref{wxTreeCtrl::GetNextSibling}{wxtreectrlgetnextsibling},
 468 \helpref{GetLastChild}{wxtreectrlgetlastchild}
 469
 470 \membersection{wxTreeCtrl::GetNextChild}\label{wxtreectrlgetnextchild}
 471
 472 \constfunc{wxTreeItemId}{GetNextChild}{\param{const wxTreeItemId\&}{ item}, \param{long\& }{cookie}}
 473
 474 Returns the next child; call \helpref{wxTreeCtrl::GetFirstChild}{wxtreectrlgetfirstchild} for the first child.
 475
 476 For this enumeration function you must pass in a `cookie' parameter
 477 which is opaque for the application but is necessary for the library
 478 to make these functions reentrant (i.e. allow more than one
 479 enumeration on one and the same object simultaneously). The cookie passed to
 480 GetFirstChild and GetNextChild should be the same.
 481
 482 Returns an invalid tree item if there are no further children.
 483
 484 \wxheading{See also}
 485
 486 \helpref{wxTreeCtrl::GetFirstChild}{wxtreectrlgetfirstchild}
 487
 488 \pythonnote{In wxPython the returned wxTreeItemId and the new cookie
 489 value are both returned as a tuple containing the two values.}
 490
 491 \perlnote{In wxPerl this method returns a 2-element list
 492   {\tt ( item, cookie )}, instead of modifying its parameters.}
 493
 494 \membersection{wxTreeCtrl::GetNextSibling}\label{wxtreectrlgetnextsibling}
 495
 496 \constfunc{wxTreeItemId}{GetNextSibling}{\param{const wxTreeItemId\&}{ item}}
 497
 498 Returns the next sibling of the specified item; call \helpref{wxTreeCtrl::GetPrevSibling}{wxtreectrlgetprevsibling} for the previous sibling.
 499
 500 Returns an invalid tree item if there are no further siblings.
 501
 502 \wxheading{See also}
 503
 504 \helpref{wxTreeCtrl::GetPrevSibling}{wxtreectrlgetprevsibling}
 505
 506 \membersection{wxTreeCtrl::GetNextVisible}\label{wxtreectrlgetnextvisible}
 507
 508 \constfunc{wxTreeItemId}{GetNextVisible}{\param{const wxTreeItemId\&}{ item}}
 509
 510 Returns the next visible item.
 511
 512 \membersection{wxTreeCtrl::GetItemParent}\label{wxtreectrlgetitemparent}
 513
 514 \constfunc{wxTreeItemId}{GetItemParent}{\param{const wxTreeItemId\&}{ item}}
 515
 516 Returns the item's parent.
 517
 518 \membersection{wxTreeCtrl::GetParent}\label{wxtreectrlgetparent}
 519
 520 \constfunc{wxTreeItemId}{GetParent}{\param{const wxTreeItemId\&}{ item}}
 521
 522 {\bf NOTE:} This function is deprecated and will only work if {\tt WXWIN\_COMPATIBILITY\_2\_2}
 523 is defined.  Use \helpref{wxTreeCtrl::GetItemParent}{wxtreectrlgetitemparent} instead.
 524
 525 Returns the item's parent.
 526
 527 \pythonnote{This method is named {\tt GetItemParent} to avoid a name
 528 clash with wxWindow::GetParent.}
 529
 530 \membersection{wxTreeCtrl::GetPrevSibling}\label{wxtreectrlgetprevsibling}
 531
 532 \constfunc{wxTreeItemId}{GetPrevSibling}{\param{const wxTreeItemId\&}{ item}}
 533
 534 Returns the previous sibling of the specified item; call \helpref{wxTreeCtrl::GetNextSibling}{wxtreectrlgetnextsibling} for the next sibling.
 535
 536 Returns an invalid tree item if there are no further children.
 537
 538 \wxheading{See also}
 539
 540 \helpref{wxTreeCtrl::GetNextSibling}{wxtreectrlgetnextsibling}
 541
 542 \membersection{wxTreeCtrl::GetPrevVisible}\label{wxtreectrlgetprevvisible}
 543
 544 \constfunc{wxTreeItemId}{GetPrevVisible}{\param{const wxTreeItemId\&}{ item}}
 545
 546 Returns the previous visible item.
 547
 548 \membersection{wxTreeCtrl::GetRootItem}\label{wxtreectrlgetrootitem}
 549
 550 \constfunc{wxTreeItemId}{GetRootItem}{\void}
 551
 552 Returns the root item for the tree control.
 553
 554 \membersection{wxTreeCtrl::GetItemSelectedImage}\label{wxtreectrlgetitemselectedimage}
 555
 556 \constfunc{int}{GetItemSelectedImage}{\param{const wxTreeItemId\& }{item}}
 557
 558 Gets the selected item image (this function is obsolete, use
 559 {\tt GetItemImage(item, wxTreeItemIcon\_Selected}) instead).
 560
 561 \membersection{wxTreeCtrl::GetSelection}\label{wxtreectrlgetselection}
 562
 563 \constfunc{wxTreeItemId}{GetSelection}{\void}
 564
 565 Returns the selection, or an invalid item if there is no selection.
 566 This function only works with the controls without wxTR\_MULTIPLE style, use
 567 \helpref{GetSelections}{wxtreectrlgetselections} for the controls which do have
 568 this style.
 569
 570 \membersection{wxTreeCtrl::GetSelections}\label{wxtreectrlgetselections}
 571
 572 \constfunc{size\_t}{GetSelections}{\param{wxArrayTreeItemIds\& }{selection}}
 573
 574 Fills the array of tree items passed in with the currently selected items. This
 575 function can be called only if the control has the wxTR\_MULTIPLE style.
 576
 577 Returns the number of selected items.
 578
 579 \pythonnote{The wxPython version of this method accepts no parameters
 580 and returns a Python list of {\tt wxTreeItemId}s.}
 581
 582 \perlnote{In wxPerl this method takes no parameters and returns a list of
 583  {\tt Wx::TreeItemId}s.}
 584
 585 \membersection{wxTreeCtrl::GetStateImageList}\label{wxtreectrlgetstateimagelist}
 586
 587 \constfunc{wxImageList*}{GetStateImageList}{\void}
 588
 589 Returns the state image list (from which application-defined state images are taken).
 590
 591 \membersection{wxTreeCtrl::HitTest}\label{wxtreectrlhittest}
 592
 593 \func{wxTreeItemId}{HitTest}{\param{const wxPoint\& }{point}, \param{int\& }{flags}}
 594
 595 Calculates which (if any) item is under the given point, returning the tree item
 596 id at this point plus extra information {\it flags}. {\it flags} is a bitlist of the following:
 597
 598 \twocolwidtha{5cm}
 599 \begin{twocollist}\itemsep=0pt
 600 \twocolitem{wxTREE\_HITTEST\_ABOVE}{Above the client area.}
 601 \twocolitem{wxTREE\_HITTEST\_BELOW}{Below the client area.}
 602 \twocolitem{wxTREE\_HITTEST\_NOWHERE}{In the client area but below the last item.}
 603 \twocolitem{wxTREE\_HITTEST\_ONITEMBUTTON}{On the button associated with an item.}
 604 \twocolitem{wxTREE\_HITTEST\_ONITEMICON}{On the bitmap associated with an item.}
 605 \twocolitem{wxTREE\_HITTEST\_ONITEMINDENT}{In the indentation associated with an item.}
 606 \twocolitem{wxTREE\_HITTEST\_ONITEMLABEL}{On the label (string) associated with an item.}
 607 \twocolitem{wxTREE\_HITTEST\_ONITEMRIGHT}{In the area to the right of an item.}
 608 \twocolitem{wxTREE\_HITTEST\_ONITEMSTATEICON}{On the state icon for a tree view item that is in a user-defined state.}
 609 \twocolitem{wxTREE\_HITTEST\_TOLEFT}{To the right of the client area.}
 610 \twocolitem{wxTREE\_HITTEST\_TORIGHT}{To the left of the client area.}
 611 \end{twocollist}
 612
 613 \pythonnote{in wxPython both the wxTreeItemId and the flags are
 614 returned as a tuple.}
 615
 616 \perlnote{In wxPerl this method only takes the {\tt point} parameter
 617   and returns a 2-element list {\tt ( item, flags )}.}
 618
 619 \membersection{wxTreeCtrl::InsertItem}\label{wxtreectrlinsertitem}
 620
 621 \func{wxTreeItemId}{InsertItem}{\param{const wxTreeItemId\& }{parent}, \param{const wxTreeItemId\& }{previous}, \param{const wxString\&}{ text},
 622  \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = {\tt NULL}}}
 623
 624 \func{wxTreeItemId}{InsertItem}{\param{const wxTreeItemId\& }{parent}, \param{size\_t}{ before}, \param{const wxString\&}{ text},
 625  \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = {\tt NULL}}}
 626
 627 Inserts an item after a given one ({\it previous}) or before one identified by its position ({\it before}).
 628
 629 The {\it image} and {\it selImage} parameters are an index within
 630 the normal image list specifying the image to use for unselected and
 631 selected items, respectively.
 632 If {\it image} > -1 and {\it selImage} is -1, the same image is used for
 633 both selected and unselected items.
 634
 635 \pythonnote{The second form of this method is called
 636 {\tt InsertItemBefore} in wxPython.}
 637
 638 \membersection{wxTreeCtrl::IsBold}\label{wxtreectrlisbold}
 639
 640 \constfunc{bool}{IsBold}{\param{const wxTreeItemId\& }{item}}
 641
 642 Returns {\tt true} if the given item is in bold state.
 643
 644 See also: \helpref{SetItemBold}{wxtreectrlsetitembold}
 645
 646 \membersection{wxTreeCtrl::IsExpanded}\label{wxtreectrlisexpanded}
 647
 648 \constfunc{bool}{IsExpanded}{\param{const wxTreeItemId\&}{ item}}
 649
 650 Returns {\tt true} if the item is expanded (only makes sense if it has children).
 651
 652 \membersection{wxTreeCtrl::IsSelected}\label{wxtreectrlisselected}
 653
 654 \constfunc{bool}{IsSelected}{\param{const wxTreeItemId\&}{ item}}
 655
 656 Returns {\tt true} if the item is selected.
 657
 658 \membersection{wxTreeCtrl::IsVisible}\label{wxtreectrlisvisible}
 659
 660 \constfunc{bool}{IsVisible}{\param{const wxTreeItemId\&}{ item}}
 661
 662 Returns {\tt true} if the item is visible (it might be outside the view, or not expanded).
 663
 664 \membersection{wxTreeCtrl::ItemHasChildren}\label{wxtreectrlitemhaschildren}
 665
 666 \constfunc{bool}{ItemHasChildren}{\param{const wxTreeItemId\&}{ item}}
 667
 668 Returns {\tt true} if the item has children.
 669
 670 \membersection{wxTreeCtrl::OnCompareItems}\label{wxtreectrloncompareitems}
 671
 672 \func{int}{OnCompareItems}{\param{const wxTreeItemId\& }{item1}, \param{const wxTreeItemId\& }{item2}}
 673
 674 Override this function in the derived class to change the sort order of the
 675 items in the tree control. The function should return a negative, zero or
 676 positive value if the first item is less than, equal to or greater than the
 677 second one.
 678
 679 The base class version compares items alphabetically.
 680
 681 See also: \helpref{SortChildren}{wxtreectrlsortchildren}
 682
 683 \membersection{wxTreeCtrl::PrependItem}\label{wxtreectrlprependitem}
 684
 685 \func{wxTreeItemId}{PrependItem}{\param{const wxTreeItemId\& }{parent}, \param{const wxString\&}{ text},
 686  \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = {\tt NULL}}}
 687
 688 Appends an item as the first child of {\it parent}, return a new item id.
 689
 690 The {\it image} and {\it selImage} parameters are an index within
 691 the normal image list specifying the image to use for unselected and
 692 selected items, respectively.
 693 If {\it image} > -1 and {\it selImage} is -1, the same image is used for
 694 both selected and unselected items.
 695
 696 \membersection{wxTreeCtrl::ScrollTo}\label{wxtreectrlscrollto}
 697
 698 \func{void}{ScrollTo}{\param{const wxTreeItemId\&}{ item}}
 699
 700 Scrolls the specified item into view.
 701
 702 \membersection{wxTreeCtrl::SelectItem}\label{wxtreectrlselectitem}
 703
 704 \func{bool}{SelectItem}{\param{const wxTreeItemId\&}{ item}}
 705
 706 Selects the given item.
 707
 708 \membersection{wxTreeCtrl::SetButtonsImageList}\label{wxtreectrlsetbuttonsimagelist}
 709
 710 \func{void}{SetButtonsImageList}{\param{wxImageList*}{ imageList}}
 711
 712 Sets the buttons image list (from which application-defined button images are taken).
 713 The button images assigned with this method will
 714 {\bf not} be deleted by wxTreeCtrl's destructor, you must delete it yourself.
 715
 716 Setting or assigning the button image list enables the display of image buttons.
 717 Once enabled, the only way to disable the display of button images is to set
 718 the button image list to {\tt NULL}.
 719
 720 This function is only available in the generic version.
 721
 722 See also \helpref{AssignButtonsImageList}{wxtreectrlassignbuttonsimagelist}.
 723
 724 \membersection{wxTreeCtrl::SetIndent}\label{wxtreectrlsetindent}
 725
 726 \func{void}{SetIndent}{\param{int }{indent}}
 727
 728 Sets the indentation for the tree control.
 729
 730 \membersection{wxTreeCtrl::SetImageList}\label{wxtreectrlsetimagelist}
 731
 732 \func{void}{SetImageList}{\param{wxImageList*}{ imageList}}
 733
 734 Sets the normal image list. Image list assigned with this method will
 735 {\bf not} be deleted by wxTreeCtrl's destructor, you must delete it yourself.
 736
 737 See also \helpref{AssignImageList}{wxtreectrlassignimagelist}.
 738
 739
 740 \membersection{wxTreeCtrl::SetItemBackgroundColour}\label{wxtreectrlsetitembackgroundcolour}
 741
 742 \func{void}{SetItemBackgroundColour}{\param{const wxTreeItemId\&}{ item}, \param{const wxColour\& }{col}}
 743
 744 Sets the colour of the item's background.
 745
 746 \membersection{wxTreeCtrl::SetItemBold}\label{wxtreectrlsetitembold}
 747
 748 \func{void}{SetItemBold}{\param{const wxTreeItemId\& }{item}, \param{bool}{ bold = {\tt true}}}
 749
 750 Makes item appear in bold font if {\it bold} parameter is {\tt true} or resets it to
 751 the normal state.
 752
 753 See also: \helpref{IsBold}{wxtreectrlisbold}
 754
 755 \membersection{wxTreeCtrl::SetItemData}\label{wxtreectrlsetitemdata}
 756
 757 \func{void}{SetItemData}{\param{const wxTreeItemId\&}{ item}, \param{wxTreeItemData* }{data}}
 758
 759 Sets the item client data.
 760
 761 \pythonnote{wxPython provides the following shortcut method:\par
 762 \indented{2cm}{\begin{twocollist}\itemsep=0pt
 763 \twocolitem{{\bf SetPyData(item, obj)}}{Associate the given Python
 764 Object with the wxTreeItemData for the given item Id.}
 765 \end{twocollist}}
 766 }
 767
 768 \perlnote{wxPerl provides the following shortcut method:
 769 \indented{2cm}{
 770 \begin{twocollist}\itemsep=0pt
 771 \twocolitem{{\bf SetPlData( item, data )}}{Sets the Perl data
 772 associated with the Wx::TreeItemData ( it is just the same as
 773 tree->GetItemData( item )->SetData( data ); ).}
 774 \end{twocollist}}
 775 }
 776
 777 \membersection{wxTreeCtrl::SetItemFont}\label{wxtreectrlsetitemfont}
 778
 779 \func{void}{SetItemFont}{\param{const wxTreeItemId\&}{ item}, \param{const wxFont\& }{font}}
 780
 781 Sets the item's font. All items in the tree should have the same height to avoid
 782 text clipping, so the fonts height should be the same for all of them,
 783 although font attributes may vary.
 784
 785 \wxheading{See also}
 786
 787 \helpref{SetItemBold}{wxtreectrlsetitembold}
 788
 789 \membersection{wxTreeCtrl::SetItemHasChildren}\label{wxtreectrlsetitemhaschildren}
 790
 791 \func{void}{SetItemHasChildren}{\param{const wxTreeItemId\&}{ item}, \param{bool }{hasChildren = {\tt true}}}
 792
 793 Force appearance of the button next to the item. This is useful to
 794 allow the user to expand the items which don't have any children now,
 795 but instead adding them only when needed, thus minimizing memory
 796 usage and loading time.
 797
 798 \membersection{wxTreeCtrl::SetItemImage}\label{wxtreectrlsetitemimage}
 799
 800 \func{void}{SetItemImage}{\param{const wxTreeItemId\&}{ item},
 801  \param{int }{image}, \param{wxTreeItemIcon }{which = wxTreeItemIcon\_Normal}}
 802
 803 Sets the specified item image. See \helpref{GetItemImage}{wxtreectrlgetitemimage}
 804 for the description of the {\it which} parameter.
 805
 806 \membersection{wxTreeCtrl::SetItemSelectedImage}\label{wxtreectrlsetitemselectedimage}
 807
 808 \func{void}{SetItemSelectedImage}{\param{const wxTreeItemId\&}{ item}, \param{int }{selImage}}
 809
 810 Sets the selected item image (this function is obsolete, use {\tt SetItemImage(item, wxTreeItemIcon\_Selected}) instead).
 811
 812 \membersection{wxTreeCtrl::SetItemText}\label{wxtreectrlsetitemtext}
 813
 814 \func{void}{SetItemText}{\param{const wxTreeItemId\&}{ item}, \param{const wxString\& }{text}}
 815
 816 Sets the item label.
 817
 818 \membersection{wxTreeCtrl::SetItemTextColour}\label{wxtreectrlsetitemtextcolour}
 819
 820 \func{void}{SetItemTextColour}{\param{const wxTreeItemId\&}{ item}, \param{const wxColour\& }{col}}
 821
 822 Sets the colour of the item's text.
 823
 824 \membersection{wxTreeCtrl::SetStateImageList}\label{wxtreectrlsetstateimagelist}
 825
 826 \func{void}{SetStateImageList}{\param{wxImageList*}{ imageList}}
 827
 828 Sets the state image list (from which application-defined state images are taken).
 829 Image list assigned with this method will
 830 {\bf not} be deleted by wxTreeCtrl's destructor, you must delete it yourself.
 831
 832 See also \helpref{AssignStateImageList}{wxtreectrlassignstateimagelist}.
 833
 834 \func{void}{SetWindowStyle}{\param{long}{styles}}
 835
 836 Sets the mode flags associated with the display of the tree control.
 837 The new mode takes effect immediately.
 838 (Generic only; MSW ignores changes.)
 839
 840 \membersection{wxTreeCtrl::SortChildren}\label{wxtreectrlsortchildren}
 841
 842 \func{void}{SortChildren}{\param{const wxTreeItemId\&}{ item}}
 843
 844 Sorts the children of the given item using
 845 \helpref{OnCompareItems}{wxtreectrloncompareitems} method of wxTreeCtrl. You
 846 should override that method to change the sort order (the default is ascending
 847 alphabetical order).
 848
 849 \wxheading{See also}
 850
 851 \helpref{wxTreeItemData}{wxtreeitemdata}, \helpref{OnCompareItems}{wxtreectrloncompareitems}
 852
 853 \membersection{wxTreeCtrl::Toggle}\label{wxtreectrltoggle}
 854
 855 \func{void}{Toggle}{\param{const wxTreeItemId\&}{ item}}
 856
 857 Toggles the given item between collapsed and expanded states.
 858
 859 \membersection{wxTreeCtrl::Unselect}\label{wxtreectrlunselect}
 860
 861 \func{void}{Unselect}{\void}
 862
 863 Removes the selection from the currently selected item (if any).
 864
 865 \membersection{wxTreeCtrl::UnselectAll}\label{wxtreectrlunselectall}
 866
 867 \func{void}{UnselectAll}{\void}
 868
 869 This function either behaves the same as \helpref{Unselect}{wxtreectrlunselect}
 870 if the control doesn't have wxTR\_MULTIPLE style, or removes the selection from
 871 all items if it does have this style.
 872