src/generic/treectlg.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        treectlg.cpp
   3 // Purpose:     generic tree control implementation
   4 // Author:      Robert Roebling
   5 // Created:     01/02/97
   6 // Modified:    22/10/98 - almost total rewrite, simpler interface (VZ)
   7 // Id:          $Id$
   8 // Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // =============================================================================
  13 // declarations
  14 // =============================================================================
  15
  16 // -----------------------------------------------------------------------------
  17 // headers
  18 // -----------------------------------------------------------------------------
  19
  20 #ifdef __GNUG__
  21   #pragma implementation "treectlg.h"
  22 #endif
  23
  24 // For compilers that support precompilation, includes "wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #ifdef __BORLANDC__
  28     #pragma hdrstop
  29 #endif
  30
  31 #if wxUSE_TREECTRL
  32
  33 #include "wx/treebase.h"
  34 #include "wx/generic/treectlg.h"
  35 #include "wx/timer.h"
  36 #include "wx/textctrl.h"
  37 #include "wx/imaglist.h"
  38 #include "wx/settings.h"
  39 #include "wx/dcclient.h"
  40
  41 // -----------------------------------------------------------------------------
  42 // array types
  43 // -----------------------------------------------------------------------------
  44
  45 class WXDLLEXPORT wxGenericTreeItem;
  46
  47 WX_DEFINE_EXPORTED_ARRAY(wxGenericTreeItem *, wxArrayGenericTreeItems);
  48
  49 // ----------------------------------------------------------------------------
  50 // constants
  51 // ----------------------------------------------------------------------------
  52
  53 static const int NO_IMAGE = -1;
  54
  55 static const int PIXELS_PER_UNIT = 10;
  56
  57 // ----------------------------------------------------------------------------
  58 // Aqua arrows
  59 // ----------------------------------------------------------------------------
  60
  61 /* XPM */
  62 static const char *aqua_arrow_right[] = {
  63 /* columns rows colors chars-per-pixel */
  64 "13 11 4 1",
  65 "  c None",
  66 "b c #C0C0C0",
  67 "c c #707070",
  68 "d c #A0A0A0",
  69 /* pixels */
  70 "    b        ",
  71 "    ddb      ",
  72 "    cccdb    ",
  73 "    cccccd   ",
  74 "    ccccccdb ",
  75 "    ccccccccd",
  76 "    ccccccdb ",
  77 "    cccccb   ",
  78 "    cccdb    ",
  79 "    ddb      ",
  80 "    b        "
  81 };
  82
  83 /* XPM */
  84 static const char *aqua_arrow_down[] = {
  85 /* columns rows colors chars-per-pixel */
  86 "13 11 4 1",
  87 "  c None",
  88 "b c #C0C0C0",
  89 "c c #707070",
  90 "d c #A0A0A0",
  91 /* pixels */
  92 "             ",
  93 "             ",
  94 " bdcccccccdb ",
  95 "  dcccccccd  ",
  96 "  bcccccccb  ",
  97 "   dcccccd   ",
  98 "   bcccccb   ",
  99 "    bcccd    ",
 100 "     dcd     ",
 101 "     bcb     ",
 102 "      d      "
 103 };
 104
 105 // -----------------------------------------------------------------------------
 106 // private classes
 107 // -----------------------------------------------------------------------------
 108
 109 // timer used for enabling in-place edit
 110 class WXDLLEXPORT wxTreeRenameTimer: public wxTimer
 111 {
 112 public:
 113     // start editing the current item after half a second (if the mouse hasn't
 114     // been clicked/moved)
 115     enum { DELAY = 500 };
 116
 117     wxTreeRenameTimer( wxGenericTreeCtrl *owner );
 118
 119     virtual void Notify();
 120
 121 private:
 122     wxGenericTreeCtrl *m_owner;
 123 };
 124
 125 // control used for in-place edit
 126 class WXDLLEXPORT wxTreeTextCtrl: public wxTextCtrl
 127 {
 128 public:
 129     wxTreeTextCtrl(wxGenericTreeCtrl *owner, wxGenericTreeItem *item);
 130
 131 protected:
 132     void OnChar( wxKeyEvent &event );
 133     void OnKeyUp( wxKeyEvent &event );
 134     void OnKillFocus( wxFocusEvent &event );
 135
 136     bool AcceptChanges();
 137     void Finish();
 138
 139 private:
 140     wxGenericTreeCtrl  *m_owner;
 141     wxGenericTreeItem  *m_itemEdited;
 142     wxString            m_startValue;
 143     bool                m_finished;
 144
 145     DECLARE_EVENT_TABLE()
 146 };
 147
 148 // timer used to clear wxGenericTreeCtrl::m_findPrefix if no key was pressed
 149 // for a sufficiently long time
 150 class WXDLLEXPORT wxTreeFindTimer : public wxTimer
 151 {
 152 public:
 153     // reset the current prefix after half a second of inactivity
 154     enum { DELAY = 500 };
 155
 156     wxTreeFindTimer( wxGenericTreeCtrl *owner ) { m_owner = owner; }
 157
 158     virtual void Notify() { m_owner->m_findPrefix.clear(); }
 159
 160 private:
 161     wxGenericTreeCtrl *m_owner;
 162 };
 163
 164 // a tree item
 165 class WXDLLEXPORT wxGenericTreeItem
 166 {
 167 public:
 168     // ctors & dtor
 169     wxGenericTreeItem() { m_data = NULL; }
 170     wxGenericTreeItem( wxGenericTreeItem *parent,
 171                        const wxString& text,
 172                        int image,
 173                        int selImage,
 174                        wxTreeItemData *data );
 175
 176     ~wxGenericTreeItem();
 177
 178     // trivial accessors
 179     wxArrayGenericTreeItems& GetChildren() { return m_children; }
 180
 181     const wxString& GetText() const { return m_text; }
 182     int GetImage(wxTreeItemIcon which = wxTreeItemIcon_Normal) const
 183         { return m_images[which]; }
 184     wxTreeItemData *GetData() const { return m_data; }
 185
 186     // returns the current image for the item (depending on its
 187     // selected/expanded/whatever state)
 188     int GetCurrentImage() const;
 189
 190     void SetText( const wxString &text );
 191     void SetImage(int image, wxTreeItemIcon which) { m_images[which] = image; }
 192     void SetData(wxTreeItemData *data) { m_data = data; }
 193
 194     void SetHasPlus(bool has = TRUE) { m_hasPlus = has; }
 195
 196     void SetBold(bool bold) { m_isBold = bold; }
 197
 198     int GetX() const { return m_x; }
 199     int GetY() const { return m_y; }
 200
 201     void SetX(int x) { m_x = x; }
 202     void SetY(int y) { m_y = y; }
 203
 204     int  GetHeight() const { return m_height; }
 205     int  GetWidth()  const { return m_width; }
 206
 207     void SetHeight(int h) { m_height = h; }
 208     void SetWidth(int w) { m_width = w; }
 209
 210     wxGenericTreeItem *GetParent() const { return m_parent; }
 211
 212     // operations
 213         // deletes all children notifying the treectrl about it if !NULL
 214         // pointer given
 215     void DeleteChildren(wxGenericTreeCtrl *tree = NULL);
 216
 217     // get count of all children (and grand children if 'recursively')
 218     size_t GetChildrenCount(bool recursively = TRUE) const;
 219
 220     void Insert(wxGenericTreeItem *child, size_t index)
 221     { m_children.Insert(child, index); }
 222
 223     void GetSize( int &x, int &y, const wxGenericTreeCtrl* );
 224
 225         // return the item at given position (or NULL if no item), onButton is
 226         // TRUE if the point belongs to the item's button, otherwise it lies
 227         // on the button's label
 228     wxGenericTreeItem *HitTest( const wxPoint& point,
 229                                 const wxGenericTreeCtrl *,
 230                                 int &flags,
 231                                 int level );
 232
 233     void Expand() { m_isCollapsed = FALSE; }
 234     void Collapse() { m_isCollapsed = TRUE; }
 235
 236     void SetHilight( bool set = TRUE ) { m_hasHilight = set; }
 237
 238     // status inquiries
 239     bool HasChildren() const { return !m_children.IsEmpty(); }
 240     bool IsSelected()  const { return m_hasHilight != 0; }
 241     bool IsExpanded()  const { return !m_isCollapsed; }
 242     bool HasPlus()     const { return m_hasPlus || HasChildren(); }
 243     bool IsBold()      const { return m_isBold != 0; }
 244
 245     // attributes
 246         // get them - may be NULL
 247     wxTreeItemAttr *GetAttributes() const { return m_attr; }
 248         // get them ensuring that the pointer is not NULL
 249     wxTreeItemAttr& Attr()
 250     {
 251         if ( !m_attr )
 252         {
 253             m_attr = new wxTreeItemAttr;
 254             m_ownsAttr = TRUE;
 255         }
 256         return *m_attr;
 257     }
 258         // set them
 259     void SetAttributes(wxTreeItemAttr *attr)
 260     {
 261         if ( m_ownsAttr ) delete m_attr;
 262         m_attr = attr;
 263         m_ownsAttr = FALSE;
 264     }
 265         // set them and delete when done
 266     void AssignAttributes(wxTreeItemAttr *attr)
 267     {
 268         SetAttributes(attr);
 269         m_ownsAttr = TRUE;
 270     }
 271
 272 private:
 273     // since there can be very many of these, we save size by chosing
 274     // the smallest representation for the elements and by ordering
 275     // the members to avoid padding.
 276     wxString            m_text;         // label to be rendered for item
 277
 278     wxTreeItemData     *m_data;         // user-provided data
 279
 280     wxArrayGenericTreeItems m_children; // list of children
 281     wxGenericTreeItem  *m_parent;       // parent of this item
 282
 283     wxTreeItemAttr     *m_attr;         // attributes???
 284
 285     // tree ctrl images for the normal, selected, expanded and
 286     // expanded+selected states
 287     short               m_images[wxTreeItemIcon_Max];
 288
 289     wxCoord             m_x;            // (virtual) offset from top
 290     short               m_y;            // (virtual) offset from left
 291     short               m_width;        // width of this item
 292     unsigned char       m_height;       // height of this item
 293
 294     // use bitfields to save size
 295     int                 m_isCollapsed :1;
 296     int                 m_hasHilight  :1; // same as focused
 297     int                 m_hasPlus     :1; // used for item which doesn't have
 298                                           // children but has a [+] button
 299     int                 m_isBold      :1; // render the label in bold font
 300     int                 m_ownsAttr    :1; // delete attribute when done
 301 };
 302
 303 // =============================================================================
 304 // implementation
 305 // =============================================================================
 306
 307 // ----------------------------------------------------------------------------
 308 // private functions
 309 // ----------------------------------------------------------------------------
 310
 311 // translate the key or mouse event flags to the type of selection we're
 312 // dealing with
 313 static void EventFlagsToSelType(long style,
 314                                 bool shiftDown,
 315                                 bool ctrlDown,
 316                                 bool &is_multiple,
 317                                 bool &extended_select,
 318                                 bool &unselect_others)
 319 {
 320     is_multiple = (style & wxTR_MULTIPLE) != 0;
 321     extended_select = shiftDown && is_multiple;
 322     unselect_others = !(extended_select || (ctrlDown && is_multiple));
 323 }
 324
 325 // -----------------------------------------------------------------------------
 326 // wxTreeRenameTimer (internal)
 327 // -----------------------------------------------------------------------------
 328
 329 wxTreeRenameTimer::wxTreeRenameTimer( wxGenericTreeCtrl *owner )
 330 {
 331     m_owner = owner;
 332 }
 333
 334 void wxTreeRenameTimer::Notify()
 335 {
 336     m_owner->OnRenameTimer();
 337 }
 338
 339 //-----------------------------------------------------------------------------
 340 // wxTreeTextCtrl (internal)
 341 //-----------------------------------------------------------------------------
 342
 343 BEGIN_EVENT_TABLE(wxTreeTextCtrl,wxTextCtrl)
 344     EVT_CHAR           (wxTreeTextCtrl::OnChar)
 345     EVT_KEY_UP         (wxTreeTextCtrl::OnKeyUp)
 346     EVT_KILL_FOCUS     (wxTreeTextCtrl::OnKillFocus)
 347 END_EVENT_TABLE()
 348
 349 wxTreeTextCtrl::wxTreeTextCtrl(wxGenericTreeCtrl *owner,
 350                                wxGenericTreeItem *item)
 351               : m_itemEdited(item), m_startValue(item->GetText())
 352 {
 353     m_owner = owner;
 354     m_finished = FALSE;
 355
 356     int w = m_itemEdited->GetWidth(),
 357         h = m_itemEdited->GetHeight();
 358
 359     int x, y;
 360     m_owner->CalcScrolledPosition(item->GetX(), item->GetY(), &x, &y);
 361
 362     int image_h = 0,
 363         image_w = 0;
 364
 365     int image = item->GetCurrentImage();
 366     if ( image != NO_IMAGE )
 367     {
 368         if ( m_owner->m_imageListNormal )
 369         {
 370             m_owner->m_imageListNormal->GetSize( image, image_w, image_h );
 371             image_w += 4;
 372         }
 373         else
 374         {
 375             wxFAIL_MSG(_T("you must create an image list to use images!"));
 376         }
 377     }
 378
 379     // FIXME: what are all these hardcoded 4, 8 and 11s really?
 380     x += image_w;
 381     w -= image_w + 4;
 382
 383     (void)Create(m_owner, wxID_ANY, m_startValue,
 384                  wxPoint(x - 4, y - 4), wxSize(w + 11, h + 8));
 385 }
 386
 387 bool wxTreeTextCtrl::AcceptChanges()
 388 {
 389     const wxString value = GetValue();
 390
 391     if ( value == m_startValue )
 392     {
 393         // nothing changed, always accept
 394         return TRUE;
 395     }
 396
 397     if ( !m_owner->OnRenameAccept(m_itemEdited, value) )
 398     {
 399         // vetoed by the user
 400         return FALSE;
 401     }
 402
 403     // accepted, do rename the item
 404     m_owner->SetItemText(m_itemEdited, value);
 405
 406     return TRUE;
 407 }
 408
 409 void wxTreeTextCtrl::Finish()
 410 {
 411     if ( !m_finished )
 412     {
 413         wxPendingDelete.Append(this);
 414
 415         m_finished = TRUE;
 416
 417         m_owner->SetFocus(); // This doesn't work. TODO.
 418     }
 419 }
 420
 421 void wxTreeTextCtrl::OnChar( wxKeyEvent &event )
 422 {
 423     switch ( event.m_keyCode )
 424     {
 425         case WXK_RETURN:
 426             if ( !AcceptChanges() )
 427             {
 428                 // vetoed by the user, don't disappear
 429                 break;
 430             }
 431             //else: fall through
 432
 433         case WXK_ESCAPE:
 434             Finish();
 435             break;
 436
 437         default:
 438             event.Skip();
 439     }
 440 }
 441
 442 void wxTreeTextCtrl::OnKeyUp( wxKeyEvent &event )
 443 {
 444     if ( !m_finished )
 445     {
 446         // auto-grow the textctrl:
 447         wxSize parentSize = m_owner->GetSize();
 448         wxPoint myPos = GetPosition();
 449         wxSize mySize = GetSize();
 450         int sx, sy;
 451         GetTextExtent(GetValue() + _T("M"), &sx, &sy);
 452         if (myPos.x + sx > parentSize.x)
 453             sx = parentSize.x - myPos.x;
 454         if (mySize.x > sx)
 455             sx = mySize.x;
 456         SetSize(sx, -1);
 457     }
 458
 459     event.Skip();
 460 }
 461
 462 void wxTreeTextCtrl::OnKillFocus( wxFocusEvent &event )
 463 {
 464     if ( m_finished )
 465     {
 466         event.Skip();
 467         return;
 468     }
 469
 470     if ( AcceptChanges() )
 471     {
 472         Finish();
 473     }
 474 }
 475
 476 // -----------------------------------------------------------------------------
 477 // wxGenericTreeItem
 478 // -----------------------------------------------------------------------------
 479
 480 wxGenericTreeItem::wxGenericTreeItem(wxGenericTreeItem *parent,
 481                                      const wxString& text,
 482                                      int image, int selImage,
 483                                      wxTreeItemData *data)
 484                  : m_text(text)
 485 {
 486     m_images[wxTreeItemIcon_Normal] = image;
 487     m_images[wxTreeItemIcon_Selected] = selImage;
 488     m_images[wxTreeItemIcon_Expanded] = NO_IMAGE;
 489     m_images[wxTreeItemIcon_SelectedExpanded] = NO_IMAGE;
 490
 491     m_data = data;
 492     m_x = m_y = 0;
 493
 494     m_isCollapsed = TRUE;
 495     m_hasHilight = FALSE;
 496     m_hasPlus = FALSE;
 497     m_isBold = FALSE;
 498
 499     m_parent = parent;
 500
 501     m_attr = (wxTreeItemAttr *)NULL;
 502     m_ownsAttr = FALSE;
 503
 504     // We don't know the height here yet.
 505     m_width = 0;
 506     m_height = 0;
 507 }
 508
 509 wxGenericTreeItem::~wxGenericTreeItem()
 510 {
 511     delete m_data;
 512
 513     if (m_ownsAttr) delete m_attr;
 514
 515     wxASSERT_MSG( m_children.IsEmpty(),
 516                   wxT("please call DeleteChildren() before deleting the item") );
 517 }
 518
 519 void wxGenericTreeItem::DeleteChildren(wxGenericTreeCtrl *tree)
 520 {
 521     size_t count = m_children.Count();
 522     for ( size_t n = 0; n < count; n++ )
 523     {
 524         wxGenericTreeItem *child = m_children[n];
 525         if (tree)
 526             tree->SendDeleteEvent(child);
 527
 528         child->DeleteChildren(tree);
 529         delete child;
 530     }
 531
 532     m_children.Empty();
 533 }
 534
 535 void wxGenericTreeItem::SetText( const wxString &text )
 536 {
 537     m_text = text;
 538 }
 539
 540 size_t wxGenericTreeItem::GetChildrenCount(bool recursively) const
 541 {
 542     size_t count = m_children.Count();
 543     if ( !recursively )
 544         return count;
 545
 546     size_t total = count;
 547     for (size_t n = 0; n < count; ++n)
 548     {
 549         total += m_children[n]->GetChildrenCount();
 550     }
 551
 552     return total;
 553 }
 554
 555 void wxGenericTreeItem::GetSize( int &x, int &y,
 556                                  const wxGenericTreeCtrl *theButton )
 557 {
 558     int bottomY=m_y+theButton->GetLineHeight(this);
 559     if ( y < bottomY ) y = bottomY;
 560     int width = m_x +  m_width;
 561     if ( x < width ) x = width;
 562
 563     if (IsExpanded())
 564     {
 565         size_t count = m_children.Count();
 566         for ( size_t n = 0; n < count; ++n )
 567         {
 568             m_children[n]->GetSize( x, y, theButton );
 569         }
 570     }
 571 }
 572
 573 wxGenericTreeItem *wxGenericTreeItem::HitTest(const wxPoint& point,
 574                                               const wxGenericTreeCtrl *theCtrl,
 575                                               int &flags,
 576                                               int level)
 577 {
 578     // for a hidden root node, don't evaluate it, but do evaluate children
 579     if ( !(level == 0 && theCtrl->HasFlag(wxTR_HIDE_ROOT)) )
 580     {
 581         // evaluate the item
 582         int h = theCtrl->GetLineHeight(this);
 583         if ((point.y > m_y) && (point.y < m_y + h))
 584         {
 585             int y_mid = m_y + h/2;
 586             if (point.y < y_mid )
 587                 flags |= wxTREE_HITTEST_ONITEMUPPERPART;
 588             else
 589                 flags |= wxTREE_HITTEST_ONITEMLOWERPART;
 590
 591             // 5 is the size of the plus sign
 592             int xCross = m_x - theCtrl->GetSpacing();
 593             if ((point.x > xCross-5) && (point.x < xCross+5) &&
 594                 (point.y > y_mid-5) && (point.y < y_mid+5) &&
 595                 HasPlus() && theCtrl->HasButtons() )
 596             {
 597                 flags |= wxTREE_HITTEST_ONITEMBUTTON;
 598                 return this;
 599             }
 600
 601             if ((point.x >= m_x) && (point.x <= m_x+m_width))
 602             {
 603                 int image_w = -1;
 604                 int image_h;
 605
 606                 // assuming every image (normal and selected) has the same size!
 607                 if ( (GetImage() != NO_IMAGE) && theCtrl->m_imageListNormal )
 608                     theCtrl->m_imageListNormal->GetSize(GetImage(),
 609                                                         image_w, image_h);
 610
 611                 if ((image_w != -1) && (point.x <= m_x + image_w + 1))
 612                     flags |= wxTREE_HITTEST_ONITEMICON;
 613                 else
 614                     flags |= wxTREE_HITTEST_ONITEMLABEL;
 615
 616                 return this;
 617             }
 618
 619             if (point.x < m_x)
 620                 flags |= wxTREE_HITTEST_ONITEMINDENT;
 621             if (point.x > m_x+m_width)
 622                 flags |= wxTREE_HITTEST_ONITEMRIGHT;
 623
 624             return this;
 625         }
 626
 627         // if children are expanded, fall through to evaluate them
 628         if (m_isCollapsed) return (wxGenericTreeItem*) NULL;
 629     }
 630
 631     // evaluate children
 632     size_t count = m_children.Count();
 633     for ( size_t n = 0; n < count; n++ )
 634     {
 635         wxGenericTreeItem *res = m_children[n]->HitTest( point,
 636                                                          theCtrl,
 637                                                          flags,
 638                                                          level + 1 );
 639         if ( res != NULL )
 640             return res;
 641     }
 642
 643     return (wxGenericTreeItem*) NULL;
 644 }
 645
 646 int wxGenericTreeItem::GetCurrentImage() const
 647 {
 648     int image = NO_IMAGE;
 649     if ( IsExpanded() )
 650     {
 651         if ( IsSelected() )
 652         {
 653             image = GetImage(wxTreeItemIcon_SelectedExpanded);
 654         }
 655
 656         if ( image == NO_IMAGE )
 657         {
 658             // we usually fall back to the normal item, but try just the
 659             // expanded one (and not selected) first in this case
 660             image = GetImage(wxTreeItemIcon_Expanded);
 661         }
 662     }
 663     else // not expanded
 664     {
 665         if ( IsSelected() )
 666             image = GetImage(wxTreeItemIcon_Selected);
 667     }
 668
 669     // maybe it doesn't have the specific image we want,
 670     // try the default one instead
 671     if ( image == NO_IMAGE ) image = GetImage();
 672
 673     return image;
 674 }
 675
 676 // -----------------------------------------------------------------------------
 677 // wxGenericTreeCtrl implementation
 678 // -----------------------------------------------------------------------------
 679
 680 IMPLEMENT_DYNAMIC_CLASS(wxGenericTreeCtrl, wxScrolledWindow)
 681
 682 BEGIN_EVENT_TABLE(wxGenericTreeCtrl,wxScrolledWindow)
 683     EVT_PAINT          (wxGenericTreeCtrl::OnPaint)
 684     EVT_MOUSE_EVENTS   (wxGenericTreeCtrl::OnMouse)
 685     EVT_CHAR           (wxGenericTreeCtrl::OnChar)
 686     EVT_SET_FOCUS      (wxGenericTreeCtrl::OnSetFocus)
 687     EVT_KILL_FOCUS     (wxGenericTreeCtrl::OnKillFocus)
 688     EVT_IDLE           (wxGenericTreeCtrl::OnIdle)
 689 END_EVENT_TABLE()
 690
 691 #if !defined(__WXMSW__) || defined(__WIN16__) || defined(__WXUNIVERSAL__)
 692 /*
 693  * wxTreeCtrl has to be a real class or we have problems with
 694  * the run-time information.
 695  */
 696
 697 IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl, wxGenericTreeCtrl)
 698 #endif
 699
 700 // -----------------------------------------------------------------------------
 701 // construction/destruction
 702 // -----------------------------------------------------------------------------
 703
 704 void wxGenericTreeCtrl::Init()
 705 {
 706     m_current = m_key_current = m_anchor = (wxGenericTreeItem *) NULL;
 707     m_hasFocus = FALSE;
 708     m_dirty = FALSE;
 709
 710     m_lineHeight = 10;
 711     m_indent = 15;
 712     m_spacing = 18;
 713
 714     m_hilightBrush = new wxBrush
 715                          (
 716                             wxSystemSettings::GetColour
 717                             (
 718                                 wxSYS_COLOUR_HIGHLIGHT
 719                             ),
 720                             wxSOLID
 721                          );
 722
 723     m_hilightUnfocusedBrush = new wxBrush
 724                               (
 725                                  wxSystemSettings::GetColour
 726                                  (
 727                                      wxSYS_COLOUR_BTNSHADOW
 728                                  ),
 729                                  wxSOLID
 730                               );
 731
 732     m_imageListNormal = m_imageListButtons =
 733     m_imageListState = (wxImageList *) NULL;
 734     m_ownsImageListNormal = m_ownsImageListButtons =
 735     m_ownsImageListState = FALSE;
 736
 737     m_dragCount = 0;
 738     m_isDragging = FALSE;
 739     m_dropTarget = m_oldSelection = (wxGenericTreeItem *)NULL;
 740
 741     m_renameTimer = NULL;
 742     m_findTimer = NULL;
 743
 744     m_lastOnSame = FALSE;
 745
 746     m_normalFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
 747     m_boldFont = wxFont( m_normalFont.GetPointSize(),
 748                          m_normalFont.GetFamily(),
 749                          m_normalFont.GetStyle(),
 750                          wxBOLD,
 751                          m_normalFont.GetUnderlined());
 752 }
 753
 754 bool wxGenericTreeCtrl::Create(wxWindow *parent,
 755                                wxWindowID id,
 756                                const wxPoint& pos,
 757                                const wxSize& size,
 758                                long style,
 759                                const wxValidator &validator,
 760                                const wxString& name )
 761 {
 762 #ifdef __WXMAC__
 763     int major,minor;
 764     wxGetOsVersion( &major, &minor );
 765
 766     if (style & wxTR_HAS_BUTTONS) style |= wxTR_MAC_BUTTONS;
 767     if (style & wxTR_HAS_BUTTONS) style &= ~wxTR_HAS_BUTTONS;
 768     style &= ~wxTR_LINES_AT_ROOT;
 769     style |= wxTR_NO_LINES;
 770     if (major < 10)
 771         style |= wxTR_ROW_LINES;
 772     if (major >= 10)
 773         style |= wxTR_AQUA_BUTTONS;
 774 #endif
 775
 776     if (style & wxTR_AQUA_BUTTONS)
 777     {
 778         m_arrowRight = new wxBitmap( aqua_arrow_right );
 779         m_arrowDown = new wxBitmap( aqua_arrow_down );
 780     }
 781     else
 782     {
 783         m_arrowRight = NULL;
 784         m_arrowDown = NULL;
 785     }
 786
 787     wxScrolledWindow::Create( parent, id, pos, size,
 788                               style|wxHSCROLL|wxVSCROLL, name );
 789
 790     // If the tree display has no buttons, but does have
 791     // connecting lines, we can use a narrower layout.
 792     // It may not be a good idea to force this...
 793     if (!HasButtons() && !HasFlag(wxTR_NO_LINES))
 794     {
 795         m_indent= 10;
 796         m_spacing = 10;
 797     }
 798
 799 #if wxUSE_VALIDATORS
 800     SetValidator( validator );
 801 #endif
 802
 803     SetForegroundColour( wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT) );
 804     SetBackgroundColour( wxSystemSettings::GetColour(wxSYS_COLOUR_LISTBOX) );
 805
 806 //  m_dottedPen = wxPen( "grey", 0, wxDOT );  too slow under XFree86
 807     m_dottedPen = wxPen( wxT("grey"), 0, 0 );
 808
 809     return TRUE;
 810 }
 811
 812 wxGenericTreeCtrl::~wxGenericTreeCtrl()
 813 {
 814     delete m_hilightBrush;
 815     delete m_hilightUnfocusedBrush;
 816
 817     delete m_arrowRight;
 818     delete m_arrowDown;
 819
 820     DeleteAllItems();
 821
 822     delete m_renameTimer;
 823     delete m_findTimer;
 824
 825     if (m_ownsImageListNormal)
 826         delete m_imageListNormal;
 827     if (m_ownsImageListState)
 828         delete m_imageListState;
 829     if (m_ownsImageListButtons)
 830         delete m_imageListButtons;
 831 }
 832
 833 // -----------------------------------------------------------------------------
 834 // accessors
 835 // -----------------------------------------------------------------------------
 836
 837 size_t wxGenericTreeCtrl::GetCount() const
 838 {
 839     return m_anchor == NULL ? 0u : m_anchor->GetChildrenCount();
 840 }
 841
 842 void wxGenericTreeCtrl::SetIndent(unsigned int indent)
 843 {
 844     m_indent = (unsigned short) indent;
 845     m_dirty = TRUE;
 846 }
 847
 848 void wxGenericTreeCtrl::SetSpacing(unsigned int spacing)
 849 {
 850     m_spacing = (unsigned short) spacing;
 851     m_dirty = TRUE;
 852 }
 853
 854 size_t wxGenericTreeCtrl::GetChildrenCount(const wxTreeItemId& item, bool recursively)
 855 {
 856     wxCHECK_MSG( item.IsOk(), 0u, wxT("invalid tree item") );
 857
 858     return ((wxGenericTreeItem*) item.m_pItem)->GetChildrenCount(recursively);
 859 }
 860
 861 void wxGenericTreeCtrl::SetWindowStyle(const long styles)
 862 {
 863     if (!HasFlag(wxTR_HIDE_ROOT) && (styles & wxTR_HIDE_ROOT))
 864     {
 865         // if we will hide the root, make sure children are visible
 866         m_anchor->SetHasPlus();
 867         m_anchor->Expand();
 868         CalculatePositions();
 869     }
 870
 871     // right now, just sets the styles.  Eventually, we may
 872     // want to update the inherited styles, but right now
 873     // none of the parents has updatable styles
 874     m_windowStyle = styles;
 875     m_dirty = TRUE;
 876 }
 877
 878 // -----------------------------------------------------------------------------
 879 // functions to work with tree items
 880 // -----------------------------------------------------------------------------
 881
 882 wxString wxGenericTreeCtrl::GetItemText(const wxTreeItemId& item) const
 883 {
 884     wxCHECK_MSG( item.IsOk(), wxT(""), wxT("invalid tree item") );
 885
 886     return ((wxGenericTreeItem*) item.m_pItem)->GetText();
 887 }
 888
 889 int wxGenericTreeCtrl::GetItemImage(const wxTreeItemId& item,
 890                              wxTreeItemIcon which) const
 891 {
 892     wxCHECK_MSG( item.IsOk(), -1, wxT("invalid tree item") );
 893
 894     return ((wxGenericTreeItem*) item.m_pItem)->GetImage(which);
 895 }
 896
 897 wxTreeItemData *wxGenericTreeCtrl::GetItemData(const wxTreeItemId& item) const
 898 {
 899     wxCHECK_MSG( item.IsOk(), NULL, wxT("invalid tree item") );
 900
 901     return ((wxGenericTreeItem*) item.m_pItem)->GetData();
 902 }
 903
 904 void wxGenericTreeCtrl::SetItemText(const wxTreeItemId& item, const wxString& text)
 905 {
 906     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
 907
 908     wxClientDC dc(this);
 909     wxGenericTreeItem *pItem = (wxGenericTreeItem*) item.m_pItem;
 910     pItem->SetText(text);
 911     CalculateSize(pItem, dc);
 912     RefreshLine(pItem);
 913 }
 914
 915 void wxGenericTreeCtrl::SetItemImage(const wxTreeItemId& item,
 916                               int image,
 917                               wxTreeItemIcon which)
 918 {
 919     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
 920
 921     wxGenericTreeItem *pItem = (wxGenericTreeItem*) item.m_pItem;
 922     pItem->SetImage(image, which);
 923
 924     wxClientDC dc(this);
 925     CalculateSize(pItem, dc);
 926     RefreshLine(pItem);
 927 }
 928
 929 void wxGenericTreeCtrl::SetItemData(const wxTreeItemId& item, wxTreeItemData *data)
 930 {
 931     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
 932
 933     ((wxGenericTreeItem*) item.m_pItem)->SetData(data);
 934 }
 935
 936 void wxGenericTreeCtrl::SetItemHasChildren(const wxTreeItemId& item, bool has)
 937 {
 938     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
 939
 940     wxGenericTreeItem *pItem = (wxGenericTreeItem*) item.m_pItem;
 941     pItem->SetHasPlus(has);
 942     RefreshLine(pItem);
 943 }
 944
 945 void wxGenericTreeCtrl::SetItemBold(const wxTreeItemId& item, bool bold)
 946 {
 947     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
 948
 949     // avoid redrawing the tree if no real change
 950     wxGenericTreeItem *pItem = (wxGenericTreeItem*) item.m_pItem;
 951     if ( pItem->IsBold() != bold )
 952     {
 953         pItem->SetBold(bold);
 954         RefreshLine(pItem);
 955     }
 956 }
 957
 958 void wxGenericTreeCtrl::SetItemTextColour(const wxTreeItemId& item,
 959                                    const wxColour& col)
 960 {
 961     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
 962
 963     wxGenericTreeItem *pItem = (wxGenericTreeItem*) item.m_pItem;
 964     pItem->Attr().SetTextColour(col);
 965     RefreshLine(pItem);
 966 }
 967
 968 void wxGenericTreeCtrl::SetItemBackgroundColour(const wxTreeItemId& item,
 969                                          const wxColour& col)
 970 {
 971     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
 972
 973     wxGenericTreeItem *pItem = (wxGenericTreeItem*) item.m_pItem;
 974     pItem->Attr().SetBackgroundColour(col);
 975     RefreshLine(pItem);
 976 }
 977
 978 void wxGenericTreeCtrl::SetItemFont(const wxTreeItemId& item, const wxFont& font)
 979 {
 980     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
 981
 982     wxGenericTreeItem *pItem = (wxGenericTreeItem*) item.m_pItem;
 983     pItem->Attr().SetFont(font);
 984     RefreshLine(pItem);
 985 }
 986
 987 bool wxGenericTreeCtrl::SetFont( const wxFont &font )
 988 {
 989     wxScrolledWindow::SetFont(font);
 990
 991     m_normalFont = font ;
 992     m_boldFont = wxFont( m_normalFont.GetPointSize(),
 993                             m_normalFont.GetFamily(),
 994                             m_normalFont.GetStyle(),
 995                             wxBOLD,
 996                             m_normalFont.GetUnderlined());
 997
 998     return TRUE;
 999 }
