src/msw/treectrl.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/msw/treectrl.cpp
   3 // Purpose:     wxTreeCtrl
   4 // Author:      Julian Smart
   5 // Modified by: Vadim Zeitlin to be less MSW-specific on 10.10.98
   6 // Created:     1997
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #if wxUSE_TREECTRL
  28
  29 #include "wx/treectrl.h"
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
  33     #include "wx/msw/missing.h"
  34     #include "wx/dynarray.h"
  35     #include "wx/log.h"
  36     #include "wx/app.h"
  37     #include "wx/settings.h"
  38 #endif
  39
  40 #include "wx/msw/private.h"
  41
  42 // Set this to 1 to be _absolutely_ sure that repainting will work for all
  43 // comctl32.dll versions
  44 #define wxUSE_COMCTL32_SAFELY 0
  45
  46 #include "wx/imaglist.h"
  47 #include "wx/msw/dragimag.h"
  48
  49 // macros to hide the cast ugliness
  50 // --------------------------------
  51
  52 // get HTREEITEM from wxTreeItemId
  53 #define HITEM(item)     ((HTREEITEM)(((item).m_pItem)))
  54
  55
  56 // older SDKs are missing these
  57 #ifndef TVN_ITEMCHANGINGA
  58
  59 #define TVN_ITEMCHANGINGA (TVN_FIRST-16)
  60 #define TVN_ITEMCHANGINGW (TVN_FIRST-17)
  61
  62 typedef struct tagNMTVITEMCHANGE
  63 {
  64     NMHDR hdr;
  65     UINT uChanged;
  66     HTREEITEM hItem;
  67     UINT uStateNew;
  68     UINT uStateOld;
  69     LPARAM lParam;
  70 } NMTVITEMCHANGE;
  71
  72 #endif
  73
  74
  75 // this helper class is used on vista systems for preventing unwanted
  76 // item state changes in the vista tree control.  It is only effective in
  77 // multi-select mode on vista systems.
  78
  79 // The vista tree control includes some new code that originally broke the
  80 // multi-selection tree, causing seemingly spurious item selection state changes
  81 // during Shift or Ctrl-click item selection. (To witness the original broken
  82 // behavior, simply make IsLocked() below always return false). This problem was
  83 // solved by using the following class to 'unlock' an item's selection state.
  84
  85 class TreeItemUnlocker
  86 {
  87 public:
  88     // unlock a single item
  89     TreeItemUnlocker(HTREEITEM item) { ms_unlockedItem = item; }
  90
  91     // unlock all items, don't use unless absolutely necessary
  92     TreeItemUnlocker() { ms_unlockedItem = (HTREEITEM)-1; }
  93
  94     // lock everything back
  95     ~TreeItemUnlocker() { ms_unlockedItem = NULL; }
  96
  97
  98     // check if the item state is currently locked
  99     static bool IsLocked(HTREEITEM item)
 100         { return ms_unlockedItem != (HTREEITEM)-1 && item != ms_unlockedItem; }
 101
 102 private:
 103     static HTREEITEM ms_unlockedItem;
 104 };
 105
 106 HTREEITEM TreeItemUnlocker::ms_unlockedItem = NULL;
 107
 108 // ----------------------------------------------------------------------------
 109 // private functions
 110 // ----------------------------------------------------------------------------
 111
 112 // wrappers for TreeView_GetItem/TreeView_SetItem
 113 static bool IsItemSelected(HWND hwndTV, HTREEITEM hItem)
 114 {
 115
 116     TV_ITEM tvi;
 117     tvi.mask = TVIF_STATE | TVIF_HANDLE;
 118     tvi.stateMask = TVIS_SELECTED;
 119     tvi.hItem = hItem;
 120
 121     TreeItemUnlocker unlocker(hItem);
 122
 123     if ( !TreeView_GetItem(hwndTV, &tvi) )
 124     {
 125         wxLogLastError(wxT("TreeView_GetItem"));
 126     }
 127
 128     return (tvi.state & TVIS_SELECTED) != 0;
 129 }
 130
 131 static bool SelectItem(HWND hwndTV, HTREEITEM hItem, bool select = true)
 132 {
 133     TV_ITEM tvi;
 134     tvi.mask = TVIF_STATE | TVIF_HANDLE;
 135     tvi.stateMask = TVIS_SELECTED;
 136     tvi.state = select ? TVIS_SELECTED : 0;
 137     tvi.hItem = hItem;
 138
 139     TreeItemUnlocker unlocker(hItem);
 140
 141     if ( TreeView_SetItem(hwndTV, &tvi) == -1 )
 142     {
 143         wxLogLastError(wxT("TreeView_SetItem"));
 144         return false;
 145     }
 146
 147     return true;
 148 }
 149
 150 static inline void UnselectItem(HWND hwndTV, HTREEITEM htItem)
 151 {
 152     SelectItem(hwndTV, htItem, false);
 153 }
 154
 155 // helper function which selects all items in a range and, optionally,
 156 // unselects all others
 157 static void SelectRange(HWND hwndTV,
 158                         HTREEITEM htFirst,
 159                         HTREEITEM htLast,
 160                         bool unselectOthers = true)
 161 {
 162     // find the first (or last) item and select it
 163     bool cont = true;
 164     HTREEITEM htItem = (HTREEITEM)TreeView_GetRoot(hwndTV);
 165     while ( htItem && cont )
 166     {
 167         if ( (htItem == htFirst) || (htItem == htLast) )
 168         {
 169             if ( !IsItemSelected(hwndTV, htItem) )
 170             {
 171                 SelectItem(hwndTV, htItem);
 172             }
 173
 174             cont = false;
 175         }
 176         else
 177         {
 178             if ( unselectOthers && IsItemSelected(hwndTV, htItem) )
 179             {
 180                 UnselectItem(hwndTV, htItem);
 181             }
 182         }
 183
 184         htItem = (HTREEITEM)TreeView_GetNextVisible(hwndTV, htItem);
 185     }
 186
 187     // select the items in range
 188     cont = htFirst != htLast;
 189     while ( htItem && cont )
 190     {
 191         if ( !IsItemSelected(hwndTV, htItem) )
 192         {
 193             SelectItem(hwndTV, htItem);
 194         }
 195
 196         cont = (htItem != htFirst) && (htItem != htLast);
 197
 198         htItem = (HTREEITEM)TreeView_GetNextVisible(hwndTV, htItem);
 199     }
 200
 201     // unselect the rest
 202     if ( unselectOthers )
 203     {
 204         while ( htItem )
 205         {
 206             if ( IsItemSelected(hwndTV, htItem) )
 207             {
 208                 UnselectItem(hwndTV, htItem);
 209             }
 210
 211             htItem = (HTREEITEM)TreeView_GetNextVisible(hwndTV, htItem);
 212         }
 213     }
 214
 215     // seems to be necessary - otherwise the just selected items don't always
 216     // appear as selected
 217     UpdateWindow(hwndTV);
 218 }
 219
 220 // helper function which tricks the standard control into changing the focused
 221 // item without changing anything else (if someone knows why Microsoft doesn't
 222 // allow to do it by just setting TVIS_FOCUSED flag, please tell me!)
 223 //
 224 // returns true if the focus was changed, false if the given item was already
 225 // the focused one
 226 static bool SetFocus(HWND hwndTV, HTREEITEM htItem)
 227 {
 228     // the current focus
 229     HTREEITEM htFocus = (HTREEITEM)TreeView_GetSelection(hwndTV);
 230
 231     if ( htItem == htFocus )
 232         return false;
 233
 234     if ( htItem )
 235     {
 236         // remember the selection state of the item
 237         bool wasSelected = IsItemSelected(hwndTV, htItem);
 238
 239         if ( htFocus && IsItemSelected(hwndTV, htFocus) )
 240         {
 241             // prevent the tree from unselecting the old focus which it
 242             // would do by default (TreeView_SelectItem unselects the
 243             // focused item)
 244             TreeView_SelectItem(hwndTV, 0);
 245             SelectItem(hwndTV, htFocus);
 246         }
 247
 248         TreeView_SelectItem(hwndTV, htItem);
 249
 250         if ( !wasSelected )
 251         {
 252             // need to clear the selection which TreeView_SelectItem() gave
 253             // us
 254             UnselectItem(hwndTV, htItem);
 255         }
 256         //else: was selected, still selected - ok
 257     }
 258     else // reset focus
 259     {
 260         bool wasFocusSelected = IsItemSelected(hwndTV, htFocus);
 261
 262         // just clear the focus
 263         TreeView_SelectItem(hwndTV, 0);
 264
 265         if ( wasFocusSelected )
 266         {
 267             // restore the selection state
 268             SelectItem(hwndTV, htFocus);
 269         }
 270     }
 271
 272     return true;
 273 }
 274
 275 // ----------------------------------------------------------------------------
 276 // private classes
 277 // ----------------------------------------------------------------------------
 278
 279 // a convenient wrapper around TV_ITEM struct which adds a ctor
 280 #ifdef __VISUALC__
 281 #pragma warning( disable : 4097 ) // inheriting from typedef
 282 #endif
 283
 284 struct wxTreeViewItem : public TV_ITEM
 285 {
 286     wxTreeViewItem(const wxTreeItemId& item,    // the item handle
 287                    UINT mask_,                  // fields which are valid
 288                    UINT stateMask_ = 0)         // for TVIF_STATE only
 289     {
 290         wxZeroMemory(*this);
 291
 292         // hItem member is always valid
 293         mask = mask_ | TVIF_HANDLE;
 294         stateMask = stateMask_;
 295         hItem = HITEM(item);
 296     }
 297 };
 298
 299 // ----------------------------------------------------------------------------
 300 // This class is our userdata/lParam for the TV_ITEMs stored in the treeview.
 301 //
 302 // We need this for a couple of reasons:
 303 //
 304 // 1) This class is needed for support of different images: the Win32 common
 305 // control natively supports only 2 images (the normal one and another for the
 306 // selected state). We wish to provide support for 2 more of them for folder
 307 // items (i.e. those which have children): for expanded state and for expanded
 308 // selected state. For this we use this structure to store the additional items
 309 // images.
 310 //
 311 // 2) This class is also needed to hold the HITEM so that we can sort
 312 // it correctly in the MSW sort callback.
 313 //
 314 // In addition it makes other workarounds such as this easier and helps
 315 // simplify the code.
 316 // ----------------------------------------------------------------------------
 317
 318 class wxTreeItemParam
 319 {
 320 public:
 321     wxTreeItemParam()
 322     {
 323         m_data = NULL;
 324
 325         for ( size_t n = 0; n < WXSIZEOF(m_images); n++ )
 326         {
 327             m_images[n] = -1;
 328         }
 329     }
 330
 331     // dtor deletes the associated data as well
 332     virtual ~wxTreeItemParam() { delete m_data; }
 333
 334     // accessors
 335         // get the real data associated with the item
 336     wxTreeItemData *GetData() const { return m_data; }
 337         // change it
 338     void SetData(wxTreeItemData *data) { m_data = data; }
 339
 340         // do we have such image?
 341     bool HasImage(wxTreeItemIcon which) const { return m_images[which] != -1; }
 342         // get image, falling back to the other images if this one is not
 343         // specified
 344     int GetImage(wxTreeItemIcon which) const
 345     {
 346         int image = m_images[which];
 347         if ( image == -1 )
 348         {
 349             switch ( which )
 350             {
 351                 case wxTreeItemIcon_SelectedExpanded:
 352                     image = GetImage(wxTreeItemIcon_Expanded);
 353                     if ( image != -1 )
 354                         break;
 355                     //else: fall through
 356
 357                 case wxTreeItemIcon_Selected:
 358                 case wxTreeItemIcon_Expanded:
 359                     image = GetImage(wxTreeItemIcon_Normal);
 360                     break;
 361
 362                 case wxTreeItemIcon_Normal:
 363                     // no fallback
 364                     break;
 365
 366                 default:
 367                     wxFAIL_MSG( _T("unsupported wxTreeItemIcon value") );
 368             }
 369         }
 370
 371         return image;
 372     }
 373         // change the given image
 374     void SetImage(int image, wxTreeItemIcon which) { m_images[which] = image; }
 375
 376         // get item
 377     const wxTreeItemId& GetItem() const { return m_item; }
 378         // set item
 379     void SetItem(const wxTreeItemId& item) { m_item = item; }
 380
 381 protected:
 382     // all the images associated with the item
 383     int m_images[wxTreeItemIcon_Max];
 384
 385     // item for sort callbacks
 386     wxTreeItemId m_item;
 387
 388     // the real client data
 389     wxTreeItemData *m_data;
 390
 391     DECLARE_NO_COPY_CLASS(wxTreeItemParam)
 392 };
 393
 394 // wxVirutalNode is used in place of a single root when 'hidden' root is
 395 // specified.
 396 class wxVirtualNode : public wxTreeViewItem
 397 {
 398 public:
 399     wxVirtualNode(wxTreeItemParam *param)
 400         : wxTreeViewItem(TVI_ROOT, 0)
 401     {
 402         m_param = param;
 403     }
 404
 405     ~wxVirtualNode()
 406     {
 407         delete m_param;
 408     }
 409
 410     wxTreeItemParam *GetParam() const { return m_param; }
 411     void SetParam(wxTreeItemParam *param) { delete m_param; m_param = param; }
 412
 413 private:
 414     wxTreeItemParam *m_param;
 415
 416     DECLARE_NO_COPY_CLASS(wxVirtualNode)
 417 };
 418
 419 #ifdef __VISUALC__
 420 #pragma warning( default : 4097 )
 421 #endif
 422
 423 // a macro to get the virtual root, returns NULL if none
 424 #define GET_VIRTUAL_ROOT() ((wxVirtualNode *)m_pVirtualRoot)
 425
 426 // returns true if the item is the virtual root
 427 #define IS_VIRTUAL_ROOT(item) (HITEM(item) == TVI_ROOT)
 428
 429 // a class which encapsulates the tree traversal logic: it vists all (unless
 430 // OnVisit() returns false) items under the given one
 431 class wxTreeTraversal
 432 {
 433 public:
 434     wxTreeTraversal(const wxTreeCtrl *tree)
 435     {
 436         m_tree = tree;
 437     }
 438
 439     // give it a virtual dtor: not really needed as the class is never used
 440     // polymorphically and not even allocated on heap at all, but this is safer
 441     // (in case it ever is) and silences the compiler warnings for now
 442     virtual ~wxTreeTraversal() { }
 443
 444     // do traverse the tree: visit all items (recursively by default) under the
 445     // given one; return true if all items were traversed or false if the
 446     // traversal was aborted because OnVisit returned false
 447     bool DoTraverse(const wxTreeItemId& root, bool recursively = true);
 448
 449     // override this function to do whatever is needed for each item, return
 450     // false to stop traversing
 451     virtual bool OnVisit(const wxTreeItemId& item) = 0;
 452
 453 protected:
 454     const wxTreeCtrl *GetTree() const { return m_tree; }
 455
 456 private:
 457     bool Traverse(const wxTreeItemId& root, bool recursively);
 458
 459     const wxTreeCtrl *m_tree;
 460
 461     DECLARE_NO_COPY_CLASS(wxTreeTraversal)
 462 };
 463
 464 // internal class for getting the selected items
 465 class TraverseSelections : public wxTreeTraversal
 466 {
 467 public:
 468     TraverseSelections(const wxTreeCtrl *tree,
 469                        wxArrayTreeItemIds& selections)
 470         : wxTreeTraversal(tree), m_selections(selections)
 471         {
 472             m_selections.Empty();
 473
 474             if (tree->GetCount() > 0)
 475                 DoTraverse(tree->GetRootItem());
 476         }
 477
 478     virtual bool OnVisit(const wxTreeItemId& item)
 479     {
 480         const wxTreeCtrl * const tree = GetTree();
 481
 482         // can't visit a virtual node.
 483         if ( (tree->GetRootItem() == item) && tree->HasFlag(wxTR_HIDE_ROOT) )
 484         {
 485             return true;
 486         }
 487
 488         if ( ::IsItemSelected(GetHwndOf(tree), HITEM(item)) )
 489         {
 490             m_selections.Add(item);
 491         }
 492
 493         return true;
 494     }
 495
 496     size_t GetCount() const { return m_selections.GetCount(); }
 497
 498 private:
 499     wxArrayTreeItemIds& m_selections;
 500
 501     DECLARE_NO_COPY_CLASS(TraverseSelections)
 502 };
 503
 504 // internal class for counting tree items
 505 class TraverseCounter : public wxTreeTraversal
 506 {
 507 public:
 508     TraverseCounter(const wxTreeCtrl *tree,
 509                     const wxTreeItemId& root,
 510                     bool recursively)
 511         : wxTreeTraversal(tree)
 512         {
 513             m_count = 0;
 514
 515             DoTraverse(root, recursively);
 516         }
 517
 518     virtual bool OnVisit(const wxTreeItemId& WXUNUSED(item))
 519     {
 520         m_count++;
 521
 522         return true;
 523     }
 524
 525     size_t GetCount() const { return m_count; }
 526
 527 private:
 528     size_t m_count;
 529
 530     DECLARE_NO_COPY_CLASS(TraverseCounter)
 531 };
 532
 533 // ----------------------------------------------------------------------------
 534 // wxWin macros
 535 // ----------------------------------------------------------------------------
 536
 537 #if wxUSE_EXTENDED_RTTI
 538 WX_DEFINE_FLAGS( wxTreeCtrlStyle )
 539
 540 wxBEGIN_FLAGS( wxTreeCtrlStyle )
 541     // new style border flags, we put them first to
 542     // use them for streaming out
 543     wxFLAGS_MEMBER(wxBORDER_SIMPLE)
 544     wxFLAGS_MEMBER(wxBORDER_SUNKEN)
 545     wxFLAGS_MEMBER(wxBORDER_DOUBLE)
 546     wxFLAGS_MEMBER(wxBORDER_RAISED)
 547     wxFLAGS_MEMBER(wxBORDER_STATIC)
 548     wxFLAGS_MEMBER(wxBORDER_NONE)
 549
 550     // old style border flags
 551     wxFLAGS_MEMBER(wxSIMPLE_BORDER)
 552     wxFLAGS_MEMBER(wxSUNKEN_BORDER)
 553     wxFLAGS_MEMBER(wxDOUBLE_BORDER)
 554     wxFLAGS_MEMBER(wxRAISED_BORDER)
 555     wxFLAGS_MEMBER(wxSTATIC_BORDER)
 556     wxFLAGS_MEMBER(wxBORDER)
 557
 558     // standard window styles
 559     wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
 560     wxFLAGS_MEMBER(wxCLIP_CHILDREN)
 561     wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
 562     wxFLAGS_MEMBER(wxWANTS_CHARS)
 563     wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
 564     wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
 565     wxFLAGS_MEMBER(wxVSCROLL)
 566     wxFLAGS_MEMBER(wxHSCROLL)
 567
 568     wxFLAGS_MEMBER(wxTR_EDIT_LABELS)
 569     wxFLAGS_MEMBER(wxTR_NO_BUTTONS)
 570     wxFLAGS_MEMBER(wxTR_HAS_BUTTONS)
 571     wxFLAGS_MEMBER(wxTR_TWIST_BUTTONS)
 572     wxFLAGS_MEMBER(wxTR_NO_LINES)
 573     wxFLAGS_MEMBER(wxTR_FULL_ROW_HIGHLIGHT)
 574     wxFLAGS_MEMBER(wxTR_LINES_AT_ROOT)
 575     wxFLAGS_MEMBER(wxTR_HIDE_ROOT)
 576     wxFLAGS_MEMBER(wxTR_ROW_LINES)
 577     wxFLAGS_MEMBER(wxTR_HAS_VARIABLE_ROW_HEIGHT)
 578     wxFLAGS_MEMBER(wxTR_SINGLE)
 579     wxFLAGS_MEMBER(wxTR_MULTIPLE)
 580 #if WXWIN_COMPATIBILITY_2_8
 581     wxFLAGS_MEMBER(wxTR_EXTENDED)
 582 #endif
 583     wxFLAGS_MEMBER(wxTR_DEFAULT_STYLE)
 584
 585 wxEND_FLAGS( wxTreeCtrlStyle )
 586
 587 IMPLEMENT_DYNAMIC_CLASS_XTI(wxTreeCtrl, wxControl,"wx/treectrl.h")
 588
 589 wxBEGIN_PROPERTIES_TABLE(wxTreeCtrl)
 590     wxEVENT_PROPERTY( TextUpdated , wxEVT_COMMAND_TEXT_UPDATED , wxCommandEvent )
 591     wxEVENT_RANGE_PROPERTY( TreeEvent , wxEVT_COMMAND_TREE_BEGIN_DRAG , wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK , wxTreeEvent )
 592     wxPROPERTY_FLAGS( WindowStyle , wxTreeCtrlStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
 593 wxEND_PROPERTIES_TABLE()
 594
 595 wxBEGIN_HANDLERS_TABLE(wxTreeCtrl)
 596 wxEND_HANDLERS_TABLE()
 597
 598 wxCONSTRUCTOR_5( wxTreeCtrl , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size , long , WindowStyle )
 599 #else
 600 IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl, wxControl)
 601 #endif
 602
 603 // ----------------------------------------------------------------------------
 604 // constants
 605 // ----------------------------------------------------------------------------
 606
 607 // indices in gs_expandEvents table below
 608 enum
 609 {
 610     IDX_COLLAPSE,
 611     IDX_EXPAND,
 612     IDX_WHAT_MAX
 613 };
 614
 615 enum
 616 {
 617     IDX_DONE,
 618     IDX_DOING,
 619     IDX_HOW_MAX
 620 };
 621
 622 // handy table for sending events - it has to be initialized during run-time
 623 // now so can't be const any more
 624 static /* const */ wxEventType gs_expandEvents[IDX_WHAT_MAX][IDX_HOW_MAX];
 625
 626 /*
 627    but logically it's a const table with the following entries:
 628 =
 629 {
 630     { wxEVT_COMMAND_TREE_ITEM_COLLAPSED, wxEVT_COMMAND_TREE_ITEM_COLLAPSING },
 631     { wxEVT_COMMAND_TREE_ITEM_EXPANDED,  wxEVT_COMMAND_TREE_ITEM_EXPANDING  }
 632 };
 633 */
 634
 635 // ============================================================================
 636 // implementation
 637 // ============================================================================
 638
 639 // ----------------------------------------------------------------------------
 640 // tree traversal
 641 // ----------------------------------------------------------------------------
 642
 643 bool wxTreeTraversal::DoTraverse(const wxTreeItemId& root, bool recursively)
 644 {
 645     if ( !OnVisit(root) )
 646         return false;
 647
 648     return Traverse(root, recursively);
 649 }
 650
 651 bool wxTreeTraversal::Traverse(const wxTreeItemId& root, bool recursively)
 652 {
 653     wxTreeItemIdValue cookie;
 654     wxTreeItemId child = m_tree->GetFirstChild(root, cookie);
 655     while ( child.IsOk() )
 656     {
 657         // depth first traversal
 658         if ( recursively && !Traverse(child, true) )
 659             return false;
 660
 661         if ( !OnVisit(child) )
 662             return false;
 663
 664         child = m_tree->GetNextChild(root, cookie);
 665     }
 666
 667     return true;
 668 }
 669
 670 // ----------------------------------------------------------------------------
 671 // construction and destruction
 672 // ----------------------------------------------------------------------------
 673
 674 void wxTreeCtrl::Init()
 675 {
 676     m_textCtrl = NULL;
 677     m_hasAnyAttr = false;
 678 #if wxUSE_DRAGIMAGE
 679     m_dragImage = NULL;
 680 #endif
 681     m_pVirtualRoot = NULL;
 682
 683     // initialize the global array of events now as it can't be done statically
 684     // with the wxEVT_XXX values being allocated during run-time only
 685     gs_expandEvents[IDX_COLLAPSE][IDX_DONE] = wxEVT_COMMAND_TREE_ITEM_COLLAPSED;
 686     gs_expandEvents[IDX_COLLAPSE][IDX_DOING] = wxEVT_COMMAND_TREE_ITEM_COLLAPSING;
 687     gs_expandEvents[IDX_EXPAND][IDX_DONE] = wxEVT_COMMAND_TREE_ITEM_EXPANDED;
 688     gs_expandEvents[IDX_EXPAND][IDX_DOING] = wxEVT_COMMAND_TREE_ITEM_EXPANDING;
 689 }
 690
 691 bool wxTreeCtrl::Create(wxWindow *parent,
 692                         wxWindowID id,
 693                         const wxPoint& pos,
 694                         const wxSize& size,
 695                         long style,
 696                         const wxValidator& validator,
 697                         const wxString& name)
 698 {
 699     Init();
 700
 701     if ( (style & wxBORDER_MASK) == wxBORDER_DEFAULT )
 702         style |= wxBORDER_SUNKEN;
 703
 704     if ( !CreateControl(parent, id, pos, size, style, validator, name) )
 705         return false;
 706
 707     WXDWORD exStyle = 0;
 708     DWORD wstyle = MSWGetStyle(m_windowStyle, & exStyle);
 709     wstyle |= WS_TABSTOP | TVS_SHOWSELALWAYS;
 710
 711     if ((m_windowStyle & wxTR_NO_LINES) == 0)
 712         wstyle |= TVS_HASLINES;
 713     if ( m_windowStyle & wxTR_HAS_BUTTONS )
 714         wstyle |= TVS_HASBUTTONS;
 715
 716     if ( m_windowStyle & wxTR_EDIT_LABELS )
 717         wstyle |= TVS_EDITLABELS;
 718
 719     if ( m_windowStyle & wxTR_LINES_AT_ROOT )
 720         wstyle |= TVS_LINESATROOT;
 721
 722     if ( m_windowStyle & wxTR_FULL_ROW_HIGHLIGHT )
 723     {
 724         if ( wxApp::GetComCtl32Version() >= 471 )
 725             wstyle |= TVS_FULLROWSELECT;
 726     }
 727
 728 #if !defined(__WXWINCE__) && defined(TVS_INFOTIP)
 729     // Need so that TVN_GETINFOTIP messages will be sent
 730     wstyle |= TVS_INFOTIP;
 731 #endif
 732
 733     // Create the tree control.
 734     if ( !MSWCreateControl(WC_TREEVIEW, wstyle, pos, size) )
 735         return false;
 736
 737 #if wxUSE_COMCTL32_SAFELY
 738     wxWindow::SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
 739     wxWindow::SetForegroundColour(wxWindow::GetParent()->GetForegroundColour());
 740 #elif 1
 741     SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
 742     SetForegroundColour(wxWindow::GetParent()->GetForegroundColour());
 743 #else
 744     // This works around a bug in the Windows tree control whereby for some versions
 745     // of comctrl32, setting any colour actually draws the background in black.
 746     // This will initialise the background to the system colour.
 747     // THIS FIX NOW REVERTED since it caused problems on _other_ systems.
 748     // Assume the user has an updated comctl32.dll.
 749     ::SendMessage(GetHwnd(), TVM_SETBKCOLOR, 0,-1);
 750     wxWindow::SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
 751     SetForegroundColour(wxWindow::GetParent()->GetForegroundColour());
 752 #endif
 753
 754     wxSetCCUnicodeFormat(GetHwnd());
 755
 756     return true;
 757 }
 758
 759 wxTreeCtrl::~wxTreeCtrl()
 760 {
 761     // delete any attributes
 762     if ( m_hasAnyAttr )
 763     {
 764         WX_CLEAR_HASH_MAP(wxMapTreeAttr, m_attrs);
 765
 766         // prevent TVN_DELETEITEM handler from deleting the attributes again!
 767         m_hasAnyAttr = false;
 768     }
 769
 770     DeleteTextCtrl();
 771
 772     // delete user data to prevent memory leaks
 773     // also deletes hidden root node storage.
 774     DeleteAllItems();
 775 }
 776
 777 // ----------------------------------------------------------------------------
 778 // accessors
 779 // ----------------------------------------------------------------------------
 780
 781 /* static */ wxVisualAttributes
 782 wxTreeCtrl::GetClassDefaultAttributes(wxWindowVariant variant)
 783 {
 784     wxVisualAttributes attrs = GetCompositeControlsDefaultAttributes(variant);
 785
 786     // common controls have their own default font
 787     attrs.font = wxGetCCDefaultFont();
 788
 789     return attrs;
 790 }
 791
 792
 793 // simple wrappers which add error checking in debug mode
 794
 795 bool wxTreeCtrl::DoGetItem(wxTreeViewItem *tvItem) const
 796 {
 797     wxCHECK_MSG( tvItem->hItem != TVI_ROOT, false,
 798                  _T("can't retrieve virtual root item") );
 799
 800     if ( !TreeView_GetItem(GetHwnd(), tvItem) )
 801     {
 802         wxLogLastError(wxT("TreeView_GetItem"));
 803
 804         return false;
 805     }
 806
 807     return true;
 808 }
 809
 810 void wxTreeCtrl::DoSetItem(wxTreeViewItem *tvItem)
 811 {
 812     TreeItemUnlocker unlocker(tvItem->hItem);
 813
 814     if ( TreeView_SetItem(GetHwnd(), tvItem) == -1 )
 815     {
 816         wxLogLastError(wxT("TreeView_SetItem"));
 817     }
 818 }
 819
 820 unsigned int wxTreeCtrl::GetCount() const
 821 {
 822     return (unsigned int)TreeView_GetCount(GetHwnd());
 823 }
 824
 825 unsigned int wxTreeCtrl::GetIndent() const
 826 {
 827     return TreeView_GetIndent(GetHwnd());
 828 }
 829
 830 void wxTreeCtrl::SetIndent(unsigned int indent)
 831 {
 832     TreeView_SetIndent(GetHwnd(), indent);
 833 }
 834
 835 void wxTreeCtrl::SetAnyImageList(wxImageList *imageList, int which)
 836 {
 837     // no error return
 838     (void) TreeView_SetImageList(GetHwnd(),
 839                                  imageList ? imageList->GetHIMAGELIST() : 0,
 840                                  which);
 841 }
 842
 843 void wxTreeCtrl::SetImageList(wxImageList *imageList)
 844 {
 845     if (m_ownsImageListNormal)
 846         delete m_imageListNormal;
 847
 848     SetAnyImageList(m_imageListNormal = imageList, TVSIL_NORMAL);
 849     m_ownsImageListNormal = false;
 850 }
 851
 852 void wxTreeCtrl::SetStateImageList(wxImageList *imageList)
 853 {
 854     if (m_ownsImageListState) delete m_imageListState;
 855     SetAnyImageList(m_imageListState = imageList, TVSIL_STATE);
 856     m_ownsImageListState = false;
 857 }
 858
 859 size_t wxTreeCtrl::GetChildrenCount(const wxTreeItemId& item,
 860                                     bool recursively) const
 861 {
 862     wxCHECK_MSG( item.IsOk(), 0u, wxT("invalid tree item") );
 863
 864     TraverseCounter counter(this, item, recursively);
 865     return counter.GetCount() - 1;
 866 }
 867
 868 // ----------------------------------------------------------------------------
 869 // control colours
 870 // ----------------------------------------------------------------------------
 871
 872 bool wxTreeCtrl::SetBackgroundColour(const wxColour &colour)
 873 {
 874 #if !wxUSE_COMCTL32_SAFELY
 875     if ( !wxWindowBase::SetBackgroundColour(colour) )
 876         return false;
 877
 878     ::SendMessage(GetHwnd(), TVM_SETBKCOLOR, 0, colour.GetPixel());
 879 #endif
 880
 881     return true;
 882 }
 883
 884 bool wxTreeCtrl::SetForegroundColour(const wxColour &colour)
 885 {
 886 #if !wxUSE_COMCTL32_SAFELY
 887     if ( !wxWindowBase::SetForegroundColour(colour) )
 888         return false;
 889
 890     ::SendMessage(GetHwnd(), TVM_SETTEXTCOLOR, 0, colour.GetPixel());
 891 #endif
 892
 893     return true;
 894 }
 895
 896 // ----------------------------------------------------------------------------
 897 // Item access
 898 // ----------------------------------------------------------------------------
 899
 900 bool wxTreeCtrl::IsHiddenRoot(const wxTreeItemId& item) const
 901 {
 902     return HITEM(item) == TVI_ROOT && HasFlag(wxTR_HIDE_ROOT);
 903 }
 904
 905 wxString wxTreeCtrl::GetItemText(const wxTreeItemId& item) const
 906 {
 907     wxCHECK_MSG( item.IsOk(), wxEmptyString, wxT("invalid tree item") );
 908
 909     wxChar buf[512];  // the size is arbitrary...
 910
 911     wxTreeViewItem tvItem(item, TVIF_TEXT);
 912     tvItem.pszText = buf;
 913     tvItem.cchTextMax = WXSIZEOF(buf);
 914     if ( !DoGetItem(&tvItem) )
 915     {
 916         // don't return some garbage which was on stack, but an empty string
 917         buf[0] = wxT('\0');
 918     }
 919
 920     return wxString(buf);
 921 }
 922
 923 void wxTreeCtrl::SetItemText(const wxTreeItemId& item, const wxString& text)
 924 {
 925     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
 926
 927     if ( IS_VIRTUAL_ROOT(item) )
 928         return;
 929
 930     wxTreeViewItem tvItem(item, TVIF_TEXT);
 931     tvItem.pszText = (wxChar *)text.wx_str();  // conversion is ok
 932     DoSetItem(&tvItem);
 933
 934     // when setting the text of the item being edited, the text control should
 935     // be updated to reflect the new text as well, otherwise calling
 936     // SetItemText() in the OnBeginLabelEdit() handler doesn't have any effect
 937     //
 938     // don't use GetEditControl() here because m_textCtrl is not set yet
 939     HWND hwndEdit = TreeView_GetEditControl(GetHwnd());
 940     if ( hwndEdit )
 941     {
 942         if ( item == m_idEdited )
 943         {
 944             ::SetWindowText(hwndEdit, text.wx_str());
 945         }
 946     }
 947 }
 948
 949 int wxTreeCtrl::GetItemImage(const wxTreeItemId& item,
 950                              wxTreeItemIcon which) const
 951 {
 952     wxCHECK_MSG( item.IsOk(), -1, wxT("invalid tree item") );
 953
 954     if ( IsHiddenRoot(item) )
 955     {
 956         // no images for hidden root item
 957         return -1;
 958     }
 959
 960     wxTreeItemParam *param = GetItemParam(item);
 961
 962     return param && param->HasImage(which) ? param->GetImage(which) : -1;
 963 }
 964
 965 void wxTreeCtrl::SetItemImage(const wxTreeItemId& item, int image,
 966                               wxTreeItemIcon which)
 967 {
 968     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
 969     wxCHECK_RET( which >= 0 &&
 970                  which < wxTreeItemIcon_Max,
 971                  wxT("invalid image index"));
 972
 973
 974     if ( IsHiddenRoot(item) )
 975     {
 976         // no images for hidden root item
 977         return;
 978     }
 979
 980     wxTreeItemParam *data = GetItemParam(item);
 981     if ( !data )
 982         return;
 983
 984     data->SetImage(image, which);
 985
 986     RefreshItem(item);
 987 }
 988
 989 wxTreeItemParam *wxTreeCtrl::GetItemParam(const wxTreeItemId& item) const
 990 {
 991     wxCHECK_MSG( item.IsOk(), NULL, wxT("invalid tree item") );
 992
 993     wxTreeViewItem tvItem(item, TVIF_PARAM);
 994
 995     // hidden root may still have data.
 996     if ( IS_VIRTUAL_ROOT(item) )
 997     {
 998         return GET_VIRTUAL_ROOT()->GetParam();
 999     }
1000
1001     // visible node.
1002     if ( !DoGetItem(&tvItem) )
1003     {
1004         return NULL;
1005     }
1006
1007     return (wxTreeItemParam *)tvItem.lParam;
1008 }
1009
1010 wxTreeItemData *wxTreeCtrl::GetItemData(const wxTreeItemId& item) const
1011 {
1012     wxTreeItemParam *data = GetItemParam(item);
1013
1014     return data ? data->GetData() : NULL;
1015 }
1016
1017 void wxTreeCtrl::SetItemData(const wxTreeItemId& item, wxTreeItemData *data)
1018 {
1019     // first, associate this piece of data with this item
1020     if ( data )
1021     {
1022         data->SetId(item);
1023     }
1024
1025     wxTreeItemParam *param = GetItemParam(item);
1026
1027     wxCHECK_RET( param, wxT("failed to change tree items data") );
1028
1029     param->SetData(data);
1030 }
1031
1032 void wxTreeCtrl::SetItemHasChildren(const wxTreeItemId& item, bool has)
1033 {
1034     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
1035
1036     if ( IS_VIRTUAL_ROOT(item) )
1037         return;
1038
1039     wxTreeViewItem tvItem(item, TVIF_CHILDREN);
1040     tvItem.cChildren = (int)has;
1041     DoSetItem(&tvItem);
1042 }
1043
1044 void wxTreeCtrl::SetItemBold(const wxTreeItemId& item, bool bold)
1045 {
1046     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
1047
1048     if ( IS_VIRTUAL_ROOT(item) )
1049         return;
1050
1051     wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_BOLD);
1052     tvItem.state = bold ? TVIS_BOLD : 0;
1053     DoSetItem(&tvItem);
1054 }
1055
1056 void wxTreeCtrl::SetItemDropHighlight(const wxTreeItemId& item, bool highlight)
1057 {
1058     if ( IS_VIRTUAL_ROOT(item) )
1059         return;
1060
1061     wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_DROPHILITED);
1062     tvItem.state = highlight ? TVIS_DROPHILITED : 0;
1063     DoSetItem(&tvItem);
1064 }
1065
1066 void wxTreeCtrl::RefreshItem(const wxTreeItemId& item)
1067 {
1068     if ( IS_VIRTUAL_ROOT(item) )
1069         return;
1070
1071     wxRect rect;
1072     if ( GetBoundingRect(item, rect) )
1073     {
1074         RefreshRect(rect);
1075     }
1076 }
1077
1078 wxColour wxTreeCtrl::GetItemTextColour(const wxTreeItemId& item) const
1079 {
1080     wxCHECK_MSG( item.IsOk(), wxNullColour, wxT("invalid tree item") );
1081
1082     wxMapTreeAttr::const_iterator it = m_attrs.find(item.m_pItem);
1083     return it == m_attrs.end() ? wxNullColour : it->second->GetTextColour();
1084 }
1085
1086 wxColour wxTreeCtrl::GetItemBackgroundColour(const wxTreeItemId& item) const
1087 {
1088     wxCHECK_MSG( item.IsOk(), wxNullColour, wxT("invalid tree item") );
1089
1090     wxMapTreeAttr::const_iterator it = m_attrs.find(item.m_pItem);
1091     return it == m_attrs.end() ? wxNullColour : it->second->GetBackgroundColour();
1092 }
1093
1094 wxFont wxTreeCtrl::GetItemFont(const wxTreeItemId& item) const
1095 {
1096     wxCHECK_MSG( item.IsOk(), wxNullFont, wxT("invalid tree item") );
1097
1098     wxMapTreeAttr::const_iterator it = m_attrs.find(item.m_pItem);
1099     return it == m_attrs.end() ? wxNullFont : it->second->GetFont();
1100 }
1101
1102 void wxTreeCtrl::SetItemTextColour(const wxTreeItemId& item,
1103                                    const wxColour& col)
1104 {
1105     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
1106
1107     wxTreeItemAttr *attr;
1108     wxMapTreeAttr::iterator it = m_attrs.find(item.m_pItem);
1109     if ( it == m_attrs.end() )
1110     {
1111         m_hasAnyAttr = true;
1112
1113         m_attrs[item.m_pItem] =
1114         attr = new wxTreeItemAttr;
1115     }
1116     else
1117     {
1118         attr = it->second;
1119     }
1120
1121     attr->SetTextColour(col);
1122
1123     RefreshItem(item);
1124 }
1125
1126 void wxTreeCtrl::SetItemBackgroundColour(const wxTreeItemId& item,
1127                                          const wxColour& col)
1128 {
1129     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
1130
1131     wxTreeItemAttr *attr;
1132     wxMapTreeAttr::iterator it = m_attrs.find(item.m_pItem);
1133     if ( it == m_attrs.end() )
1134     {
1135         m_hasAnyAttr = true;
1136
1137         m_attrs[item.m_pItem] =
1138         attr = new wxTreeItemAttr;
1139     }
1140     else // already in the hash
1141     {
1142         attr = it->second;
1143     }
1144
1145     attr->SetBackgroundColour(col);
1146
1147     RefreshItem(item);
1148 }
1149
1150 void wxTreeCtrl::SetItemFont(const wxTreeItemId& item, const wxFont& font)
1151 {
1152     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
1153
1154     wxTreeItemAttr *attr;
1155     wxMapTreeAttr::iterator it = m_attrs.find(item.m_pItem);
1156     if ( it == m_attrs.end() )
1157     {
1158         m_hasAnyAttr = true;
1159
1160         m_attrs[item.m_pItem] =
1161         attr = new wxTreeItemAttr;
1162     }
1163     else // already in the hash
1164     {
1165         attr = it->second;
1166     }
1167
1168     attr->SetFont(font);
1169
1170     // Reset the item's text to ensure that the bounding rect will be adjusted
1171     // for the new font.
1172     SetItemText(item, GetItemText(item));
1173
1174     RefreshItem(item);
1175 }
1176
1177 // ----------------------------------------------------------------------------
1178 // Item status
1179 // ----------------------------------------------------------------------------
1180
1181 bool wxTreeCtrl::IsVisible(const wxTreeItemId& item) const
1182 {
1183     wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") );
1184
1185     if ( item == wxTreeItemId(TVI_ROOT) )
1186     {
1187         // virtual (hidden) root is never visible
1188         return false;
1189     }
1190
1191     // Bug in Gnu-Win32 headers, so don't use the macro TreeView_GetItemRect
1192     RECT rect;
1193
1194     // this ugliness comes directly from MSDN - it *is* the correct way to pass
1195     // the HTREEITEM with TVM_GETITEMRECT
1196     *(HTREEITEM *)&rect = HITEM(item);
1197
1198     // true means to get rect for just the text, not the whole line
1199     if ( !::SendMessage(GetHwnd(), TVM_GETITEMRECT, true, (LPARAM)&rect) )
1200     {
1201         // if TVM_GETITEMRECT returned false, then the item is definitely not
1202         // visible (because its parent is not expanded)
1203         return false;
1204     }
1205
1206     // however if it returned true, the item might still be outside the
1207     // currently visible part of the tree, test for it (notice that partly
1208     // visible means visible here)
1209     return rect.bottom > 0 && rect.top < GetClientSize().y;
1210 }
1211
1212 bool wxTreeCtrl::ItemHasChildren(const wxTreeItemId& item) const
1213 {
1214     wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") );
1215
1216     wxTreeViewItem tvItem(item, TVIF_CHILDREN);
1217     DoGetItem(&tvItem);
1218
1219     return tvItem.cChildren != 0;
1220 }
1221
1222 bool wxTreeCtrl::IsExpanded(const wxTreeItemId& item) const
1223 {
1224     wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") );
1225
1226     wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_EXPANDED);
1227     DoGetItem(&tvItem);
1228
1229     return (tvItem.state & TVIS_EXPANDED) != 0;
1230 }
1231
1232 bool wxTreeCtrl::IsSelected(const wxTreeItemId& item) const
1233 {
1234     wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") );
1235
1236     wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_SELECTED);
1237     DoGetItem(&tvItem);
1238
1239     return (tvItem.state & TVIS_SELECTED) != 0;
1240 }
1241
1242 bool wxTreeCtrl::IsBold(const wxTreeItemId& item) const
1243 {
1244     wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") );
1245
1246     wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_BOLD);
1247     DoGetItem(&tvItem);
1248
1249     return (tvItem.state & TVIS_BOLD) != 0;
1250 }
1251
1252 // ----------------------------------------------------------------------------
1253 // navigation
1254 // ----------------------------------------------------------------------------
1255
1256 wxTreeItemId wxTreeCtrl::GetRootItem() const
1257 {
1258     // Root may be real (visible) or virtual (hidden).
1259     if ( GET_VIRTUAL_ROOT() )
1260         return TVI_ROOT;
1261
1262     return wxTreeItemId(TreeView_GetRoot(GetHwnd()));
1263 }
1264
1265 wxTreeItemId wxTreeCtrl::GetSelection() const
1266 {
1267     wxCHECK_MSG( !(m_windowStyle & wxTR_MULTIPLE), wxTreeItemId(),
1268                  wxT("this only works with single selection controls") );
1269
1270     return wxTreeItemId(TreeView_GetSelection(GetHwnd()));
1271 }
1272
1273 wxTreeItemId wxTreeCtrl::GetItemParent(const wxTreeItemId& item) const
1274 {
1275     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1276
1277     HTREEITEM hItem;
1278
1279     if ( IS_VIRTUAL_ROOT(item) )
1280     {
1281         // no parent for the virtual root
1282         hItem = 0;
1283     }
1284     else // normal item
1285     {
1286         hItem = TreeView_GetParent(GetHwnd(), HITEM(item));
1287         if ( !hItem && HasFlag(wxTR_HIDE_ROOT) )
1288         {
1289             // the top level items should have the virtual root as their parent
1290             hItem = TVI_ROOT;
1291         }
1292     }
1293
1294     return wxTreeItemId(hItem);
1295 }
1296
1297 wxTreeItemId wxTreeCtrl::GetFirstChild(const wxTreeItemId& item,
1298                                        wxTreeItemIdValue& cookie) const
1299 {
1300     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1301
1302     // remember the last child returned in 'cookie'
1303     cookie = TreeView_GetChild(GetHwnd(), HITEM(item));
1304
1305     return wxTreeItemId(cookie);
1306 }
1307
1308 wxTreeItemId wxTreeCtrl::GetNextChild(const wxTreeItemId& WXUNUSED(item),
1309                                       wxTreeItemIdValue& cookie) const
1310 {
1311     wxTreeItemId fromCookie(cookie);
1312
1313     HTREEITEM hitem = HITEM(fromCookie);
1314
1315     hitem = TreeView_GetNextSibling(GetHwnd(), hitem);
1316
1317     wxTreeItemId item(hitem);
1318
1319     cookie = item.m_pItem;
1320
1321     return item;
1322 }
1323
1324 wxTreeItemId wxTreeCtrl::GetLastChild(const wxTreeItemId& item) const
1325 {
1326     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1327
1328     // can this be done more efficiently?
1329     wxTreeItemIdValue cookie;
1330
1331     wxTreeItemId childLast,
1332     child = GetFirstChild(item, cookie);
1333     while ( child.IsOk() )
1334     {
1335         childLast = child;
1336         child = GetNextChild(item, cookie);
1337     }
1338
1339     return childLast;
1340 }
1341
1342 wxTreeItemId wxTreeCtrl::GetNextSibling(const wxTreeItemId& item) const
1343 {
1344     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1345     return wxTreeItemId(TreeView_GetNextSibling(GetHwnd(), HITEM(item)));
1346 }
1347
1348 wxTreeItemId wxTreeCtrl::GetPrevSibling(const wxTreeItemId& item) const
1349 {
1350     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1351     return wxTreeItemId(TreeView_GetPrevSibling(GetHwnd(), HITEM(item)));
1352 }
1353
1354 wxTreeItemId wxTreeCtrl::GetFirstVisibleItem() const
1355 {
1356     return wxTreeItemId(TreeView_GetFirstVisible(GetHwnd()));
1357 }
1358
1359 wxTreeItemId wxTreeCtrl::GetNextVisible(const wxTreeItemId& item) const
1360 {
1361     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1362     wxASSERT_MSG( IsVisible(item), wxT("The item you call GetNextVisible() for must be visible itself!"));
1363
1364     wxTreeItemId next(TreeView_GetNextVisible(GetHwnd(), HITEM(item)));
1365     if ( next.IsOk() && !IsVisible(next) )
1366     {
1367         // Win32 considers that any non-collapsed item is visible while we want
1368         // to return only really visible items
1369         next.Unset();
1370     }
1371
1372     return next;
1373 }
1374
1375 wxTreeItemId wxTreeCtrl::GetPrevVisible(const wxTreeItemId& item) const
1376 {
1377     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1378     wxASSERT_MSG( IsVisible(item), wxT("The item you call GetPrevVisible() for must be visible itself!"));
1379
1380     wxTreeItemId prev(TreeView_GetPrevVisible(GetHwnd(), HITEM(item)));
1381     if ( prev.IsOk() && !IsVisible(prev) )
1382     {
1383         // just as above, Win32 function will happily return the previous item
1384         // in the tree for the first visible item too
1385         prev.Unset();
1386     }
1387
1388     return prev;
1389 }
1390
1391 // ----------------------------------------------------------------------------
1392 // multiple selections emulation
1393 // ----------------------------------------------------------------------------
1394
1395 size_t wxTreeCtrl::GetSelections(wxArrayTreeItemIds& selections) const
1396 {
1397     TraverseSelections selector(this, selections);
1398
1399     return selector.GetCount();
1400 }
1401
1402 // ----------------------------------------------------------------------------
1403 // Usual operations
1404 // ----------------------------------------------------------------------------
1405
1406 wxTreeItemId wxTreeCtrl::DoInsertAfter(const wxTreeItemId& parent,
1407                                        const wxTreeItemId& hInsertAfter,
1408                                        const wxString& text,
1409                                        int image, int selectedImage,
1410                                        wxTreeItemData *data)
1411 {
1412     wxCHECK_MSG( parent.IsOk() || !TreeView_GetRoot(GetHwnd()),
1413                  wxTreeItemId(),
1414                  _T("can't have more than one root in the tree") );
1415
1416     TV_INSERTSTRUCT tvIns;
1417     tvIns.hParent = HITEM(parent);
1418     tvIns.hInsertAfter = HITEM(hInsertAfter);
1419
1420     // this is how we insert the item as the first child: supply a NULL
1421     // hInsertAfter
1422     if ( !tvIns.hInsertAfter )
1423     {
1424         tvIns.hInsertAfter = TVI_FIRST;
1425     }
1426
1427     UINT mask = 0;
1428     if ( !text.empty() )
1429     {
1430         mask |= TVIF_TEXT;
1431         tvIns.item.pszText = (wxChar *)text.wx_str();  // cast is ok
1432     }
1433     else
1434     {
1435         tvIns.item.pszText = NULL;
1436         tvIns.item.cchTextMax = 0;
1437     }
1438
1439     // create the param which will store the other item parameters
1440     wxTreeItemParam *param = new wxTreeItemParam;
1441
1442     // we return the images on demand as they depend on whether the item is
1443     // expanded or collapsed too in our case
1444     mask |= TVIF_IMAGE | TVIF_SELECTEDIMAGE;
1445     tvIns.item.iImage = I_IMAGECALLBACK;
1446     tvIns.item.iSelectedImage = I_IMAGECALLBACK;
1447
1448     param->SetImage(image, wxTreeItemIcon_Normal);
1449     param->SetImage(selectedImage, wxTreeItemIcon_Selected);
1450
1451     mask |= TVIF_PARAM;
1452     tvIns.item.lParam = (LPARAM)param;
1453     tvIns.item.mask = mask;
1454
1455     // don't use the hack below for the children of hidden root: this results
1456     // in a crash inside comctl32.dll when we call TreeView_GetItemRect()
1457     const bool firstChild = !IsHiddenRoot(parent) &&
1458                                 !TreeView_GetChild(GetHwnd(), HITEM(parent));
1459
1460     HTREEITEM id = TreeView_InsertItem(GetHwnd(), &tvIns);
1461     if ( id == 0 )
1462     {
1463         wxLogLastError(wxT("TreeView_InsertItem"));
1464     }
1465
1466     // apparently some Windows versions (2000 and XP are reported to do this)
1467     // sometimes don't refresh the tree after adding the first child and so we
1468     // need this to make the "[+]" appear
1469     if ( firstChild )
1470     {
1471         RECT rect;
1472         TreeView_GetItemRect(GetHwnd(), HITEM(parent), &rect, FALSE);
1473         ::InvalidateRect(GetHwnd(), &rect, FALSE);
1474     }
1475
1476     // associate the application tree item with Win32 tree item handle
1477     param->SetItem(id);
1478
1479     // setup wxTreeItemData
1480     if ( data != NULL )
1481     {
1482         param->SetData(data);
1483         data->SetId(id);
1484     }
1485
1486     return wxTreeItemId(id);
1487 }
1488
1489 wxTreeItemId wxTreeCtrl::AddRoot(const wxString& text,
1490                                  int image, int selectedImage,
1491                                  wxTreeItemData *data)
1492 {
1493     if ( HasFlag(wxTR_HIDE_ROOT) )
1494     {
1495         wxASSERT_MSG( !m_pVirtualRoot, _T("tree can have only a single root") );
1496
1497         // create a virtual root item, the parent for all the others
1498         wxTreeItemParam *param = new wxTreeItemParam;
1499         param->SetData(data);
1500
1501         m_pVirtualRoot = new wxVirtualNode(param);
1502
1503         return TVI_ROOT;
1504     }
1505
1506     return DoInsertAfter(wxTreeItemId(), wxTreeItemId(),
1507                            text, image, selectedImage, data);
1508 }
1509
1510 wxTreeItemId wxTreeCtrl::DoInsertItem(const wxTreeItemId& parent,
1511                                       size_t index,
1512                                       const wxString& text,
1513                                       int image, int selectedImage,
1514                                       wxTreeItemData *data)
1515 {
1516     wxTreeItemId idPrev;
1517     if ( index == (size_t)-1 )
1518     {
1519         // special value: append to the end
1520         idPrev = TVI_LAST;
1521     }
1522     else // find the item from index
1523     {
1524         wxTreeItemIdValue cookie;
1525         wxTreeItemId idCur = GetFirstChild(parent, cookie);
1526         while ( index != 0 && idCur.IsOk() )
1527         {
1528             index--;
1529
1530             idPrev = idCur;
1531             idCur = GetNextChild(parent, cookie);
1532         }
1533
1534         // assert, not check: if the index is invalid, we will append the item
1535         // to the end
1536         wxASSERT_MSG( index == 0, _T("bad index in wxTreeCtrl::InsertItem") );
1537     }
1538
1539     return DoInsertAfter(parent, idPrev, text, image, selectedImage, data);
1540 }
1541
1542 void wxTreeCtrl::Delete(const wxTreeItemId& item)
1543 {
1544     // unlock tree selections on vista, without this the
1545     // tree ctrl will eventually crash after item deletion
1546     TreeItemUnlocker unlock_all;
1547
1548     if ( !TreeView_DeleteItem(GetHwnd(), HITEM(item)) )
1549     {
1550         wxLogLastError(wxT("TreeView_DeleteItem"));
1551     }
1552 }
1553
1554 // delete all children (but don't delete the item itself)
1555 void wxTreeCtrl::DeleteChildren(const wxTreeItemId& item)
1556 {
1557     // unlock tree selections on vista for the duration of this call
1558     TreeItemUnlocker unlock_all;
1559
1560     wxTreeItemIdValue cookie;
1561
1562     wxArrayTreeItemIds children;
1563     wxTreeItemId child = GetFirstChild(item, cookie);
1564     while ( child.IsOk() )
1565     {
1566         children.Add(child);
1567
1568         child = GetNextChild(item, cookie);
1569     }
1570
1571     size_t nCount = children.Count();
1572     for ( size_t n = 0; n < nCount; n++ )
1573     {
1574         if ( !TreeView_DeleteItem(GetHwnd(), HITEM(children[n])) )
1575         {
1576             wxLogLastError(wxT("TreeView_DeleteItem"));
1577         }
1578     }
1579 }
1580
1581 void wxTreeCtrl::DeleteAllItems()
1582 {
1583     // unlock tree selections on vista for the duration of this call
1584     TreeItemUnlocker unlock_all;
1585
1586     // delete the "virtual" root item.
1587     if ( GET_VIRTUAL_ROOT() )
1588     {
1589         delete GET_VIRTUAL_ROOT();
1590         m_pVirtualRoot = NULL;
1591     }
1592
1593     // and all the real items
1594
1595     if ( !TreeView_DeleteAllItems(GetHwnd()) )
1596     {
1597         wxLogLastError(wxT("TreeView_DeleteAllItems"));
1598     }
1599 }
1600
1601 void wxTreeCtrl::DoExpand(const wxTreeItemId& item, int flag)
1602 {
1603     wxASSERT_MSG( flag == TVE_COLLAPSE ||
1604                   flag == (TVE_COLLAPSE | TVE_COLLAPSERESET) ||
1605                   flag == TVE_EXPAND   ||
1606                   flag == TVE_TOGGLE,
1607                   wxT("Unknown flag in wxTreeCtrl::DoExpand") );
1608
1609     // A hidden root can be neither expanded nor collapsed.
1610     wxCHECK_RET( !IsHiddenRoot(item),
1611                  wxT("Can't expand/collapse hidden root node!") );
1612
1613     // TreeView_Expand doesn't send TVN_ITEMEXPAND(ING) messages, so we must
1614     // emulate them. This behaviour has changed slightly with comctl32.dll
1615     // v 4.70 - now it does send them but only the first time. To maintain
1616     // compatible behaviour and also in order to not have surprises with the
1617     // future versions, don't rely on this and still do everything ourselves.
1618     // To avoid that the messages be sent twice when the item is expanded for
1619     // the first time we must clear TVIS_EXPANDEDONCE style manually.
1620
1621     wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_EXPANDEDONCE);
1622     tvItem.state = 0;
1623     DoSetItem(&tvItem);
1624
1625     if ( TreeView_Expand(GetHwnd(), HITEM(item), flag) != 0 )
1626     {
1627         // note that the {EXPAND|COLLAPS}ING event is sent by TreeView_Expand()
1628         // itself
1629         wxTreeEvent event(gs_expandEvents[IsExpanded(item) ? IDX_EXPAND
1630                                                            : IDX_COLLAPSE]
1631                                          [IDX_DONE],
1632                            this, item);
1633         (void)HandleWindowEvent(event);
1634     }
1635     //else: change didn't took place, so do nothing at all
1636 }
1637
1638 void wxTreeCtrl::Expand(const wxTreeItemId& item)
1639 {
1640     DoExpand(item, TVE_EXPAND);
1641 }
1642
1643 void wxTreeCtrl::Collapse(const wxTreeItemId& item)
1644 {
1645     DoExpand(item, TVE_COLLAPSE);
1646 }
1647
1648 void wxTreeCtrl::CollapseAndReset(const wxTreeItemId& item)
1649 {
1650     DoExpand(item, TVE_COLLAPSE | TVE_COLLAPSERESET);
1651 }
1652
1653 void wxTreeCtrl::Toggle(const wxTreeItemId& item)
1654 {
1655     DoExpand(item, TVE_TOGGLE);
1656 }
1657
1658 void wxTreeCtrl::Unselect()
1659 {
1660     wxASSERT_MSG( !(m_windowStyle & wxTR_MULTIPLE),
1661                   wxT("doesn't make sense, may be you want UnselectAll()?") );
1662
1663     // just remove the selection
1664     SelectItem(wxTreeItemId());
1665 }
1666
1667 void wxTreeCtrl::UnselectAll()
1668 {
1669     if ( m_windowStyle & wxTR_MULTIPLE )
1670     {
1671         wxArrayTreeItemIds selections;
1672         size_t count = GetSelections(selections);
1673         for ( size_t n = 0; n < count; n++ )
1674         {
1675             ::UnselectItem(GetHwnd(), HITEM(selections[n]));
1676         }
1677
1678         m_htSelStart.Unset();
1679     }
1680     else
1681     {
1682         // just remove the selection
1683         Unselect();
1684     }
1685 }
1686
1687 void wxTreeCtrl::SelectItem(const wxTreeItemId& item, bool select)
1688 {
1689     wxCHECK_RET( !IsHiddenRoot(item), _T("can't select hidden root item") );
1690
1691     wxASSERT_MSG( select || HasFlag(wxTR_MULTIPLE),
1692                   _T("SelectItem(false) works only for multiselect") );
1693
1694     wxTreeEvent event(wxEVT_COMMAND_TREE_SEL_CHANGING, this, item);
1695     if ( !HandleWindowEvent(event) || event.IsAllowed() )
1696     {
1697         if ( HasFlag(wxTR_MULTIPLE) )
1698         {
1699             if ( !::SelectItem(GetHwnd(), HITEM(item), select) )
1700             {
1701                 wxLogLastError(wxT("TreeView_SelectItem"));
1702                 return;
1703             }
1704         }
1705         else // single selection
1706         {
1707             // use TreeView_SelectItem() to deselect the previous selection
1708             if ( !TreeView_SelectItem(GetHwnd(), HITEM(item)) )
1709             {
1710                 wxLogLastError(wxT("TreeView_SelectItem"));
1711                 return;
1712             }
1713         }
1714
1715         event.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED);
1716         (void)HandleWindowEvent(event);
1717     }
1718     //else: program vetoed the change
1719 }
1720
1721 void wxTreeCtrl::EnsureVisible(const wxTreeItemId& item)
1722 {
1723     wxCHECK_RET( !IsHiddenRoot(item), _T("can't show hidden root item") );
1724
1725     // no error return
1726     TreeView_EnsureVisible(GetHwnd(), HITEM(item));
1727 }
1728
1729 void wxTreeCtrl::ScrollTo(const wxTreeItemId& item)
1730 {
1731     if ( !TreeView_SelectSetFirstVisible(GetHwnd(), HITEM(item)) )
1732     {
1733         wxLogLastError(wxT("TreeView_SelectSetFirstVisible"));
1734     }
1735 }
1736
1737 wxTextCtrl *wxTreeCtrl::GetEditControl() const
1738 {
1739     return m_textCtrl;
1740 }
1741
1742 void wxTreeCtrl::DeleteTextCtrl()
1743 {
1744     if ( m_textCtrl )
1745     {
1746         // the HWND corresponding to this control is deleted by the tree
1747         // control itself and we don't know when exactly this happens, so check
1748         // if the window still exists before calling UnsubclassWin()
1749         if ( !::IsWindow(GetHwndOf(m_textCtrl)) )
1750         {
1751             m_textCtrl->SetHWND(0);
1752         }
1753
1754         m_textCtrl->UnsubclassWin();
1755         m_textCtrl->SetHWND(0);
1756         delete m_textCtrl;
1757         m_textCtrl = NULL;
1758
1759         m_idEdited.Unset();
1760     }
1761 }
1762
1763 wxTextCtrl *wxTreeCtrl::EditLabel(const wxTreeItemId& item,
1764                                   wxClassInfo *textControlClass)
1765 {
1766     wxASSERT( textControlClass->IsKindOf(CLASSINFO(wxTextCtrl)) );
1767
1768     DeleteTextCtrl();
1769
1770     m_idEdited = item;
1771     m_textCtrl = (wxTextCtrl *)textControlClass->CreateObject();
1772     HWND hWnd = (HWND) TreeView_EditLabel(GetHwnd(), HITEM(item));
1773
1774     // this is not an error - the TVN_BEGINLABELEDIT handler might have
1775     // returned false
1776     if ( !hWnd )
1777     {
1778         delete m_textCtrl;
1779         m_textCtrl = NULL;
1780         return NULL;
1781     }
1782
1783     // textctrl is subclassed in MSWOnNotify
1784     return m_textCtrl;
1785 }
1786
1787 // End label editing, optionally cancelling the edit
1788 void wxTreeCtrl::DoEndEditLabel(bool discardChanges)
1789 {
1790     TreeView_EndEditLabelNow(GetHwnd(), discardChanges);
1791
1792     DeleteTextCtrl();
1793 }
1794
1795 wxTreeItemId wxTreeCtrl::DoTreeHitTest(const wxPoint& point, int& flags) const
1796 {
1797     TV_HITTESTINFO hitTestInfo;
1798     hitTestInfo.pt.x = (int)point.x;
1799     hitTestInfo.pt.y = (int)point.y;
1800
1801     (void) TreeView_HitTest(GetHwnd(), &hitTestInfo);
1802
1803     flags = 0;
1804
1805     // avoid repetition
1806     #define TRANSLATE_FLAG(flag) if ( hitTestInfo.flags & TVHT_##flag ) \
1807                                     flags |= wxTREE_HITTEST_##flag
1808
1809     TRANSLATE_FLAG(ABOVE);
1810     TRANSLATE_FLAG(BELOW);
1811     TRANSLATE_FLAG(NOWHERE);
1812     TRANSLATE_FLAG(ONITEMBUTTON);
1813     TRANSLATE_FLAG(ONITEMICON);
1814     TRANSLATE_FLAG(ONITEMINDENT);
1815     TRANSLATE_FLAG(ONITEMLABEL);
1816     TRANSLATE_FLAG(ONITEMRIGHT);
1817     TRANSLATE_FLAG(ONITEMSTATEICON);
1818     TRANSLATE_FLAG(TOLEFT);
1819     TRANSLATE_FLAG(TORIGHT);
1820
1821     #undef TRANSLATE_FLAG
1822
1823     return wxTreeItemId(hitTestInfo.hItem);
1824 }
1825
1826 bool wxTreeCtrl::GetBoundingRect(const wxTreeItemId& item,
1827                                  wxRect& rect,
1828                                  bool textOnly) const
1829 {
1830     RECT rc;
1831
1832     // Virtual root items have no bounding rectangle
1833     if ( IS_VIRTUAL_ROOT(item) )
1834     {
1835         return false;
1836     }
1837
1838     if ( TreeView_GetItemRect(GetHwnd(), HITEM(item),
1839                               &rc, textOnly) )
1840     {
1841         rect = wxRect(wxPoint(rc.left, rc.top), wxPoint(rc.right, rc.bottom));
1842
1843         return true;
1844     }
1845     else
1846     {
1847         // couldn't retrieve rect: for example, item isn't visible
1848         return false;
1849     }
1850 }
1851
1852 // ----------------------------------------------------------------------------
1853 // sorting stuff
1854 // ----------------------------------------------------------------------------
1855
1856 // this is just a tiny namespace which is friend to wxTreeCtrl and so can use
1857 // functions such as IsDataIndirect()
1858 class wxTreeSortHelper
1859 {
1860 public:
1861     static int CALLBACK Compare(LPARAM data1, LPARAM data2, LPARAM tree);
1862
1863 private:
1864     static wxTreeItemId GetIdFromData(LPARAM lParam)
1865     {
1866         return ((wxTreeItemParam*)lParam)->GetItem();
1867         }
1868 };
1869
1870 int CALLBACK wxTreeSortHelper::Compare(LPARAM pItem1,
1871                                        LPARAM pItem2,
1872                                        LPARAM htree)
1873 {
1874     wxCHECK_MSG( pItem1 && pItem2, 0,
1875                  wxT("sorting tree without data doesn't make sense") );
1876
1877     wxTreeCtrl *tree = (wxTreeCtrl *)htree;
1878
1879     return tree->OnCompareItems(GetIdFromData(pItem1),
1880                                 GetIdFromData(pItem2));
1881 }
1882
1883 void wxTreeCtrl::SortChildren(const wxTreeItemId& item)
1884 {
1885     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
1886
1887     // rely on the fact that TreeView_SortChildren does the same thing as our
1888     // default behaviour, i.e. sorts items alphabetically and so call it
1889     // directly if we're not in derived class (much more efficient!)
1890     // RN: Note that if you find you're code doesn't sort as expected this
1891     //     may be why as if you don't use the DECLARE_CLASS/IMPLEMENT_CLASS
1892     //     combo for your derived wxTreeCtrl if will sort without
1893     //     OnCompareItems
1894     if ( GetClassInfo() == CLASSINFO(wxTreeCtrl) )
1895     {
1896         TreeView_SortChildren(GetHwnd(), HITEM(item), 0);
1897     }
1898     else
1899     {
1900         TV_SORTCB tvSort;
1901         tvSort.hParent = HITEM(item);
1902         tvSort.lpfnCompare = wxTreeSortHelper::Compare;
1903         tvSort.lParam = (LPARAM)this;
1904         TreeView_SortChildrenCB(GetHwnd(), &tvSort, 0 /* reserved */);
1905     }
1906 }
1907
1908 // ----------------------------------------------------------------------------
1909 // implementation
1910 // ----------------------------------------------------------------------------
1911
1912 bool wxTreeCtrl::MSWShouldPreProcessMessage(WXMSG* msg)
1913 {
1914     if ( msg->message == WM_KEYDOWN )
1915     {
1916         // Only eat VK_RETURN if not being used by the application in
1917         // conjunction with modifiers
1918         if ( (msg->wParam == VK_RETURN) && !wxIsAnyModifierDown() )
1919         {
1920             // we need VK_RETURN to generate wxEVT_COMMAND_TREE_ITEM_ACTIVATED
1921             return false;
1922         }
1923     }
1924
1925     return wxTreeCtrlBase::MSWShouldPreProcessMessage(msg);
1926 }
1927
1928 bool wxTreeCtrl::MSWCommand(WXUINT cmd, WXWORD id_)
1929 {
1930     const int id = (signed short)id_;
1931
1932     if ( cmd == EN_UPDATE )
1933     {
1934         wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, id);
1935         event.SetEventObject( this );
1936         ProcessCommand(event);
1937     }
1938     else if ( cmd == EN_KILLFOCUS )
1939     {
1940         wxCommandEvent event(wxEVT_KILL_FOCUS, id);
1941         event.SetEventObject( this );
1942         ProcessCommand(event);
1943     }
1944     else
1945     {
1946         // nothing done
1947         return false;
1948     }
1949
1950     // command processed
1951     return true;
1952 }
1953
1954 // we hook into WndProc to process WM_MOUSEMOVE/WM_BUTTONUP messages - as we
1955 // only do it during dragging, minimize wxWin overhead (this is important for
1956 // WM_MOUSEMOVE as they're a lot of them) by catching Windows messages directly
1957 // instead of passing by wxWin events
1958 WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
1959 {
1960     bool processed = false;
1961     WXLRESULT rc = 0;
1962     bool isMultiple = HasFlag(wxTR_MULTIPLE);
1963
1964     // This message is sent after a right-click, or when the "menu" key is pressed
1965     if ( nMsg == WM_CONTEXTMENU )
1966     {
1967         int x = GET_X_LPARAM(lParam),
1968             y = GET_Y_LPARAM(lParam);
1969
1970         // the item for which the menu should be shown
1971         wxTreeItemId item;
1972
1973         // the position where the menu should be shown in client coordinates
1974         // (so that it can be passed directly to PopupMenu())
1975         wxPoint pt;
1976
1977         if ( x == -1 || y == -1 )
1978         {
1979             // this means that the event was generated from keyboard (e.g. with
1980             // Shift-F10 or special Windows menu key)
1981             //
1982             // use the Explorer standard of putting the menu at the left edge
1983             // of the text, in the vertical middle of the text
1984             item = wxTreeItemId(TreeView_GetSelection(GetHwnd()));
1985             if ( item.IsOk() )
1986             {
1987                 // Use the bounding rectangle of only the text part
1988                 wxRect rect;
1989                 GetBoundingRect(item, rect, true);
1990                 pt = wxPoint(rect.GetX(), rect.GetY() + rect.GetHeight() / 2);
1991             }
1992         }
1993         else // event from mouse, use mouse position
1994         {
1995             pt = ScreenToClient(wxPoint(x, y));
1996
1997             TV_HITTESTINFO tvhti;
1998             tvhti.pt.x = pt.x;
1999             tvhti.pt.y = pt.y;
2000             if ( TreeView_HitTest(GetHwnd(), &tvhti) )
2001                 item = wxTreeItemId(tvhti.hItem);
2002         }
2003
2004         // create the event
2005         wxTreeEvent event(wxEVT_COMMAND_TREE_ITEM_MENU, this, item);
2006
2007         event.m_pointDrag = pt;
2008
2009         if ( HandleWindowEvent(event) )
2010             processed = true;
2011         //else: continue with generating wxEVT_CONTEXT_MENU in base class code
2012     }
2013     else if ( (nMsg >= WM_MOUSEFIRST) && (nMsg <= WM_MOUSELAST) )
2014     {
2015         // we only process mouse messages here and these parameters have the
2016         // same meaning for all of them
2017         int x = GET_X_LPARAM(lParam),
2018             y = GET_Y_LPARAM(lParam);
2019
2020         TV_HITTESTINFO tvht;
2021         tvht.pt.x = x;
2022         tvht.pt.y = y;
2023
2024         HTREEITEM htItem = TreeView_HitTest(GetHwnd(), &tvht);
2025
2026         switch ( nMsg )
2027         {
2028             case WM_LBUTTONDOWN:
2029                 if ( htItem && isMultiple && (tvht.flags & TVHT_ONITEM) != 0 )
2030                 {
2031                     m_htClickedItem = (WXHTREEITEM) htItem;
2032                     m_ptClick = wxPoint(x, y);
2033
2034                     if ( wParam & MK_CONTROL )
2035                     {
2036                         SetFocus();
2037
2038                         // toggle selected state
2039                         ToggleItemSelection(htItem);
2040
2041                         ::SetFocus(GetHwnd(), htItem);
2042
2043                         // reset on any click without Shift
2044                         m_htSelStart.Unset();
2045
2046                         processed = true;
2047                     }
2048                     else if ( wParam & MK_SHIFT )
2049                     {
2050                         // this selects all items between the starting one and
2051                         // the current
2052
2053                         if ( !m_htSelStart )
2054                         {
2055                             // take the focused item
2056                             m_htSelStart = TreeView_GetSelection(GetHwnd());
2057                         }
2058
2059                         if ( m_htSelStart )
2060                             SelectRange(GetHwnd(), HITEM(m_htSelStart), htItem,
2061                                     !(wParam & MK_CONTROL));
2062                         else
2063                             ::SelectItem(GetHwnd(), htItem);
2064
2065                         ::SetFocus(GetHwnd(), htItem);
2066
2067                         processed = true;
2068                     }
2069                     else // normal click
2070                     {
2071                         // avoid doing anything if we click on the only
2072                         // currently selected item
2073
2074                         SetFocus();
2075
2076                         wxArrayTreeItemIds selections;
2077                         size_t count = GetSelections(selections);
2078                         if ( count == 0 ||
2079                              count > 1 ||
2080                              HITEM(selections[0]) != htItem )
2081                         {
2082                             // clear the previously selected items, if the
2083                             // user clicked outside of the present selection.
2084                             // otherwise, perform the deselection on mouse-up.
2085                             // this allows multiple drag and drop to work.
2086
2087                             if (!IsItemSelected(GetHwnd(), htItem))
2088                             {
2089                                 UnselectAll();
2090
2091                                 // prevent the click from starting in-place editing
2092                                 // which should only happen if we click on the
2093                                 // already selected item (and nothing else is
2094                                 // selected)
2095
2096                                 TreeView_SelectItem(GetHwnd(), 0);
2097                                 ::SelectItem(GetHwnd(), htItem);
2098                             }
2099                             ::SetFocus(GetHwnd(), htItem);
2100                             processed = true;
2101                         }
2102                         else // click on a single selected item
2103                         {
2104                             // don't interfere with the default processing in
2105                             // WM_MOUSEMOVE handler below as the default window
2106                             // proc will start the drag itself if we let have
2107                             // WM_LBUTTONDOWN
2108                             m_htClickedItem.Unset();
2109                         }
2110
2111                         // reset on any click without Shift
2112                         m_htSelStart.Unset();
2113                     }
2114                 }
2115                 break;
2116
2117             case WM_RBUTTONDOWN:
2118                 // default handler removes the highlight from the currently
2119                 // focused item when right mouse button is pressed on another
2120                 // one but keeps the remaining items highlighted, which is
2121                 // confusing, so override this default behaviour for tree with
2122                 // multiple selections
2123                 if ( isMultiple )
2124                 {
2125                     if ( !IsItemSelected(GetHwnd(), htItem) )
2126                     {
2127                         UnselectAll();
2128                         SelectItem(htItem);
2129                         ::SetFocus(GetHwnd(), htItem);
2130                     }
2131
2132                     // fire EVT_RIGHT_DOWN
2133                     HandleMouseEvent(nMsg, x, y, wParam);
2134
2135                     // send NM_RCLICK
2136                     NMHDR nmhdr;
2137                     nmhdr.hwndFrom = GetHwnd();
2138                     nmhdr.idFrom = ::GetWindowLong(GetHwnd(), GWL_ID);
2139                     nmhdr.code = NM_RCLICK;
2140                     ::SendMessage(::GetParent(GetHwnd()), WM_NOTIFY,
2141                                   nmhdr.idFrom, (LPARAM)&nmhdr);
2142
2143                     // prevent tree control default processing, as we've
2144                     // already done everything
2145                     processed = true;
2146                 }
2147                 break;
2148
2149             case WM_MOUSEMOVE:
2150 #ifndef __WXWINCE__
2151                 if ( m_htClickedItem )
2152                 {
2153                     int cx = abs(m_ptClick.x - x);
2154                     int cy = abs(m_ptClick.y - y);
2155
2156                     if ( cx > ::GetSystemMetrics(SM_CXDRAG) ||
2157                             cy > ::GetSystemMetrics(SM_CYDRAG) )
2158                     {
2159                         NM_TREEVIEW tv;
2160                         wxZeroMemory(tv);
2161
2162                         tv.hdr.hwndFrom = GetHwnd();
2163                         tv.hdr.idFrom = ::GetWindowLong(GetHwnd(), GWL_ID);
2164                         tv.hdr.code = TVN_BEGINDRAG;
2165
2166                         tv.itemNew.hItem = HITEM(m_htClickedItem);
2167
2168
2169                         TVITEM tviAux;
2170                         wxZeroMemory(tviAux);
2171
2172                         tviAux.hItem = HITEM(m_htClickedItem);
2173                         tviAux.mask = TVIF_STATE | TVIF_PARAM;
2174                         tviAux.stateMask = 0xffffffff;
2175                         TreeView_GetItem(GetHwnd(), &tviAux);
2176
2177                         tv.itemNew.state = tviAux.state;
2178                         tv.itemNew.lParam = tviAux.lParam;
2179
2180                         tv.ptDrag.x = x;
2181                         tv.ptDrag.y = y;
2182
2183                         // do it before SendMessage() call below to avoid
2184                         // reentrancies here if there is another WM_MOUSEMOVE
2185                         // in the queue already
2186                         m_htClickedItem.Unset();
2187
2188                         ::SendMessage(GetHwndOf(GetParent()), WM_NOTIFY,
2189                                       tv.hdr.idFrom, (LPARAM)&tv );
2190
2191                         // don't pass it to the default window proc, it would
2192                         // start dragging again
2193                         processed = true;
2194                     }
2195                 }
2196 #endif // __WXWINCE__
2197
2198 #if wxUSE_DRAGIMAGE
2199                 if ( m_dragImage )
2200                 {
2201                     m_dragImage->Move(wxPoint(x, y));
2202                     if ( htItem )
2203                     {
2204                         // highlight the item as target (hiding drag image is
2205                         // necessary - otherwise the display will be corrupted)
2206                         m_dragImage->Hide();
2207                         TreeView_SelectDropTarget(GetHwnd(), htItem);
2208                         m_dragImage->Show();
2209                     }
2210                 }
2211 #endif // wxUSE_DRAGIMAGE
2212                 break;
2213
2214             case WM_LBUTTONUP:
2215
2216                 // facilitates multiple drag-and-drop
2217                 if (htItem && isMultiple)
2218                 {
2219                     wxArrayTreeItemIds selections;
2220                     size_t count = GetSelections(selections);
2221
2222                     if (count > 1 &&
2223                         !(wParam & MK_CONTROL) &&
2224                         !(wParam & MK_SHIFT))
2225                     {
2226                         UnselectAll();
2227                         TreeView_SelectItem(GetHwnd(), htItem);
2228                         ::SelectItem(GetHwnd(), htItem);
2229                         ::SetFocus(GetHwnd(), htItem);
2230                     }
2231                     m_htClickedItem.Unset();
2232                 }
2233
2234                 // fall through
2235
2236             case WM_RBUTTONUP:
2237 #if wxUSE_DRAGIMAGE
2238                 if ( m_dragImage )
2239                 {
2240                     m_dragImage->EndDrag();
2241                     delete m_dragImage;
2242                     m_dragImage = NULL;
2243
2244                     // generate the drag end event
2245                     wxTreeEvent event(wxEVT_COMMAND_TREE_END_DRAG, this, htItem);
2246                     event.m_pointDrag = wxPoint(x, y);
2247
2248                     (void)HandleWindowEvent(event);
2249
2250                     // if we don't do it, the tree seems to think that 2 items
2251                     // are selected simultaneously which is quite weird
2252                     TreeView_SelectDropTarget(GetHwnd(), 0);
2253                 }
2254 #endif // wxUSE_DRAGIMAGE
2255                 break;
2256         }
2257     }
2258     else if ( (nMsg == WM_SETFOCUS || nMsg == WM_KILLFOCUS) && isMultiple )
2259     {
2260         // the tree control greys out the selected item when it loses focus and
2261         // paints it as selected again when it regains it, but it won't do it
2262         // for the other items itself - help it
2263         wxArrayTreeItemIds selections;
2264         size_t count = GetSelections(selections);
2265         RECT rect;
2266         for ( size_t n = 0; n < count; n++ )
2267         {
2268             // TreeView_GetItemRect() will return false if item is not visible,
2269             // which may happen perfectly well
2270             if ( TreeView_GetItemRect(GetHwnd(), HITEM(selections[n]),
2271                                       &rect, TRUE) )
2272             {
2273                 ::InvalidateRect(GetHwnd(), &rect, FALSE);
2274             }
2275         }
2276     }
2277     else if ( nMsg == WM_KEYDOWN && isMultiple )
2278     {
2279         bool bCtrl = wxIsCtrlDown(),
2280              bShift = wxIsShiftDown();
2281
2282         HTREEITEM htSel = (HTREEITEM)TreeView_GetSelection(GetHwnd());
2283         switch ( wParam )
2284         {
2285             case VK_SPACE:
2286                 if ( bCtrl )
2287                 {
2288                     ToggleItemSelection(htSel);
2289                 }
2290                 else
2291                 {
2292                     UnselectAll();
2293
2294                     ::SelectItem(GetHwnd(), htSel);
2295                 }
2296
2297                 processed = true;
2298                 break;
2299
2300             case VK_UP:
2301             case VK_DOWN:
2302                 if ( !bCtrl && !bShift )
2303                 {
2304                     // no modifiers, just clear selection and then let the default
2305                     // processing to take place
2306                     UnselectAll();
2307                 }
2308                 else if ( htSel )
2309                 {
2310                     (void)wxControl::MSWWindowProc(nMsg, wParam, lParam);
2311
2312                     HTREEITEM htNext = (HTREEITEM)
2313                         TreeView_GetNextItem
2314                         (
2315                             GetHwnd(),
2316                             htSel,
2317                             wParam == VK_UP ? TVGN_PREVIOUSVISIBLE
2318                                             : TVGN_NEXTVISIBLE
2319                         );
2320
2321                     if ( !htNext )
2322                     {
2323                         // at the top/bottom
2324                         htNext = htSel;
2325                     }
2326
2327                     if ( bShift )
2328                     {
2329                         if ( !m_htSelStart )
2330                             m_htSelStart = htSel;
2331
2332                         SelectRange(GetHwnd(), HITEM(m_htSelStart), htNext);
2333                     }
2334                     else // bCtrl
2335                     {
2336                         // without changing selection
2337                         ::SetFocus(GetHwnd(), htNext);
2338                     }
2339
2340                     processed = true;
2341                 }
2342                 break;
2343
2344             case VK_HOME:
2345             case VK_END:
2346             case VK_PRIOR:
2347             case VK_NEXT:
2348                 // TODO: handle Shift/Ctrl with these keys
2349                 if ( !bCtrl && !bShift )
2350                 {
2351                     UnselectAll();
2352
2353                     m_htSelStart.Unset();
2354                 }
2355         }
2356     }
2357     else if ( nMsg == WM_COMMAND )
2358     {
2359         // if we receive a EN_KILLFOCUS command from the in-place edit control
2360         // used for label editing, make sure to end editing
2361         WORD id, cmd;
2362         WXHWND hwnd;
2363         UnpackCommand(wParam, lParam, &id, &hwnd, &cmd);
2364
2365         if ( cmd == EN_KILLFOCUS )
2366         {
2367             if ( m_textCtrl && m_textCtrl->GetHandle() == hwnd )
2368             {
2369                 DoEndEditLabel();
2370
2371                 processed = true;
2372             }
2373         }
2374     }
2375
2376     if ( !processed )
2377         rc = wxControl::MSWWindowProc(nMsg, wParam, lParam);
2378
2379     return rc;
2380 }
2381
2382 WXLRESULT
2383 wxTreeCtrl::MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
2384 {
2385     if ( nMsg == WM_CHAR )
2386     {
2387         // don't let the control process Space and Return keys because it
2388         // doesn't do anything useful with them anyhow but always beeps
2389         // annoyingly when it receives them and there is no way to turn it off
2390         // simply if you just process TREEITEM_ACTIVATED event to which Space
2391         // and Enter presses are mapped in your code
2392         if ( wParam == VK_SPACE || wParam == VK_RETURN )
2393             return 0;
2394     }
2395 #if wxUSE_DRAGIMAGE
2396     else if ( nMsg == WM_KEYDOWN )
2397     {
2398         if ( wParam == VK_ESCAPE )
2399         {
2400             if ( m_dragImage )
2401             {
2402                 m_dragImage->EndDrag();
2403                 delete m_dragImage;
2404                 m_dragImage = NULL;
2405
2406                 // if we don't do it, the tree seems to think that 2 items
2407                 // are selected simultaneously which is quite weird
2408                 TreeView_SelectDropTarget(GetHwnd(), 0);
2409             }
2410         }
2411     }
2412 #endif // wxUSE_DRAGIMAGE
2413
2414     return wxControl::MSWDefWindowProc(nMsg, wParam, lParam);
2415 }
2416
2417 // process WM_NOTIFY Windows message
2418 bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
2419 {
2420     wxTreeEvent event(wxEVT_NULL, this);
2421     wxEventType eventType = wxEVT_NULL;
2422     NMHDR *hdr = (NMHDR *)lParam;
2423
2424     switch ( hdr->code )
2425     {
2426         case TVN_BEGINDRAG:
2427             eventType = wxEVT_COMMAND_TREE_BEGIN_DRAG;
2428             // fall through
2429
2430         case TVN_BEGINRDRAG:
2431             {
2432                 if ( eventType == wxEVT_NULL )
2433                     eventType = wxEVT_COMMAND_TREE_BEGIN_RDRAG;
2434                 //else: left drag, already set above
2435
2436                 NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam;
2437
2438                 event.m_item = tv->itemNew.hItem;
2439                 event.m_pointDrag = wxPoint(tv->ptDrag.x, tv->ptDrag.y);
2440
2441                 // don't allow dragging by default: the user code must
2442                 // explicitly say that it wants to allow it to avoid breaking
2443                 // the old apps
2444                 event.Veto();
2445             }
2446             break;
2447
2448         case TVN_BEGINLABELEDIT:
2449             {
2450                 eventType = wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT;
2451                 TV_DISPINFO *info = (TV_DISPINFO *)lParam;
2452
2453                 // although the user event handler may still veto it, it is
2454                 // important to set it now so that calls to SetItemText() from
2455                 // the event handler would change the text controls contents
2456                 m_idEdited =
2457                 event.m_item = info->item.hItem;
2458                 event.m_label = info->item.pszText;
2459                 event.m_editCancelled = false;
2460             }
2461             break;
2462
2463         case TVN_DELETEITEM:
2464             {
2465                 eventType = wxEVT_COMMAND_TREE_DELETE_ITEM;
2466                 NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam;
2467
2468                 event.m_item = tv->itemOld.hItem;
2469
2470                 if ( m_hasAnyAttr )
2471                 {
2472                     wxMapTreeAttr::iterator it = m_attrs.find(tv->itemOld.hItem);
2473                     if ( it != m_attrs.end() )
2474                     {
2475                         delete it->second;
2476                         m_attrs.erase(it);
2477                     }
2478                 }
2479             }
2480             break;
2481
2482         case TVN_ENDLABELEDIT:
2483             {
2484                 eventType = wxEVT_COMMAND_TREE_END_LABEL_EDIT;
2485                 TV_DISPINFO *info = (TV_DISPINFO *)lParam;
2486
2487                 event.m_item = info->item.hItem;
2488                 event.m_label = info->item.pszText;
2489                 event.m_editCancelled = info->item.pszText == NULL;
2490                 break;
2491             }
2492
2493 #ifndef __WXWINCE__
2494         // These *must* not be removed or TVN_GETINFOTIP will
2495         // not be processed each time the mouse is moved
2496         // and the tooltip will only ever update once.
2497         case TTN_NEEDTEXTA:
2498         case TTN_NEEDTEXTW:
2499             {
2500                 *result = 0;
2501
2502                 break;
2503             }
2504
2505 #ifdef TVN_GETINFOTIP
2506         case TVN_GETINFOTIP:
2507             {
2508                 eventType = wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP;
2509                 NMTVGETINFOTIP *info = (NMTVGETINFOTIP*)lParam;
2510
2511                 // Which item are we trying to get a tooltip for?
2512                 event.m_item = info->hItem;
2513
2514                 break;
2515             }
2516 #endif // TVN_GETINFOTIP
2517 #endif // !__WXWINCE__
2518
2519         case TVN_GETDISPINFO:
2520             eventType = wxEVT_COMMAND_TREE_GET_INFO;
2521             // fall through
2522
2523         case TVN_SETDISPINFO:
2524             {
2525                 if ( eventType == wxEVT_NULL )
2526                     eventType = wxEVT_COMMAND_TREE_SET_INFO;
2527                 //else: get, already set above
2528
2529                 TV_DISPINFO *info = (TV_DISPINFO *)lParam;
2530
2531                 event.m_item = info->item.hItem;
2532                 break;
2533             }
2534
2535         case TVN_ITEMEXPANDING:
2536         case TVN_ITEMEXPANDED:
2537             {
2538                 NM_TREEVIEW *tv = (NM_TREEVIEW*)lParam;
2539
2540                 int what;
2541                 switch ( tv->action )
2542                 {
2543                     default:
2544                         wxLogDebug(wxT("unexpected code %d in TVN_ITEMEXPAND message"), tv->action);
2545                         // fall through
2546
2547                     case TVE_EXPAND:
2548                         what = IDX_EXPAND;
2549                         break;
2550
2551                     case TVE_COLLAPSE:
2552                         what = IDX_COLLAPSE;
2553                         break;
2554                 }
2555
2556                 int how = hdr->code == TVN_ITEMEXPANDING ? IDX_DOING
2557                                                          : IDX_DONE;
2558
2559                 eventType = gs_expandEvents[what][how];
2560
2561                 event.m_item = tv->itemNew.hItem;
2562             }
2563             break;
2564
2565         case TVN_KEYDOWN:
2566             {
2567                 eventType = wxEVT_COMMAND_TREE_KEY_DOWN;
2568                 TV_KEYDOWN *info = (TV_KEYDOWN *)lParam;
2569
2570                 // fabricate the lParam and wParam parameters sufficiently
2571                 // similar to the ones from a "real" WM_KEYDOWN so that
2572                 // CreateKeyEvent() works correctly
2573                 WXLPARAM lParam = (wxIsAltDown() ? KF_ALTDOWN : 0) << 16;
2574
2575                 WXWPARAM wParam = info->wVKey;
2576
2577                 int keyCode = wxCharCodeMSWToWX(wParam);
2578                 if ( !keyCode )
2579                 {
2580                     // wxCharCodeMSWToWX() returns 0 to indicate that this is a
2581                     // simple ASCII key
2582                     keyCode = wParam;
2583                 }
2584
2585                 event.m_evtKey = CreateKeyEvent(wxEVT_KEY_DOWN,
2586                                                 keyCode,
2587                                                 lParam,
2588                                                 wParam);
2589
2590                 // a separate event for Space/Return
2591                 if ( !wxIsAnyModifierDown() &&
2592                      ((info->wVKey == VK_SPACE) || (info->wVKey == VK_RETURN)) )
2593                 {
2594                    wxTreeItemId item;
2595                    if ( !HasFlag(wxTR_MULTIPLE) )
2596                        item = GetSelection();
2597
2598                    wxTreeEvent event2(wxEVT_COMMAND_TREE_ITEM_ACTIVATED,
2599                                         this, item);
2600                    (void)HandleWindowEvent(event2);
2601                 }
2602             }
2603             break;
2604
2605
2606         // Vista's tree control has introduced some problems with our
2607         // multi-selection tree.  When TreeView_SelectItem() is called,
2608         // the wrong items are deselected.
2609
2610         // Fortunately, Vista provides a new notification, TVN_ITEMCHANGING
2611         // that can be used to regulate this incorrect behavior.  The
2612         // following messages will allow only the unlocked item's selection
2613         // state to change
2614
2615         case TVN_ITEMCHANGINGA:
2616         case TVN_ITEMCHANGINGW:
2617             {
2618                 // we only need to handles these in multi-select trees
2619                 if ( HasFlag(wxTR_MULTIPLE) )
2620                 {
2621                     // get info about the item about to be changed
2622                     NMTVITEMCHANGE* info = (NMTVITEMCHANGE*)lParam;
2623                     if (TreeItemUnlocker::IsLocked(info->hItem))
2624                     {
2625                         // item's state is locked, don't allow the change
2626                         // returning 1 will disallow the change
2627                         *result = 1;
2628                         return true;
2629                     }
2630                 }
2631
2632                 // allow the state change
2633             }
2634             return false;
2635
2636         // NB: MSLU is broken and sends TVN_SELCHANGEDA instead of
2637         //     TVN_SELCHANGEDW in Unicode mode under Win98. Therefore
2638         //     we have to handle both messages:
2639         case TVN_SELCHANGEDA:
2640         case TVN_SELCHANGEDW:
2641             eventType = wxEVT_COMMAND_TREE_SEL_CHANGED;
2642             // fall through
2643
2644         case TVN_SELCHANGINGA:
2645         case TVN_SELCHANGINGW:
2646             {
2647                 if ( eventType == wxEVT_NULL )
2648                     eventType = wxEVT_COMMAND_TREE_SEL_CHANGING;
2649                 //else: already set above
2650
2651                 if (hdr->code == TVN_SELCHANGINGW ||
2652                     hdr->code == TVN_SELCHANGEDW)
2653                 {
2654                     NM_TREEVIEWW *tv = (NM_TREEVIEWW *)lParam;
2655                     event.m_item = tv->itemNew.hItem;
2656                     event.m_itemOld = tv->itemOld.hItem;
2657                 }
2658                 else
2659                 {
2660                     NM_TREEVIEWA *tv = (NM_TREEVIEWA *)lParam;
2661                     event.m_item = tv->itemNew.hItem;
2662                     event.m_itemOld = tv->itemOld.hItem;
2663                 }
2664             }
2665
2666             // we receive this message from WM_LBUTTONDOWN handler inside
2667             // comctl32.dll and so before the click is passed to
2668             // DefWindowProc() which sets the focus to the window which was
2669             // clicked and this can lead to unexpected event sequences: for
2670             // example, we may get a "selection change" event from the tree
2671             // before getting a "kill focus" event for the text control which
2672             // had the focus previously, thus breaking user code doing input
2673             // validation
2674             //
2675             // to avoid such surprises, we force the generation of focus events
2676             // now, before we generate the selection change ones
2677             SetFocus();
2678             break;
2679
2680             // instead of explicitly checking for _WIN32_IE, check if the
2681             // required symbols are available in the headers
2682 #if defined(CDDS_PREPAINT) && !wxUSE_COMCTL32_SAFELY
2683         case NM_CUSTOMDRAW:
2684             {
2685                 LPNMTVCUSTOMDRAW lptvcd = (LPNMTVCUSTOMDRAW)lParam;
2686                 NMCUSTOMDRAW& nmcd = lptvcd->nmcd;
2687                 switch ( nmcd.dwDrawStage )
2688                 {
2689                     case CDDS_PREPAINT:
2690                         // if we've got any items with non standard attributes,
2691                         // notify us before painting each item
2692                         *result = m_hasAnyAttr ? CDRF_NOTIFYITEMDRAW
2693                                                : CDRF_DODEFAULT;
2694                         break;
2695
2696                     case CDDS_ITEMPREPAINT:
2697                         {
2698                             wxMapTreeAttr::iterator
2699                                 it = m_attrs.find((void *)nmcd.dwItemSpec);
2700
2701                             if ( it == m_attrs.end() )
2702                             {
2703                                 // nothing to do for this item
2704                                 *result = CDRF_DODEFAULT;
2705                                 break;
2706                             }
2707
2708                             wxTreeItemAttr * const attr = it->second;
2709
2710                             wxTreeViewItem tvItem((void *)nmcd.dwItemSpec,
2711                                                   TVIF_STATE, TVIS_DROPHILITED);
2712                             DoGetItem(&tvItem);
2713                             const UINT tvItemState = tvItem.state;
2714
2715                             // selection colours should override ours,
2716                             // otherwise it is too confusing to the user
2717                             if ( !(nmcd.uItemState & CDIS_SELECTED) &&
2718                                  !(tvItemState & TVIS_DROPHILITED) )
2719                             {
2720                                 wxColour colBack;
2721                                 if ( attr->HasBackgroundColour() )
2722                                 {
2723                                     colBack = attr->GetBackgroundColour();
2724                                     lptvcd->clrTextBk = wxColourToRGB(colBack);
2725                                 }
2726                             }
2727
2728                             // but we still want to keep the special foreground
2729                             // colour when we don't have focus (we can't keep
2730                             // it when we do, it would usually be unreadable on
2731                             // the almost inverted bg colour...)
2732                             if ( ( !(nmcd.uItemState & CDIS_SELECTED) ||
2733                                     FindFocus() != this ) &&
2734                                  !(tvItemState & TVIS_DROPHILITED) )
2735                             {
2736                                 wxColour colText;
2737                                 if ( attr->HasTextColour() )
2738                                 {
2739                                     colText = attr->GetTextColour();
2740                                     lptvcd->clrText = wxColourToRGB(colText);
2741                                 }
2742                             }
2743
2744                             if ( attr->HasFont() )
2745                             {
2746                                 HFONT hFont = GetHfontOf(attr->GetFont());
2747
2748                                 ::SelectObject(nmcd.hdc, hFont);
2749
2750                                 *result = CDRF_NEWFONT;
2751                             }
2752                             else // no specific font
2753                             {
2754                                 *result = CDRF_DODEFAULT;
2755                             }
2756                         }
2757                         break;
2758
2759                     default:
2760                         *result = CDRF_DODEFAULT;
2761                 }
2762             }
2763
2764             // we always process it
2765             return true;
2766 #endif // have owner drawn support in headers
2767
2768         case NM_CLICK:
2769             {
2770                 DWORD pos = GetMessagePos();
2771                 POINT point;
2772                 point.x = LOWORD(pos);
2773                 point.y = HIWORD(pos);
2774                 ::MapWindowPoints(HWND_DESKTOP, GetHwnd(), &point, 1);
2775                 int flags = 0;
2776                 wxTreeItemId item = HitTest(wxPoint(point.x, point.y), flags);
2777                 if (flags & wxTREE_HITTEST_ONITEMSTATEICON)
2778                 {
2779                     event.m_item = item;
2780                     eventType = wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK;
2781                 }
2782                 break;
2783             }
2784
2785         case NM_DBLCLK:
2786         case NM_RCLICK:
2787             {
2788                 TV_HITTESTINFO tvhti;
2789                 ::GetCursorPos(&tvhti.pt);
2790                 ::ScreenToClient(GetHwnd(), &tvhti.pt);
2791                 if ( TreeView_HitTest(GetHwnd(), &tvhti) )
2792                 {
2793                     if ( tvhti.flags & TVHT_ONITEM )
2794                     {
2795                         event.m_item = tvhti.hItem;
2796                         eventType = (int)hdr->code == NM_DBLCLK
2797                                     ? wxEVT_COMMAND_TREE_ITEM_ACTIVATED
2798                                     : wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK;
2799
2800                         event.m_pointDrag.x = tvhti.pt.x;
2801                         event.m_pointDrag.y = tvhti.pt.y;
2802                     }
2803
2804                     break;
2805                 }
2806             }
2807             // fall through
2808
2809         default:
2810             return wxControl::MSWOnNotify(idCtrl, lParam, result);
2811     }
2812
2813     event.SetEventType(eventType);
2814
2815     if ( event.m_item.IsOk() )
2816         event.SetClientObject(GetItemData(event.m_item));
2817
2818     bool processed = HandleWindowEvent(event);
2819
2820     // post processing
2821     switch ( hdr->code )
2822     {
2823         case NM_DBLCLK:
2824             // we translate NM_DBLCLK into ACTIVATED event, so don't interpret
2825             // the return code of this event handler as the return value for
2826             // NM_DBLCLK - otherwise, double clicking the item to toggle its
2827             // expanded status would never work
2828             *result = false;
2829             break;
2830
2831         case NM_RCLICK:
2832             // prevent tree control from sending WM_CONTEXTMENU to our parent
2833             // (which it does if NM_RCLICK is not handled) because we want to
2834             // send it to the control itself
2835             *result =
2836             processed = true;
2837
2838             ::SendMessage(GetHwnd(), WM_CONTEXTMENU,
2839                           (WPARAM)GetHwnd(), ::GetMessagePos());
2840             break;
2841
2842         case TVN_BEGINDRAG:
2843         case TVN_BEGINRDRAG:
2844 #if wxUSE_DRAGIMAGE
2845             if ( event.IsAllowed() )
2846             {
2847                 // normally this is impossible because the m_dragImage is
2848                 // deleted once the drag operation is over
2849                 wxASSERT_MSG( !m_dragImage, _T("starting to drag once again?") );
2850
2851                 m_dragImage = new wxDragImage(*this, event.m_item);
2852                 m_dragImage->BeginDrag(wxPoint(0,0), this);
2853                 m_dragImage->Show();
2854             }
2855 #endif // wxUSE_DRAGIMAGE
2856             break;
2857
2858         case TVN_DELETEITEM:
2859             {
2860                 // NB: we might process this message using wxWidgets event
2861                 //     tables, but due to overhead of wxWin event system we
2862                 //     prefer to do it here ourself (otherwise deleting a tree
2863                 //     with many items is just too slow)
2864                 NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam;
2865
2866                 wxTreeItemParam *param =
2867                         (wxTreeItemParam *)tv->itemOld.lParam;
2868                 delete param;
2869
2870                 processed = true; // Make sure we don't get called twice
2871             }
2872             break;
2873
2874         case TVN_BEGINLABELEDIT:
2875             // return true to cancel label editing
2876             *result = !event.IsAllowed();
2877
2878             // set ES_WANTRETURN ( like we do in BeginLabelEdit )
2879             if ( event.IsAllowed() )
2880             {
2881                 HWND hText = TreeView_GetEditControl(GetHwnd());
2882                 if ( hText )
2883                 {
2884                     // MBN: if m_textCtrl already has an HWND, it is a stale
2885                     // pointer from a previous edit (because the user
2886                     // didn't modify the label before dismissing the control,
2887                     // and TVN_ENDLABELEDIT was not sent), so delete it
2888                     if ( m_textCtrl && m_textCtrl->GetHWND() )
2889                         DeleteTextCtrl();
2890                     if ( !m_textCtrl )
2891                         m_textCtrl = new wxTextCtrl();
2892                     m_textCtrl->SetParent(this);
2893                     m_textCtrl->SetHWND((WXHWND)hText);
2894                     m_textCtrl->SubclassWin((WXHWND)hText);
2895
2896                     // set wxTE_PROCESS_ENTER style for the text control to
2897                     // force it to process the Enter presses itself, otherwise
2898                     // they could be stolen from it by the dialog
2899                     // navigation code
2900                     m_textCtrl->SetWindowStyle(m_textCtrl->GetWindowStyle()
2901                                                | wxTE_PROCESS_ENTER);
2902                 }
2903             }
2904             else // we had set m_idEdited before
2905             {
2906                 m_idEdited.Unset();
2907             }
2908             break;
2909
2910         case TVN_ENDLABELEDIT:
2911             // return true to set the label to the new string: note that we
2912             // also must pretend that we did process the message or it is going
2913             // to be passed to DefWindowProc() which will happily return false
2914             // cancelling the label change
2915             *result = event.IsAllowed();
2916             processed = true;
2917
2918             // ensure that we don't have the text ctrl which is going to be
2919             // deleted any more
2920             DeleteTextCtrl();
2921             break;
2922
2923 #ifndef __WXWINCE__
2924 #ifdef TVN_GETINFOTIP
2925          case TVN_GETINFOTIP:
2926             {
2927                 // If the user permitted a tooltip change, change it
2928                 if (event.IsAllowed())
2929                 {
2930                     SetToolTip(event.m_label);
2931                 }
2932             }
2933             break;
2934 #endif
2935 #endif
2936
2937         case TVN_SELCHANGING:
2938         case TVN_ITEMEXPANDING:
2939             // return true to prevent the action from happening
2940             *result = !event.IsAllowed();
2941             break;
2942
2943         case TVN_ITEMEXPANDED:
2944             {
2945                 NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam;
2946                 const wxTreeItemId id(tv->itemNew.hItem);
2947
2948                 if ( tv->action == TVE_COLLAPSE )
2949                 {
2950                     if ( wxApp::GetComCtl32Version() >= 600 )
2951                     {
2952                         // for some reason the item selection rectangle depends
2953                         // on whether it is expanded or collapsed (at least
2954                         // with comctl32.dll v6): it is wider (by 3 pixels) in
2955                         // the expanded state, so when the item collapses and
2956                         // then is deselected the rightmost 3 pixels of the
2957                         // previously drawn selection are left on the screen
2958                         //
2959                         // it's not clear if it's a bug in comctl32.dll or in
2960                         // our code (because it does not happen in Explorer but
2961                         // OTOH we don't do anything which could result in this
2962                         // AFAICS) but we do need to work around it to avoid
2963                         // ugly artifacts
2964                         RefreshItem(id);
2965                     }
2966                 }
2967                 else // expand
2968                 {
2969                     // the item is also not refreshed properly after expansion when
2970                     // it has an image depending on the expanded/collapsed state:
2971                     // again, it's not clear if the bug is in comctl32.dll or our
2972                     // code...
2973                     int image = GetItemImage(id, wxTreeItemIcon_Expanded);
2974                     if ( image != -1 )
2975                     {
2976                         RefreshItem(id);
2977                     }
2978                 }
2979             }
2980             break;
2981
2982         case TVN_GETDISPINFO:
2983             // NB: so far the user can't set the image himself anyhow, so do it
2984             //     anyway - but this may change later
2985             //if ( /* !processed && */ )
2986             {
2987                 wxTreeItemId item = event.m_item;
2988                 TV_DISPINFO *info = (TV_DISPINFO *)lParam;
2989
2990                 const wxTreeItemParam * const param = GetItemParam(item);
2991                 if ( !param )
2992                     break;
2993
2994                 if ( info->item.mask & TVIF_IMAGE )
2995                 {
2996                     info->item.iImage =
2997                         param->GetImage
2998                         (
2999                          IsExpanded(item) ? wxTreeItemIcon_Expanded
3000                                           : wxTreeItemIcon_Normal
3001                         );
3002                 }
3003                 if ( info->item.mask & TVIF_SELECTEDIMAGE )
3004                 {
3005                     info->item.iSelectedImage =
3006                         param->GetImage
3007                         (
3008                          IsExpanded(item) ? wxTreeItemIcon_SelectedExpanded
3009                                           : wxTreeItemIcon_Selected
3010                         );
3011                 }
3012             }
3013             break;
3014
3015         //default:
3016             // for the other messages the return value is ignored and there is
3017             // nothing special to do
3018     }
3019     return processed;
3020 }
3021
3022 // ----------------------------------------------------------------------------
3023 // State control.
3024 // ----------------------------------------------------------------------------
3025
3026 // why do they define INDEXTOSTATEIMAGEMASK but not the inverse?
3027 #define STATEIMAGEMASKTOINDEX(state) (((state) & TVIS_STATEIMAGEMASK) >> 12)
3028
3029 int wxTreeCtrl::DoGetItemState(const wxTreeItemId& item) const
3030 {
3031     wxCHECK_MSG( item.IsOk(), wxTREE_ITEMSTATE_NONE, wxT("invalid tree item") );
3032
3033     // receive the desired information
3034     wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_STATEIMAGEMASK);
3035     DoGetItem(&tvItem);
3036
3037     // state images are one-based
3038     return STATEIMAGEMASKTOINDEX(tvItem.state) - 1;
3039 }
3040
3041 void wxTreeCtrl::DoSetItemState(const wxTreeItemId& item, int state)
3042 {
3043     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
3044
3045     wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_STATEIMAGEMASK);
3046
3047     // state images are one-based
3048     // 0 if no state image display (wxTREE_ITEMSTATE_NONE = -1)
3049     tvItem.state = INDEXTOSTATEIMAGEMASK(state + 1);
3050
3051     DoSetItem(&tvItem);
3052 }
3053
3054 #endif // wxUSE_TREECTRL