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