1000
1001
1002 // -----------------------------------------------------------------------------
1003 // item status inquiries
1004 // -----------------------------------------------------------------------------
1005
1006 bool wxGenericTreeCtrl::IsVisible(const wxTreeItemId& item) const
1007 {
1008     wxCHECK_MSG( item.IsOk(), FALSE, wxT("invalid tree item") );
1009
1010     // An item is only visible if it's not a descendant of a collapsed item
1011     wxGenericTreeItem *pItem = (wxGenericTreeItem*) item.m_pItem;
1012     wxGenericTreeItem* parent = pItem->GetParent();
1013     while (parent)
1014     {
1015         if (!parent->IsExpanded())
1016             return FALSE;
1017         parent = parent->GetParent();
1018     }
1019
1020     int startX, startY;
1021     GetViewStart(& startX, & startY);
1022
1023     wxSize clientSize = GetClientSize();
1024
1025     wxRect rect;
1026     if (!GetBoundingRect(item, rect))
1027         return FALSE;
1028     if (rect.GetWidth() == 0 || rect.GetHeight() == 0)
1029         return FALSE;
1030     if (rect.GetBottom() < 0 || rect.GetTop() > clientSize.y)
1031         return FALSE;
1032     if (rect.GetRight() < 0 || rect.GetLeft() > clientSize.x)
1033         return FALSE;
1034
1035     return TRUE;
1036 }
1037
1038 bool wxGenericTreeCtrl::ItemHasChildren(const wxTreeItemId& item) const
1039 {
1040     wxCHECK_MSG( item.IsOk(), FALSE, wxT("invalid tree item") );
1041
1042     // consider that the item does have children if it has the "+" button: it
1043     // might not have them (if it had never been expanded yet) but then it
1044     // could have them as well and it's better to err on this side rather than
1045     // disabling some operations which are restricted to the items with
1046     // children for an item which does have them
1047     return ((wxGenericTreeItem*) item.m_pItem)->HasPlus();
1048 }
1049
1050 bool wxGenericTreeCtrl::IsExpanded(const wxTreeItemId& item) const
1051 {
1052     wxCHECK_MSG( item.IsOk(), FALSE, wxT("invalid tree item") );
1053
1054     return ((wxGenericTreeItem*) item.m_pItem)->IsExpanded();
1055 }
1056
1057 bool wxGenericTreeCtrl::IsSelected(const wxTreeItemId& item) const
1058 {
1059     wxCHECK_MSG( item.IsOk(), FALSE, wxT("invalid tree item") );
1060
1061     return ((wxGenericTreeItem*) item.m_pItem)->IsSelected();
1062 }
1063
1064 bool wxGenericTreeCtrl::IsBold(const wxTreeItemId& item) const
1065 {
1066     wxCHECK_MSG( item.IsOk(), FALSE, wxT("invalid tree item") );
1067
1068     return ((wxGenericTreeItem*) item.m_pItem)->IsBold();
1069 }
1070
1071 // -----------------------------------------------------------------------------
1072 // navigation
1073 // -----------------------------------------------------------------------------
1074
1075 wxTreeItemId wxGenericTreeCtrl::GetParent(const wxTreeItemId& item) const
1076 {
1077     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1078
1079     return ((wxGenericTreeItem*) item.m_pItem)->GetParent();
1080 }
1081
1082 wxTreeItemId wxGenericTreeCtrl::GetFirstChild(const wxTreeItemId& item, long& cookie) const
1083 {
1084     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1085
1086     cookie = 0;
1087     return GetNextChild(item, cookie);
1088 }
1089
1090 wxTreeItemId wxGenericTreeCtrl::GetNextChild(const wxTreeItemId& item, long& cookie) const
1091 {
1092     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1093
1094     wxArrayGenericTreeItems& children = ((wxGenericTreeItem*) item.m_pItem)->GetChildren();
1095     if ( (size_t)cookie < children.Count() )
1096     {
1097         return children.Item((size_t)cookie++);
1098     }
1099     else
1100     {
1101         // there are no more of them
1102         return wxTreeItemId();
1103     }
1104 }
1105
1106 wxTreeItemId wxGenericTreeCtrl::GetLastChild(const wxTreeItemId& item) const
1107 {
1108     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1109
1110     wxArrayGenericTreeItems& children = ((wxGenericTreeItem*) item.m_pItem)->GetChildren();
1111     return (children.IsEmpty() ? wxTreeItemId() : wxTreeItemId(children.Last()));
1112 }
1113
1114 wxTreeItemId wxGenericTreeCtrl::GetNextSibling(const wxTreeItemId& item) const
1115 {
1116     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1117
1118     wxGenericTreeItem *i = (wxGenericTreeItem*) item.m_pItem;
1119     wxGenericTreeItem *parent = i->GetParent();
1120     if ( parent == NULL )
1121     {
1122         // root item doesn't have any siblings
1123         return wxTreeItemId();
1124     }
1125
1126     wxArrayGenericTreeItems& siblings = parent->GetChildren();
1127     int index = siblings.Index(i);
1128     wxASSERT( index != wxNOT_FOUND ); // I'm not a child of my parent?
1129
1130     size_t n = (size_t)(index + 1);
1131     return n == siblings.Count() ? wxTreeItemId() : wxTreeItemId(siblings[n]);
1132 }
1133
1134 wxTreeItemId wxGenericTreeCtrl::GetPrevSibling(const wxTreeItemId& item) const
1135 {
1136     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1137
1138     wxGenericTreeItem *i = (wxGenericTreeItem*) item.m_pItem;
1139     wxGenericTreeItem *parent = i->GetParent();
1140     if ( parent == NULL )
1141     {
1142         // root item doesn't have any siblings
1143         return wxTreeItemId();
1144     }
1145
1146     wxArrayGenericTreeItems& siblings = parent->GetChildren();
1147     int index = siblings.Index(i);
1148     wxASSERT( index != wxNOT_FOUND ); // I'm not a child of my parent?
1149
1150     return index == 0 ? wxTreeItemId()
1151                       : wxTreeItemId(siblings[(size_t)(index - 1)]);
1152 }
1153
1154 // Only for internal use right now, but should probably be public
1155 wxTreeItemId wxGenericTreeCtrl::GetNext(const wxTreeItemId& item) const
1156 {
1157     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1158
1159     wxGenericTreeItem *i = (wxGenericTreeItem*) item.m_pItem;
1160
1161     // First see if there are any children.
1162     wxArrayGenericTreeItems& children = i->GetChildren();
1163     if (children.GetCount() > 0)
1164     {
1165          return children.Item(0);
1166     }
1167     else
1168     {
1169          // Try a sibling of this or ancestor instead
1170          wxTreeItemId p = item;
1171          wxTreeItemId toFind;
1172          do
1173          {
1174               toFind = GetNextSibling(p);
1175               p = GetParent(p);
1176          } while (p.IsOk() && !toFind.IsOk());
1177          return toFind;
1178     }
1179 }
1180
1181 wxTreeItemId wxGenericTreeCtrl::GetFirstVisibleItem() const
1182 {
1183     wxTreeItemId id = GetRootItem();
1184     if (!id.IsOk())
1185         return id;
1186
1187     do
1188     {
1189         if (IsVisible(id))
1190               return id;
1191         id = GetNext(id);
1192     } while (id.IsOk());
1193
1194     return wxTreeItemId();
1195 }
1196
1197 wxTreeItemId wxGenericTreeCtrl::GetNextVisible(const wxTreeItemId& item) const
1198 {
1199     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1200
1201     wxTreeItemId id = item;
1202     if (id.IsOk())
1203     {
1204         while (id = GetNext(id), id.IsOk())
1205         {
1206             if (IsVisible(id))
1207                 return id;
1208         }
1209     }
1210     return wxTreeItemId();
1211 }
1212
1213 wxTreeItemId wxGenericTreeCtrl::GetPrevVisible(const wxTreeItemId& item) const
1214 {
1215     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1216
1217     wxFAIL_MSG(wxT("not implemented"));
1218
1219     return wxTreeItemId();
1220 }
1221
1222 // find the first item starting with the given prefix after the given item
1223 wxTreeItemId wxGenericTreeCtrl::FindItem(const wxTreeItemId& idParent,
1224                                          const wxString& prefixOrig) const
1225 {
1226     // match is case insensitive as this is more convenient to the user: having
1227     // to press Shift-letter to go to the item starting with a capital letter
1228     // would be too bothersome
1229     wxString prefix = prefixOrig.Lower();
1230
1231     // determine the starting point: we shouldn't take the current item (this
1232     // allows to switch between two items starting with the same letter just by
1233     // pressing it) but we shouldn't jump to the next one if the user is
1234     // continuing to type as otherwise he might easily skip the item he wanted
1235     wxTreeItemId id = idParent;
1236     if ( prefix.length() == 1 )
1237     {
1238         id = GetNext(id);
1239     }
1240
1241     // look for the item starting with the given prefix after it
1242     while ( id.IsOk() && !GetItemText(id).Lower().StartsWith(prefix) )
1243     {
1244         id = GetNext(id);
1245     }
1246
1247     // if we haven't found anything...
1248     if ( !id.IsOk() )
1249     {
1250         // ... wrap to the beginning
1251         id = GetRootItem();
1252         if ( HasFlag(wxTR_HIDE_ROOT) )
1253         {
1254             // can't select virtual root
1255             id = GetNext(id);
1256         }
1257
1258         // and try all the items (stop when we get to the one we started from)
1259         while ( id != idParent && !GetItemText(id).Lower().StartsWith(prefix) )
1260         {
1261             id = GetNext(id);
1262         }
1263     }
1264
1265     return id;
1266 }
1267
1268 // -----------------------------------------------------------------------------
1269 // operations
1270 // -----------------------------------------------------------------------------
1271
1272 wxTreeItemId wxGenericTreeCtrl::DoInsertItem(const wxTreeItemId& parentId,
1273                                       size_t previous,
1274                                       const wxString& text,
1275                                       int image, int selImage,
1276                                       wxTreeItemData *data)
1277 {
1278     wxGenericTreeItem *parent = (wxGenericTreeItem*) parentId.m_pItem;
1279     if ( !parent )
1280     {
1281         // should we give a warning here?
1282         return AddRoot(text, image, selImage, data);
1283     }
1284
1285     m_dirty = TRUE;     // do this first so stuff below doesn't cause flicker
1286
1287     wxGenericTreeItem *item =
1288         new wxGenericTreeItem( parent, text, image, selImage, data );
1289
1290     if ( data != NULL )
1291     {
1292         data->m_pItem = (long) item;
1293     }
1294
1295     parent->Insert( item, previous );
1296
1297     return item;
1298 }
1299
1300 wxTreeItemId wxGenericTreeCtrl::AddRoot(const wxString& text,
1301                                  int image, int selImage,
1302                                  wxTreeItemData *data)
1303 {
1304     wxCHECK_MSG( !m_anchor, wxTreeItemId(), wxT("tree can have only one root") );
1305
1306     m_dirty = TRUE;     // do this first so stuff below doesn't cause flicker
1307
1308     m_anchor = new wxGenericTreeItem((wxGenericTreeItem *)NULL, text,
1309                                    image, selImage, data);
1310     if ( data != NULL )
1311     {
1312         data->m_pItem = (long) m_anchor;
1313     }
1314
1315     if (HasFlag(wxTR_HIDE_ROOT))
1316     {
1317         // if root is hidden, make sure we can navigate
1318         // into children
1319         m_anchor->SetHasPlus();
1320         m_anchor->Expand();
1321         CalculatePositions();
1322     }
1323
1324     if (!HasFlag(wxTR_MULTIPLE))
1325     {
1326         m_current = m_key_current = m_anchor;
1327         m_current->SetHilight( TRUE );
1328     }
1329
1330     return m_anchor;
1331 }
1332
1333 wxTreeItemId wxGenericTreeCtrl::PrependItem(const wxTreeItemId& parent,
1334                                      const wxString& text,
1335                                      int image, int selImage,
1336                                      wxTreeItemData *data)
1337 {
1338     return DoInsertItem(parent, 0u, text, image, selImage, data);
1339 }
1340
1341 wxTreeItemId wxGenericTreeCtrl::InsertItem(const wxTreeItemId& parentId,
1342                                     const wxTreeItemId& idPrevious,
1343                                     const wxString& text,
1344                                     int image, int selImage,
1345                                     wxTreeItemData *data)
1346 {
1347     wxGenericTreeItem *parent = (wxGenericTreeItem*) parentId.m_pItem;
1348     if ( !parent )
1349     {
1350         // should we give a warning here?
1351         return AddRoot(text, image, selImage, data);
1352     }
1353
1354     int index = -1;
1355     if (idPrevious.IsOk())
1356     {
1357         index = parent->GetChildren().Index((wxGenericTreeItem*) idPrevious.m_pItem);
1358         wxASSERT_MSG( index != wxNOT_FOUND,
1359                       wxT("previous item in wxGenericTreeCtrl::InsertItem() is not a sibling") );
1360     }
1361
1362     return DoInsertItem(parentId, (size_t)++index, text, image, selImage, data);
1363 }
1364
1365 wxTreeItemId wxGenericTreeCtrl::InsertItem(const wxTreeItemId& parentId,
1366                                     size_t before,
1367                                     const wxString& text,
1368                                     int image, int selImage,
1369                                     wxTreeItemData *data)
1370 {
1371     wxGenericTreeItem *parent = (wxGenericTreeItem*) parentId.m_pItem;
1372     if ( !parent )
1373     {
1374         // should we give a warning here?
1375         return AddRoot(text, image, selImage, data);
1376     }
1377
1378     return DoInsertItem(parentId, before, text, image, selImage, data);
1379 }
1380
1381 wxTreeItemId wxGenericTreeCtrl::AppendItem(const wxTreeItemId& parentId,
1382                                     const wxString& text,
1383                                     int image, int selImage,
1384                                     wxTreeItemData *data)
1385 {
1386     wxGenericTreeItem *parent = (wxGenericTreeItem*) parentId.m_pItem;
1387     if ( !parent )
1388     {
1389         // should we give a warning here?
1390         return AddRoot(text, image, selImage, data);
1391     }
1392
1393     return DoInsertItem( parent, parent->GetChildren().Count(), text,
1394                          image, selImage, data);
1395 }
1396
1397 void wxGenericTreeCtrl::SendDeleteEvent(wxGenericTreeItem *item)
1398 {
1399     wxTreeEvent event( wxEVT_COMMAND_TREE_DELETE_ITEM, GetId() );
1400     event.m_item = (long) item;
1401     event.SetEventObject( this );
1402     ProcessEvent( event );
1403 }
1404
1405 void wxGenericTreeCtrl::DeleteChildren(const wxTreeItemId& itemId)
1406 {
1407     m_dirty = TRUE;     // do this first so stuff below doesn't cause flicker
1408
1409     wxGenericTreeItem *item = (wxGenericTreeItem*) itemId.m_pItem;
1410     item->DeleteChildren(this);
1411 }
1412
1413 void wxGenericTreeCtrl::Delete(const wxTreeItemId& itemId)
1414 {
1415     m_dirty = TRUE;     // do this first so stuff below doesn't cause flicker
1416
1417     wxGenericTreeItem *item = (wxGenericTreeItem*) itemId.m_pItem;
1418
1419     // don't stay with invalid m_key_current or we will crash in
1420     // the next call to OnChar()
1421     bool changeKeyCurrent = FALSE;
1422     wxGenericTreeItem *itemKey = m_key_current;
1423     while ( itemKey )
1424     {
1425         if ( itemKey == item )
1426         {
1427             // m_key_current is a descendant of the item being deleted
1428             changeKeyCurrent = TRUE;
1429             break;
1430         }
1431         itemKey = itemKey->GetParent();
1432     }
1433
1434     wxGenericTreeItem *parent = item->GetParent();
1435     if ( parent )
1436     {
1437         parent->GetChildren().Remove( item );  // remove by value
1438     }
1439
1440     if ( changeKeyCurrent )
1441     {
1442         // may be NULL or not
1443         m_key_current = parent;
1444     }
1445
1446     item->DeleteChildren(this);
1447     SendDeleteEvent(item);
1448     delete item;
1449 }
1450
1451 void wxGenericTreeCtrl::DeleteAllItems()
1452 {
1453     if ( m_anchor )
1454     {
1455         m_dirty = TRUE;
1456
1457         m_anchor->DeleteChildren(this);
1458         delete m_anchor;
1459
1460         m_anchor = NULL;
1461     }
1462 }
1463
1464 void wxGenericTreeCtrl::Expand(const wxTreeItemId& itemId)
1465 {
1466     wxGenericTreeItem *item = (wxGenericTreeItem*) itemId.m_pItem;
1467
1468     wxCHECK_RET( item, _T("invalid item in wxGenericTreeCtrl::Expand") );
1469     wxCHECK_RET( !HasFlag(wxTR_HIDE_ROOT) || itemId != GetRootItem(),
1470                  _T("can't expand hidden root") );
1471
1472     if ( !item->HasPlus() )
1473         return;
1474
1475     if ( item->IsExpanded() )
1476         return;
1477
1478     wxTreeEvent event( wxEVT_COMMAND_TREE_ITEM_EXPANDING, GetId() );
1479     event.m_item = (long) item;
1480     event.SetEventObject( this );
1481
1482     if ( ProcessEvent( event ) && !event.IsAllowed() )
1483     {
1484         // cancelled by program
1485         return;
1486     }
1487
1488     item->Expand();
1489     CalculatePositions();
1490
1491     RefreshSubtree(item);
1492
1493     event.SetEventType(wxEVT_COMMAND_TREE_ITEM_EXPANDED);
1494     ProcessEvent( event );
1495 }
1496
1497 void wxGenericTreeCtrl::ExpandAll(const wxTreeItemId& item)
1498 {
1499     Expand(item);
1500     if ( IsExpanded(item) )
1501     {
1502         long cookie;
1503         wxTreeItemId child = GetFirstChild(item, cookie);
1504         while ( child.IsOk() )
1505         {
1506             ExpandAll(child);
1507
1508             child = GetNextChild(item, cookie);
1509         }
1510     }
1511 }
1512
1513 void wxGenericTreeCtrl::Collapse(const wxTreeItemId& itemId)
1514 {
1515     wxCHECK_RET( !HasFlag(wxTR_HIDE_ROOT) || itemId != GetRootItem(),
1516                  _T("can't collapse hidden root") );
1517
1518     wxGenericTreeItem *item = (wxGenericTreeItem*) itemId.m_pItem;
1519
1520     if ( !item->IsExpanded() )
1521         return;
1522
1523     wxTreeEvent event( wxEVT_COMMAND_TREE_ITEM_COLLAPSING, GetId() );
1524     event.m_item = (long) item;
1525     event.SetEventObject( this );
1526     if ( ProcessEvent( event ) && !event.IsAllowed() )
1527     {
1528         // cancelled by program
1529         return;
1530     }
1531
1532     item->Collapse();
1533
1534 #if 0  // TODO why should items be collapsed recursively?
1535     wxArrayGenericTreeItems& children = item->GetChildren();
1536     size_t count = children.Count();
1537     for ( size_t n = 0; n < count; n++ )
1538     {
1539         Collapse(children[n]);
1540     }
1541 #endif
1542
1543     CalculatePositions();
1544
1545     RefreshSubtree(item);
1546
1547     event.SetEventType(wxEVT_COMMAND_TREE_ITEM_COLLAPSED);
1548     ProcessEvent( event );
1549 }
1550
1551 void wxGenericTreeCtrl::CollapseAndReset(const wxTreeItemId& item)
1552 {
1553     Collapse(item);
1554     DeleteChildren(item);
1555 }
1556
1557 void wxGenericTreeCtrl::Toggle(const wxTreeItemId& itemId)
1558 {
1559     wxGenericTreeItem *item = (wxGenericTreeItem*) itemId.m_pItem;
1560
1561     if (item->IsExpanded())
1562         Collapse(itemId);
1563     else
1564         Expand(itemId);
1565 }
1566
1567 void wxGenericTreeCtrl::Unselect()
1568 {
1569     if (m_current)
1570     {
1571         m_current->SetHilight( FALSE );
1572         RefreshLine( m_current );
1573     }
1574 }
1575
1576 void wxGenericTreeCtrl::UnselectAllChildren(wxGenericTreeItem *item)
1577 {
1578     if (item->IsSelected())
1579     {
1580         item->SetHilight(FALSE);
1581         RefreshLine(item);
1582     }
1583
1584     if (item->HasChildren())
1585     {
1586         wxArrayGenericTreeItems& children = item->GetChildren();
1587         size_t count = children.Count();
1588         for ( size_t n = 0; n < count; ++n )
1589         {
1590             UnselectAllChildren(children[n]);
1591         }
1592     }
1593 }
1594
1595 void wxGenericTreeCtrl::UnselectAll()
1596 {
1597     wxTreeItemId rootItem = GetRootItem();
1598
1599     // the tree might not have the root item at all
1600     if ( rootItem )
1601     {
1602         UnselectAllChildren((wxGenericTreeItem*) rootItem.m_pItem);
1603     }
1604 }
1605
1606 // Recursive function !
1607 // To stop we must have crt_item<last_item
1608 // Algorithm :
1609 // Tag all next children, when no more children,
1610 // Move to parent (not to tag)
1611 // Keep going... if we found last_item, we stop.
1612 bool wxGenericTreeCtrl::TagNextChildren(wxGenericTreeItem *crt_item, wxGenericTreeItem *last_item, bool select)
1613 {
1614     wxGenericTreeItem *parent = crt_item->GetParent();
1615
1616     if (parent == NULL) // This is root item
1617         return TagAllChildrenUntilLast(crt_item, last_item, select);
1618
1619     wxArrayGenericTreeItems& children = parent->GetChildren();
1620     int index = children.Index(crt_item);
1621     wxASSERT( index != wxNOT_FOUND ); // I'm not a child of my parent?
1622
1623     size_t count = children.Count();
1624     for (size_t n=(size_t)(index+1); n<count; ++n)
1625     {
1626         if (TagAllChildrenUntilLast(children[n], last_item, select)) return TRUE;
1627     }
1628
1629     return TagNextChildren(parent, last_item, select);
1630 }
1631
1632 bool wxGenericTreeCtrl::TagAllChildrenUntilLast(wxGenericTreeItem *crt_item, wxGenericTreeItem *last_item, bool select)
1633 {
1634     crt_item->SetHilight(select);
1635     RefreshLine(crt_item);
1636
1637     if (crt_item==last_item)
1638         return TRUE;
1639
1640     if (crt_item->HasChildren())
1641     {
1642         wxArrayGenericTreeItems& children = crt_item->GetChildren();
1643         size_t count = children.Count();
1644         for ( size_t n = 0; n < count; ++n )
1645         {
1646             if (TagAllChildrenUntilLast(children[n], last_item, select))
1647                 return TRUE;
1648         }
1649     }
1650
1651   return FALSE;
1652 }
1653
1654 void wxGenericTreeCtrl::SelectItemRange(wxGenericTreeItem *item1, wxGenericTreeItem *item2)
1655 {
1656     // item2 is not necessary after item1
1657     wxGenericTreeItem *first=NULL, *last=NULL;
1658
1659     // choice first' and 'last' between item1 and item2
1660     if (item1->GetY()<item2->GetY())
1661     {
1662         first=item1;
1663         last=item2;
1664     }
1665     else
1666     {
1667         first=item2;
1668         last=item1;
1669     }
1670
1671     bool select = m_current->IsSelected();
1672
1673     if ( TagAllChildrenUntilLast(first,last,select) )
1674         return;
1675
1676     TagNextChildren(first,last,select);
1677 }
1678
1679 void wxGenericTreeCtrl::SelectItem(const wxTreeItemId& itemId,
1680                                    bool unselect_others,
1681                                    bool extended_select)
1682 {
1683     wxCHECK_RET( itemId.IsOk(), wxT("invalid tree item") );
1684
1685     bool is_single=!(GetWindowStyleFlag() & wxTR_MULTIPLE);
1686     wxGenericTreeItem *item = (wxGenericTreeItem*) itemId.m_pItem;
1687
1688     //wxCHECK_RET( ( (!unselect_others) && is_single),
1689     //           wxT("this is a single selection tree") );
1690
1691     // to keep going anyhow !!!
1692     if (is_single)
1693     {
1694         if (item->IsSelected())
1695             return; // nothing to do
1696         unselect_others = TRUE;
1697         extended_select = FALSE;
1698     }
1699     else if ( unselect_others && item->IsSelected() )
1700     {
1701         // selection change if there is more than one item currently selected
1702         wxArrayTreeItemIds selected_items;
1703         if ( GetSelections(selected_items) == 1 )
1704             return;
1705     }
1706
1707     wxTreeEvent event( wxEVT_COMMAND_TREE_SEL_CHANGING, GetId() );
1708     event.m_item = (long) item;
1709     event.m_itemOld = (long) m_current;
1710     event.SetEventObject( this );
1711     // TODO : Here we don't send any selection mode yet !
1712
1713     if ( GetEventHandler()->ProcessEvent( event ) && !event.IsAllowed() )
1714         return;
1715
1716     wxTreeItemId parent = GetParent( itemId );
1717     while (parent.IsOk())
1718     {
1719         if (!IsExpanded(parent))
1720             Expand( parent );
1721
1722         parent = GetParent( parent );
1723     }
1724
1725     EnsureVisible( itemId );
1726
1727     // ctrl press
1728     if (unselect_others)
1729     {
1730         if (is_single) Unselect(); // to speed up thing
1731         else UnselectAll();
1732     }
1733
1734     // shift press
1735     if (extended_select)
1736     {
1737         if ( !m_current )
1738         {
1739             m_current = m_key_current = (wxGenericTreeItem*) GetRootItem().m_pItem;
1740         }
1741
1742         // don't change the mark (m_current)
1743         SelectItemRange(m_current, item);
1744     }
1745     else
1746     {
1747         bool select=TRUE; // the default
1748
1749         // Check if we need to toggle hilight (ctrl mode)
1750         if (!unselect_others)
1751             select=!item->IsSelected();
1752
1753         m_current = m_key_current = item;
1754         m_current->SetHilight(select);
1755         RefreshLine( m_current );
1756     }
1757
1758     event.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED);
1759     GetEventHandler()->ProcessEvent( event );
1760 }
1761
1762 void wxGenericTreeCtrl::FillArray(wxGenericTreeItem *item,
1763                                   wxArrayTreeItemIds &array) const
1764 {
1765     if ( item->IsSelected() )
1766         array.Add(wxTreeItemId(item));
1767
1768     if ( item->HasChildren() )
1769     {
1770         wxArrayGenericTreeItems& children = item->GetChildren();
1771         size_t count = children.GetCount();
1772         for ( size_t n = 0; n < count; ++n )
1773             FillArray(children[n], array);
1774     }
1775 }
1776
1777 size_t wxGenericTreeCtrl::GetSelections(wxArrayTreeItemIds &array) const
1778 {
1779     array.Empty();
1780     wxTreeItemId idRoot = GetRootItem();
1781     if ( idRoot.IsOk() )
1782     {
1783         FillArray((wxGenericTreeItem*) idRoot.m_pItem, array);
1784     }
1785     //else: the tree is empty, so no selections
1786
1787     return array.Count();
1788 }
1789
1790 void wxGenericTreeCtrl::EnsureVisible(const wxTreeItemId& item)
1791 {
1792     if (!item.IsOk()) return;
1793
1794     wxGenericTreeItem *gitem = (wxGenericTreeItem*) item.m_pItem;
1795
1796     // first expand all parent branches
1797     wxGenericTreeItem *parent = gitem->GetParent();
1798
1799     if ( HasFlag(wxTR_HIDE_ROOT) )
1800     {
1801         while ( parent != m_anchor )
1802         {
1803             Expand(parent);
1804             parent = parent->GetParent();
1805         }
1806     }
1807     else
1808     {
1809         while ( parent )
1810         {
1811             Expand(parent);
1812             parent = parent->GetParent();
1813         }
1814     }
1815
1816     //if (parent) CalculatePositions();
1817
1818     ScrollTo(item);
1819 }
1820
1821 void wxGenericTreeCtrl::ScrollTo(const wxTreeItemId &item)
1822 {
1823     if (!item.IsOk()) return;
1824
1825     // We have to call this here because the label in
1826     // question might just have been added and no screen
1827     // update taken place.
1828     if (m_dirty) wxYieldIfNeeded();
1829
1830     wxGenericTreeItem *gitem = (wxGenericTreeItem*) item.m_pItem;
1831
1832     // now scroll to the item
1833     int item_y = gitem->GetY();
1834
1835     int start_x = 0;
1836     int start_y = 0;
1837     GetViewStart( &start_x, &start_y );
1838     start_y *= PIXELS_PER_UNIT;
1839
1840     int client_h = 0;
1841     int client_w = 0;
1842     GetClientSize( &client_w, &client_h );
1843
1844     if (item_y < start_y+3)
1845     {
1846         // going down
1847         int x = 0;
1848         int y = 0;
1849         m_anchor->GetSize( x, y, this );
1850         y += PIXELS_PER_UNIT+2; // one more scrollbar unit + 2 pixels
1851         x += PIXELS_PER_UNIT+2; // one more scrollbar unit + 2 pixels
1852         int x_pos = GetScrollPos( wxHORIZONTAL );
1853         // Item should appear at top
1854         SetScrollbars( PIXELS_PER_UNIT, PIXELS_PER_UNIT, x/PIXELS_PER_UNIT, y/PIXELS_PER_UNIT, x_pos, item_y/PIXELS_PER_UNIT );
1855     }
1856     else if (item_y+GetLineHeight(gitem) > start_y+client_h)
1857     {
1858         // going up
1859         int x = 0;
1860         int y = 0;
1861         m_anchor->GetSize( x, y, this );
1862         y += PIXELS_PER_UNIT+2; // one more scrollbar unit + 2 pixels
1863         x += PIXELS_PER_UNIT+2; // one more scrollbar unit + 2 pixels
1864         item_y += PIXELS_PER_UNIT+2;
1865         int x_pos = GetScrollPos( wxHORIZONTAL );
1866         // Item should appear at bottom
1867         SetScrollbars( PIXELS_PER_UNIT, PIXELS_PER_UNIT, x/PIXELS_PER_UNIT, y/PIXELS_PER_UNIT, x_pos, (item_y+GetLineHeight(gitem)-client_h)/PIXELS_PER_UNIT );
1868     }
1869 }
1870
1871 // FIXME: tree sorting functions are not reentrant and not MT-safe!
1872 static wxGenericTreeCtrl *s_treeBeingSorted = NULL;
1873
1874 static int LINKAGEMODE tree_ctrl_compare_func(wxGenericTreeItem **item1,
1875                                   wxGenericTreeItem **item2)
1876 {
1877     wxCHECK_MSG( s_treeBeingSorted, 0, wxT("bug in wxGenericTreeCtrl::SortChildren()") );
1878
1879     return s_treeBeingSorted->OnCompareItems(*item1, *item2);
1880 }
1881
1882 int wxGenericTreeCtrl::OnCompareItems(const wxTreeItemId& item1,
1883                                const wxTreeItemId& item2)
1884 {
1885     return wxStrcmp(GetItemText(item1), GetItemText(item2));
1886 }
1887
1888 void wxGenericTreeCtrl::SortChildren(const wxTreeItemId& itemId)
1889 {
1890     wxCHECK_RET( itemId.IsOk(), wxT("invalid tree item") );
1891
1892     wxGenericTreeItem *item = (wxGenericTreeItem*) itemId.m_pItem;
1893
1894     wxCHECK_RET( !s_treeBeingSorted,
1895                  wxT("wxGenericTreeCtrl::SortChildren is not reentrant") );
1896
1897     wxArrayGenericTreeItems& children = item->GetChildren();
1898     if ( children.Count() > 1 )
1899     {
1900         m_dirty = TRUE;
1901
1902         s_treeBeingSorted = this;
1903         children.Sort(tree_ctrl_compare_func);
1904         s_treeBeingSorted = NULL;
1905     }
1906     //else: don't make the tree dirty as nothing changed
1907 }
1908
1909 wxImageList *wxGenericTreeCtrl::GetImageList() const
1910 {
1911     return m_imageListNormal;
1912 }
1913
1914 wxImageList *wxGenericTreeCtrl::GetButtonsImageList() const
1915 {
1916     return m_imageListButtons;
1917 }
1918
1919 wxImageList *wxGenericTreeCtrl::GetStateImageList() const
1920 {
1921     return m_imageListState;
1922 }
1923
1924 void wxGenericTreeCtrl::CalculateLineHeight()
1925 {
1926     wxClientDC dc(this);
1927     m_lineHeight = (int)(dc.GetCharHeight() + 4);
1928
1929     if ( m_imageListNormal )
1930     {
1931         // Calculate a m_lineHeight value from the normal Image sizes.
1932         // May be toggle off. Then wxGenericTreeCtrl will spread when
1933         // necessary (which might look ugly).
1934         int n = m_imageListNormal->GetImageCount();
1935         for (int i = 0; i < n ; i++)
1936         {
1937             int width = 0, height = 0;
1938             m_imageListNormal->GetSize(i, width, height);
1939             if (height > m_lineHeight) m_lineHeight = height;
1940         }
1941     }
1942
1943     if (m_imageListButtons)
1944     {
1945         // Calculate a m_lineHeight value from the Button image sizes.
1946         // May be toggle off. Then wxGenericTreeCtrl will spread when
1947         // necessary (which might look ugly).
1948         int n = m_imageListButtons->GetImageCount();
1949         for (int i = 0; i < n ; i++)
1950         {
1951             int width = 0, height = 0;
1952             m_imageListButtons->GetSize(i, width, height);
1953             if (height > m_lineHeight) m_lineHeight = height;
1954         }
1955     }
1956
1957     if (m_lineHeight < 30)
1958         m_lineHeight += 2;                 // at least 2 pixels
1959     else
1960         m_lineHeight += m_lineHeight/10;   // otherwise 10% extra spacing
1961 }
1962
1963 void wxGenericTreeCtrl::SetImageList(wxImageList *imageList)
1964 {
1965     if (m_ownsImageListNormal) delete m_imageListNormal;
1966     m_imageListNormal = imageList;
1967     m_ownsImageListNormal = FALSE;
1968     m_dirty = TRUE;
1969     // Don't do any drawing if we're setting the list to NULL,
1970     // since we may be in the process of deleting the tree control.
1971     if (imageList)
1972         CalculateLineHeight();
1973 }
1974
1975 void wxGenericTreeCtrl::SetStateImageList(wxImageList *imageList)
1976 {
1977     if (m_ownsImageListState) delete m_imageListState;
1978     m_imageListState = imageList;
1979     m_ownsImageListState = FALSE;
1980 }
1981
1982 void wxGenericTreeCtrl::SetButtonsImageList(wxImageList *imageList)
1983 {
1984     if (m_ownsImageListButtons) delete m_imageListButtons;
1985     m_imageListButtons = imageList;
1986     m_ownsImageListButtons = FALSE;
1987     m_dirty = TRUE;
1988     CalculateLineHeight();
1989 }
1990
1991 void wxGenericTreeCtrl::AssignImageList(wxImageList *imageList)
1992 {
1993     SetImageList(imageList);
1994     m_ownsImageListNormal = TRUE;
1995 }
1996
1997 void wxGenericTreeCtrl::AssignStateImageList(wxImageList *imageList)
1998 {
1999     SetStateImageList(imageList);
2000     m_ownsImageListState = TRUE;
2001 }
2002
2003 void wxGenericTreeCtrl::AssignButtonsImageList(wxImageList *imageList)
2004 {
2005     SetButtonsImageList(imageList);
2006     m_ownsImageListButtons = TRUE;
2007 }
2008
2009 // -----------------------------------------------------------------------------
2010 // helpers
2011 // -----------------------------------------------------------------------------
2012
2013 void wxGenericTreeCtrl::AdjustMyScrollbars()
2014 {
2015     if (m_anchor)
2016     {
2017         int x = 0, y = 0;
2018         m_anchor->GetSize( x, y, this );
2019         y += PIXELS_PER_UNIT+2; // one more scrollbar unit + 2 pixels
2020         x += PIXELS_PER_UNIT+2; // one more scrollbar unit + 2 pixels
2021         int x_pos = GetScrollPos( wxHORIZONTAL );
2022         int y_pos = GetScrollPos( wxVERTICAL );
2023         SetScrollbars( PIXELS_PER_UNIT, PIXELS_PER_UNIT, x/PIXELS_PER_UNIT, y/PIXELS_PER_UNIT, x_pos, y_pos );
2024     }
2025     else
2026     {
2027         SetScrollbars( 0, 0, 0, 0 );
2028     }
2029 }
2030
2031 int wxGenericTreeCtrl::GetLineHeight(wxGenericTreeItem *item) const
2032 {
2033     if (GetWindowStyleFlag() & wxTR_HAS_VARIABLE_ROW_HEIGHT)
2034         return item->GetHeight();
2035     else
2036         return m_lineHeight;
2037 }
2038
2039 void wxGenericTreeCtrl::PaintItem(wxGenericTreeItem *item, wxDC& dc)
2040 {
2041     // TODO implement "state" icon on items
2042
2043     wxTreeItemAttr *attr = item->GetAttributes();
2044     if ( attr && attr->HasFont() )
2045         dc.SetFont(attr->GetFont());
2046     else if (item->IsBold())
2047         dc.SetFont(m_boldFont);
2048
2049     long text_w = 0, text_h = 0;
2050     dc.GetTextExtent( item->GetText(), &text_w, &text_h );
2051
2052     int image_h = 0, image_w = 0;
2053     int image = item->GetCurrentImage();
2054     if ( image != NO_IMAGE )
2055     {
2056         if ( m_imageListNormal )
2057         {
2058             m_imageListNormal->GetSize( image, image_w, image_h );
2059             image_w += 4;
2060         }
2061         else
2062         {
2063             image = NO_IMAGE;
2064         }
2065     }
2066
2067     int total_h = GetLineHeight(item);
2068
2069     if ( item->IsSelected() )
2070     {
2071         dc.SetBrush(*(m_hasFocus ? m_hilightBrush : m_hilightUnfocusedBrush));
2072     }
2073     else
2074     {
2075         wxColour colBg;
2076         if ( attr && attr->HasBackgroundColour() )
2077             colBg = attr->GetBackgroundColour();
2078         else
2079             colBg = m_backgroundColour;
2080         dc.SetBrush(wxBrush(colBg, wxSOLID));
2081     }
2082
2083     int offset = HasFlag(wxTR_ROW_LINES) ? 1 : 0;
2084
2085     if ( HasFlag(wxTR_FULL_ROW_HIGHLIGHT) )
2086     {
2087         int x, y, w, h;
2088
2089         DoGetPosition(&x, &y);
2090         DoGetSize(&w, &h);
2091         dc.DrawRectangle(x, item->GetY()+offset, w, total_h-offset);
2092     }
2093     else
2094     {
2095         if ( item->IsSelected() && image != NO_IMAGE )
2096         {
2097             // If it's selected, and there's an image, then we should
2098             // take care to leave the area under the image painted in the
2099             // background colour.
2100             dc.DrawRectangle( item->GetX() + image_w - 2, item->GetY()+offset,
2101                               item->GetWidth() - image_w + 2, total_h-offset );
2102         }
2103         else
2104         {
2105             dc.DrawRectangle( item->GetX()-2, item->GetY()+offset,
2106                               item->GetWidth()+2, total_h-offset );
2107         }
2108     }
2109
2110     if ( image != NO_IMAGE )
2111     {
2112         dc.SetClippingRegion( item->GetX(), item->GetY(), image_w-2, total_h );
2113         m_imageListNormal->Draw( image, dc,
2114                                  item->GetX(),
2115                                  item->GetY() +((total_h > image_h)?((total_h-image_h)/2):0),
2116                                  wxIMAGELIST_DRAW_TRANSPARENT );
2117         dc.DestroyClippingRegion();
2118     }
2119
2120     dc.SetBackgroundMode(wxTRANSPARENT);
2121     int extraH = (total_h > text_h) ? (total_h - text_h)/2 : 0;
2122     dc.DrawText( item->GetText(),
2123                  (wxCoord)(image_w + item->GetX()),
2124                  (wxCoord)(item->GetY() + extraH));
2125
2126     // restore normal font
2127     dc.SetFont( m_normalFont );
2128 }
2129
2130 // Now y stands for the top of the item, whereas it used to stand for middle !
2131 void wxGenericTreeCtrl::PaintLevel( wxGenericTreeItem *item, wxDC &dc, int level, int &y )
2132 {
2133     int x = level*m_indent;
2134     if (!HasFlag(wxTR_HIDE_ROOT))
2135     {
2136         x += m_indent;
2137     }
2138     else if (level == 0)
2139     {
2140         // always expand hidden root
2141         int origY = y;
2142         wxArrayGenericTreeItems& children = item->GetChildren();
2143         int count = children.Count();
2144         if (count > 0)
2145         {
2146             int n = 0, oldY;
2147             do {
2148                 oldY = y;
2149                 PaintLevel(children[n], dc, 1, y);
2150             } while (++n < count);
2151
2152             if (!HasFlag(wxTR_NO_LINES) && HasFlag(wxTR_LINES_AT_ROOT) && count > 0)
2153             {
2154                 // draw line down to last child
2155                 origY += GetLineHeight(children[0])>>1;
2156                 oldY += GetLineHeight(children[n-1])>>1;
2157                 dc.DrawLine(3, origY, 3, oldY);
2158             }
2159         }
2160         return;
2161     }
2162
2163     item->SetX(x+m_spacing);
2164     item->SetY(y);
2165
2166     int h = GetLineHeight(item);
2167     int y_top = y;
2168     int y_mid = y_top + (h>>1);
2169     y += h;
2170
2171     int exposed_x = dc.LogicalToDeviceX(0);
2172     int exposed_y = dc.LogicalToDeviceY(y_top);
2173
2174     if (IsExposed(exposed_x, exposed_y, 10000, h))  // 10000 = very much
2175     {
2176         wxPen *pen =
2177 #ifndef __WXMAC__
2178             // don't draw rect outline if we already have the
2179             // background color under Mac
2180             (item->IsSelected() && m_hasFocus) ? wxBLACK_PEN :
2181 #endif // !__WXMAC__
2182             wxTRANSPARENT_PEN;
2183
2184         wxColour colText;
2185         if ( item->IsSelected() )
2186         {
2187             colText = wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHTTEXT);
2188         }
2189         else
2190         {
2191             wxTreeItemAttr *attr = item->GetAttributes();
2192             if (attr && attr->HasTextColour())
2193                 colText = attr->GetTextColour();
2194             else
2195                 colText = GetForegroundColour();
2196         }
2197
2198         // prepare to draw
2199         dc.SetTextForeground(colText);
2200         dc.SetPen(*pen);
2201
2202         // draw
2203         PaintItem(item, dc);
2204
2205         if (HasFlag(wxTR_ROW_LINES))
2206         {
2207             // if the background colour is white, choose a
2208             // contrasting color for the lines
2209             dc.SetPen(*((GetBackgroundColour() == *wxWHITE)
2210                          ? wxMEDIUM_GREY_PEN : wxWHITE_PEN));
2211             dc.DrawLine(0, y_top, 10000, y_top);
2212             dc.DrawLine(0, y, 10000, y);
2213         }
2214
2215         // restore DC objects
2216         dc.SetBrush(*wxWHITE_BRUSH);
2217         dc.SetPen(m_dottedPen);
2218         dc.SetTextForeground(*wxBLACK);
2219
2220         if (item->HasPlus() && HasButtons())  // should the item show a button?
2221         {
2222             if (!HasFlag(wxTR_NO_LINES))
2223             {
2224                 if (x > (signed)m_indent)
2225                     dc.DrawLine(x - m_indent, y_mid, x - 5, y_mid);
2226                 else if (HasFlag(wxTR_LINES_AT_ROOT))
2227                     dc.DrawLine(3, y_mid, x - 5, y_mid);
2228                 dc.DrawLine(x + 5, y_mid, x + m_spacing, y_mid);
2229             }
2230
2231             if (m_imageListButtons != NULL)
2232             {
2233                 // draw the image button here
2234                 int image_h = 0, image_w = 0, image = wxTreeItemIcon_Normal;
2235                 if (item->IsExpanded()) image = wxTreeItemIcon_Expanded;
2236                 if (item->IsSelected())
2237                     image += wxTreeItemIcon_Selected - wxTreeItemIcon_Normal;
2238                 m_imageListButtons->GetSize(image, image_w, image_h);
2239                 int xx = x - (image_w>>1);
2240                 int yy = y_mid - (image_h>>1);
2241                 dc.SetClippingRegion(xx, yy, image_w, image_h);
2242                 m_imageListButtons->Draw(image, dc, xx, yy,
2243                                          wxIMAGELIST_DRAW_TRANSPARENT);
2244                 dc.DestroyClippingRegion();
2245             }
2246             else if (HasFlag(wxTR_TWIST_BUTTONS))
2247             {
2248                 // draw the twisty button here
2249
2250                 if (HasFlag(wxTR_AQUA_BUTTONS))
2251                 {
2252                     if (item->IsExpanded())
2253                         dc.DrawBitmap( *m_arrowDown, x-5, y_mid-6, TRUE );
2254                     else
2255                         dc.DrawBitmap( *m_arrowRight, x-5, y_mid-6, TRUE );
2256                 }
2257                 else
2258                 {
2259                     dc.SetBrush(*m_hilightBrush);
2260                     dc.SetPen(*wxBLACK_PEN);
2261                     wxPoint button[3];
2262
2263                     if (item->IsExpanded())
2264                     {
2265                         button[0].x = x-5;
2266                         button[0].y = y_mid-2;
2267                         button[1].x = x+5;
2268                         button[1].y = y_mid-2;
2269                         button[2].x = x;
2270                         button[2].y = y_mid+3;
2271                     }
2272                     else
2273                     {
2274                         button[0].y = y_mid-5;
2275                         button[0].x = x-2;
2276                         button[1].y = y_mid+5;
2277                         button[1].x = x-2;
2278                         button[2].y = y_mid;
2279                         button[2].x = x+3;
2280                     }
2281                     dc.DrawPolygon(3, button);
2282                     dc.SetPen(m_dottedPen);
2283                 }
2284             }
2285             else // if (HasFlag(wxTR_HAS_BUTTONS))
2286             {
2287                 // draw the plus sign here
2288                 dc.SetPen(*wxGREY_PEN);
2289                 dc.SetBrush(*wxWHITE_BRUSH);
2290                 dc.DrawRectangle(x-5, y_mid-4, 11, 9);
2291                 dc.SetPen(*wxBLACK_PEN);
2292                 dc.DrawLine(x-2, y_mid, x+3, y_mid);
2293                 if (!item->IsExpanded())
2294                     dc.DrawLine(x, y_mid-2, x, y_mid+3);
2295                 dc.SetPen(m_dottedPen);
2296             }
2297         }
2298         else if (!HasFlag(wxTR_NO_LINES))  // no button; maybe a line?
2299         {
2300             // draw the horizontal line here
2301             int x_start = x;
2302             if (x > (signed)m_indent)
2303                 x_start -= m_indent;
2304             else if (HasFlag(wxTR_LINES_AT_ROOT))
2305                 x_start = 3;
2306             dc.DrawLine(x_start, y_mid, x + m_spacing, y_mid);
2307         }
2308     }
2309
2310     if (item->IsExpanded())
2311     {
2312         wxArrayGenericTreeItems& children = item->GetChildren();
2313         int count = children.Count();
2314         if (count > 0)
2315         {
2316             int n = 0, oldY;
2317             ++level;
2318             do {
2319                 oldY = y;
2320                 PaintLevel(children[n], dc, level, y);
2321             } while (++n < count);
2322
2323             if (!HasFlag(wxTR_NO_LINES) && count > 0)
2324             {
2325                 // draw line down to last child
2326                 oldY += GetLineHeight(children[n-1])>>1;
2327                 if (HasButtons()) y_mid += 5;
2328                 dc.DrawLine(x, y_mid, x, oldY);
2329             }
2330         }
2331     }
2332 }
2333
2334 void wxGenericTreeCtrl::DrawDropEffect(wxGenericTreeItem *item)
2335 {
2336     if ( item )
2337     {
2338         if ( item->HasPlus() )
2339         {
2340             // it's a folder, indicate it by a border
2341             DrawBorder(item);
2342         }
2343         else
2344         {
2345             // draw a line under the drop target because the item will be
2346             // dropped there
2347             DrawLine(item, TRUE /* below */);
2348         }
2349
2350         SetCursor(wxCURSOR_BULLSEYE);
2351     }
2352     else
2353     {
2354         // can't drop here
2355         SetCursor(wxCURSOR_NO_ENTRY);
2356     }
2357 }
2358
2359 void wxGenericTreeCtrl::DrawBorder(const wxTreeItemId &item)
2360 {
2361     wxCHECK_RET( item.IsOk(), _T("invalid item in wxGenericTreeCtrl::DrawLine") );
2362
2363     wxGenericTreeItem *i = (wxGenericTreeItem*) item.m_pItem;
2364
2365     wxClientDC dc(this);
2366     PrepareDC( dc );
2367     dc.SetLogicalFunction(wxINVERT);
2368     dc.SetBrush(*wxTRANSPARENT_BRUSH);
2369
2370     int w = i->GetWidth() + 2;
2371     int h = GetLineHeight(i) + 2;
2372
2373     dc.DrawRectangle( i->GetX() - 1, i->GetY() - 1, w, h);
2374 }
2375
2376 void wxGenericTreeCtrl::DrawLine(const wxTreeItemId &item, bool below)
2377 {
2378     wxCHECK_RET( item.IsOk(), _T("invalid item in wxGenericTreeCtrl::DrawLine") );
2379
2380     wxGenericTreeItem *i = (wxGenericTreeItem*) item.m_pItem;
2381
2382     wxClientDC dc(this);
2383     PrepareDC( dc );
2384     dc.SetLogicalFunction(wxINVERT);
2385
2386     int x = i->GetX(),
2387         y = i->GetY();
2388     if ( below )
2389     {
2390         y += GetLineHeight(i) - 1;
2391     }
2392
2393     dc.DrawLine( x, y, x + i->GetWidth(), y);
2394 }
2395
2396 // -----------------------------------------------------------------------------
2397 // wxWindows callbacks
2398 // -----------------------------------------------------------------------------
2399
2400 void wxGenericTreeCtrl::OnPaint( wxPaintEvent &WXUNUSED(event) )
2401 {
2402     wxPaintDC dc(this);
2403     PrepareDC( dc );
2404
2405     if ( !m_anchor)
2406         return;
2407
2408     dc.SetFont( m_normalFont );
2409     dc.SetPen( m_dottedPen );
2410
2411     // this is now done dynamically
2412     //if(GetImageList() == NULL)
2413     // m_lineHeight = (int)(dc.GetCharHeight() + 4);
2414
2415     int y = 2;
2416     PaintLevel( m_anchor, dc, 0, y );
2417 }
2418
2419 void wxGenericTreeCtrl::OnSetFocus( wxFocusEvent &event )
2420 {
2421     m_hasFocus = TRUE;
2422
2423     RefreshSelected();
2424
2425     event.Skip();
2426 }
2427
2428 void wxGenericTreeCtrl::OnKillFocus( wxFocusEvent &event )
2429 {
2430     m_hasFocus = FALSE;
2431
2432     RefreshSelected();
2433
2434     event.Skip();
2435 }
2436
2437 void wxGenericTreeCtrl::OnChar( wxKeyEvent &event )
2438 {
2439     wxTreeEvent te( wxEVT_COMMAND_TREE_KEY_DOWN, GetId() );
2440     te.m_evtKey = event;
2441     te.SetEventObject( this );
2442     if ( GetEventHandler()->ProcessEvent( te ) )
2443     {
2444         // intercepted by the user code
2445         return;
2446     }
2447
2448     if ( (m_current == 0) || (m_key_current == 0) )
2449     {
2450         event.Skip();
2451         return;
2452     }
2453
2454     // how should the selection work for this event?
2455     bool is_multiple, extended_select, unselect_others;
2456     EventFlagsToSelType(GetWindowStyleFlag(),
2457                         event.ShiftDown(),
2458                         event.ControlDown(),
2459                         is_multiple, extended_select, unselect_others);
2460
2461     // + : Expand
2462     // - : Collaspe
2463     // * : Expand all/Collapse all
2464     // ' ' | return : activate
2465     // up    : go up (not last children!)
2466     // down  : go down
2467     // left  : go to parent
2468     // right : open if parent and go next
2469     // home  : go to root
2470     // end   : go to last item without opening parents
2471     // alnum : start or continue searching for the item with this prefix
2472     int keyCode = event.KeyCode();
2473     switch ( keyCode )
2474     {
2475         case '+':
2476         case WXK_ADD:
2477             if (m_current->HasPlus() && !IsExpanded(m_current))
2478             {
2479                 Expand(m_current);
2480             }
2481             break;
2482
2483         case '*':
2484         case WXK_MULTIPLY:
2485             if ( !IsExpanded(m_current) )
2486             {
2487                 // expand all
2488                 ExpandAll(m_current);
2489                 break;
2490             }
2491             //else: fall through to Collapse() it
2492
2493         case '-':
2494         case WXK_SUBTRACT:
2495             if (IsExpanded(m_current))
2496             {
2497                 Collapse(m_current);
2498             }
2499             break;
2500
2501         case ' ':
2502         case WXK_RETURN:
2503             {
2504                 wxTreeEvent event( wxEVT_COMMAND_TREE_ITEM_ACTIVATED, GetId() );
2505                 event.m_item = (long) m_current;
2506                 event.SetEventObject( this );
2507                 GetEventHandler()->ProcessEvent( event );
2508             }
2509             break;
2510
2511             // up goes to the previous sibling or to the last
2512             // of its children if it's expanded
2513         case WXK_UP:
2514             {
2515                 wxTreeItemId prev = GetPrevSibling( m_key_current );
2516                 if (!prev)
2517                 {
2518                     prev = GetParent( m_key_current );
2519                     if ((prev == GetRootItem()) && HasFlag(wxTR_HIDE_ROOT))
2520                     {
2521                         break;  // don't go to root if it is hidden
2522                     }
2523                     if (prev)
2524                     {
2525                         long cookie = 0;
2526                         wxTreeItemId current = m_key_current;
2527                         // TODO: Huh?  If we get here, we'd better be the first child of our parent.  How else could it be?
2528                         if (current == GetFirstChild( prev, cookie ))
2529                         {
2530                             // otherwise we return to where we came from
2531                             SelectItem( prev, unselect_others, extended_select );
2532                             m_key_current= (wxGenericTreeItem*) prev.m_pItem;
2533                             break;
2534                         }
2535                     }
2536                 }
2537                 if (prev)
2538                 {
2539                     while ( IsExpanded(prev) && HasChildren(prev) )
2540                     {
2541                         wxTreeItemId child = GetLastChild(prev);
2542                         if ( child )
2543                         {
2544                             prev = child;
2545                         }
2546                     }
2547
2548                     SelectItem( prev, unselect_others, extended_select );
2549                     m_key_current=(wxGenericTreeItem*) prev.m_pItem;
2550                 }
2551             }
2552             break;
2553
2554             // left arrow goes to the parent
2555         case WXK_LEFT:
2556             {
2557                 wxTreeItemId prev = GetParent( m_current );
2558                 if ((prev == GetRootItem()) && HasFlag(wxTR_HIDE_ROOT))
2559                 {
2560                     // don't go to root if it is hidden
2561                     prev = GetPrevSibling( m_current );
2562                 }
2563                 if (prev)
2564                 {
2565                     SelectItem( prev, unselect_others, extended_select );
2566                 }
2567             }
2568             break;
2569
2570         case WXK_RIGHT:
2571             // this works the same as the down arrow except that we
2572             // also expand the item if it wasn't expanded yet
2573             Expand(m_current);
2574             // fall through
2575
2576         case WXK_DOWN:
2577             {
2578                 if (IsExpanded(m_key_current) && HasChildren(m_key_current))
2579                 {
2580                     long cookie = 0;
2581                     wxTreeItemId child = GetFirstChild( m_key_current, cookie );
2582                     SelectItem( child, unselect_others, extended_select );
2583                     m_key_current=(wxGenericTreeItem*) child.m_pItem;
2584                 }
2585                 else
2586                 {
2587                     wxTreeItemId next = GetNextSibling( m_key_current );
2588                     if (!next)
2589                     {
2590                         wxTreeItemId current = m_key_current;
2591                         while (current && !next)
2592                         {
2593                             current = GetParent( current );
2594                             if (current) next = GetNextSibling( current );
2595                         }
2596                     }
2597                     if (next)
2598                     {
2599                         SelectItem( next, unselect_others, extended_select );
2600                         m_key_current=(wxGenericTreeItem*) next.m_pItem;
2601                     }
2602                 }
2603             }
2604             break;
2605
2606             // <End> selects the last visible tree item
2607         case WXK_END:
2608             {
2609                 wxTreeItemId last = GetRootItem();
2610
2611                 while ( last.IsOk() && IsExpanded(last) )
2612                 {
2613                     wxTreeItemId lastChild = GetLastChild(last);
2614
2615                     // it may happen if the item was expanded but then all of
2616                     // its children have been deleted - so IsExpanded() returned
2617                     // TRUE, but GetLastChild() returned invalid item
2618                     if ( !lastChild )
2619                         break;
2620
2621                     last = lastChild;
2622                 }
2623
2624                 if ( last.IsOk() )
2625                 {
2626                     SelectItem( last, unselect_others, extended_select );
2627                 }
2628             }
2629             break;
2630
2631             // <Home> selects the root item
2632         case WXK_HOME:
2633             {
2634                 wxTreeItemId prev = GetRootItem();
2635                 if (!prev)
2636                     break;
2637
2638                 if ( HasFlag(wxTR_HIDE_ROOT) )
2639                 {
2640                     long dummy;
2641                     prev = GetFirstChild(prev, dummy);
2642                     if (!prev)
2643                         break;
2644                 }
2645
2646                 SelectItem( prev, unselect_others, extended_select );
2647             }
2648             break;
2649
2650         default:
2651             // do not use wxIsalnum() here
2652             if ( !event.HasModifiers() &&
2653                  ((keyCode >= '0' && keyCode <= '9') ||
2654                   (keyCode >= 'a' && keyCode <= 'z') ||
2655                   (keyCode >= 'A' && keyCode <= 'Z' )))
2656             {
2657                 // find the next item starting with the given prefix
2658                 char ch = (char)keyCode;
2659
2660                 wxTreeItemId id = FindItem(m_current, m_findPrefix + (wxChar)ch);
2661                 if ( !id.IsOk() )
2662                 {
2663                     // no such item
2664                     break;
2665                 }
2666
2667                 SelectItem(id);
2668
2669                 m_findPrefix += ch;
2670
2671                 // also start the timer to reset the current prefix if the user
2672                 // doesn't press any more alnum keys soon -- we wouldn't want
2673                 // to use this prefix for a new item search
2674                 if ( !m_findTimer )
2675                 {
2676                     m_findTimer = new wxTreeFindTimer(this);
2677                 }
2678
2679                 m_findTimer->Start(wxTreeFindTimer::DELAY, wxTIMER_ONE_SHOT);
2680             }
2681             else
2682             {
2683                 event.Skip();
2684             }
2685     }
2686 }
2687
2688 wxTreeItemId wxGenericTreeCtrl::HitTest(const wxPoint& point, int& flags)
2689 {
2690     // JACS: removed wxYieldIfNeeded() because it can cause the window
2691     // to be deleted from under us if a close window event is pending
2692
2693     int w, h;
2694     GetSize(&w, &h);
2695     flags=0;
2696     if (point.x<0) flags |= wxTREE_HITTEST_TOLEFT;
2697     if (point.x>w) flags |= wxTREE_HITTEST_TORIGHT;
2698     if (point.y<0) flags |= wxTREE_HITTEST_ABOVE;
2699     if (point.y>h) flags |= wxTREE_HITTEST_BELOW;
2700     if (flags) return wxTreeItemId();
2701
2702     if (m_anchor == NULL)
2703     {
2704         flags = wxTREE_HITTEST_NOWHERE;
2705         return wxTreeItemId();
2706     }
2707
2708     wxGenericTreeItem *hit =  m_anchor->HitTest(CalcUnscrolledPosition(point),
2709                                                 this, flags, 0);
2710     if (hit == NULL)
2711     {
2712         flags = wxTREE_HITTEST_NOWHERE;
2713         return wxTreeItemId();
2714     }
2715     return hit;
2716 }
2717
2718 // get the bounding rectangle of the item (or of its label only)
2719 bool wxGenericTreeCtrl::GetBoundingRect(const wxTreeItemId& item,
2720                                         wxRect& rect,
2721                                         bool WXUNUSED(textOnly)) const
2722 {
2723     wxCHECK_MSG( item.IsOk(), FALSE, _T("invalid item in wxGenericTreeCtrl::GetBoundingRect") );
2724
2725     wxGenericTreeItem *i = (wxGenericTreeItem*) item.m_pItem;
2726
2727     int startX, startY;
2728     GetViewStart(& startX, & startY);
2729
2730     rect.x = i->GetX() - startX*PIXELS_PER_UNIT;
2731     rect.y = i->GetY() - startY*PIXELS_PER_UNIT;
2732     rect.width = i->GetWidth();
2733     //rect.height = i->GetHeight();
2734     rect.height = GetLineHeight(i);
2735
2736     return TRUE;
2737 }
2738
2739 void wxGenericTreeCtrl::Edit( const wxTreeItemId& item )
2740 {
2741     wxCHECK_RET( item.IsOk(), _T("can't edit an invalid item") );
2742
2743     wxGenericTreeItem *itemEdit = (wxGenericTreeItem *)item.m_pItem;
2744
2745     wxTreeEvent te( wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, GetId() );
2746     te.m_item = (long) itemEdit;
2747     te.SetEventObject( this );
2748     if ( GetEventHandler()->ProcessEvent( te ) && !te.IsAllowed() )
2749     {
2750         // vetoed by user
2751         return;
2752     }
2753
2754     // We have to call this here because the label in
2755     // question might just have been added and no screen
2756     // update taken place.
2757     if ( m_dirty )
2758         wxYieldIfNeeded();
2759
2760     wxTreeTextCtrl *text = new wxTreeTextCtrl(this, itemEdit);
2761
2762     text->SetFocus();
2763 }
2764
2765 bool wxGenericTreeCtrl::OnRenameAccept(wxGenericTreeItem *item,
2766                                        const wxString& value)
2767 {
2768     wxTreeEvent le( wxEVT_COMMAND_TREE_END_LABEL_EDIT, GetId() );
2769     le.m_item = (long) item;
2770     le.SetEventObject( this );
2771     le.m_label = value;
2772
2773     return !GetEventHandler()->ProcessEvent( le ) || le.IsAllowed();
2774 }
2775
2776 void wxGenericTreeCtrl::OnRenameTimer()
2777 {
2778     Edit( m_current );
2779 }
2780
2781 void wxGenericTreeCtrl::OnMouse( wxMouseEvent &event )
2782 {
2783     if ( !m_anchor ) return;
2784
2785     // we process left mouse up event (enables in-place edit), right down
2786     // (pass to the user code), left dbl click (activate item) and
2787     // dragging/moving events for items drag-and-drop
2788     if ( !(event.LeftDown() ||
2789            event.LeftUp() ||
2790            event.RightDown() ||
2791            event.LeftDClick() ||
2792            event.Dragging() ||
2793            ((event.Moving() || event.RightUp()) && m_isDragging)) )
2794     {
2795         event.Skip();
2796
2797         return;
2798     }
2799
2800     wxPoint pt = CalcUnscrolledPosition(event.GetPosition());
2801
2802     int flags = 0;
2803     wxGenericTreeItem *item = m_anchor->HitTest(pt, this, flags, 0);
2804
2805     if ( event.Dragging() && !m_isDragging )
2806     {
2807         if (m_dragCount == 0)
2808             m_dragStart = pt;
2809
2810         m_dragCount++;
2811
2812         if (m_dragCount != 3)
2813         {
2814             // wait until user drags a bit further...
2815             return;
2816         }
2817
2818         wxEventType command = event.RightIsDown()
2819                               ? wxEVT_COMMAND_TREE_BEGIN_RDRAG
2820                               : wxEVT_COMMAND_TREE_BEGIN_DRAG;
2821
2822         wxTreeEvent nevent( command, GetId() );
2823         nevent.m_item = (long) m_current;
2824         nevent.SetEventObject(this);
2825
2826         // by default the dragging is not supported, the user code must
2827         // explicitly allow the event for it to take place
2828         nevent.Veto();
2829
2830         if ( GetEventHandler()->ProcessEvent(nevent) && nevent.IsAllowed() )
2831         {
2832             // we're going to drag this item
2833             m_isDragging = TRUE;
2834
2835             // remember the old cursor because we will change it while
2836             // dragging
2837             m_oldCursor = m_cursor;
2838
2839             // in a single selection control, hide the selection temporarily
2840             if ( !(GetWindowStyleFlag() & wxTR_MULTIPLE) )
2841             {
2842                 m_oldSelection = (wxGenericTreeItem*) GetSelection().m_pItem;
2843
2844                 if ( m_oldSelection )
2845                 {
2846                     m_oldSelection->SetHilight(FALSE);
2847                     RefreshLine(m_oldSelection);
2848                 }
2849             }
2850
2851             CaptureMouse();
2852         }
2853     }
2854     else if ( event.Moving() )
2855     {
2856         if ( item != m_dropTarget )
2857         {
2858             // unhighlight the previous drop target
2859             DrawDropEffect(m_dropTarget);
2860
2861             m_dropTarget = item;
2862
2863             // highlight the current drop target if any
2864             DrawDropEffect(m_dropTarget);
2865
2866             wxYieldIfNeeded();
2867         }
2868     }
2869     else if ( (event.LeftUp() || event.RightUp()) && m_isDragging )
2870     {
2871         // erase the highlighting
2872         DrawDropEffect(m_dropTarget);
2873
2874         if ( m_oldSelection )
2875         {
2876             m_oldSelection->SetHilight(TRUE);
2877             RefreshLine(m_oldSelection);
2878             m_oldSelection = (wxGenericTreeItem *)NULL;
2879         }
2880
2881         // generate the drag end event
2882         wxTreeEvent event(wxEVT_COMMAND_TREE_END_DRAG, GetId());
2883
2884         event.m_item = (long) item;
2885         event.m_pointDrag = pt;
2886         event.SetEventObject(this);
2887
2888         (void)GetEventHandler()->ProcessEvent(event);
2889
2890         m_isDragging = FALSE;
2891         m_dropTarget = (wxGenericTreeItem *)NULL;
2892
2893         ReleaseMouse();
2894
2895         SetCursor(m_oldCursor);
2896
2897         wxYieldIfNeeded();
2898     }
2899     else
2900     {
2901         // here we process only the messages which happen on tree items
2902
2903         m_dragCount = 0;
2904
2905         if (item == NULL) return;  /* we hit the blank area */
2906
2907         if ( event.RightDown() )
2908         {
2909             wxTreeEvent nevent(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK, GetId());
2910             nevent.m_item = (long) item;
2911             nevent.m_pointDrag = CalcScrolledPosition(pt);
2912             nevent.SetEventObject(this);
2913             GetEventHandler()->ProcessEvent(nevent);
2914         }
2915         else if ( event.LeftUp() )
2916         {
2917             if ( m_lastOnSame )
2918             {
2919                 if ( (item == m_current) &&
2920                      (flags & wxTREE_HITTEST_ONITEMLABEL) &&
2921                      HasFlag(wxTR_EDIT_LABELS) )
2922                 {
2923                     if ( m_renameTimer )
2924                     {
2925                         if ( m_renameTimer->IsRunning() )
2926                             m_renameTimer->Stop();
2927                     }
2928                     else
2929                     {
2930                         m_renameTimer = new wxTreeRenameTimer( this );
2931                     }
2932
2933                     m_renameTimer->Start( wxTreeRenameTimer::DELAY, TRUE );
2934                 }
2935
2936                 m_lastOnSame = FALSE;
2937             }
2938         }
2939         else // !RightDown() && !LeftUp() ==> LeftDown() || LeftDClick()
2940         {
2941             if ( event.LeftDown() )
2942             {
2943                 m_lastOnSame = item == m_current;
2944             }
2945
2946             if ( flags & wxTREE_HITTEST_ONITEMBUTTON )
2947             {
2948                 // only toggle the item for a single click, double click on
2949                 // the button doesn't do anything (it toggles the item twice)
2950                 if ( event.LeftDown() )
2951                 {
2952                     Toggle( item );
2953                 }
2954
2955                 // don't select the item if the button was clicked
2956                 return;
2957             }
2958
2959             // how should the selection work for this event?
2960             bool is_multiple, extended_select, unselect_others;
2961             EventFlagsToSelType(GetWindowStyleFlag(),
2962                                 event.ShiftDown(),
2963                                 event.ControlDown(),
2964                                 is_multiple, extended_select, unselect_others);
2965
2966             SelectItem(item, unselect_others, extended_select);
2967
2968             // For some reason, Windows isn't recognizing a left double-click,
2969             // so we need to simulate it here.  Allow 200 milliseconds for now.
2970             if ( event.LeftDClick() )
2971             {
2972                 // double clicking should not start editing the item label
2973                 if ( m_renameTimer )
2974                     m_renameTimer->Stop();
2975
2976                 m_lastOnSame = FALSE;
2977
2978                 // send activate event first
2979                 wxTreeEvent nevent( wxEVT_COMMAND_TREE_ITEM_ACTIVATED, GetId() );
2980                 nevent.m_item = (long) item;
2981                 nevent.m_pointDrag = CalcScrolledPosition(pt);
2982                 nevent.SetEventObject( this );
2983                 if ( !GetEventHandler()->ProcessEvent( nevent ) )
2984                 {
2985                     // if the user code didn't process the activate event,
2986                     // handle it ourselves by toggling the item when it is
2987                     // double clicked
2988                     if ( item->HasPlus() )
2989                     {
2990                         Toggle(item);
2991                     }
2992                 }
2993             }
2994         }
2995     }
2996 }
2997
2998 void wxGenericTreeCtrl::OnIdle( wxIdleEvent &WXUNUSED(event) )
2999 {
3000     /* after all changes have been done to the tree control,
3001      * we actually redraw the tree when everything is over */
3002
3003     if (!m_dirty) return;
3004
3005     m_dirty = FALSE;
3006
3007     CalculatePositions();
3008     Refresh();
3009     AdjustMyScrollbars();
3010 }
3011
3012 void wxGenericTreeCtrl::CalculateSize( wxGenericTreeItem *item, wxDC &dc )
3013 {
3014     wxCoord text_w = 0;
3015     wxCoord text_h = 0;
3016
3017     wxTreeItemAttr *attr = item->GetAttributes();
3018     if ( attr && attr->HasFont() )
3019         dc.SetFont(attr->GetFont());
3020     else if ( item->IsBold() )
3021         dc.SetFont(m_boldFont);
3022
3023     dc.GetTextExtent( item->GetText(), &text_w, &text_h );
3024     text_h+=2;
3025
3026     // restore normal font
3027     dc.SetFont( m_normalFont );
3028
3029     int image_h = 0;
3030     int image_w = 0;
3031     int image = item->GetCurrentImage();
3032     if ( image != NO_IMAGE )
3033     {
3034         if ( m_imageListNormal )
3035         {
3036             m_imageListNormal->GetSize( image, image_w, image_h );
3037             image_w += 4;
3038         }
3039     }
3040
3041     int total_h = (image_h > text_h) ? image_h : text_h;
3042
3043     if (total_h < 30)
3044         total_h += 2;            // at least 2 pixels
3045     else
3046         total_h += total_h/10;   // otherwise 10% extra spacing
3047
3048     item->SetHeight(total_h);
3049     if (total_h>m_lineHeight)
3050         m_lineHeight=total_h;
3051
3052     item->SetWidth(image_w+text_w+2);
3053 }
3054
3055 // -----------------------------------------------------------------------------
3056 // for developper : y is now the top of the level
3057 // not the middle of it !
3058 void wxGenericTreeCtrl::CalculateLevel( wxGenericTreeItem *item, wxDC &dc, int level, int &y )
3059 {
3060     int x = level*m_indent;
3061     if (!HasFlag(wxTR_HIDE_ROOT))
3062     {
3063         x += m_indent;
3064     }
3065     else if (level == 0)
3066     {
3067         // a hidden root is not evaluated, but its
3068         // children are always calculated
3069         goto Recurse;
3070     }
3071
3072     CalculateSize( item, dc );
3073
3074     // set its position
3075     item->SetX( x+m_spacing );
3076     item->SetY( y );
3077     y += GetLineHeight(item);
3078
3079     if ( !item->IsExpanded() )
3080     {
3081         // we don't need to calculate collapsed branches
3082         return;
3083     }
3084
3085   Recurse:
3086     wxArrayGenericTreeItems& children = item->GetChildren();
3087     size_t n, count = children.Count();
3088     ++level;
3089     for (n = 0; n < count; ++n )
3090         CalculateLevel( children[n], dc, level, y );  // recurse
3091 }
3092
3093 void wxGenericTreeCtrl::CalculatePositions()
3094 {
3095     if ( !m_anchor ) return;
3096
3097     wxClientDC dc(this);
3098     PrepareDC( dc );
3099
3100     dc.SetFont( m_normalFont );
3101
3102     dc.SetPen( m_dottedPen );
3103     //if(GetImageList() == NULL)
3104     // m_lineHeight = (int)(dc.GetCharHeight() + 4);
3105
3106     int y = 2;
3107     CalculateLevel( m_anchor, dc, 0, y ); // start recursion
3108 }
3109
3110 void wxGenericTreeCtrl::RefreshSubtree(wxGenericTreeItem *item)
3111 {
3112     if (m_dirty) return;
3113
3114     wxSize client = GetClientSize();
3115
3116     wxRect rect;
3117     CalcScrolledPosition(0, item->GetY(), NULL, &rect.y);
3118     rect.width = client.x;
3119     rect.height = client.y;
3120
3121     Refresh(TRUE, &rect);
3122
3123     AdjustMyScrollbars();
3124 }
3125
3126 void wxGenericTreeCtrl::RefreshLine( wxGenericTreeItem *item )
3127 {
3128     if (m_dirty) return;
3129
3130     wxRect rect;
3131     CalcScrolledPosition(0, item->GetY(), NULL, &rect.y);
3132     rect.width = GetClientSize().x;
3133     rect.height = GetLineHeight(item); //dc.GetCharHeight() + 6;
3134
3135     Refresh(TRUE, &rect);
3136 }
3137
3138 void wxGenericTreeCtrl::RefreshSelected()
3139 {
3140     // TODO: this is awfully inefficient, we should keep the list of all
3141     //       selected items internally, should be much faster
3142     if ( m_anchor )
3143         RefreshSelectedUnder(m_anchor);
3144 }
3145
3146 void wxGenericTreeCtrl::RefreshSelectedUnder(wxGenericTreeItem *item)
3147 {
3148     if ( item->IsSelected() )
3149         RefreshLine(item);
3150
3151     const wxArrayGenericTreeItems& children = item->GetChildren();
3152     size_t count = children.GetCount();
3153     for ( size_t n = 0; n < count; n++ )
3154     {
3155         RefreshSelectedUnder(children[n]);
3156     }
3157 }
3158
3159 // ----------------------------------------------------------------------------
3160 // changing colours: we need to refresh the tree control
3161 // ----------------------------------------------------------------------------
3162
3163 bool wxGenericTreeCtrl::SetBackgroundColour(const wxColour& colour)
3164 {
3165     if ( !wxWindow::SetBackgroundColour(colour) )
3166         return FALSE;
3167
3168     Refresh();
3169
3170     return TRUE;
3171 }
3172
3173 bool wxGenericTreeCtrl::SetForegroundColour(const wxColour& colour)
3174 {
3175     if ( !wxWindow::SetForegroundColour(colour) )
3176         return FALSE;
3177
3178     Refresh();
3179
3180     return TRUE;
3181 }
3182
3183 #endif // wxUSE_TREECTRL