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