src/msw/treectrl.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 #ifdef __GNUG__
  20     #pragma implementation "treectrl.h"
  21 #endif
  22
  23 // For compilers that support precompilation, includes "wx.h".
  24 #include "wx/wxprec.h"
  25
  26 #ifdef __BORLANDC__
  27     #pragma hdrstop
  28 #endif
  29
  30 #ifndef WX_PRECOMP
  31     #include "wx/wx.h"
  32 #endif
  33
  34 #if defined(__WIN95__)
  35
  36 #include "wx/log.h"
  37 #include "wx/dynarray.h"
  38 #include "wx/imaglist.h"
  39 #include "wx/msw/treectrl.h"
  40
  41 #include "wx/msw/private.h"
  42
  43 #ifdef __GNUWIN32__
  44 #include "wx/msw/gnuwin32/extra.h"
  45 #endif
  46
  47 #if (defined(__WIN95__) && !defined(__GNUWIN32__)) || defined(__TWIN32__)
  48     #include <commctrl.h>
  49 #endif
  50
  51 #ifdef GetFirstChild
  52 #undef GetFirstChild
  53 #endif
  54
  55 #ifdef GetNextChild
  56 #undef GetNextChild
  57 #endif
  58
  59 #ifdef GetNextSibling
  60 #undef GetNextSibling
  61 #endif
  62
  63 #ifdef GetClassInfo
  64 #undef GetClassInfo
  65 #endif
  66
  67 // Bug in headers, sometimes
  68 #ifndef TVIS_FOCUSED
  69     #define TVIS_FOCUSED            0x0001
  70 #endif
  71
  72 // ----------------------------------------------------------------------------
  73 // private classes
  74 // ----------------------------------------------------------------------------
  75
  76 // a convenient wrapper around TV_ITEM struct which adds a ctor
  77 struct wxTreeViewItem : public TV_ITEM
  78 {
  79     wxTreeViewItem(const wxTreeItemId& item,
  80                    UINT mask_, UINT stateMask_ = 0)
  81     {
  82         mask = mask_;
  83         stateMask = stateMask_;
  84         hItem = (HTREEITEM) (WXHTREEITEM) item;
  85     }
  86 };
  87
  88 // ----------------------------------------------------------------------------
  89 // macros
  90 // ----------------------------------------------------------------------------
  91
  92 #if !USE_SHARED_LIBRARY
  93     IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl, wxControl)
  94 #endif
  95
  96 // hide the ugly cast (of course, the macro is _quite_ ugly too...)
  97 #define wxhWnd    ((HWND)m_hWnd)
  98
  99 // ----------------------------------------------------------------------------
 100 // variables
 101 // ----------------------------------------------------------------------------
 102
 103 // handy table for sending events
 104 static const wxEventType g_events[2][2] =
 105 {
 106     { wxEVT_COMMAND_TREE_ITEM_COLLAPSED, wxEVT_COMMAND_TREE_ITEM_COLLAPSING },
 107     { wxEVT_COMMAND_TREE_ITEM_EXPANDED,  wxEVT_COMMAND_TREE_ITEM_EXPANDING  }
 108 };
 109
 110 // ============================================================================
 111 // implementation
 112 // ============================================================================
 113
 114 // ----------------------------------------------------------------------------
 115 // construction and destruction
 116 // ----------------------------------------------------------------------------
 117
 118 void wxTreeCtrl::Init()
 119 {
 120     m_imageListNormal = NULL;
 121     m_imageListState = NULL;
 122     m_textCtrl = NULL;
 123 }
 124
 125 bool wxTreeCtrl::Create(wxWindow *parent, wxWindowID id,
 126                         const wxPoint& pos, const wxSize& size,
 127                         long style, const wxValidator& validator,
 128                         const wxString& name)
 129 {
 130     Init();
 131
 132     wxSystemSettings settings;
 133
 134     SetName(name);
 135     SetValidator(validator);
 136
 137     m_windowStyle = style;
 138
 139     SetParent(parent);
 140
 141     m_windowId = (id == -1) ? NewControlId() : id;
 142
 143     DWORD wstyle = WS_VISIBLE | WS_CHILD | WS_TABSTOP | TVS_HASLINES | TVS_SHOWSELALWAYS ;
 144
 145
 146     bool want3D;
 147     WXDWORD exStyle = Determine3DEffects(WS_EX_CLIENTEDGE, &want3D) ;
 148
 149     // Even with extended styles, need to combine with WS_BORDER
 150     // for them to look right.
 151     if ( want3D || wxStyleHasBorder(m_windowStyle) )
 152     {
 153         wstyle |= WS_BORDER;
 154     }
 155
 156     if ( m_windowStyle & wxTR_HAS_BUTTONS )
 157         wstyle |= TVS_HASBUTTONS;
 158
 159     if ( m_windowStyle & wxTR_EDIT_LABELS )
 160         wstyle |= TVS_EDITLABELS;
 161
 162     if ( m_windowStyle & wxTR_LINES_AT_ROOT )
 163         wstyle |= TVS_LINESATROOT;
 164
 165     // Create the tree control.
 166     m_hWnd = (WXHWND)::CreateWindowEx
 167                        (
 168                         exStyle,
 169                         WC_TREEVIEW,
 170                         "",
 171                         wstyle,
 172                         pos.x, pos.y, size.x, size.y,
 173                         (HWND)parent->GetHWND(),
 174                         (HMENU)m_windowId,
 175                         wxGetInstance(),
 176                         NULL
 177                        );
 178
 179     wxCHECK_MSG( m_hWnd, FALSE, "Failed to create tree ctrl" );
 180
 181     if ( parent )
 182         parent->AddChild(this);
 183
 184     SubclassWin(m_hWnd);
 185
 186     return TRUE;
 187 }
 188
 189 wxTreeCtrl::~wxTreeCtrl()
 190 {
 191     DeleteTextCtrl();
 192
 193     // delete user data to prevent memory leaks
 194     DeleteAllItems();
 195 }
 196
 197 // ----------------------------------------------------------------------------
 198 // accessors
 199 // ----------------------------------------------------------------------------
 200
 201 // simple wrappers which add error checking in debug mode
 202
 203 bool wxTreeCtrl::DoGetItem(wxTreeViewItem* tvItem) const
 204 {
 205     if ( !TreeView_GetItem(wxhWnd, tvItem) )
 206     {
 207         wxLogLastError("TreeView_GetItem");
 208
 209         return FALSE;
 210     }
 211
 212     return TRUE;
 213 }
 214
 215 void wxTreeCtrl::DoSetItem(wxTreeViewItem* tvItem)
 216 {
 217     if ( TreeView_SetItem(wxhWnd, tvItem) == -1 )
 218     {
 219         wxLogLastError("TreeView_SetItem");
 220     }
 221 }
 222
 223 size_t wxTreeCtrl::GetCount() const
 224 {
 225     return (size_t)TreeView_GetCount(wxhWnd);
 226 }
 227
 228 unsigned int wxTreeCtrl::GetIndent() const
 229 {
 230     return TreeView_GetIndent(wxhWnd);
 231 }
 232
 233 void wxTreeCtrl::SetIndent(unsigned int indent)
 234 {
 235     TreeView_SetIndent(wxhWnd, indent);
 236 }
 237
 238 wxImageList *wxTreeCtrl::GetImageList() const
 239 {
 240     return m_imageListNormal;
 241 }
 242
 243 wxImageList *wxTreeCtrl::GetStateImageList() const
 244 {
 245     return m_imageListNormal;
 246 }
 247
 248 void wxTreeCtrl::SetAnyImageList(wxImageList *imageList, int which)
 249 {
 250     // no error return
 251     TreeView_SetImageList(wxhWnd,
 252                           imageList ? imageList->GetHIMAGELIST() : 0,
 253                           which);
 254 }
 255
 256 void wxTreeCtrl::SetImageList(wxImageList *imageList)
 257 {
 258     SetAnyImageList(m_imageListNormal = imageList, TVSIL_NORMAL);
 259 }
 260
 261 void wxTreeCtrl::SetStateImageList(wxImageList *imageList)
 262 {
 263     SetAnyImageList(m_imageListState = imageList, TVSIL_STATE);
 264 }
 265
 266 size_t wxTreeCtrl::GetChildrenCount(const wxTreeItemId& item, bool recursively)
 267 {
 268     long cookie;
 269
 270     size_t result = 0;
 271
 272     wxArrayLong children;
 273     wxTreeItemId child = GetFirstChild(item, cookie);
 274     while ( child.IsOk() )
 275     {
 276         if ( recursively )
 277         {
 278             // recursive call
 279             result += GetChildrenCount(child, TRUE);
 280         }
 281
 282         // add the child to the result in any case
 283         result++;
 284
 285         child = GetNextChild(item, cookie);
 286     }
 287
 288     return result;
 289 }
 290
 291 // ----------------------------------------------------------------------------
 292 // Item access
 293 // ----------------------------------------------------------------------------
 294
 295 wxString wxTreeCtrl::GetItemText(const wxTreeItemId& item) const
 296 {
 297     char buf[512];  // the size is arbitrary...
 298
 299     wxTreeViewItem tvItem(item, TVIF_TEXT);
 300     tvItem.pszText = buf;
 301     tvItem.cchTextMax = WXSIZEOF(buf);
 302     if ( !DoGetItem(&tvItem) )
 303     {
 304         // don't return some garbage which was on stack, but an empty string
 305         buf[0] = '\0';
 306     }
 307
 308     return wxString(buf);
 309 }
 310
 311 void wxTreeCtrl::SetItemText(const wxTreeItemId& item, const wxString& text)
 312 {
 313     wxTreeViewItem tvItem(item, TVIF_TEXT);
 314     tvItem.pszText = (char *)text.c_str();  // conversion is ok
 315     DoSetItem(&tvItem);
 316 }
 317
 318 int wxTreeCtrl::GetItemImage(const wxTreeItemId& item) const
 319 {
 320     wxTreeViewItem tvItem(item, TVIF_IMAGE);
 321     DoGetItem(&tvItem);
 322
 323     return tvItem.iImage;
 324 }
 325
 326 void wxTreeCtrl::SetItemImage(const wxTreeItemId& item, int image)
 327 {
 328     wxTreeViewItem tvItem(item, TVIF_IMAGE);
 329     tvItem.iImage = image;
 330     DoSetItem(&tvItem);
 331 }
 332
 333 int wxTreeCtrl::GetItemSelectedImage(const wxTreeItemId& item) const
 334 {
 335     wxTreeViewItem tvItem(item, TVIF_SELECTEDIMAGE);
 336     DoGetItem(&tvItem);
 337
 338     return tvItem.iSelectedImage;
 339 }
 340
 341 void wxTreeCtrl::SetItemSelectedImage(const wxTreeItemId& item, int image)
 342 {
 343     wxTreeViewItem tvItem(item, TVIF_SELECTEDIMAGE);
 344     tvItem.iSelectedImage = image;
 345     DoSetItem(&tvItem);
 346 }
 347
 348 wxTreeItemData *wxTreeCtrl::GetItemData(const wxTreeItemId& item) const
 349 {
 350     wxTreeViewItem tvItem(item, TVIF_PARAM);
 351     if ( !DoGetItem(&tvItem) )
 352     {
 353         return NULL;
 354     }
 355
 356     return (wxTreeItemData *)tvItem.lParam;
 357 }
 358
 359 void wxTreeCtrl::SetItemData(const wxTreeItemId& item, wxTreeItemData *data)
 360 {
 361     wxTreeViewItem tvItem(item, TVIF_PARAM);
 362     tvItem.lParam = (LPARAM)data;
 363     DoSetItem(&tvItem);
 364 }
 365
 366 void wxTreeCtrl::SetItemHasChildren(const wxTreeItemId& item, bool has)
 367 {
 368     wxTreeViewItem tvItem(item, TVIF_CHILDREN);
 369     tvItem.cChildren = (int)has;
 370     DoSetItem(&tvItem);
 371 }
 372
 373 void wxTreeCtrl::SetItemBold(const wxTreeItemId& item, bool bold)
 374 {
 375     wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_BOLD);
 376     tvItem.state = bold ? TVIS_BOLD : 0;
 377     DoSetItem(&tvItem);
 378 }
 379
 380 void wxTreeCtrl::SetItemDropHighlight(const wxTreeItemId& item, bool highlight)
 381 {
 382     wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_DROPHILITED);
 383     tvItem.state = highlight ? TVIS_DROPHILITED : 0;
 384     DoSetItem(&tvItem);
 385 }
 386
 387 // ----------------------------------------------------------------------------
 388 // Item status
 389 // ----------------------------------------------------------------------------
 390
 391 bool wxTreeCtrl::IsVisible(const wxTreeItemId& item) const
 392 {
 393     // Bug in Gnu-Win32 headers, so don't use the macro TreeView_GetItemRect
 394     RECT rect;
 395     return SendMessage(wxhWnd, TVM_GETITEMRECT, FALSE, (LPARAM)&rect) != 0;
 396
 397 }
 398
 399 bool wxTreeCtrl::ItemHasChildren(const wxTreeItemId& item) const
 400 {
 401     wxTreeViewItem tvItem(item, TVIF_CHILDREN);
 402     DoGetItem(&tvItem);
 403
 404     return tvItem.cChildren != 0;
 405 }
 406
 407 bool wxTreeCtrl::IsExpanded(const wxTreeItemId& item) const
 408 {
 409     // probably not a good idea to put it here
 410     //wxASSERT( ItemHasChildren(item) );
 411
 412     wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_EXPANDED);
 413     DoGetItem(&tvItem);
 414
 415     return (tvItem.state & TVIS_EXPANDED) != 0;
 416 }
 417
 418 bool wxTreeCtrl::IsSelected(const wxTreeItemId& item) const
 419 {
 420     wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_SELECTED);
 421     DoGetItem(&tvItem);
 422
 423     return (tvItem.state & TVIS_SELECTED) != 0;
 424 }
 425
 426 bool wxTreeCtrl::IsBold(const wxTreeItemId& item) const
 427 {
 428     wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_BOLD);
 429     DoGetItem(&tvItem);
 430
 431     return (tvItem.state & TVIS_BOLD) != 0;
 432 }
 433
 434 // ----------------------------------------------------------------------------
 435 // navigation
 436 // ----------------------------------------------------------------------------
 437
 438 wxTreeItemId wxTreeCtrl::GetRootItem() const
 439 {
 440     return wxTreeItemId((WXHTREEITEM) TreeView_GetRoot(wxhWnd));
 441 }
 442
 443 wxTreeItemId wxTreeCtrl::GetSelection() const
 444 {
 445     return wxTreeItemId((WXHTREEITEM) TreeView_GetSelection(wxhWnd));
 446 }
 447
 448 wxTreeItemId wxTreeCtrl::GetParent(const wxTreeItemId& item) const
 449 {
 450     return wxTreeItemId((WXHTREEITEM) TreeView_GetParent(wxhWnd, (HTREEITEM) (WXHTREEITEM) item));
 451 }
 452
 453 wxTreeItemId wxTreeCtrl::GetFirstChild(const wxTreeItemId& item,
 454                                        long& _cookie) const
 455 {
 456     // remember the last child returned in 'cookie'
 457     _cookie = (long)TreeView_GetChild(wxhWnd, (HTREEITEM) (WXHTREEITEM)item);
 458
 459     return wxTreeItemId((WXHTREEITEM)_cookie);
 460 }
 461
 462 wxTreeItemId wxTreeCtrl::GetNextChild(const wxTreeItemId& WXUNUSED(item),
 463                                       long& _cookie) const
 464 {
 465     wxTreeItemId l = wxTreeItemId((WXHTREEITEM)TreeView_GetNextSibling(wxhWnd,
 466                                    (HTREEITEM)(WXHTREEITEM)_cookie));
 467     _cookie = (long)l;
 468
 469     return l;
 470 }
 471
 472 wxTreeItemId wxTreeCtrl::GetLastChild(const wxTreeItemId& item) const
 473 {
 474     // can this be done more efficiently?
 475     long cookie;
 476
 477     wxTreeItemId childLast,
 478     child = GetFirstChild(item, cookie);
 479     while ( child.IsOk() )
 480     {
 481         childLast = child;
 482         child = GetNextChild(item, cookie);
 483     }
 484
 485     return childLast;
 486 }
 487
 488 wxTreeItemId wxTreeCtrl::GetNextSibling(const wxTreeItemId& item) const
 489 {
 490     return wxTreeItemId((WXHTREEITEM) TreeView_GetNextSibling(wxhWnd, (HTREEITEM) (WXHTREEITEM) item));
 491 }
 492
 493 wxTreeItemId wxTreeCtrl::GetPrevSibling(const wxTreeItemId& item) const
 494 {
 495     return wxTreeItemId((WXHTREEITEM) TreeView_GetPrevSibling(wxhWnd, (HTREEITEM) (WXHTREEITEM) item));
 496 }
 497
 498 wxTreeItemId wxTreeCtrl::GetFirstVisibleItem() const
 499 {
 500     return wxTreeItemId((WXHTREEITEM) TreeView_GetFirstVisible(wxhWnd));
 501 }
 502
 503 wxTreeItemId wxTreeCtrl::GetNextVisible(const wxTreeItemId& item) const
 504 {
 505     wxASSERT_MSG( IsVisible(item), "The item you call GetNextVisible() "
 506                                    "for must be visible itself!");
 507
 508     return wxTreeItemId((WXHTREEITEM) TreeView_GetNextVisible(wxhWnd, (HTREEITEM) (WXHTREEITEM) item));
 509 }
 510
 511 wxTreeItemId wxTreeCtrl::GetPrevVisible(const wxTreeItemId& item) const
 512 {
 513     wxASSERT_MSG( IsVisible(item), "The item you call GetPrevVisible() "
 514                                    "for must be visible itself!");
 515
 516     return wxTreeItemId((WXHTREEITEM) TreeView_GetPrevVisible(wxhWnd, (HTREEITEM) (WXHTREEITEM) item));
 517 }
 518
 519 // ----------------------------------------------------------------------------
 520 // Usual operations
 521 // ----------------------------------------------------------------------------
 522
 523 wxTreeItemId wxTreeCtrl::DoInsertItem(const wxTreeItemId& parent,
 524                                       wxTreeItemId hInsertAfter,
 525                                       const wxString& text,
 526                                       int image, int selectedImage,
 527                                       wxTreeItemData *data)
 528 {
 529     TV_INSERTSTRUCT tvIns;
 530     tvIns.hParent = (HTREEITEM) (WXHTREEITEM)parent;
 531     tvIns.hInsertAfter = (HTREEITEM) (WXHTREEITEM) hInsertAfter;
 532
 533     // This is how we insert the item as the first child: supply a NULL hInsertAfter
 534     if (tvIns.hInsertAfter == (HTREEITEM) 0)
 535     {
 536         tvIns.hInsertAfter = TVI_FIRST;
 537     }
 538
 539     UINT mask = 0;
 540     if ( !text.IsEmpty() )
 541     {
 542         mask |= TVIF_TEXT;
 543         tvIns.item.pszText = (char *)text.c_str();  // cast is ok
 544     }
 545
 546     if ( image != -1 )
 547     {
 548         mask |= TVIF_IMAGE;
 549         tvIns.item.iImage = image;
 550
 551         if ( selectedImage == -1 )
 552         {
 553             // take the same image for selected icon if not specified
 554             selectedImage = image;
 555         }
 556     }
 557
 558     if ( selectedImage != -1 )
 559     {
 560         mask |= TVIF_SELECTEDIMAGE;
 561         tvIns.item.iSelectedImage = selectedImage;
 562     }
 563
 564     if ( data != NULL )
 565     {
 566         mask |= TVIF_PARAM;
 567         tvIns.item.lParam = (LPARAM)data;
 568     }
 569
 570     tvIns.item.mask = mask;
 571
 572     HTREEITEM id = (HTREEITEM) TreeView_InsertItem(wxhWnd, &tvIns);
 573     if ( id == 0 )
 574     {
 575         wxLogLastError("TreeView_InsertItem");
 576     }
 577
 578     if ( data != NULL )
 579     {
 580         // associate the application tree item with Win32 tree item handle
 581         data->SetId((WXHTREEITEM)id);
 582     }
 583
 584     return wxTreeItemId((WXHTREEITEM)id);
 585 }
 586
 587 // for compatibility only
 588 wxTreeItemId wxTreeCtrl::InsertItem(const wxTreeItemId& parent,
 589                                     const wxString& text,
 590                                     int image, int selImage,
 591                                     long insertAfter)
 592 {
 593     return DoInsertItem(parent, (WXHTREEITEM)insertAfter, text,
 594                         image, selImage, NULL);
 595 }
 596
 597 wxTreeItemId wxTreeCtrl::AddRoot(const wxString& text,
 598                                  int image, int selectedImage,
 599                                  wxTreeItemData *data)
 600 {
 601     return DoInsertItem(wxTreeItemId((WXHTREEITEM) 0), (WXHTREEITEM) 0,
 602                         text, image, selectedImage, data);
 603 }
 604
 605 wxTreeItemId wxTreeCtrl::PrependItem(const wxTreeItemId& parent,
 606                                      const wxString& text,
 607                                      int image, int selectedImage,
 608                                      wxTreeItemData *data)
 609 {
 610     return DoInsertItem(parent, (WXHTREEITEM) TVI_FIRST,
 611                         text, image, selectedImage, data);
 612 }
 613
 614 wxTreeItemId wxTreeCtrl::InsertItem(const wxTreeItemId& parent,
 615                                     const wxTreeItemId& idPrevious,
 616                                     const wxString& text,
 617                                     int image, int selectedImage,
 618                                     wxTreeItemData *data)
 619 {
 620     return DoInsertItem(parent, idPrevious, text, image, selectedImage, data);
 621 }
 622
 623 wxTreeItemId wxTreeCtrl::AppendItem(const wxTreeItemId& parent,
 624                                     const wxString& text,
 625                                     int image, int selectedImage,
 626                                     wxTreeItemData *data)
 627 {
 628     return DoInsertItem(parent, (WXHTREEITEM) TVI_LAST,
 629                         text, image, selectedImage, data);
 630 }
 631
 632 void wxTreeCtrl::Delete(const wxTreeItemId& item)
 633 {
 634     if ( !TreeView_DeleteItem(wxhWnd, (HTREEITEM)(WXHTREEITEM)item) )
 635     {
 636         wxLogLastError("TreeView_DeleteItem");
 637     }
 638 }
 639
 640 // delete all children (but don't delete the item itself)
 641 void wxTreeCtrl::DeleteChildren(const wxTreeItemId& item)
 642 {
 643     long cookie;
 644
 645     wxArrayLong children;
 646     wxTreeItemId child = GetFirstChild(item, cookie);
 647     while ( child.IsOk() )
 648     {
 649         children.Add((long)(WXHTREEITEM)child);
 650
 651         child = GetNextChild(item, cookie);
 652     }
 653
 654     size_t nCount = children.Count();
 655     for ( size_t n = 0; n < nCount; n++ )
 656     {
 657         if ( !TreeView_DeleteItem(wxhWnd, (HTREEITEM)children[n]) )
 658         {
 659             wxLogLastError("TreeView_DeleteItem");
 660         }
 661     }
 662 }
 663
 664 void wxTreeCtrl::DeleteAllItems()
 665 {
 666     if ( !TreeView_DeleteAllItems(wxhWnd) )
 667     {
 668         wxLogLastError("TreeView_DeleteAllItems");
 669     }
 670 }
 671
 672 void wxTreeCtrl::DoExpand(const wxTreeItemId& item, int flag)
 673 {
 674     wxASSERT_MSG( flag == TVE_COLLAPSE ||
 675                   flag == (TVE_COLLAPSE | TVE_COLLAPSERESET) ||
 676                   flag == TVE_EXPAND   ||
 677                   flag == TVE_TOGGLE,
 678                   "Unknown flag in wxTreeCtrl::DoExpand" );
 679
 680     // TreeView_Expand doesn't send TVN_ITEMEXPAND(ING) messages, so we must
 681     // emulate them
 682     if ( TreeView_Expand(wxhWnd, (HTREEITEM) (WXHTREEITEM) item, flag) != 0 )
 683     {
 684         wxTreeEvent event(wxEVT_NULL, m_windowId);
 685         event.m_item = item;
 686
 687         bool isExpanded = IsExpanded(item);
 688
 689         event.SetEventObject(this);
 690
 691         // @@@ return values of {EXPAND|COLLAPS}ING event handler is discarded
 692         event.SetEventType(g_events[isExpanded][TRUE]);
 693         GetEventHandler()->ProcessEvent(event);
 694
 695         event.SetEventType(g_events[isExpanded][FALSE]);
 696         GetEventHandler()->ProcessEvent(event);
 697     }
 698     else
 699     {
 700         // I wonder if it really ever happens...
 701         wxLogDebug("TreeView_Expand: change didn't took place.");
 702     }
 703 }
 704
 705 void wxTreeCtrl::Expand(const wxTreeItemId& item)
 706 {
 707     DoExpand(item, TVE_EXPAND);
 708 }
 709
 710 void wxTreeCtrl::Collapse(const wxTreeItemId& item)
 711 {
 712     DoExpand(item, TVE_COLLAPSE);
 713 }
 714
 715 void wxTreeCtrl::CollapseAndReset(const wxTreeItemId& item)
 716 {
 717     DoExpand(item, TVE_COLLAPSE | TVE_COLLAPSERESET);
 718 }
 719
 720 void wxTreeCtrl::Toggle(const wxTreeItemId& item)
 721 {
 722     DoExpand(item, TVE_TOGGLE);
 723 }
 724
 725 void wxTreeCtrl::ExpandItem(const wxTreeItemId& item, int action)
 726 {
 727         DoExpand(item, action);
 728 }
 729
 730 void wxTreeCtrl::Unselect()
 731 {
 732     SelectItem(wxTreeItemId((WXHTREEITEM) 0));
 733 }
 734
 735 void wxTreeCtrl::SelectItem(const wxTreeItemId& item)
 736 {
 737     if ( !TreeView_SelectItem(wxhWnd, (HTREEITEM) (WXHTREEITEM) item) )
 738     {
 739         wxLogLastError("TreeView_SelectItem");
 740     }
 741 }
 742
 743 void wxTreeCtrl::EnsureVisible(const wxTreeItemId& item)
 744 {
 745     // no error return
 746     TreeView_EnsureVisible(wxhWnd, (HTREEITEM) (WXHTREEITEM) item);
 747 }
 748
 749 void wxTreeCtrl::ScrollTo(const wxTreeItemId& item)
 750 {
 751     if ( !TreeView_SelectSetFirstVisible(wxhWnd, (HTREEITEM) (WXHTREEITEM) item) )
 752     {
 753         wxLogLastError("TreeView_SelectSetFirstVisible");
 754     }
 755 }
 756
 757 wxTextCtrl* wxTreeCtrl::GetEditControl() const
 758 {
 759     return m_textCtrl;
 760 }
 761
 762 void wxTreeCtrl::DeleteTextCtrl()
 763 {
 764     if ( m_textCtrl )
 765     {
 766         m_textCtrl->UnsubclassWin();
 767         m_textCtrl->SetHWND(0);
 768         delete m_textCtrl;
 769         m_textCtrl = NULL;
 770     }
 771 }
 772
 773 wxTextCtrl* wxTreeCtrl::EditLabel(const wxTreeItemId& item,
 774                                   wxClassInfo* textControlClass)
 775 {
 776     wxASSERT( textControlClass->IsKindOf(CLASSINFO(wxTextCtrl)) );
 777
 778     HWND hWnd = (HWND) TreeView_EditLabel(wxhWnd, (HTREEITEM) (WXHTREEITEM) item);
 779
 780     wxCHECK_MSG( hWnd, NULL, "Can't edit tree ctrl label" );
 781
 782     DeleteTextCtrl();
 783
 784     m_textCtrl = (wxTextCtrl *)textControlClass->CreateObject();
 785     m_textCtrl->SetHWND((WXHWND)hWnd);
 786     m_textCtrl->SubclassWin((WXHWND)hWnd);
 787
 788     return m_textCtrl;
 789 }
 790
 791 // End label editing, optionally cancelling the edit
 792 void wxTreeCtrl::EndEditLabel(const wxTreeItemId& item, bool discardChanges)
 793 {
 794     TreeView_EndEditLabelNow(wxhWnd, discardChanges);
 795
 796     DeleteTextCtrl();
 797 }
 798
 799 wxTreeItemId wxTreeCtrl::HitTest(const wxPoint& point, int& flags)
 800 {
 801     TV_HITTESTINFO hitTestInfo;
 802     hitTestInfo.pt.x = (int)point.x;
 803     hitTestInfo.pt.y = (int)point.y;
 804
 805     TreeView_HitTest(wxhWnd, &hitTestInfo);
 806
 807     flags = 0;
 808
 809     // avoid repetition
 810     #define TRANSLATE_FLAG(flag) if ( hitTestInfo.flags & TVHT_##flag ) \
 811                                     flags |= wxTREE_HITTEST_##flag
 812
 813     TRANSLATE_FLAG(ABOVE);
 814     TRANSLATE_FLAG(BELOW);
 815     TRANSLATE_FLAG(NOWHERE);
 816     TRANSLATE_FLAG(ONITEMBUTTON);
 817     TRANSLATE_FLAG(ONITEMICON);
 818     TRANSLATE_FLAG(ONITEMINDENT);
 819     TRANSLATE_FLAG(ONITEMLABEL);
 820     TRANSLATE_FLAG(ONITEMRIGHT);
 821     TRANSLATE_FLAG(ONITEMSTATEICON);
 822     TRANSLATE_FLAG(TOLEFT);
 823     TRANSLATE_FLAG(TORIGHT);
 824
 825     #undef TRANSLATE_FLAG
 826
 827     return wxTreeItemId((WXHTREEITEM) hitTestInfo.hItem);
 828 }
 829
 830 bool wxTreeCtrl::GetBoundingRect(const wxTreeItemId& item,
 831                                  wxRect& rect,
 832                                  bool textOnly) const
 833 {
 834     RECT rc;
 835     if ( TreeView_GetItemRect(wxhWnd, (HTREEITEM)(WXHTREEITEM)item,
 836                               &rc, textOnly) )
 837     {
 838         rect = wxRect(wxPoint(rc.left, rc.top), wxPoint(rc.right, rc.bottom));
 839
 840         return TRUE;
 841     }
 842     else
 843     {
 844         // couldn't retrieve rect: for example, item isn't visible
 845         return FALSE;
 846     }
 847 }
 848
 849 // ----------------------------------------------------------------------------
 850 // sorting stuff
 851 // ----------------------------------------------------------------------------
 852
 853 static int CALLBACK TreeView_CompareCallback(wxTreeItemData *pItem1,
 854                                              wxTreeItemData *pItem2,
 855                                              wxTreeCtrl *tree)
 856 {
 857     wxCHECK_MSG( pItem1 && pItem2, 0,
 858                  _T("sorting tree without data doesn't make sense") );
 859
 860     return tree->OnCompareItems(pItem1->GetId(), pItem2->GetId());
 861 }
 862
 863 int wxTreeCtrl::OnCompareItems(const wxTreeItemId& item1,
 864                                const wxTreeItemId& item2)
 865 {
 866     return strcmp(GetItemText(item1), GetItemText(item2));
 867 }
 868
 869 void wxTreeCtrl::SortChildren(const wxTreeItemId& item)
 870 {
 871     // rely on the fact that TreeView_SortChildren does the same thing as our
 872     // default behaviour, i.e. sorts items alphabetically and so call it
 873     // directly if we're not in derived class (much more efficient!)
 874     if ( GetClassInfo() == CLASSINFO(wxTreeCtrl) )
 875     {
 876         TreeView_SortChildren(wxhWnd, (HTREEITEM)(WXHTREEITEM)item, 0);
 877     }
 878     else
 879     {
 880         TV_SORTCB tvSort;
 881         tvSort.hParent = (HTREEITEM)(WXHTREEITEM)item;
 882         tvSort.lpfnCompare = (PFNTVCOMPARE)TreeView_CompareCallback;
 883         tvSort.lParam = (LPARAM)this;
 884         TreeView_SortChildrenCB(wxhWnd, &tvSort, 0 /* reserved */);
 885     }
 886 }
 887
 888 // ----------------------------------------------------------------------------
 889 // implementation
 890 // ----------------------------------------------------------------------------
 891
 892 bool wxTreeCtrl::MSWCommand(WXUINT cmd, WXWORD id)
 893 {
 894     if ( cmd == EN_UPDATE )
 895     {
 896         wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, id);
 897         event.SetEventObject( this );
 898         ProcessCommand(event);
 899     }
 900     else if ( cmd == EN_KILLFOCUS )
 901     {
 902         wxCommandEvent event(wxEVT_KILL_FOCUS, id);
 903         event.SetEventObject( this );
 904         ProcessCommand(event);
 905     }
 906     else
 907     {
 908         // nothing done
 909         return FALSE;
 910     }
 911
 912     // command processed
 913     return TRUE;
 914 }
 915
 916 // process WM_NOTIFY Windows message
 917 bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
 918 {
 919     wxTreeEvent event(wxEVT_NULL, m_windowId);
 920     wxEventType eventType = wxEVT_NULL;
 921     NMHDR *hdr = (NMHDR *)lParam;
 922
 923     switch ( hdr->code )
 924     {
 925         case TVN_BEGINDRAG:
 926             eventType = wxEVT_COMMAND_TREE_BEGIN_DRAG;
 927             // fall through
 928
 929         case TVN_BEGINRDRAG:
 930             {
 931                 if ( eventType == wxEVT_NULL )
 932                     eventType = wxEVT_COMMAND_TREE_BEGIN_RDRAG;
 933                 //else: left drag, already set above
 934
 935                 NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam;
 936
 937                 event.m_item = (WXHTREEITEM) tv->itemNew.hItem;
 938                 event.m_pointDrag = wxPoint(tv->ptDrag.x, tv->ptDrag.y);
 939                 break;
 940             }
 941
 942         case TVN_BEGINLABELEDIT:
 943             {
 944                 eventType = wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT;
 945                 TV_DISPINFO *info = (TV_DISPINFO *)lParam;
 946
 947                 event.m_item = (WXHTREEITEM) info->item.hItem;
 948                 break;
 949             }
 950
 951         case TVN_DELETEITEM:
 952             {
 953                 eventType = wxEVT_COMMAND_TREE_DELETE_ITEM;
 954                 NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam;
 955
 956                 event.m_item = (WXHTREEITEM) tv->itemOld.hItem;
 957                 break;
 958             }
 959
 960         case TVN_ENDLABELEDIT:
 961             {
 962                 eventType = wxEVT_COMMAND_TREE_END_LABEL_EDIT;
 963                 TV_DISPINFO *info = (TV_DISPINFO *)lParam;
 964
 965                 event.m_item = (WXHTREEITEM) info->item.hItem;
 966                 break;
 967             }
 968
 969         case TVN_GETDISPINFO:
 970             eventType = wxEVT_COMMAND_TREE_GET_INFO;
 971             // fall through
 972
 973         case TVN_SETDISPINFO:
 974             {
 975                 if ( eventType == wxEVT_NULL )
 976                     eventType = wxEVT_COMMAND_TREE_SET_INFO;
 977                 //else: get, already set above
 978
 979                 TV_DISPINFO *info = (TV_DISPINFO *)lParam;
 980
 981                 event.m_item = (WXHTREEITEM) info->item.hItem;
 982                 break;
 983             }
 984
 985         case TVN_ITEMEXPANDING:
 986             event.m_code = FALSE;
 987             // fall through
 988
 989         case TVN_ITEMEXPANDED:
 990             {
 991                 NM_TREEVIEW* tv = (NM_TREEVIEW*)lParam;
 992
 993                 bool expand = FALSE;
 994                 switch ( tv->action )
 995                 {
 996                     case TVE_EXPAND:
 997                         expand = TRUE;
 998                         break;
 999
1000                     case TVE_COLLAPSE:
1001                         expand = FALSE;
1002                         break;
1003
1004                     default:
1005                         wxLogDebug("unexpected code %d in TVN_ITEMEXPAND "
1006                                    "message", tv->action);
1007                 }
1008
1009                 bool ing = (hdr->code == TVN_ITEMEXPANDING);
1010                 eventType = g_events[expand][ing];
1011
1012                 event.m_item = (WXHTREEITEM) tv->itemNew.hItem;
1013                 break;
1014             }
1015
1016         case TVN_KEYDOWN:
1017             {
1018                 eventType = wxEVT_COMMAND_TREE_KEY_DOWN;
1019                 TV_KEYDOWN *info = (TV_KEYDOWN *)lParam;
1020
1021                 event.m_code = wxCharCodeMSWToWX(info->wVKey);
1022
1023                 // a separate event for this case
1024                 if ( info->wVKey == VK_SPACE || info->wVKey == VK_RETURN )
1025                 {
1026                     wxTreeEvent event2(wxEVT_COMMAND_TREE_ITEM_ACTIVATED,
1027                                        m_windowId);
1028                     event2.SetEventObject(this);
1029
1030                     GetEventHandler()->ProcessEvent(event2);
1031                 }
1032                 break;
1033             }
1034
1035         case TVN_SELCHANGED:
1036             eventType = wxEVT_COMMAND_TREE_SEL_CHANGED;
1037             // fall through
1038
1039         case TVN_SELCHANGING:
1040             {
1041                 if ( eventType == wxEVT_NULL )
1042                     eventType = wxEVT_COMMAND_TREE_SEL_CHANGING;
1043                 //else: already set above
1044
1045                 NM_TREEVIEW* tv = (NM_TREEVIEW *)lParam;
1046
1047                 event.m_item = (WXHTREEITEM) tv->itemNew.hItem;
1048                 event.m_itemOld = (WXHTREEITEM) tv->itemOld.hItem;
1049                 break;
1050             }
1051
1052         default:
1053             return wxControl::MSWOnNotify(idCtrl, lParam, result);
1054     }
1055
1056     event.SetEventObject(this);
1057     event.SetEventType(eventType);
1058
1059     bool processed = GetEventHandler()->ProcessEvent(event);
1060
1061     // post processing
1062     if ( hdr->code == TVN_DELETEITEM )
1063     {
1064         // NB: we might process this message using wxWindows event tables, but
1065         //     due to overhead of wxWin event system we prefer to do it here
1066         //     (otherwise deleting a tree with many items is just too slow)
1067         NM_TREEVIEW* tv = (NM_TREEVIEW *)lParam;
1068         wxTreeItemData *data = (wxTreeItemData *)tv->itemOld.lParam;
1069         delete data; // may be NULL, ok
1070         processed = TRUE; // Make sure we don't get called twice
1071     }
1072
1073     *result = !event.IsAllowed();
1074
1075     return processed;
1076 }
1077
1078 // ----------------------------------------------------------------------------
1079 // Tree event
1080 // ----------------------------------------------------------------------------
1081
1082 IMPLEMENT_DYNAMIC_CLASS(wxTreeEvent, wxNotifyEvent)
1083
1084 wxTreeEvent::wxTreeEvent(wxEventType commandType, int id)
1085            : wxNotifyEvent(commandType, id)
1086 {
1087     m_code = 0;
1088     m_itemOld = 0;
1089 }
1090
1091 #endif // __WIN95__
1092