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}{\void}
 259
 260 Returns the normal image list.
 261
 262 \membersection{wxTreeCtrl::GetIndent}\label{wxtreectrlgetindent}
 263
 264 \constfunc{int}{GetIndent}{\void}
 265
 266 Returns the current tree control indentation.
 267
 268 \membersection{wxTreeCtrl::GetItemData}\label{wxtreectrlgetitemdata}
 269
 270 \constfunc{wxTreeItemData*}{GetItemData}{\param{const wxTreeItemId\&}{ item}}
 271
 272 Returns the tree item data associated with the item.
 273
 274 \wxheading{See also}
 275
 276 \helpref{wxTreeItemData}{wxtreeitemdata}
 277
 278 \pythonnote{wxPython provides the following shortcut method:\par
 279 \indented{2cm}{\begin{twocollist}
 280 \twocolitem{{\bf GetPyData(item)}}{Returns the Python Object
 281 associated with the wxTreeItemData for the given item Id.}
 282 \end{twocollist}}
 283 }
 284
 285 \membersection{wxTreeCtrl::GetItemImage}\label{wxtreectrlgetitemimage}
 286
 287 \constfunc{int}{GetItemImage}{\param{const wxTreeItemId\& }{item},
 288 \param{wxTreeItemIcon }{which = wxTreeItemIcon\_Normal}}
 289
 290 Gets the specified item image. The value of {\it which} may be:
 291 \begin{itemize}\itemsep=0pt
 292 \item{wxTreeItemIcon\_Normal} to get the normal item image
 293 \item{wxTreeItemIcon\_Selected} to get the selected item image (i.e. the image
 294 which is shown when the item is currently selected)
 295 \item{wxTreeItemIcon\_Expanded} to get the expanded image (this only
 296 makes sense for items which have children - then this image is shown when the
 297 item is expanded and the normal image is shown when it is collapsed)
 298 \item{wxTreeItemIcon\_SelectedExpanded} to get the selected expanded image
 299 (which is shown when an expanded item is currently selected)
 300 \end{itemize}
 301
 302 \membersection{wxTreeCtrl::GetItemText}\label{wxtreectrlgetitemtext}
 303
 304 \constfunc{wxString}{GetItemText}{\param{const wxTreeItemId\&}{ item}}
 305
 306 Returns the item label.
 307
 308 \membersection{wxTreeCtrl::GetLastChild}\label{wxtreectrlgetlastchild}
 309
 310 \constfunc{wxTreeItemId}{GetLastChild}{\param{const wxTreeItemId\&}{ item}}
 311
 312 Returns the last child of the item (or an invalid tree item if this item has no children).
 313
 314 \wxheading{See also}
 315
 316 \helpref{GetFirstChild}{wxtreectrlgetfirstchild},
 317 \helpref{GetLastChild}{wxtreectrlgetlastchild}
 318
 319 \membersection{wxTreeCtrl::GetNextChild}\label{wxtreectrlgetnextchild}
 320
 321 \constfunc{wxTreeItemId}{GetNextChild}{\param{const wxTreeItemId\&}{ item}, \param{long\& }{cookie}}
 322
 323 Returns the next child; call \helpref{wxTreeCtrl::GetFirstChild}{wxtreectrlgetfirstchild} for the first child.
 324
 325 For this enumeration function you must pass in a `cookie' parameter
 326 which is opaque for the application but is necessary for the library
 327 to make these functions reentrant (i.e. allow more than one
 328 enumeration on one and the same object simultaneously). The cookie passed to
 329 GetFirstChild and GetNextChild should be the same.
 330
 331 Returns an invalid tree item if there are no further children.
 332
 333 \wxheading{See also}
 334
 335 \helpref{wxTreeCtrl::GetFirstChild}{wxtreectrlgetfirstchild}
 336
 337 \pythonnote{In wxPython the returned wxTreeItemId and the new cookie
 338 value are both returned as a tuple containing the two values.}
 339
 340 \membersection{wxTreeCtrl::GetNextSibling}\label{wxtreectrlgetnextsibling}
 341
 342 \constfunc{wxTreeItemId}{GetNextSibling}{\param{const wxTreeItemId\&}{ item}}
 343
 344 Returns the next sibling of the specified item; call \helpref{wxTreeCtrl::GetPrevSibling}{wxtreectrlgetprevsibling} for the previous sibling.
 345
 346 Returns an invalid tree item if there are no further siblings.
 347
 348 \wxheading{See also}
 349
 350 \helpref{wxTreeCtrl::GetPrevSibling}{wxtreectrlgetprevsibling}
 351
 352 \membersection{wxTreeCtrl::GetNextVisible}\label{wxtreectrlgetnextvisible}
 353
 354 \constfunc{wxTreeItemId}{GetNextVisible}{\param{const wxTreeItemId\&}{ item}}
 355
 356 Returns the next visible item.
 357
 358 \membersection{wxTreeCtrl::GetParent}\label{wxtreectrlgetparent}
 359
 360 \constfunc{wxTreeItemId}{GetParent}{\param{const wxTreeItemId\&}{ item}}
 361
 362 Returns the item's parent.
 363
 364 \pythonnote{This method is named {\tt GetItemParent} to avoid a name
 365 clash with wxWindow::GetParent.}
 366
 367 \membersection{wxTreeCtrl::GetPrevSibling}\label{wxtreectrlgetprevsibling}
 368
 369 \constfunc{wxTreeItemId}{GetPrevSibling}{\param{const wxTreeItemId\&}{ item}}
 370
 371 Returns the previous sibling of the specified item; call \helpref{wxTreeCtrl::GetNextSibling}{wxtreectrlgetnextsibling} for the next sibling.
 372
 373 Returns an invalid tree item if there are no further children.
 374
 375 \wxheading{See also}
 376
 377 \helpref{wxTreeCtrl::GetNextSibling}{wxtreectrlgetnextsibling}
 378
 379 \membersection{wxTreeCtrl::GetPrevVisible}\label{wxtreectrlgetprevvisible}
 380
 381 \constfunc{wxTreeItemId}{GetPrevVisible}{\param{const wxTreeItemId\&}{ item}}
 382
 383 Returns the previous visible item.
 384
 385 \membersection{wxTreeCtrl::GetRootItem}\label{wxtreectrlgetrootitem}
 386
 387 \constfunc{wxTreeItemId}{GetRootItem}{\void}
 388
 389 Returns the root item for the tree control.
 390
 391 \membersection{wxTreeCtrl::GetItemSelectedImage}\label{wxtreectrlgetitemselectedimage}
 392
 393 \constfunc{int}{GetItemSelectedImage}{\param{const wxTreeItemId\& }{item}}
 394
 395 Gets the selected item image (this function is obsolete, use
 396 {\tt GetItemImage(item, wxTreeItemIcon\_Selected} instead).
 397
 398 \membersection{wxTreeCtrl::GetSelection}\label{wxtreectrlgetselection}
 399
 400 \constfunc{wxTreeItemId}{GetSelection}{\void}
 401
 402 Returns the selection, or an invalid item if there is no selection.
 403 This function only works with the controls without wxTR\_MULTIPLE style, use
 404 \helpref{GetSelections}{wxtreectrlgetselections} for the controls which do have
 405 this style.
 406
 407 \membersection{wxTreeCtrl::GetSelections}\label{wxtreectrlgetselections}
 408
 409 \constfunc{size\_t}{GetSelections}{\param{wxArrayTreeItemIds\& }{selection}}
 410
 411 Fills the array of tree items passed in with the currently selected items. This
 412 function can be called only if the control has the wxTR\_MULTIPLE style.
 413
 414 Returns the number of selected items.
 415
 416 \pythonnote{The wxPython version of this method accepts no parameters
 417 and returns a Python list of {\tt wxTreeItemId}'s.}
 418
 419 \membersection{wxTreeCtrl::GetStateImageList}\label{wxtreectrlgetstateimagelist}
 420
 421 \constfunc{wxImageList*}{GetStateImageList}{\void}
 422
 423 Returns the state image list (from which application-defined state images are taken).
 424
 425 \membersection{wxTreeCtrl::HitTest}\label{wxtreectrlhittest}
 426
 427 \func{long}{HitTest}{\param{const wxPoint\& }{point}, \param{int\& }{flags}}
 428
 429 Calculates which (if any) item is under the given point, returning extra information
 430 in {\it flags}. {\it flags} is a bitlist of the following:
 431
 432 \twocolwidtha{5cm}
 433 \begin{twocollist}\itemsep=0pt
 434 \twocolitem{wxTREE\_HITTEST\_ABOVE}{Above the client area.}
 435 \twocolitem{wxTREE\_HITTEST\_BELOW}{Below the client area.}
 436 \twocolitem{wxTREE\_HITTEST\_NOWHERE}{In the client area but below the last item.}
 437 \twocolitem{wxTREE\_HITTEST\_ONITEMBUTTON}{On the button associated with an item.}
 438 \twocolitem{wxTREE\_HITTEST\_ONITEMICON}{On the bitmap associated with an item.}
 439 \twocolitem{wxTREE\_HITTEST\_ONITEMINDENT}{In the indentation associated with an item.}
 440 \twocolitem{wxTREE\_HITTEST\_ONITEMLABEL}{On the label (string) associated with an item.}
 441 \twocolitem{wxTREE\_HITTEST\_ONITEMRIGHT}{In the area to the right of an item.}
 442 \twocolitem{wxTREE\_HITTEST\_ONITEMSTATEICON}{On the state icon for a tree view item that is in a user-defined state.}
 443 \twocolitem{wxTREE\_HITTEST\_TOLEFT}{To the right of the client area.}
 444 \twocolitem{wxTREE\_HITTEST\_TORIGHT}{To the left of the client area.}
 445 \end{twocollist}
 446
 447 \membersection{wxTreeCtrl::InsertItem}\label{wxtreectrlinsertitem}
 448
 449 \func{wxTreeItemId}{InsertItem}{\param{const wxTreeItemId\& }{parent}, \param{const wxTreeItemId\& }{previous}, \param{const wxString\&}{ text},
 450  \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = NULL}}
 451
 452 \func{wxTreeItemId}{InsertItem}{\param{const wxTreeItemId\& }{parent}, \param{size\_t}{ before}, \param{const wxString\&}{ text},
 453  \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = NULL}}
 454
 455 Inserts an item after a given one ({\it previous}) or before one identified by its position ({\it before}).
 456
 457 If {\it image} > -1 and {\it selImage} is -1, the same image is used for
 458 both selected and unselected items.
 459
 460 \membersection{wxTreeCtrl::IsBold}\label{wxtreectrlisbold}
 461
 462 \constfunc{bool}{IsBold}{\param{const wxTreeItemId\& }{item}}
 463
 464 Returns TRUE if the given item is in bold state.
 465
 466 See also: \helpref{SetItemBold}{wxtreectrlsetitembold}
 467
 468 \membersection{wxTreeCtrl::IsExpanded}\label{wxtreectrlisexpanded}
 469
 470 \constfunc{bool}{IsExpanded}{\param{const wxTreeItemId\&}{ item}}
 471
 472 Returns TRUE if the item is expanded (only makes sense if it has children).
 473
 474 \membersection{wxTreeCtrl::IsSelected}\label{wxtreectrlisselected}
 475
 476 \constfunc{bool}{IsSelected}{\param{const wxTreeItemId\&}{ item}}
 477
 478 Returns TRUE if the item is selected.
 479
 480 \membersection{wxTreeCtrl::IsVisible}\label{wxtreectrlisvisible}
 481
 482 \constfunc{bool}{IsVisible}{\param{const wxTreeItemId\&}{ item}}
 483
 484 Returns TRUE if the item is visible (it might be outside the view, or not expanded).
 485
 486 \membersection{wxTreeCtrl::ItemHasChildren}\label{wxtreectrlitemhaschildren}
 487
 488 \constfunc{bool}{ItemHasChildren}{\param{const wxTreeItemId\&}{ item}}
 489
 490 Returns TRUE if the item has children.
 491
 492 \membersection{wxTreeCtrl::OnCompareItems}\label{wxtreectrloncompareitems}
 493
 494 \func{int}{OnCompareItems}{\param{const wxTreeItemId\& }{item1}, \param{const wxTreeItemId\& }{item2}}
 495
 496 Override this function in the derived class to change the sort order of the
 497 items in the tree control. The function should return a negative, zero or
 498 positive value if the first item is less than, equal to or greater than the
 499 second one.
 500
 501 The base class version compares items alphabetically.
 502
 503 See also: \helpref{SortChildren}{wxtreectrlsortchildren}
 504
 505 \membersection{wxTreeCtrl::PrependItem}\label{wxtreectrlprependitem}
 506
 507 \func{wxTreeItemId}{PrependItem}{\param{const wxTreeItemId\& }{parent}, \param{const wxString\&}{ text},
 508  \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = NULL}}
 509
 510 Appends an item as the first child of {\it parent}, return a new item id.
 511
 512 If {\it image} > -1 and {\it selImage} is -1, the same image is used for
 513 both selected and unselected items.
 514
 515 \membersection{wxTreeCtrl::ScrollTo}\label{wxtreectrlscrollto}
 516
 517 \func{void}{ScrollTo}{\param{const wxTreeItemId\&}{ item}}
 518
 519 Scrolls the specified item into view.
 520
 521 \membersection{wxTreeCtrl::SelectItem}\label{wxtreectrlselectitem}
 522
 523 \func{bool}{SelectItem}{\param{const wxTreeItemId\&}{ item}}
 524
 525 Selects the given item.
 526
 527 \membersection{wxTreeCtrl::SetIndent}\label{wxtreectrlsetindent}
 528
 529 \func{void}{SetIndent}{\param{int }{indent}}
 530
 531 Sets the indentation for the tree control.
 532
 533 \membersection{wxTreeCtrl::SetImageList}\label{wxtreectrlsetimagelist}
 534
 535 \func{void}{SetImageList}{\param{wxImageList*}{ imageList}}
 536
 537 Sets the normal image list.
 538
 539 \membersection{wxTreeCtrl::SetItemBackgroundColour}\label{wxtreectrlsetitembackgroundcolour}
 540
 541 \func{void}{SetItemBackgroundColour}{\param{const wxTreeItemId\&}{ item}, \param{const wxColour\& }{col}}
 542
 543 Sets the colour of the items background.
 544
 545 \membersection{wxTreeCtrl::SetItemBold}\label{wxtreectrlsetitembold}
 546
 547 \func{void}{SetItemBold}{\param{const wxTreeItemId\& }{item}, \param{bool}{ bold = TRUE}}
 548
 549 Makes item appear in bold font if {\it bold} parameter is TRUE or resets it to
 550 the normal state.
 551
 552 See also: \helpref{IsBold}{wxtreectrlisbold}
 553
 554 \membersection{wxTreeCtrl::SetItemData}\label{wxtreectrlsetitemdata}
 555
 556 \func{void}{SetItemData}{\param{const wxTreeItemId\&}{ item}, \param{wxTreeItemData* }{data}}
 557
 558 Sets the item client data.
 559
 560 \pythonnote{wxPython provides the following shortcut method:\par
 561 \indented{2cm}{\begin{twocollist}
 562 \twocolitem{{\bf SetPyData(item, obj)}}{Associate the given Python
 563 Object with the wxTreeItemData for the given item Id.}
 564 \end{twocollist}}
 565 }
 566
 567 \membersection{wxTreeCtrl::SetItemFont}\label{wxtreectrlsetitemfont}
 568
 569 \func{void}{SetItemFont}{\param{const wxTreeItemId\&}{ item}, \param{const wxFont\& }{font}}
 570
 571 Sets the items font. All items in the tree should have the same height to avoid
 572 text clipping, so the fonts height should be the same for all of them,
 573 although font attributes may vary.
 574
 575 \wxheading{See also}
 576
 577 \helpref{SetItemBold}{wxtreectrlsetitembold}
 578
 579 \membersection{wxTreeCtrl::SetItemHasChildren}\label{wxtreectrlsetitemhaschildren}
 580
 581 \func{void}{SetItemHasChildren}{\param{const wxTreeItemId\&}{ item}, \param{bool }{hasChildren = TRUE}}
 582
 583 Force appearance of the button next to the item. This is useful to
 584 allow the user to expand the items which don't have any children now,
 585 but instead adding them only when needed, thus minimizing memory
 586 usage and loading time.
 587
 588 \membersection{wxTreeCtrl::SetItemImage}\label{wxtreectrlsetitemimage}
 589
 590 \func{void}{SetItemImage}{\param{const wxTreeItemId\&}{ item},
 591 \param{int }{image},
 592 \param{wxTreeItemIcon }{which = wxTreeItemIcon\_Normal}}
 593
 594 Sets the specified item image. See \helpref{GetItemImage}{wxtreectrlgetitemimage}
 595 for the description of {\it which} parameter.
 596
 597 \membersection{wxTreeCtrl::SetItemSelectedImage}\label{wxtreectrlsetitemselectedimage}
 598
 599 \func{void}{SetItemSelectedImage}{\param{const wxTreeItemId\&}{ item}, \param{int }{selImage}}
 600
 601 Sets the selected item image (this function is obsolete, use
 602 {\tt SetItemImage(item, wxTreeItemIcon\_Selected} instead).
 603
 604 \membersection{wxTreeCtrl::SetItemText}\label{wxtreectrlsetitemtext}
 605
 606 \func{void}{SetItemText}{\param{const wxTreeItemId\&}{ item}, \param{const wxString\& }{text}}
 607
 608 Sets the item label.
 609
 610 \membersection{wxTreeCtrl::SetItemTextColour}\label{wxtreectrlsetitemtextcolour}
 611
 612 \func{void}{SetItemTextColour}{\param{const wxTreeItemId\&}{ item}, \param{const wxColour\& }{col}}
 613
 614 Sets the colour of the items text.
 615
 616 \membersection{wxTreeCtrl::SetStateImageList}\label{wxtreectrlsetstateimagelist}
 617
 618 \func{void}{SetStateImageList}{\param{wxImageList*}{ imageList}}
 619
 620 Sets the state image list (from which application-defined state images are taken).
 621
 622 \membersection{wxTreeCtrl::SortChildren}\label{wxtreectrlsortchildren}
 623
 624 \func{void}{SortChildren}{\param{const wxTreeItemId\&}{ item}}
 625
 626 Sorts the children of the given item using
 627 \helpref{OnCompareItems}{wxtreectrloncompareitems} method of wxTreeCtrl. You
 628 should override that method to change the sort order (default is ascending
 629 alphabetical order).
 630
 631 \wxheading{See also}
 632
 633 \helpref{wxTreeItemData}{wxtreeitemdata}, \helpref{OnCompareItems}{wxtreectrloncompareitems}
 634
 635 \membersection{wxTreeCtrl::Toggle}\label{wxtreectrltoggle}
 636
 637 \func{void}{Toggle}{\param{const wxTreeItemId\&}{ item}}
 638
 639 Toggles the given item between collapsed and expanded states.
 640
 641 \membersection{wxTreeCtrl::Unselect}\label{wxtreectrlunselect}
 642
 643 \func{void}{Unselect}{\void}
 644
 645 Removes the selection from the currently selected item (if any).
 646
 647 \membersection{wxTreeCtrl::UnselectAll}\label{wxtreectrlunselectall}
 648
 649 \func{void}{UnselectAll}{\void}
 650
 651 This function either behaves the same as \helpref{Unselect}{wxtreectrlunselect}
 652 if the control doesn't have wxTR\_MULTIPLE style, or removes the selection from
 653 all items if it does have this style.
 654
 655 \section{\class{wxTreeItemData}}\label{wxtreeitemdata}
 656
 657 wxTreeItemData is some (arbitrary) user class associated with some item. The
 658 main advantage of having this class (compared to the old untyped interface) is
 659 that wxTreeItemData's are destroyed automatically by the tree and, as this
 660 class has virtual dtor, it means that the memory will be automatically
 661 freed. We don't just use wxObject instead of wxTreeItemData because
 662 the size of this class is critical: in any real application, each tree leaf
 663 will have wxTreeItemData associated with it and number of leaves may be
 664 quite big.
 665
 666 Because the objects of this class are deleted by the tree, they should
 667 always be allocated on the heap.
 668
 669 \wxheading{Derived from}
 670
 671 wxTreeItemId
 672
 673 \wxheading{Include files}
 674
 675 <wx/treectrl.h>
 676
 677 \wxheading{See also}
 678
 679 \helpref{wxTreeCtrl}{wxtreectrl}
 680
 681 \latexignore{\rtfignore{\wxheading{Members}}}
 682
 683 \membersection{wxTreeItemData::wxTreeItemData}\label{wxtreeitemdataconstr}
 684
 685 \func{}{wxTreeItemData}{\void}
 686
 687 Default constructor.
 688
 689 \pythonnote{The wxPython version of this constructor optionally
 690 accepts any Python object as a parameter.  This object is then
 691 associated with the tree item using the wxTreeItemData as a
 692 container.
 693
 694 In addition, the following methods are added in wxPython for accessing
 695 the object:\par
 696 \indented{2cm}{\begin{twocollist}
 697 \twocolitem{{\bf GetData()}}{Returns a reference to the Python Object}
 698 \twocolitem{{\bf SetData(obj)}}{Associates a new Python Object with the
 699 wxTreeItemData}
 700 \end{twocollist}}
 701 }
 702
 703
 704 \membersection{wxTreeItemData::\destruct{wxTreeItemData}}
 705
 706 \func{void}{\destruct{wxTreeItemData}}{\void}
 707
 708 Virtual destructor.
 709
 710 \membersection{wxTreeItemData::GetId}\label{wxtreeitemdatagetid}
 711
 712 \func{const wxTreeItem\&}{GetId}{\void}
 713
 714 Returns the item associated with this node.
 715
 716 \membersection{wxTreeItemData::SetId}\label{wxtreeitemdatasetid}
 717
 718 \func{void}{SetId}{\param{const wxTreeItemId\&}{ id}}
 719
 720 Sets the item associated with this node.
 721