src/generic/treectlg.cpp

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