interface/wx/treectrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        treectrl.h
   3 // Purpose:     interface of wxTreeItemData
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9
  10 /**
  11     @class wxTreeCtrl
  12
  13     A tree control presents information as a hierarchy, with items that may be
  14     expanded to show further items. Items in a tree control are referenced by
  15     wxTreeItemId handles, which may be tested for validity by calling
  16     wxTreeItemId::IsOk().
  17
  18     A similar control with a fully native implemtation for GTK+ and OS X
  19     as well is wxDataViewTreeCtrl.
  20
  21     To intercept events from a tree control, use the event table macros
  22     described in wxTreeEvent.
  23
  24     @beginStyleTable
  25     @style{wxTR_EDIT_LABELS}
  26         Use this style if you wish the user to be able to edit labels in the
  27         tree control.
  28     @style{wxTR_NO_BUTTONS}
  29         For convenience to document that no buttons are to be drawn.
  30     @style{wxTR_HAS_BUTTONS}
  31         Use this style to show + and - buttons to the left of parent items.
  32     @style{wxTR_NO_LINES}
  33         Use this style to hide vertical level connectors.
  34     @style{wxTR_FULL_ROW_HIGHLIGHT}
  35         Use this style to have the background colour and the selection highlight
  36         extend over the entire horizontal row of the tree control window. (This
  37         flag is ignored under Windows unless you specify @c wxTR_NO_LINES as
  38         well.)
  39     @style{wxTR_LINES_AT_ROOT}
  40         Use this style to show lines between root nodes. Only applicable if @c
  41         wxTR_HIDE_ROOT is set and @c wxTR_NO_LINES is not set.
  42     @style{wxTR_HIDE_ROOT}
  43         Use this style to suppress the display of the root node, effectively
  44         causing the first-level nodes to appear as a series of root nodes.
  45     @style{wxTR_ROW_LINES}
  46         Use this style to draw a contrasting border between displayed rows.
  47     @style{wxTR_HAS_VARIABLE_ROW_HEIGHT}
  48         Use this style to cause row heights to be just big enough to fit the
  49         content. If not set, all rows use the largest row height. The default is
  50         that this flag is unset. Generic only.
  51     @style{wxTR_SINGLE}
  52         For convenience to document that only one item may be selected at a
  53         time. Selecting another item causes the current selection, if any, to be
  54         deselected. This is the default.
  55     @style{wxTR_MULTIPLE}
  56         Use this style to allow a range of items to be selected. If a second
  57         range is selected, the current range, if any, is deselected.
  58     @style{wxTR_DEFAULT_STYLE}
  59         The set of flags that are closest to the defaults for the native control
  60         for a particular toolkit.
  61     @endStyleTable
  62
  63     @beginEventEmissionTable{wxTreeEvent}
  64     @event{EVT_TREE_BEGIN_DRAG(id, func)}
  65           Begin dragging with the left mouse button.
  66           If you want to enable left-dragging you need to intercept this event
  67           and explicitely call wxTreeEvent::Allow(), as it's vetoed by default.
  68     @event{EVT_TREE_BEGIN_RDRAG(id, func)}
  69           Begin dragging with the right mouse button.
  70           If you want to enable right-dragging you need to intercept this event
  71           and explicitely call wxTreeEvent::Allow(), as it's vetoed by default.
  72     @event{EVT_TREE_END_DRAG(id, func)}
  73           End dragging with the left or right mouse button.
  74     @event{EVT_TREE_BEGIN_LABEL_EDIT(id, func)}
  75           Begin editing a label. This can be prevented by calling Veto().
  76     @event{EVT_TREE_END_LABEL_EDIT(id, func)}
  77           Finish editing a label. This can be prevented by calling Veto().
  78     @event{EVT_TREE_DELETE_ITEM(id, func)}
  79           An item was deleted.
  80     @event{EVT_TREE_GET_INFO(id, func)}
  81           Request information from the application.
  82     @event{EVT_TREE_SET_INFO(id, func)}
  83           Information is being supplied.
  84     @event{EVT_TREE_ITEM_ACTIVATED(id, func)}
  85           The item has been activated, i.e. chosen by double clicking it with
  86           mouse or from keyboard.
  87     @event{EVT_TREE_ITEM_COLLAPSED(id, func)}
  88           The item has been collapsed.
  89     @event{EVT_TREE_ITEM_COLLAPSING(id, func)}
  90           The item is being collapsed. This can be prevented by calling Veto().
  91     @event{EVT_TREE_ITEM_EXPANDED(id, func)}
  92           The item has been expanded.
  93     @event{EVT_TREE_ITEM_EXPANDING(id, func)}
  94           The item is being expanded. This can be prevented by calling Veto().
  95     @event{EVT_TREE_ITEM_RIGHT_CLICK(id, func)}
  96           The user has clicked the item with the right mouse button.
  97     @event{EVT_TREE_ITEM_MIDDLE_CLICK(id, func)}
  98           The user has clicked the item with the middle mouse button.
  99     @event{EVT_TREE_SEL_CHANGED(id, func)}
 100           Selection has changed.
 101     @event{EVT_TREE_SEL_CHANGING(id, func)}
 102           Selection is changing. This can be prevented by calling Veto().
 103     @event{EVT_TREE_KEY_DOWN(id, func)}
 104           A key has been pressed.
 105     @event{EVT_TREE_ITEM_GETTOOLTIP(id, func)}
 106           The opportunity to set the item tooltip is being given to the application
 107           (call wxTreeEvent::SetToolTip). Windows only.
 108     @event{EVT_TREE_ITEM_MENU(id, func)}
 109           The context menu for the selected item has been requested, either by a
 110           right click or by using the menu key.
 111     @event{EVT_TREE_STATE_IMAGE_CLICK(id, func)}
 112           The state image has been clicked. Windows only.
 113     @endEventTable
 114
 115
 116     See also @ref overview_windowstyles.
 117
 118     @b Win32 @b notes:
 119
 120     wxTreeCtrl class uses the standard common treeview control under Win32
 121     implemented in the system library comctl32.dll. Some versions of this
 122     library are known to have bugs with handling the tree control colours: the
 123     usual symptom is that the expanded items leave black (or otherwise
 124     incorrectly coloured) background behind them, especially for the controls
 125     using non-default background colour. The recommended solution is to upgrade
 126     the comctl32.dll to a newer version: see
 127     http://www.microsoft.com/downloads/details.aspx?familyid=cb2cf3a2-8025-4e8f-8511-9b476a8d35d2
 128
 129     @library{wxcore}
 130     @category{ctrl}
 131     @appearance{treectrl.png}
 132
 133     @see wxDataViewTreeCtrl, wxTreeEvent, wxTreeItemData, @ref overview_treectrl,
 134          wxListBox, wxListCtrl, wxImageList
 135 */
 136 class wxTreeCtrl : public wxControl
 137 {
 138 public:
 139     /**
 140         Default Constructor.
 141     */
 142     wxTreeCtrl();
 143
 144     /**
 145         Constructor, creating and showing a tree control.
 146
 147         @param parent
 148             Parent window. Must not be @NULL.
 149         @param id
 150             Window identifier. The value @c wxID_ANY indicates a default value.
 151         @param pos
 152             Window position.
 153             If ::wxDefaultPosition is specified then a default position is chosen.
 154         @param size
 155             Window size.
 156             If ::wxDefaultSize is specified then the window is sized appropriately.
 157         @param style
 158             Window style. See wxTreeCtrl.
 159         @param validator
 160             Window validator.
 161         @param name
 162             Window name.
 163
 164         @see Create(), wxValidator
 165     */
 166     wxTreeCtrl(wxWindow* parent, wxWindowID id = wxID_ANY,
 167                const wxPoint& pos = wxDefaultPosition,
 168                const wxSize& size = wxDefaultSize,
 169                long style = wxTR_DEFAULT_STYLE,
 170                const wxValidator& validator = wxDefaultValidator,
 171                const wxString& name = wxTreeCtrlNameStr);
 172
 173
 174     /**
 175         Destructor, destroying the tree control.
 176     */
 177     virtual ~wxTreeCtrl();
 178
 179     /**
 180         Adds the root node to the tree, returning the new item.
 181
 182         The @a image and @a selImage parameters are an index within the normal
 183         image list specifying the image to use for unselected and selected
 184         items, respectively. If @a image -1 and @a selImage is -1, the same
 185         image is used for both selected and unselected items.
 186     */
 187     virtual wxTreeItemId AddRoot(const wxString& text, int image = -1,
 188                                  int selImage = -1,
 189                                  wxTreeItemData* data = NULL);
 190
 191     /**
 192         Appends an item to the end of the branch identified by @a parent, return
 193         a new item id.
 194
 195         The @a image and @a selImage parameters are an index within the normal
 196         image list specifying the image to use for unselected and selected
 197         items, respectively. If @a image -1 and @a selImage is -1, the same
 198         image is used for both selected and unselected items.
 199     */
 200     wxTreeItemId AppendItem(const wxTreeItemId& parent,
 201                             const wxString& text,
 202                             int image = -1,
 203                             int selImage = -1,
 204                             wxTreeItemData* data = NULL);
 205
 206     /**
 207         Sets the buttons image list. The button images assigned with this method
 208         will be automatically deleted by wxTreeCtrl as appropriate (i.e. it
 209         takes ownership of the list).
 210
 211         Setting or assigning the button image list enables the display of image
 212         buttons. Once enabled, the only way to disable the display of button
 213         images is to set the button image list to @NULL.
 214
 215         This function is only available in the generic version.
 216
 217         @see SetButtonsImageList().
 218     */
 219     void AssignButtonsImageList(wxImageList* imageList);
 220
 221     /**
 222         Sets the normal image list. The image list assigned with this method
 223         will be automatically deleted by wxTreeCtrl as appropriate (i.e. it
 224         takes ownership of the list).
 225
 226         @see SetImageList().
 227     */
 228     void AssignImageList(wxImageList* imageList);
 229
 230     /**
 231         Sets the state image list. Image list assigned with this method will be
 232         automatically deleted by wxTreeCtrl as appropriate (i.e. it takes
 233         ownership of the list).
 234
 235         @see SetStateImageList().
 236     */
 237     void AssignStateImageList(wxImageList* imageList);
 238
 239     /**
 240         Collapses the given item.
 241     */
 242     virtual void Collapse(const wxTreeItemId& item);
 243
 244     /**
 245         Collapses the root item.
 246
 247         @see ExpandAll()
 248     */
 249     void CollapseAll();
 250
 251     /**
 252         Collapses this item and all of its children, recursively.
 253
 254         @see ExpandAllChildren()
 255     */
 256     void CollapseAllChildren(const wxTreeItemId& item);
 257
 258     /**
 259         Collapses the given item and removes all children.
 260     */
 261     virtual void CollapseAndReset(const wxTreeItemId& item);
 262
 263     /**
 264         Creates the tree control.
 265         See wxTreeCtrl::wxTreeCtrl() for further details.
 266     */
 267     bool Create(wxWindow* parent, wxWindowID id = wxID_ANY,
 268                 const wxPoint& pos = wxDefaultPosition,
 269                 const wxSize& size = wxDefaultSize,
 270                 long style = wxTR_DEFAULT_STYLE,
 271                 const wxValidator& validator = wxDefaultValidator,
 272                 const wxString& name = wxTreeCtrlNameStr);
 273
 274     /**
 275         Deletes the specified item. A @c EVT_TREE_DELETE_ITEM event will be
 276         generated.
 277
 278         This function may cause a subsequent call to GetNextChild() to fail.
 279     */
 280     virtual void Delete(const wxTreeItemId& item);
 281
 282     /**
 283         Deletes all items in the control. Note that this may not generate
 284         @c EVT_TREE_DELETE_ITEM events under some Windows versions although
 285         normally such event is generated for each removed item.
 286     */
 287     virtual void DeleteAllItems();
 288
 289     /**
 290         Deletes all children of the given item (but not the item itself). Note
 291         that this will @b not generate any events unlike Delete() method.
 292
 293         If you have called SetItemHasChildren(), you may need to call it again
 294         since DeleteChildren() does not automatically clear the setting.
 295     */
 296     virtual void DeleteChildren(const wxTreeItemId& item);
 297
 298     /**
 299         Starts editing the label of the given @a item. This function generates a
 300         @c EVT_TREE_BEGIN_LABEL_EDIT event which can be vetoed so that no text
 301         control will appear for in-place editing.
 302
 303         If the user changed the label (i.e. s/he does not press ESC or leave the
 304         text control without changes, a @c EVT_TREE_END_LABEL_EDIT event will be
 305         sent which can be vetoed as well.
 306
 307         @see EndEditLabel(), wxTreeEvent
 308     */
 309     virtual wxTextCtrl *EditLabel(const wxTreeItemId& item,
 310                                   wxClassInfo* textCtrlClass = CLASSINFO(wxTextCtrl));
 311
 312     /**
 313         Ends label editing. If @a cancelEdit is @true, the edit will be
 314         cancelled.
 315
 316         @note
 317             This function is currently supported under Windows only.
 318
 319         @see EditLabel()
 320     */
 321     virtual void EndEditLabel(const wxTreeItemId& item, bool discardChanges = false);
 322
 323     /**
 324         Scrolls and/or expands items to ensure that the given item is visible.
 325     */
 326     virtual void EnsureVisible(const wxTreeItemId& item);
 327
 328     /**
 329         Expands the given item.
 330     */
 331     virtual void Expand(const wxTreeItemId& item);
 332
 333     /**
 334         Expands all items in the tree.
 335     */
 336     void ExpandAll();
 337
 338     /**
 339         Expands the given item and all its children recursively.
 340     */
 341     void ExpandAllChildren(const wxTreeItemId& item);
 342
 343     /**
 344         Retrieves the rectangle bounding the @a item. If @a textOnly is @true,
 345         only the rectangle around the item's label will be returned, otherwise
 346         the item's image is also taken into account.
 347
 348         The return value is @true if the rectangle was successfully retrieved or
 349         @c @false if it was not (in this case @a rect is not changed) -- for
 350         example, if the item is currently invisible.
 351
 352         Notice that the rectangle coordinates are logical, not physical ones.
 353         So, for example, the x coordinate may be negative if the tree has a
 354         horizontal scrollbar and its position is not 0.
 355
 356         @beginWxPythonOnly
 357         The wxPython version of this method requires only the @a item and @a
 358         textOnly parameters. The return value is either a wxRect object or @c
 359         None.
 360         @endWxPythonOnly
 361
 362         @beginWxPerlOnly
 363         In wxPerl this method only takes the @a item and
 364         @a textOnly parameters and returns a @c Wx::Rect (or @c undef).
 365         @endWxPerlOnly
 366     */
 367     virtual bool GetBoundingRect(const wxTreeItemId& item, wxRect& rect,
 368                                  bool textOnly = false) const;
 369
 370     /**
 371         Returns the buttons image list (from which application-defined button
 372         images are taken).
 373
 374         This function is only available in the generic version.
 375     */
 376     wxImageList* GetButtonsImageList() const;
 377
 378     /**
 379         Returns the number of items in the branch. If @a recursively is @true,
 380         returns the total number of descendants, otherwise only one level of
 381         children is counted.
 382     */
 383     virtual size_t GetChildrenCount(const wxTreeItemId& item,
 384                                     bool recursively = true) const;
 385
 386     /**
 387         Returns the number of items in the control.
 388     */
 389     virtual unsigned int GetCount() const;
 390
 391     /**
 392         Returns the edit control being currently used to edit a label. Returns
 393         @NULL if no label is being edited.
 394
 395         @note This is currently only implemented for wxMSW.
 396     */
 397     virtual wxTextCtrl* GetEditControl() const;
 398
 399     /**
 400         Returns the first child; call GetNextChild() for the next child.
 401
 402         For this enumeration function you must pass in a 'cookie' parameter
 403         which is opaque for the application but is necessary for the library to
 404         make these functions reentrant (i.e. allow more than one enumeration on
 405         one and the same object simultaneously). The cookie passed to
 406         GetFirstChild() and GetNextChild() should be the same variable.
 407
 408         Returns an invalid tree item (i.e. wxTreeItemId::IsOk() returns @false)
 409         if there are no further children.
 410
 411         @beginWxPythonOnly
 412         In wxPython the returned wxTreeItemId and the new cookie value are both
 413         returned as a tuple containing the two values.
 414         @endWxPythonOnly
 415
 416         @beginWxPerlOnly
 417         In wxPerl this method only takes the @a item parameter, and
 418         returns a 2-element list (item, cookie).
 419         @endWxPerlOnly
 420
 421         @see GetNextChild(), GetNextSibling()
 422     */
 423     virtual wxTreeItemId GetFirstChild(const wxTreeItemId& item,
 424                                        wxTreeItemIdValue& cookie) const;
 425
 426     /**
 427         Returns the first visible item.
 428     */
 429     virtual wxTreeItemId GetFirstVisibleItem() const;
 430
 431     /**
 432         Returns the item last clicked or otherwise selected.
 433         Unlike GetSelection(), it can be used whether or not
 434         the control has the @c wxTR_MULTIPLE style.
 435
 436         @since 2.9.1
 437     */
 438     virtual wxTreeItemId GetFocusedItem() const;
 439
 440
 441     /**
 442         Clears the currently focused item
 443
 444         @since 2.9.1
 445     */
 446     virtual void ClearFocusedItem();
 447
 448     /**
 449         Sets the currently focused item.
 450
 451         @param item
 452             The item to make the current one. It must be valid.
 453         @since 2.9.1
 454     */
 455     virtual void SetFocusedItem(const wxTreeItemId& item);
 456
 457
 458     /**
 459         Returns the normal image list.
 460     */
 461     wxImageList* GetImageList() const;
 462
 463     /**
 464         Returns the current tree control indentation.
 465     */
 466     virtual unsigned int GetIndent() const;
 467
 468     /**
 469         Returns the background colour of the item.
 470     */
 471     virtual wxColour GetItemBackgroundColour(const wxTreeItemId& item) const;
 472
 473     /**
 474         Returns the tree item data associated with the item.
 475
 476         @see wxTreeItemData
 477
 478         @beginWxPythonOnly
 479         wxPython provides the following shortcut method:
 480         @li GetPyData(item): Returns the Python Object associated with the
 481             wxTreeItemData for the given item Id.
 482         @endWxPythonOnly
 483
 484         @beginWxPerlOnly
 485         wxPerl provides the following shortcut method:
 486         - GetPlData(item): returns the Perl data
 487           associated with the Wx::TreeItemData. It is just the same as
 488           tree->GetItemData(item)->GetData().
 489         @endWxPerlOnly
 490     */
 491     virtual wxTreeItemData* GetItemData(const wxTreeItemId& item) const;
 492
 493     /**
 494         Returns the font of the item label.
 495     */
 496     virtual wxFont GetItemFont(const wxTreeItemId& item) const;
 497
 498     /**
 499         Gets the specified item image. The value of @a which may be:
 500         - ::wxTreeItemIcon_Normal: to get the normal item image.
 501         - ::wxTreeItemIcon_Selected: to get the selected item image (i.e. the
 502             image which is shown when the item is currently selected).
 503         - ::wxTreeItemIcon_Expanded: to get the expanded image (this only makes
 504             sense for items which have children - then this image is shown when
 505             the item is expanded and the normal image is shown when it is
 506             collapsed).
 507         - ::wxTreeItemIcon_SelectedExpanded: to get the selected expanded image
 508             (which is shown when an expanded item is currently selected).
 509     */
 510     virtual int GetItemImage(const wxTreeItemId& item,
 511                              wxTreeItemIcon which = wxTreeItemIcon_Normal) const;
 512
 513     /**
 514         Returns the item's parent.
 515     */
 516     virtual wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
 517
 518     /**
 519         Gets the specified item state.
 520     */
 521     int GetItemState(const wxTreeItemId& item) const;
 522
 523     /**
 524         Returns the item label.
 525     */
 526     virtual wxString GetItemText(const wxTreeItemId& item) const;
 527
 528     /**
 529         Returns the colour of the item label.
 530     */
 531     virtual wxColour GetItemTextColour(const wxTreeItemId& item) const;
 532
 533     /**
 534         Returns the last child of the item (or an invalid tree item if this item
 535         has no children).
 536
 537         @see GetFirstChild(), GetNextSibling(), GetLastChild()
 538     */
 539     virtual wxTreeItemId GetLastChild(const wxTreeItemId& item) const;
 540
 541     /**
 542         Returns the next child; call GetFirstChild() for the first child. For
 543         this enumeration function you must pass in a 'cookie' parameter which is
 544         opaque for the application but is necessary for the library to make
 545         these functions reentrant (i.e. allow more than one enumeration on one
 546         and the same object simultaneously). The cookie passed to
 547         GetFirstChild() and GetNextChild() should be the same.
 548
 549         Returns an invalid tree item if there are no further children.
 550
 551         @beginWxPythonOnly
 552         In wxPython the returned wxTreeItemId and the new cookie value are both
 553         returned as a tuple containing the two values.
 554         @endWxPythonOnly
 555
 556         @beginWxPerlOnly
 557         In wxPerl this method returns a 2-element list
 558         (item, cookie) instead of modifying its parameters.
 559         @endWxPerlOnly
 560
 561         @see GetFirstChild()
 562     */
 563     virtual wxTreeItemId GetNextChild(const wxTreeItemId& item,
 564                                       wxTreeItemIdValue& cookie) const;
 565
 566     /**
 567         Returns the next sibling of the specified item; call GetPrevSibling()
 568         for the previous sibling.
 569
 570         Returns an invalid tree item if there are no further siblings.
 571
 572         @see GetPrevSibling()
 573     */
 574     virtual wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;
 575
 576     /**
 577         Returns the next visible item or an invalid item if this item is the
 578         last visible one.
 579
 580         @note The @a item itself must be visible.
 581     */
 582     virtual wxTreeItemId GetNextVisible(const wxTreeItemId& item) const;
 583
 584     /**
 585         Returns the previous sibling of the specified item; call
 586         GetNextSibling() for the next sibling.
 587
 588         Returns an invalid tree item if there are no further children.
 589
 590         @see GetNextSibling()
 591     */
 592     virtual wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const;
 593
 594     /**
 595         Returns the previous visible item or an invalid item if this item is the
 596         first visible one.
 597
 598         @note The @a item itself must be visible.
 599     */
 600     virtual wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
 601
 602     /**
 603         Returns @true if the control will use a quick calculation for the best
 604         size, looking only at the first and last items. The default is @false.
 605
 606         @see SetQuickBestSize()
 607     */
 608     bool GetQuickBestSize() const;
 609
 610     /**
 611         Returns the root item for the tree control.
 612     */
 613     virtual wxTreeItemId GetRootItem() const;
 614
 615     /**
 616         Returns the selection, or an invalid item if there is no selection. This
 617         function only works with the controls without @c wxTR_MULTIPLE style,
 618         use GetSelections() for the controls which do have this style
 619         or, if a single item is wanted, use GetFocusedItem().
 620     */
 621     virtual wxTreeItemId GetSelection() const;
 622
 623     /**
 624         Fills the array of tree items passed in with the currently selected
 625         items. This function can be called only if the control has the @c
 626         wxTR_MULTIPLE style.
 627
 628         Returns the number of selected items.
 629
 630         @beginWxPythonOnly
 631         The wxPython version of this method accepts no parameters and returns a
 632         Python list of @ref wxTreeItemId "wxTreeItemId"s.
 633         @endWxPythonOnly
 634
 635         @beginWxPerlOnly
 636         In wxPerl this method takes no parameters and returns a list of
 637         @c Wx::TreeItemId.
 638         @endWxPerlOnly
 639     */
 640     virtual size_t GetSelections(wxArrayTreeItemIds& selection) const;
 641
 642     /**
 643         Returns the state image list (from which application-defined state
 644         images are taken).
 645     */
 646     wxImageList* GetStateImageList() const;
 647
 648     /**
 649         Calculates which (if any) item is under the given @a point, returning
 650         the tree item id at this point plus extra information @a flags. @a flags
 651         is a bitlist of the following:
 652
 653         - @c wxTREE_HITTEST_ABOVE: Above the client area.
 654         - @c wxTREE_HITTEST_BELOW: Below the client area.
 655         - @c wxTREE_HITTEST_NOWHERE: In the client area but below the last item.
 656         - @c wxTREE_HITTEST_ONITEMBUTTON: On the button associated with an item.
 657         - @c wxTREE_HITTEST_ONITEMICON: On the bitmap associated with an item.
 658         - @c wxTREE_HITTEST_ONITEMINDENT: In the indentation associated with an item.
 659         - @c wxTREE_HITTEST_ONITEMLABEL: On the label (string) associated with an item.
 660         - @c wxTREE_HITTEST_ONITEMRIGHT: In the area to the right of an item.
 661         - @c wxTREE_HITTEST_ONITEMSTATEICON: On the state icon for a tree view
 662           item that is in a user-defined state.
 663         - @c wxTREE_HITTEST_TOLEFT: To the right of the client area.
 664         - @c wxTREE_HITTEST_TORIGHT: To the left of the client area.
 665
 666         @beginWxPythonOnly
 667         In wxPython both the wxTreeItemId and the flags are returned as a tuple.
 668         @endWxPythonOnly
 669
 670         @beginWxPerlOnly
 671         In wxPerl this method only takes the @a point parameter
 672         and returns a 2-element list (item, flags).
 673         @endWxPerlOnly
 674     */
 675     wxTreeItemId HitTest(const wxPoint& point, int& flags) const;
 676
 677
 678     /**
 679         Inserts an item after a given one (@a previous).
 680
 681         The @a image and @a selImage parameters are an index within the normal
 682         image list specifying the image to use for unselected and selected
 683         items, respectively. If @a image -1 and @a selImage is -1, the same
 684         image is used for both selected and unselected items.
 685     */
 686     wxTreeItemId InsertItem(const wxTreeItemId& parent,
 687                             const wxTreeItemId& previous,
 688                             const wxString& text,
 689                             int image = -1,
 690                             int selImage = -1,
 691                             wxTreeItemData* data = NULL);
 692
 693     /**
 694         Inserts an item before one identified
 695         by its position (@a before). @a before must be less than the number of
 696         children.
 697
 698         The @a image and @a selImage parameters are an index within the normal
 699         image list specifying the image to use for unselected and selected
 700         items, respectively. If @a image -1 and @a selImage is -1, the same
 701         image is used for both selected and unselected items.
 702
 703         @beginWxPythonOnly
 704         In wxPython, this form of this method is called @c InsertItemBefore().
 705         @endWxPythonOnly
 706     */
 707     wxTreeItemId InsertItem(const wxTreeItemId& parent,
 708                             size_t before,
 709                             const wxString& text,
 710                             int image = -1,
 711                             int selImage = -1,
 712                             wxTreeItemData* data = NULL);
 713
 714     /**
 715         Returns @true if the given item is in bold state.
 716
 717         @see SetItemBold()
 718     */
 719     virtual bool IsBold(const wxTreeItemId& item) const;
 720
 721     /**
 722         Returns @true if the control is empty (i.e. has no items, even no root
 723         one).
 724     */
 725     bool IsEmpty() const;
 726
 727     /**
 728         Returns @true if the item is expanded (only makes sense if it has
 729         children).
 730     */
 731     virtual bool IsExpanded(const wxTreeItemId& item) const;
 732
 733     /**
 734         Returns @true if the item is selected.
 735     */
 736     virtual bool IsSelected(const wxTreeItemId& item) const;
 737
 738     /**
 739         Returns @true if the item is visible on the screen.
 740     */
 741     virtual bool IsVisible(const wxTreeItemId& item) const;
 742
 743     /**
 744         Returns @true if the item has children.
 745     */
 746     virtual bool ItemHasChildren(const wxTreeItemId& item) const;
 747
 748     /**
 749         Override this function in the derived class to change the sort order of
 750         the items in the tree control. The function should return a negative,
 751         zero or positive value if the first item is less than, equal to or
 752         greater than the second one.
 753
 754         Please note that you @b must use wxRTTI macros DECLARE_DYNAMIC_CLASS()
 755         and IMPLEMENT_DYNAMIC_CLASS() if you override this function because
 756         otherwise the base class considers that it is not overridden and uses
 757         the default comparison, i.e. sorts the items alphabetically, which
 758         allows it optimize away the calls to the virtual function completely.
 759
 760         @see SortChildren()
 761     */
 762     virtual int OnCompareItems(const wxTreeItemId& item1,
 763                                const wxTreeItemId& item2);
 764
 765     /**
 766         Appends an item as the first child of @a parent, return a new item id.
 767
 768         The @a image and @a selImage parameters are an index within the normal
 769         image list specifying the image to use for unselected and selected
 770         items, respectively. If @a image -1 and @a selImage is -1, the same
 771         image is used for both selected and unselected items.
 772     */
 773     wxTreeItemId PrependItem(const wxTreeItemId& parent,
 774                              const wxString& text,
 775                              int image = -1,
 776                              int selImage = -1,
 777                              wxTreeItemData* data = NULL);
 778
 779     /**
 780         Scrolls the specified item into view.
 781     */
 782     virtual void ScrollTo(const wxTreeItemId& item);
 783
 784     /**
 785         Selects the given item. In multiple selection controls, can be also used
 786         to deselect a currently selected item if the value of @a select is
 787         @false.
 788     */
 789     virtual void SelectItem(const wxTreeItemId& item, bool select = true);
 790
 791     /**
 792         Sets the buttons image list (from which application-defined button
 793         images are taken).
 794
 795         The button images assigned with this method will @b not be deleted by
 796         @ref wxTreeCtrl "wxTreeCtrl"'s destructor, you must delete it yourself.
 797         Setting or assigning the button image list enables the display of image
 798         buttons. Once enabled, the only way to disable the display of button
 799         images is to set the button image list to @NULL.
 800
 801         @note This function is only available in the generic version.
 802
 803         @see AssignButtonsImageList().
 804     */
 805     void SetButtonsImageList(wxImageList* imageList);
 806
 807     /**
 808         Sets the normal image list. The image list assigned with this method
 809         will @b not be deleted by @ref wxTreeCtrl "wxTreeCtrl"'s destructor, you
 810         must delete it yourself.
 811
 812         @see AssignImageList().
 813     */
 814     virtual void SetImageList(wxImageList* imageList);
 815
 816     /**
 817         Sets the indentation for the tree control.
 818     */
 819     virtual void SetIndent(unsigned int indent);
 820
 821     /**
 822         Sets the colour of the item's background.
 823     */
 824     virtual void SetItemBackgroundColour(const wxTreeItemId& item,
 825                                          const wxColour& col);
 826
 827     /**
 828         Makes item appear in bold font if @a bold parameter is @true or resets
 829         it to the normal state.
 830
 831         @see IsBold()
 832     */
 833     virtual void SetItemBold(const wxTreeItemId& item, bool bold = true);
 834
 835     /**
 836         Sets the item client data.
 837
 838         Notice that the client data previously associated with the @a item (if
 839         any) is @em not freed by this function and so calling this function
 840         multiple times for the same item will result in memory leaks unless you
 841         delete the old item data pointer yourself.
 842
 843         @beginWxPythonOnly
 844         - @b SetPyData( @a item, @c obj): Associate the given Python Object with
 845             the wxTreeItemData for the given item Id.
 846         @endWxPythonOnly
 847
 848         @beginWxPerlOnly
 849         wxPerl provides the following shortcut method:
 850         - SetPlData(item, data): sets the Perl data
 851           associated with the @c Wx::TreeItemData. It is just the same as
 852           tree->GetItemData(item)->SetData(data).
 853         @endWxPerlOnly
 854     */
 855     virtual void SetItemData(const wxTreeItemId& item, wxTreeItemData* data);
 856
 857
 858     /**
 859         Gives the item the visual feedback for Drag'n'Drop actions, which is
 860         useful if something is dragged from the outside onto the tree control
 861         (as opposed to a DnD operation within the tree control, which already
 862         is implemented internally).
 863     */
 864     virtual void SetItemDropHighlight(const wxTreeItemId& item,
 865                                       bool highlight = true);
 866
 867     /**
 868         Sets the item's font. All items in the tree should have the same height
 869         to avoid text clipping, so the fonts height should be the same for all
 870         of them, although font attributes may vary.
 871
 872         @see SetItemBold()
 873     */
 874     virtual void SetItemFont(const wxTreeItemId& item, const wxFont& font);
 875
 876     /**
 877         Force appearance of the button next to the item. This is useful to
 878         allow the user to expand the items which don't have any children now,
 879         but instead adding them only when needed, thus minimizing memory
 880         usage and loading time.
 881     */
 882     virtual void SetItemHasChildren(const wxTreeItemId& item,
 883                                     bool hasChildren = true);
 884
 885     /**
 886         Sets the specified item's image. See GetItemImage() for the description
 887         of the @a which parameter.
 888     */
 889     virtual void SetItemImage(const wxTreeItemId& item, int image,
 890                               wxTreeItemIcon which = wxTreeItemIcon_Normal);
 891
 892     /**
 893         Sets the specified item state. The value of @a state may be:
 894         - @c wxTREE_ITEMSTATE_NONE: to disable the item state (the state image will
 895             be not displayed).
 896         - @c wxTREE_ITEMSTATE_NEXT: to set the next item state.
 897         - @c wxTREE_ITEMSTATE_PREV: to set the previous item state.
 898     */
 899     void SetItemState(const wxTreeItemId& item, int state);
 900
 901     /**
 902         Sets the item label.
 903     */
 904     virtual void SetItemText(const wxTreeItemId& item, const wxString& text);
 905
 906     /**
 907         Sets the colour of the item's text.
 908     */
 909     virtual void SetItemTextColour(const wxTreeItemId& item,
 910                                    const wxColour& col);
 911
 912     /**
 913         If @true is passed, specifies that the control will use a quick
 914         calculation for the best size, looking only at the first and last items.
 915         Otherwise, it will look at all items. The default is @false.
 916
 917         @see GetQuickBestSize()
 918     */
 919     void SetQuickBestSize(bool quickBestSize);
 920
 921     /**
 922         Sets the state image list (from which application-defined state images
 923         are taken). Image list assigned with this method will @b not be deleted
 924         by @ref wxTreeCtrl "wxTreeCtrl"'s destructor, you must delete it
 925         yourself.
 926
 927         @see AssignStateImageList().
 928     */
 929     virtual void SetStateImageList(wxImageList* imageList);
 930
 931     /**
 932         Sets the mode flags associated with the display of the tree control. The
 933         new mode takes effect immediately.
 934
 935         @note Generic only; MSW ignores changes.
 936     */
 937     void SetWindowStyle(long styles);
 938
 939     /**
 940         Sorts the children of the given item using OnCompareItems().
 941         You should override that method to change the sort order (the default is
 942         ascending case-sensitive alphabetical order).
 943
 944         @see wxTreeItemData, OnCompareItems()
 945     */
 946     virtual void SortChildren(const wxTreeItemId& item);
 947
 948     /**
 949         Toggles the given item between collapsed and expanded states.
 950     */
 951     virtual void Toggle(const wxTreeItemId& item);
 952
 953     /**
 954         Toggles the given item between selected and unselected states. For
 955         multiselection controls only.
 956     */
 957     void ToggleItemSelection(const wxTreeItemId& item);
 958
 959     /**
 960         Removes the selection from the currently selected item (if any).
 961     */
 962     virtual void Unselect();
 963
 964     /**
 965         This function either behaves the same as Unselect() if the control
 966         doesn't have @c wxTR_MULTIPLE style, or removes the selection from all
 967         items if it does have this style.
 968     */
 969     virtual void UnselectAll();
 970
 971     /**
 972         Unselects the given item. This works in multiselection controls only.
 973     */
 974     void UnselectItem(const wxTreeItemId& item);
 975
 976     /**
 977         Select all the immediate children of the given parent.
 978
 979         This function can be used with multiselection controls only.
 980
 981         @since 2.9.1
 982     */
 983     virtual void SelectChildren(const wxTreeItemId& parent);
 984 };
 985
 986
 987
 988 /**
 989     @class wxTreeEvent
 990
 991     A tree event holds information about events associated with wxTreeCtrl
 992     objects.
 993
 994     To process input from a tree control, use these event handler macros to
 995     direct input to member functions that take a wxTreeEvent argument.
 996
 997     @beginEventTable{wxTreeEvent}
 998     @event{EVT_TREE_BEGIN_DRAG(id, func)}
 999         Begin dragging with the left mouse button. If you want to enable
1000         left-dragging you need to intercept this event and explicitely call
1001         wxTreeEvent::Allow(), as it's vetoed by default. Also notice that the
1002         control must have an associated image list (see SetImageList()) to
1003         drag its items under MSW.
1004     @event{EVT_TREE_BEGIN_RDRAG(id, func)}
1005         Begin dragging with the right mouse button. If you want to enable
1006         right-dragging you need to intercept this event and explicitely call
1007         wxTreeEvent::Allow(), as it's vetoed by default.
1008     @event{EVT_TREE_END_DRAG(id, func)}
1009         End dragging with the left or right mouse button.
1010     @event{EVT_TREE_BEGIN_LABEL_EDIT(id, func)}
1011         Begin editing a label. This can be prevented by calling Veto().
1012     @event{EVT_TREE_END_LABEL_EDIT(id, func)}
1013         Finish editing a label. This can be prevented by calling Veto().
1014     @event{EVT_TREE_DELETE_ITEM(id, func)}
1015         Delete an item.
1016     @event{EVT_TREE_GET_INFO(id, func)}
1017         Request information from the application.
1018     @event{EVT_TREE_SET_INFO(id, func)}
1019         Information is being supplied.
1020     @event{EVT_TREE_ITEM_ACTIVATED(id, func)}
1021         The item has been activated, i.e. chosen by double clicking it with
1022         mouse or from keyboard.
1023     @event{EVT_TREE_ITEM_COLLAPSED(id, func)}
1024         The item has been collapsed.
1025     @event{EVT_TREE_ITEM_COLLAPSING(id, func)}
1026         The item is being collapsed. This can be prevented by calling Veto().
1027     @event{EVT_TREE_ITEM_EXPANDED(id, func)}
1028         The item has been expanded.
1029     @event{EVT_TREE_ITEM_EXPANDING(id, func)}
1030         The item is being expanded. This can be prevented by calling Veto().
1031     @event{EVT_TREE_ITEM_RIGHT_CLICK(id, func)}
1032         The user has clicked the item with the right mouse button.
1033     @event{EVT_TREE_ITEM_MIDDLE_CLICK(id, func)}
1034         The user has clicked the item with the middle mouse button.
1035     @event{EVT_TREE_SEL_CHANGED(id, func)}
1036         Selection has changed.
1037     @event{EVT_TREE_SEL_CHANGING(id, func)}
1038         Selection is changing. This can be prevented by calling Veto().
1039     @event{EVT_TREE_KEY_DOWN(id, func)}
1040         A key has been pressed.
1041     @event{EVT_TREE_ITEM_GETTOOLTIP(id, func)}
1042         The opportunity to set the item tooltip is being given to the
1043         application (call SetToolTip()). Windows only.
1044     @event{EVT_TREE_ITEM_MENU(id, func)}
1045         The context menu for the selected item has been requested, either by a
1046         right click or by using the menu key.
1047     @event{EVT_TREE_STATE_IMAGE_CLICK(id, func)}
1048         The state image has been clicked.
1049     @endEventTable
1050
1051     @library{wxbase}
1052     @category{events}
1053
1054     @see wxTreeCtrl
1055 */
1056 class wxTreeEvent : public wxNotifyEvent
1057 {
1058 public:
1059     /**
1060         Constructor, used by wxWidgets itself only.
1061     */
1062     wxTreeEvent(wxEventType commandType, wxTreeCtrl* tree,
1063                 const wxTreeItemId& item = wxTreeItemId());
1064
1065     /**
1066         Returns the item (valid for all events).
1067     */
1068     wxTreeItemId GetItem() const;
1069
1070     /**
1071         Returns the key code if the event is a key event. Use GetKeyEvent() to
1072         get the values of the modifier keys for this event (i.e. Shift or Ctrl).
1073     */
1074     int GetKeyCode() const;
1075
1076     /**
1077         Returns the key event for @c EVT_TREE_KEY_DOWN events.
1078     */
1079     const wxKeyEvent& GetKeyEvent() const;
1080
1081     /**
1082         Returns the label if the event is a begin or end edit label event.
1083     */
1084     const wxString& GetLabel() const;
1085
1086     /**
1087         Returns the old item index (valid for @c EVT_TREE_ITEM_CHANGING and
1088         @c EVT_TREE_ITEM_CHANGED events).
1089     */
1090     wxTreeItemId GetOldItem() const;
1091
1092     /**
1093         Returns the position of the mouse pointer if the event is a drag or
1094         menu-context event.
1095
1096         In both cases the position is in client coordinates - i.e. relative to
1097         the wxTreeCtrl window (so that you can pass it directly to e.g.
1098         wxWindow::PopupMenu()).
1099     */
1100     wxPoint GetPoint() const;
1101
1102     /**
1103         Returns @true if the label edit was cancelled. This should be called
1104         from within an @c EVT_TREE_END_LABEL_EDIT handler.
1105     */
1106     bool IsEditCancelled() const;
1107
1108     /**
1109         Set the tooltip for the item (valid for @c EVT_TREE_ITEM_GETTOOLTIP
1110         events). Windows only.
1111     */
1112     void SetToolTip(const wxString& tooltip);
1113 };