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