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