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
   6 To intercept events from a tree control, use the event table macros described in \helpref{wxTreeEvent}{wxtreeevent}.
   7
   8 \wxheading{Derived from}
   9
  10 \helpref{wxControl}{wxcontrol}\\
  11 \helpref{wxWindow}{wxwindow}\\
  12 \helpref{wxEvtHandler}{wxevthandler}\\
  13 \helpref{wxObject}{wxobject}
  14
  15 \wxheading{Include files}
  16
  17 <wx/treectrl.h>
  18
  19 \wxheading{Window styles}
  20
  21 \twocolwidtha{5cm}
  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\_EDIT\_LABELS}}{Use this style if you wish the user to be
  26 able to edit labels in the tree control.}
  27 \twocolitem{\windowstyle{wxTR\_MULTIPLE}}{Use this style to allow the user to
  28 select more than one item in the control - by default, only one item may be
  29 selected.}
  30 \end{twocollist}
  31
  32 See also \helpref{window styles overview}{windowstyles}.
  33
  34 \wxheading{Event handling}
  35
  36 To process input from a tree control, use these event handler macros to direct input to member
  37 functions that take a \helpref{wxTreeEvent}{wxtreeevent} argument.
  38
  39 \twocolwidtha{7cm}
  40 \begin{twocollist}\itemsep=0pt
  41 \twocolitem{{\bf EVT\_TREE\_BEGIN\_DRAG(id, func)}}{Begin dragging with the left mouse button.}
  42 \twocolitem{{\bf EVT\_TREE\_BEGIN\_RDRAG(id, func)}}{Begin dragging with the right mouse button.}
  43 \twocolitem{{\bf EVT\_TREE\_BEGIN\_LABEL\_EDIT(id, func)}}{Begin editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
  44 \twocolitem{{\bf EVT\_TREE\_END\_LABEL\_EDIT(id, func)}}{Finish editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
  45 \twocolitem{{\bf EVT\_TREE\_DELETE\_ITEM(id, func)}}{Delete an item.}
  46 \twocolitem{{\bf EVT\_TREE\_GET\_INFO(id, func)}}{Request information from the application.}
  47 \twocolitem{{\bf EVT\_TREE\_SET\_INFO(id, func)}}{Information is being supplied.}
  48 \twocolitem{{\bf EVT\_TREE\_ITEM\_EXPANDED(id, func)}}{Parent has been expanded.}
  49 \twocolitem{{\bf EVT\_TREE\_ITEM\_EXPANDING(id, func)}}{Parent is being expanded. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
  50 \twocolitem{{\bf EVT\_TREE\_SEL\_CHANGED(id, func)}}{Selection has changed.}
  51 \twocolitem{{\bf EVT\_TREE\_SEL\_CHANGING(id, func)}}{Selection is changing. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
  52 \twocolitem{{\bf EVT\_TREE\_KEY\_DOWN(id, func)}}{A key has been pressed.}
  53 \end{twocollist}%
  54
  55 \wxheading{See also}
  56
  57 \helpref{wxTreeItemData}{wxtreeitemdata}, \helpref{wxTreeCtrl overview}{wxtreectrloverview}, \helpref{wxListBox}{wxlistbox}, \helpref{wxListCtrl}{wxlistctrl},\rtfsp
  58 \helpref{wxImageList}{wximagelist}, \helpref{wxTreeEvent}{wxtreeevent}
  59
  60 \latexignore{\rtfignore{\wxheading{Members}}}
  61
  62 \membersection{wxTreeCtrl::wxTreeCtrl}\label{wxtreectrlconstr}
  63
  64 \func{}{wxTreeCtrl}{\void}
  65
  66 Default constructor.
  67
  68 \func{}{wxTreeCtrl}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
  69 \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
  70 \param{long}{ style = wxTR\_HAS\_BUTTONS}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}}
  71
  72 Constructor, creating and showing a tree control.
  73
  74 \wxheading{Parameters}
  75
  76 \docparam{parent}{Parent window. Must not be NULL.}
  77
  78 \docparam{id}{Window identifier. A value of -1 indicates a default value.}
  79
  80 \docparam{pos}{Window position.}
  81
  82 \docparam{size}{Window size. If the default size (-1, -1) is specified then the window is sized
  83 appropriately.}
  84
  85 \docparam{style}{Window style. See \helpref{wxTreeCtrl}{wxtreectrl}.}
  86
  87 \docparam{validator}{Window validator.}
  88
  89 \docparam{name}{Window name.}
  90
  91 \wxheading{See also}
  92
  93 \helpref{wxTreeCtrl::Create}{wxtreectrlcreate}, \helpref{wxValidator}{wxvalidator}
  94
  95 \membersection{wxTreeCtrl::\destruct{wxTreeCtrl}}
  96
  97 \func{void}{\destruct{wxTreeCtrl}}{\void}
  98
  99 Destructor, destroying the list control.
 100
 101 \membersection{wxTreeCtrl::AddRoot}\label{wxtreectrladdroot}
 102
 103 \func{wxTreeItemId}{AddRoot}{\param{const wxString\&}{ text},
 104  \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = NULL}}
 105
 106 Adds the root node to the tree, returning the new item.
 107
 108 If {\it image} > -1 and {\it selImage} is -1, the same image is used for
 109 both selected and unselected items.
 110
 111 \membersection{wxTreeCtrl::AppendItem}\label{wxtreectrlappenditem}
 112
 113 \func{wxTreeItemId}{AppendItem}{\param{const wxTreeItemId\& }{parent}, \param{const wxString\&}{ text},
 114  \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = NULL}}
 115
 116 Appends an item to the end of the branch identified by {\it parent}, return a new item id.
 117
 118 If {\it image} > -1 and {\it selImage} is -1, the same image is used for
 119 both selected and unselected items.
 120
 121 \membersection{wxTreeCtrl::Collapse}\label{wxtreectrlcollapse}
 122
 123 \func{void}{Collapse}{\param{const wxTreeItemId\&}{ item}}
 124
 125 Collapses the given item.
 126
 127 \membersection{wxTreeCtrl::CollapseAndReset}\label{wxtreectrlcollapseandreset}
 128
 129 \func{void}{CollapseAndReset}{\param{const wxTreeItemId\&}{ item}}
 130
 131 Collapses the given item and removes all children.
 132
 133 \membersection{wxTreeCtrl::Create}\label{wxtreectrlcreate}
 134
 135 \func{bool}{wxTreeCtrl}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
 136 \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
 137 \param{long}{ style = wxTR\_HAS\_BUTTONS}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}}
 138
 139 Creates the tree control. See \helpref{wxTreeCtrl::wxTreeCtrl}{wxtreectrlconstr} for further details.
 140
 141 \membersection{wxTreeCtrl::Delete}\label{wxtreectrldelete}
 142
 143 \func{void}{Delete}{\param{const wxTreeItemId\&}{ item}}
 144
 145 Deletes the specified item.
 146
 147 \membersection{wxTreeCtrl::DeleteAllItems}\label{wxtreectrldeleteallitems}
 148
 149 \func{void}{DeleteAllItems}{\void}
 150
 151 Deletes all the items in the control.
 152
 153 \membersection{wxTreeCtrl::EditLabel}\label{wxtreectrleditlabel}
 154
 155 \func{void}{EditLabel}{\param{const wxTreeItemId\&}{ item}}
 156
 157 Starts editing the label of the given item. This function generates a
 158 EVT\_TREE\_BEGIN\_LABEL\_EDIT event which can be vetoed so that no
 159 text control will appear for in-place editing.
 160
 161 If the user changed the label (i.e. s/he does not press ESC or leave
 162 the text control without changes, a EVT\_TREE\_END\_LABEL\_EDIT event
 163 will be sent which can be vetoed as well.
 164
 165 \wxheading{See also}
 166
 167 \helpref{wxTreeCtrl::EndEditLabel}{wxtreectrlendeditlabel},
 168 \helpref{wxTreeEvent}{wxtreeevent}
 169
 170 \membersection{wxTreeCtrl::EndEditLabel}\label{wxtreectrlendeditlabel}
 171
 172 \func{void}{EndEditLabel}{\param{bool }{cancelEdit}}
 173
 174 Ends label editing. If {\it cancelEdit} is TRUE, the edit will be cancelled.
 175
 176 This function is currently supported under Windows only.
 177
 178 \wxheading{See also}
 179
 180 \helpref{wxTreeCtrl::EditLabel}{wxtreectrleditlabel}
 181
 182 \membersection{wxTreeCtrl::EnsureVisible}\label{wxtreectrlensurevisible}
 183
 184 \func{void}{EnsureVisible}{\param{const wxTreeItemId\&}{ item}}
 185
 186 Scrolls and/or expands items to ensure that the given item is visible.
 187
 188 \membersection{wxTreeCtrl::Expand}\label{wxtreectrlexpand}
 189
 190 \func{void}{Expand}{\param{const wxTreeItemId\&}{ item}}
 191
 192 Expands the given item.
 193
 194 \membersection{wxTreeCtrl::GetBoundingRect}\label{wxtreectrlgetitemrect}
 195
 196 \constfunc{bool}{GetBoundingRect}{\param{const wxTreeItemId\&}{ item}, \param{wxRect\& }{rect}, \param{bool }{textOnly = FALSE}}
 197
 198 Retrieves the rectangle bounding the {\it item}. If {\it textOnly} is TRUE,
 199 only the rectangle around the items label will be returned, otherwise the
 200 items image is also taken into account.
 201
 202 The return value is TRUE if the rectangle was successfully retrieved or FALSE
 203 if it was not (in this case {\it rect} is not changed) - for example, if the
 204 item is currently invisible.
 205
 206 \pythonnote{The wxPython version of this method requires only the
 207 \tt{item} and \tt{textOnly} parameters.  The return value is either a
 208 \tt{wxRect} object or \tt{None}.}
 209
 210 \membersection{wxTreeCtrl::GetChildrenCount}\label{wxtreectrlgetchildrencount}
 211
 212 \constfunc{size\_t}{GetChildrenCount}{\param{const wxTreeItemId\&}{ item}, \param{bool}{ recursively = TRUE}}
 213
 214 Returns the number of items in the branch. If {\it recursively} is TRUE, returns the total number
 215 of descendants, otherwise only one level of children is counted.
 216
 217 \membersection{wxTreeCtrl::GetCount}\label{wxtreectrlgetcount}
 218
 219 \constfunc{int}{GetCount}{\void}
 220
 221 Returns the number of items in the control.
 222
 223 \membersection{wxTreeCtrl::GetEditControl}\label{wxtreectrlgeteditcontrol}
 224
 225 \constfunc{wxTextCtrl\&}{GetEditControl}{\void}
 226
 227 Returns the edit control used to edit a label.
 228
 229 \membersection{wxTreeCtrl::GetFirstChild}\label{wxtreectrlgetfirstchild}
 230
 231 \constfunc{wxTreeItemId}{GetFirstChild}{\param{const wxTreeItemId\&}{ item}, \param{long\& }{cookie}}
 232
 233 Returns the first child; call \helpref{wxTreeCtrl::GetNextChild}{wxtreectrlgetnextchild} for the next child.
 234
 235 For this enumeration function you must pass in a `cookie' parameter
 236 which is opaque for the application but is necessary for the library
 237 to make these functions reentrant (i.e. allow more than one
 238 enumeration on one and the same object simultaneously). The cookie passed to
 239 GetFirstChild and GetNextChild should be the same.
 240
 241 Returns an invalid tree item if there are no further children.
 242
 243 \wxheading{See also}
 244
 245 \helpref{wxTreeCtrl::GetNextChild}{wxtreectrlgetnextchild}
 246
 247 \pythonnote{In wxPython the returned wxTreeItemId and the new cookie
 248 value are both returned as a tuple containing the two values.}
 249
 250 \membersection{wxTreeCtrl::GetFirstVisibleItem}\label{wxtreectrlgetfirstvisibleitem}
 251
 252 \constfunc{wxTreeItemId}{GetFirstVisibleItem}{\void}
 253
 254 Returns the first visible item.
 255
 256 \membersection{wxTreeCtrl::GetImageList}\label{wxtreectrlgetimagelist}
 257
 258 \constfunc{wxImageList*}{GetImageList}{\param{int }{which = wxIMAGE\_LIST\_NORMAL}}
 259
 260 Returns the specified image list. {\it which} may be one of:
 261
 262 \twocolwidtha{5cm}
 263 \begin{twocollist}\itemsep=0pt
 264 \twocolitem{\windowstyle{wxIMAGE\_LIST\_NORMAL}}{The normal (large icon) image list.}
 265 \twocolitem{\windowstyle{wxIMAGE\_LIST\_SMALL}}{The small icon image list.}
 266 \twocolitem{\windowstyle{wxIMAGE\_LIST\_STATE}}{The user-defined state image list (unimplemented).}
 267 \end{twocollist}
 268
 269 \membersection{wxTreeCtrl::GetIndent}\label{wxtreectrlgetindent}
 270
 271 \constfunc{int}{GetIndent}{\void}
 272
 273 Returns the current tree control indentation.
 274
 275 \membersection{wxTreeCtrl::GetItemData}\label{wxtreectrlgetitemdata}
 276
 277 \constfunc{wxTreeItemData*}{GetItemData}{\param{const wxTreeItemId\&}{ item}}
 278
 279 Returns the tree item data associated with the item.
 280
 281 \wxheading{See also}
 282
 283 \helpref{wxTreeItemData}{wxtreeitemdata}
 284
 285 \pythonnote{wxPython provides the following shortcut method:\par
 286 \indented{2cm}{\begin{twocollist}
 287 \twocolitem{\bf{GetPyData(item)}}{Returns the Python Object
 288 associated with the wxTreeItemData for the given item Id.}
 289 \end{twocollist}}
 290 }
 291
 292 \membersection{wxTreeCtrl::GetItemImage}\label{wxtreectrlgetitemimage}
 293
 294 \constfunc{int}{GetItemImage}{\param{const wxTreeItemId\& }{item},
 295 \param{wxTreeItemIcon }{which = wxTreeItemIcon\_Normal}}
 296
 297 Gets the specified item image. The value of {\it which} may be:
 298 \begin{itemize}\itemsep=0pt
 299 \item{wxTreeItemIcon\_Normal} to get the normal item image
 300 \item{wxTreeItemIcon\_Selected} to get the selected item image (i.e. the image
 301 which is shown when the item is currently selected)
 302 \item{wxTreeItemIcon\_Expanded} to get the expanded image (this only
 303 makes sense for items which have children - then this image is shown when the
 304 item is expanded and the normal image is shown when it is collapsed)
 305 \item{wxTreeItemIcon\_SelectedExpanded} to get the selected expanded image
 306 (which is shown when an expanded item is currently selected)
 307 \end{itemize}
 308
 309 \membersection{wxTreeCtrl::GetItemText}\label{wxtreectrlgetitemtext}
 310
 311 \constfunc{wxString}{GetItemText}{\param{const wxTreeItemId\&}{ item}}
 312
 313 Returns the item label.
 314
 315 \membersection{wxTreeCtrl::GetLastChild}\label{wxtreectrlgetlastchild}
 316
 317 \constfunc{wxTreeItemId}{GetLastChild}{\param{const wxTreeItemId\&}{ item}}
 318
 319 Returns the last child of the item (or an invalid tree item if this item has no children).
 320
 321 \wxheading{See also}
 322
 323 \helpref{GetFirstChild}{wxtreectrlgetfirstchild},
 324 \helpref{GetLastChild}{wxtreectrlgetlastchild}
 325
 326 \membersection{wxTreeCtrl::GetNextChild}\label{wxtreectrlgetnextchild}
 327
 328 \constfunc{wxTreeItemId}{GetNextChild}{\param{const wxTreeItemId\&}{ item}, \param{long\& }{cookie}}
 329
 330 Returns the next child; call \helpref{wxTreeCtrl::GetFirstChild}{wxtreectrlgetfirstchild} for the first child.
 331
 332 For this enumeration function you must pass in a `cookie' parameter
 333 which is opaque for the application but is necessary for the library
 334 to make these functions reentrant (i.e. allow more than one
 335 enumeration on one and the same object simultaneously). The cookie passed to
 336 GetFirstChild and GetNextChild should be the same.
 337
 338 Returns an invalid tree item if there are no further children.
 339
 340 \wxheading{See also}
 341
 342 \helpref{wxTreeCtrl::GetFirstChild}{wxtreectrlgetfirstchild}
 343
 344 \pythonnote{In wxPython the returned wxTreeItemId and the new cookie
 345 value are both returned as a tuple containing the two values.}
 346
 347 \membersection{wxTreeCtrl::GetNextSibling}\label{wxtreectrlgetnextsibling}
 348
 349 \constfunc{wxTreeItemId}{GetNextSibling}{\param{const wxTreeItemId\&}{ item}}
 350
 351 Returns the next sibling of the specified item; call \helpref{wxTreeCtrl::GetPrevSibling}{wxtreectrlgetprevsibling} for the previous sibling.
 352
 353 Returns an invalid tree item if there are no further siblings.
 354
 355 \wxheading{See also}
 356
 357 \helpref{wxTreeCtrl::GetPrevSibling}{wxtreectrlgetprevsibling}
 358
 359 \membersection{wxTreeCtrl::GetNextVisible}\label{wxtreectrlgetnextvisible}
 360
 361 \constfunc{wxTreeItemId}{GetNextVisible}{\param{const wxTreeItemId\&}{ item}}
 362
 363 Returns the next visible item.
 364
 365 \membersection{wxTreeCtrl::GetParent}\label{wxtreectrlgetparent}
 366
 367 \constfunc{wxTreeItemId}{GetParent}{\param{const wxTreeItemId\&}{ item}}
 368
 369 Returns the item's parent.
 370
 371 \membersection{wxTreeCtrl::GetPrevSibling}\label{wxtreectrlgetprevsibling}
 372
 373 \constfunc{wxTreeItemId}{GetPrevSibling}{\param{const wxTreeItemId\&}{ item}}
 374
 375 Returns the previous sibling of the specified item; call \helpref{wxTreeCtrl::GetNextSibling}{wxtreectrlgetnextsibling} for the next sibling.
 376
 377 Returns an invalid tree item if there are no further children.
 378
 379 \wxheading{See also}
 380
 381 \helpref{wxTreeCtrl::GetNextSibling}{wxtreectrlgetnextsibling}
 382
 383 \membersection{wxTreeCtrl::GetPrevVisible}\label{wxtreectrlgetprevvisible}
 384
 385 \constfunc{wxTreeItemId}{GetPrevVisible}{\param{const wxTreeItemId\&}{ item}}
 386
 387 Returns the previous visible item.
 388
 389 \membersection{wxTreeCtrl::GetRootItem}\label{wxtreectrlgetrootitem}
 390
 391 \constfunc{wxTreeItemId}{GetRootItem}{\void}
 392
 393 Returns the root item for the tree control.
 394
 395 \membersection{wxTreeCtrl::GetItemSelectedImage}\label{wxtreectrlgetitemselectedimage}
 396
 397 \constfunc{int}{GetItemSelectedImage}{\param{const wxTreeItemId\& }{item}}
 398
 399 Gets the selected item image (this function is obsolete, use
 400 {\tt GetItemImage(item, wxTreeItemIcon\_Selected} instead).
 401
 402 \membersection{wxTreeCtrl::GetSelection}\label{wxtreectrlgetselection}
 403
 404 \constfunc{wxTreeItemId}{GetSelection}{\void}
 405
 406 Returns the selection, or an invalid item if there is no selection.
 407 This function only works with the controls without wxTR\_MULTIPLE style, use
 408 \helpref{GetSelections}{wxtreectrlgetselections} for the controls which do have
 409 this style.
 410
 411 \membersection{wxTreeCtrl::GetSelections}\label{wxtreectrlgetselections}
 412
 413 \constfunc{size\_t}{GetSelections}{\param{wxArrayTreeItemIds\& }{selection}}
 414
 415 Fills the array of tree items passed in with the currently selected items. This
 416 function can be called only if the control has the wxTR\_MULTIPLE style.
 417
 418 Returns the number of selected items.
 419
 420 \pythonnote{The wxPython version of this method accepts no parameters
 421 and returns a Python list of \tt{wxTreeItemId}'s.}
 422
 423 \membersection{wxTreeCtrl::HitTest}\label{wxtreectrlhittest}
 424
 425 \func{long}{HitTest}{\param{const wxPoint\& }{point}, \param{int\& }{flags}}
 426
 427 Calculates which (if any) item is under the given point, returning extra information
 428 in {\it flags}. {\it flags} is a bitlist of the following:
 429
 430 \twocolwidtha{5cm}
 431 \begin{twocollist}\itemsep=0pt
 432 \twocolitem{wxTREE\_HITTEST\_ABOVE}{Above the client area.}
 433 \twocolitem{wxTREE\_HITTEST\_BELOW}{Below the client area.}
 434 \twocolitem{wxTREE\_HITTEST\_NOWHERE}{In the client area but below the last item.}
 435 \twocolitem{wxTREE\_HITTEST\_ONITEMBUTTON}{On the button associated with an item.}
 436 \twocolitem{wxTREE\_HITTEST\_ONITEMICON}{On the bitmap associated with an item.}
 437 \twocolitem{wxTREE\_HITTEST\_ONITEMINDENT}{In the indentation associated with an item.}
 438 \twocolitem{wxTREE\_HITTEST\_ONITEMLABEL}{On the label (string) associated with an item.}
 439 \twocolitem{wxTREE\_HITTEST\_ONITEMRIGHT}{In the area to the right of an item.}
 440 \twocolitem{wxTREE\_HITTEST\_ONITEMSTATEICON}{On the state icon for a tree view item that is in a user-defined state.}
 441 \twocolitem{wxTREE\_HITTEST\_TOLEFT}{To the right of the client area.}
 442 \twocolitem{wxTREE\_HITTEST\_TORIGHT}{To the left of the client area.}
 443 \end{twocollist}
 444
 445 \membersection{wxTreeCtrl::InsertItem}\label{wxtreectrlinsertitem}
 446
 447 \func{wxTreeItemId}{InsertItem}{\param{const wxTreeItemId\& }{parent}, \param{const wxTreeItemId\& }{previous}, \param{const wxString\&}{ text},
 448  \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = NULL}}
 449
 450 Inserts an item after a given one.
 451
 452 If {\it image} > -1 and {\it selImage} is -1, the same image is used for
 453 both selected and unselected items.
 454
 455 \membersection{wxTreeCtrl::IsBold}\label{wxtreectrlisbold}
 456
 457 \constfunc{bool}{IsBold}{\param{const wxTreeItemId\& }{item}}
 458
 459 Returns TRUE if the given item is in bold state.
 460
 461 See also: \helpref{SetItemBold}{wxtreectrlsetitembold}
 462
 463 \membersection{wxTreeCtrl::IsExpanded}\label{wxtreectrlisexpanded}
 464
 465 \constfunc{bool}{IsExpanded}{\param{const wxTreeItemId\&}{ item}}
 466
 467 Returns TRUE if the item is expanded (only makes sense if it has children).
 468
 469 \membersection{wxTreeCtrl::IsSelected}\label{wxtreectrlisselected}
 470
 471 \constfunc{bool}{IsSelected}{\param{const wxTreeItemId\&}{ item}}
 472
 473 Returns TRUE if the item is selected.
 474
 475 \membersection{wxTreeCtrl::IsVisible}\label{wxtreectrlisvisible}
 476
 477 \constfunc{bool}{IsVisible}{\param{const wxTreeItemId\&}{ item}}
 478
 479 Returns TRUE if the item is visible (it might be outside the view, or not expanded).
 480
 481 \membersection{wxTreeCtrl::ItemHasChildren}\label{wxtreectrlitemhaschildren}
 482
 483 \constfunc{bool}{ItemHasChildren}{\param{const wxTreeItemId\&}{ item}}
 484
 485 Returns TRUE if the item has children.
 486
 487 \membersection{wxTreeCtrl::OnCompareItems}\label{wxtreectrloncompareitems}
 488
 489 \func{int}{OnCompareItems}{\param{const wxTreeItemId\& }{item1}, \param{const wxTreeItemId\& }{item2}}
 490
 491 Override this function in the derived class to change the sort order of the
 492 items in the tree control. The function should return a negative, zero or
 493 positive value if the first item is less than, equal to or greater than the
 494 second one.
 495
 496 The base class version compares items alphabetically.
 497
 498 See also: \helpref{SortChildren}{wxtreectrlsortchildren}
 499
 500 \membersection{wxTreeCtrl::PrependItem}\label{wxtreectrlprependitem}
 501
 502 \func{wxTreeItemId}{PrependItem}{\param{const wxTreeItemId\& }{parent}, \param{const wxString\&}{ text},
 503  \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = NULL}}
 504
 505 Appends an item as the first child of {\it parent}, return a new item id.
 506
 507 If {\it image} > -1 and {\it selImage} is -1, the same image is used for
 508 both selected and unselected items.
 509
 510 \membersection{wxTreeCtrl::ScrollTo}\label{wxtreectrlscrollto}
 511
 512 \func{void}{ScrollTo}{\param{const wxTreeItemId\&}{ item}}
 513
 514 Scrolls the specified item into view.
 515
 516 \membersection{wxTreeCtrl::SelectItem}\label{wxtreectrlselectitem}
 517
 518 \func{bool}{SelectItem}{\param{const wxTreeItemId\&}{ item}}
 519
 520 Selects the given item.
 521
 522 \membersection{wxTreeCtrl::SetIndent}\label{wxtreectrlsetindent}
 523
 524 \func{void}{SetIndent}{\param{int }{indent}}
 525
 526 Sets the indentation for the tree control.
 527
 528 \membersection{wxTreeCtrl::SetImageList}\label{wxtreectrlsetimagelist}
 529
 530 \func{void}{SetImageList}{\param{wxImageList*}{ imageList}, \param{int }{which = wxIMAGE\_LIST\_NORMAL}}
 531
 532 Sets the image list. {\it which} should be one of wxIMAGE\_LIST\_NORMAL, wxIMAGE\_LIST\_SMALL and
 533 wxIMAGE\_LIST\_STATE.
 534
 535 \membersection{wxTreeCtrl::SetItemBold}\label{wxtreectrlsetitembold}
 536
 537 \func{void}{SetItemBold}{\param{const wxTreeItemId\& }{item}, \param{bool}{ bold = TRUE}}
 538
 539 Makes item appear in bold font if {\it bold} parameter is TRUE or resets it to
 540 the normal state.
 541
 542 See also: \helpref{IsBold}{wxtreectrlisbold}
 543
 544 \membersection{wxTreeCtrl::SetItemData}\label{wxtreectrlsetitemdata}
 545
 546 \func{void}{SetItemData}{\param{const wxTreeItemId\&}{ item}, \param{wxTreeItemData* }{data}}
 547
 548 Sets the item client data.
 549
 550 \pythonnote{wxPython provides the following shortcut method:\par
 551 \indented{2cm}{\begin{twocollist}
 552 \twocolitem{\bf{SetPyData(item, obj)}}{Associate the given Python
 553 Object with the wxTreeItemData for the given item Id.}
 554 \end{twocollist}}
 555 }
 556
 557 \membersection{wxTreeCtrl::SetItemHasChildren}\label{wxtreectrlsetitemhaschildren}
 558
 559 \func{void}{SetItemHasChildren}{\param{const wxTreeItemId\&}{ item}, \param{bool }{hasChildren = TRUE}}
 560
 561 Force appearance of the button next to the item. This is useful to
 562 allow the user to expand the items which don't have any children now,
 563 but instead adding them only when needed, thus minimizing memory
 564 usage and loading time.
 565
 566 \membersection{wxTreeCtrl::SetItemImage}\label{wxtreectrlsetitemimage}
 567
 568 \func{void}{SetItemImage}{\param{const wxTreeItemId\&}{ item},
 569 \param{int }{image},
 570 \param{wxTreeItemIcon }{which = wxTreeItemIcon\_Normal}}
 571
 572 Sets the specified item image. See \helpref{GetItemImage}{wxtreectrlgetitemimage}
 573 for the description of {\it which} parameter.
 574
 575 \membersection{wxTreeCtrl::SetItemSelectedImage}\label{wxtreectrlsetitemselectedimage}
 576
 577 \func{void}{SetItemSelectedImage}{\param{const wxTreeItemId\&}{ item}, \param{int }{selImage}}
 578
 579 Sets the selected item image (this function is obsolete, use
 580 {\tt SetItemImage(item, wxTreeItemIcon\_Selected} instead).
 581
 582 \membersection{wxTreeCtrl::SetItemText}\label{wxtreectrlsetitemtext}
 583
 584 \func{void}{SetItemText}{\param{const wxTreeItemId\&}{ item}, \param{const wxString\& }{text}}
 585
 586 Sets the item label.
 587
 588 \membersection{wxTreeCtrl::SortChildren}\label{wxtreectrlsortchildren}
 589
 590 \func{void}{SortChildren}{\param{const wxTreeItemId\&}{ item}}
 591
 592 Sorts the children of the given item using
 593 \helpref{OnCompareItems}{wxtreectrloncompareitems} method of wxTreeCtrl. You
 594 should override that method to change the sort order (default is ascending
 595 alphabetical order).
 596
 597 \wxheading{See also}
 598
 599 \helpref{wxTreeItemData}{wxtreeitemdata}, \helpref{OnCompareItems}{wxtreectrloncompareitems}
 600
 601 \membersection{wxTreeCtrl::Toggle}\label{wxtreectrltoggle}
 602
 603 \func{void}{Toggle}{\param{const wxTreeItemId\&}{ item}}
 604
 605 Toggles the given item between collapsed and expanded states.
 606
 607 \membersection{wxTreeCtrl::Unselect}\label{wxtreectrlunselect}
 608
 609 \func{void}{Unselect}{\void}
 610
 611 Removes the selection from the currently selected item (if any).
 612
 613 \membersection{wxTreeCtrl::UnselectAll}\label{wxtreectrlunselectall}
 614
 615 \func{void}{UnselectAll}{\void}
 616
 617 This function either behaves the same as \helpref{Unselect}{wxtreectrlunselect}
 618 if the control doesn't have wxTR\_MULTIPLE style, or removes the selection from
 619 all items if it does have this style.
 620
 621 \section{\class{wxTreeItemData}}\label{wxtreeitemdata}
 622
 623 wxTreeItemData is some (arbitrary) user class associated with some item. The
 624 main advantage of having this class (compared to the old untyped interface) is
 625 that wxTreeItemData's are destroyed automatically by the tree and, as this
 626 class has virtual dtor, it means that the memory will be automatically
 627 freed. We don't just use wxObject instead of wxTreeItemData because
 628 the size of this class is critical: in any real application, each tree leaf
 629 will have wxTreeItemData associated with it and number of leaves may be
 630 quite big.
 631
 632 Because the objects of this class are deleted by the tree, they should
 633 always be allocated on the heap.
 634
 635 \wxheading{Derived from}
 636
 637 wxTreeItemId
 638
 639 \wxheading{Include files}
 640
 641 <wx/treectrl.h>
 642
 643 \wxheading{See also}
 644
 645 \helpref{wxTreeCtrl}{wxtreectrl}
 646
 647 \latexignore{\rtfignore{\wxheading{Members}}}
 648
 649 \membersection{wxTreeItemData::wxTreeItemData}\label{wxtreeitemdataconstr}
 650
 651 \func{}{wxTreeItemData}{\void}
 652
 653 Default constructor.
 654
 655 \pythonnote{The wxPython version of this constructor optionally
 656 accepts any Python object as a parameter.  This object is then
 657 associated with the tree item using the wxTreeItemData as a
 658 container.
 659
 660 In addition, the following methods are added in wxPython for accessing
 661 the object:\par
 662 \indented{2cm}{\begin{twocollist}
 663 \twocolitem{\bf{GetData()}}{Returns a reference to the Python Object}
 664 \twocolitem{\bf{SetData(obj)}}{Associates a new Python Object with the
 665 wxTreeItemData}
 666 \end{twocollist}}
 667 }
 668
 669
 670 \membersection{wxTreeItemData::\destruct{wxTreeItemData}}
 671
 672 \func{void}{\destruct{wxTreeItemData}}{\void}
 673
 674 Virtual destructor.
 675
 676 \membersection{wxTreeItemData::GetId}\label{wxtreeitemdatagetid}
 677
 678 \func{const wxTreeItem\&}{GetId}{\void}
 679
 680 Returns the item associated with this node.
 681
 682 \membersection{wxTreeItemData::SetId}\label{wxtreeitemdatasetid}
 683
 684 \func{void}{SetId}{\param{const wxTreeItemId\&}{ id}}
 685
 686 Sets the item associated with this node.
 687