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.Count();
 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.Count();
 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.Count();
 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.Count();
 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_MOUSE_EVENTS   (wxGenericTreeCtrl::OnMouse)
 724     EVT_CHAR           (wxGenericTreeCtrl::OnChar)
 725     EVT_SET_FOCUS      (wxGenericTreeCtrl::OnSetFocus)
 726     EVT_KILL_FOCUS     (wxGenericTreeCtrl::OnKillFocus)
 727     EVT_TREE_ITEM_GETTOOLTIP(wxID_ANY, wxGenericTreeCtrl::OnGetToolTip)
 728 END_EVENT_TABLE()
 729
 730 #if !defined(__WXMSW__) || defined(__WXUNIVERSAL__)
 731 /*
 732  * wxTreeCtrl has to be a real class or we have problems with
 733  * the run-time information.
 734  */
 735
 736 IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl, wxGenericTreeCtrl)
 737 #endif
 738
 739 // -----------------------------------------------------------------------------
 740 // construction/destruction
 741 // -----------------------------------------------------------------------------
 742
 743 void wxGenericTreeCtrl::Init()
 744 {
 745     m_current =
 746     m_key_current =
 747     m_anchor =
 748     m_select_me = (wxGenericTreeItem *) NULL;
 749     m_hasFocus = false;
 750     m_dirty = false;
 751
 752     m_lineHeight = 10;
 753     m_indent = 15;
 754     m_spacing = 18;
 755
 756     m_hilightBrush = new wxBrush
 757                          (
 758                             wxSystemSettings::GetColour
 759                             (
 760                                 wxSYS_COLOUR_HIGHLIGHT
 761                             ),
 762                             wxSOLID
 763                          );
 764
 765     m_hilightUnfocusedBrush = new wxBrush
 766                               (
 767                                  wxSystemSettings::GetColour
 768                                  (
 769                                      wxSYS_COLOUR_BTNSHADOW
 770                                  ),
 771                                  wxSOLID
 772                               );
 773
 774     m_imageListButtons = NULL;
 775     m_ownsImageListButtons = false;
 776
 777     m_dragCount = 0;
 778     m_isDragging = false;
 779     m_dropTarget = m_oldSelection = NULL;
 780     m_underMouse = NULL;
 781     m_textCtrl = NULL;
 782
 783     m_renameTimer = NULL;
 784     m_freezeCount = 0;
 785
 786     m_findTimer = NULL;
 787
 788     m_dropEffectAboveItem = false;
 789
 790     m_lastOnSame = false;
 791
 792 #ifdef __WXMAC_CARBON__
 793     m_normalFont.MacCreateThemeFont( kThemeViewsFont ) ;
 794 #else
 795     m_normalFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
 796 #endif
 797     m_boldFont = wxFont(m_normalFont.GetPointSize(),
 798                         m_normalFont.GetFamily(),
 799                         m_normalFont.GetStyle(),
 800                         wxBOLD,
 801                         m_normalFont.GetUnderlined(),
 802                         m_normalFont.GetFaceName(),
 803                         m_normalFont.GetEncoding());
 804 }
 805
 806 bool wxGenericTreeCtrl::Create(wxWindow *parent,
 807                                wxWindowID id,
 808                                const wxPoint& pos,
 809                                const wxSize& size,
 810                                long style,
 811                                const wxValidator& validator,
 812                                const wxString& name )
 813 {
 814 #ifdef __WXMAC__
 815     int major,minor;
 816     wxGetOsVersion( &major, &minor );
 817
 818     style &= ~wxTR_LINES_AT_ROOT;
 819     style |= wxTR_NO_LINES;
 820     if (major < 10)
 821         style |= wxTR_ROW_LINES;
 822 #endif // __WXMAC__
 823
 824     if ( !wxControl::Create( parent, id, pos, size,
 825                              style|wxHSCROLL|wxVSCROLL,
 826                              validator,
 827                              name ) )
 828         return false;
 829
 830     // If the tree display has no buttons, but does have
 831     // connecting lines, we can use a narrower layout.
 832     // It may not be a good idea to force this...
 833     if (!HasButtons() && !HasFlag(wxTR_NO_LINES))
 834     {
 835         m_indent= 10;
 836         m_spacing = 10;
 837     }
 838
 839     wxVisualAttributes attr = GetDefaultAttributes();
 840     SetOwnForegroundColour( attr.colFg );
 841     SetOwnBackgroundColour( attr.colBg );
 842     if (!m_hasFont)
 843         SetOwnFont(attr.font);
 844
 845     m_dottedPen = wxPen( wxT("grey"), 0, 0 );
 846
 847     SetBestSize(size);
 848
 849     return true;
 850 }
 851
 852 wxGenericTreeCtrl::~wxGenericTreeCtrl()
 853 {
 854     delete m_hilightBrush;
 855     delete m_hilightUnfocusedBrush;
 856
 857     DeleteAllItems();
 858
 859     delete m_renameTimer;
 860     delete m_findTimer;
 861
 862     if (m_ownsImageListButtons)
 863         delete m_imageListButtons;
 864 }
 865
 866 // -----------------------------------------------------------------------------
 867 // accessors
 868 // -----------------------------------------------------------------------------
 869
 870 unsigned int wxGenericTreeCtrl::GetCount() const
 871 {
 872     if ( !m_anchor )
 873     {
 874         // the tree is empty
 875         return 0;
 876     }
 877
 878     unsigned int count = m_anchor->GetChildrenCount();
 879     if ( !HasFlag(wxTR_HIDE_ROOT) )
 880     {
 881         // take the root itself into account
 882         count++;
 883     }
 884
 885     return count;
 886 }
 887
 888 void wxGenericTreeCtrl::SetIndent(unsigned int indent)
 889 {
 890     m_indent = (unsigned short) indent;
 891     m_dirty = true;
 892 }
 893
 894 size_t
 895 wxGenericTreeCtrl::GetChildrenCount(const wxTreeItemId& item,
 896                                     bool recursively) const
 897 {
 898     wxCHECK_MSG( item.IsOk(), 0u, wxT("invalid tree item") );
 899
 900     return ((wxGenericTreeItem*) item.m_pItem)->GetChildrenCount(recursively);
 901 }
 902
 903 void wxGenericTreeCtrl::SetWindowStyle(const long styles)
 904 {
 905     // Do not try to expand the root node if it hasn't been created yet
 906     if (m_anchor && !HasFlag(wxTR_HIDE_ROOT) && (styles & wxTR_HIDE_ROOT))
 907     {
 908         // if we will hide the root, make sure children are visible
 909         m_anchor->SetHasPlus();
 910         m_anchor->Expand();
 911         CalculatePositions();
 912     }
 913
 914     // right now, just sets the styles.  Eventually, we may
 915     // want to update the inherited styles, but right now
 916     // none of the parents has updatable styles
 917     m_windowStyle = styles;
 918     m_dirty = true;
 919 }
 920
 921 // -----------------------------------------------------------------------------
 922 // functions to work with tree items
 923 // -----------------------------------------------------------------------------
 924
 925 wxString wxGenericTreeCtrl::GetItemText(const wxTreeItemId& item) const
 926 {
 927     wxCHECK_MSG( item.IsOk(), wxEmptyString, wxT("invalid tree item") );
 928
 929     return ((wxGenericTreeItem*) item.m_pItem)->GetText();
 930 }
 931
 932 int wxGenericTreeCtrl::GetItemImage(const wxTreeItemId& item,
 933                              wxTreeItemIcon which) const
 934 {
 935     wxCHECK_MSG( item.IsOk(), -1, wxT("invalid tree item") );
 936
 937     return ((wxGenericTreeItem*) item.m_pItem)->GetImage(which);
 938 }
 939
 940 wxTreeItemData *wxGenericTreeCtrl::GetItemData(const wxTreeItemId& item) const
 941 {
 942     wxCHECK_MSG( item.IsOk(), NULL, wxT("invalid tree item") );
 943
 944     return ((wxGenericTreeItem*) item.m_pItem)->GetData();
 945 }
 946
 947 wxColour wxGenericTreeCtrl::GetItemTextColour(const wxTreeItemId& item) const
 948 {
 949     wxCHECK_MSG( item.IsOk(), wxNullColour, wxT("invalid tree item") );
 950
 951     wxGenericTreeItem *pItem = (wxGenericTreeItem*) item.m_pItem;
 952     return pItem->Attr().GetTextColour();
 953 }
 954
 955 wxColour wxGenericTreeCtrl::GetItemBackgroundColour(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().GetBackgroundColour();
 961 }
 962
 963 wxFont wxGenericTreeCtrl::GetItemFont(const wxTreeItemId& item) const
 964 {
 965     wxCHECK_MSG( item.IsOk(), wxNullFont, wxT("invalid tree item") );
 966
 967     wxGenericTreeItem *pItem = (wxGenericTreeItem*) item.m_pItem;
 968     return pItem->Attr().GetFont();
 969 }
 970
 971 void wxGenericTreeCtrl::SetItemText(const wxTreeItemId& item, const wxString& text)
 972 {
 973     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
 974
 975     wxClientDC dc(this);
 976     wxGenericTreeItem *pItem = (wxGenericTreeItem*) item.m_pItem;
 977     pItem->SetText(text);
 978     CalculateSize(pItem, dc);
 979     RefreshLine(pItem);
 980 }
 981
 982 void wxGenericTreeCtrl::SetItemImage(const wxTreeItemId& item,
 983                               int image,
 984                               wxTreeItemIcon which)
 985 {
 986     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
 987
 988     wxGenericTreeItem *pItem = (wxGenericTreeItem*) item.m_pItem;
 989     pItem->SetImage(image, which);
 990
 991     wxClientDC dc(this);
 992     CalculateSize(pItem, dc);
 993     RefreshLine(pItem);
 994 }
 995
 996 void wxGenericTreeCtrl::SetItemData(const wxTreeItemId& item, wxTreeItemData *data)
 997 {
 998     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
 999
1000     if (data)
1001         data->SetId( item );
1002
1003     ((wxGenericTreeItem*) item.m_pItem)->SetData(data);
1004 }
1005
1006 void wxGenericTreeCtrl::SetItemHasChildren(const wxTreeItemId& item, bool has)
1007 {
1008     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
1009
1010     wxGenericTreeItem *pItem = (wxGenericTreeItem*) item.m_pItem;
1011     pItem->SetHasPlus(has);
1012     RefreshLine(pItem);
1013 }
1014
1015 void wxGenericTreeCtrl::SetItemBold(const wxTreeItemId& item, bool bold)
1016 {
1017     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
1018
1019     // avoid redrawing the tree if no real change
1020     wxGenericTreeItem *pItem = (wxGenericTreeItem*) item.m_pItem;
1021     if ( pItem->IsBold() != bold )
1022     {
1023         pItem->SetBold(bold);
1024         RefreshLine(pItem);
1025     }
1026 }
1027
1028 void wxGenericTreeCtrl::SetItemDropHighlight(const wxTreeItemId& item,
1029                                              bool highlight)
1030 {
1031     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
1032
1033     wxColour fg, bg;
1034
1035     if (highlight)
1036     {
1037         bg = wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHT);
1038         fg = wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHTTEXT);
1039     }
1040
1041     wxGenericTreeItem *pItem = (wxGenericTreeItem*) item.m_pItem;
1042     pItem->Attr().SetTextColour(fg);
1043     pItem->Attr().SetBackgroundColour(bg);
1044     RefreshLine(pItem);
1045 }
1046
1047 void wxGenericTreeCtrl::SetItemTextColour(const wxTreeItemId& item,
1048                                    const wxColour& col)
1049 {
1050     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
1051
1052     wxGenericTreeItem *pItem = (wxGenericTreeItem*) item.m_pItem;
1053     pItem->Attr().SetTextColour(col);
1054     RefreshLine(pItem);
1055 }
1056
1057 void wxGenericTreeCtrl::SetItemBackgroundColour(const wxTreeItemId& item,
1058                                          const wxColour& col)
1059 {
1060     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
1061
1062     wxGenericTreeItem *pItem = (wxGenericTreeItem*) item.m_pItem;
1063     pItem->Attr().SetBackgroundColour(col);
1064     RefreshLine(pItem);
1065 }
1066
1067 void wxGenericTreeCtrl::SetItemFont(const wxTreeItemId& item, const wxFont& font)
1068 {
1069     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
1070
1071     wxGenericTreeItem *pItem = (wxGenericTreeItem*) item.m_pItem;
1072     pItem->Attr().SetFont(font);
1073     RefreshLine(pItem);
1074 }
1075
1076 bool wxGenericTreeCtrl::SetFont( const wxFont &font )
1077 {
1078     wxTreeCtrlBase::SetFont(font);
1079
1080     m_normalFont = font ;
1081     m_boldFont = wxFont(m_normalFont.GetPointSize(),
1082                         m_normalFont.GetFamily(),
1083                         m_normalFont.GetStyle(),
1084                         wxBOLD,
1085                         m_normalFont.GetUnderlined(),
1086                         m_normalFont.GetFaceName(),
1087                         m_normalFont.GetEncoding());
1088
1089     return true;
1090 }
1091
1092
1093 // -----------------------------------------------------------------------------
1094 // item status inquiries
1095 // -----------------------------------------------------------------------------
1096
1097 bool wxGenericTreeCtrl::IsVisible(const wxTreeItemId& item) const
1098 {
1099     wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") );
1100
1101     // An item is only visible if it's not a descendant of a collapsed item
1102     wxGenericTreeItem *pItem = (wxGenericTreeItem*) item.m_pItem;
1103     wxGenericTreeItem* parent = pItem->GetParent();
1104     while (parent)
1105     {
1106         if (!parent->IsExpanded())
1107             return false;
1108         parent = parent->GetParent();
1109     }
1110
1111     int startX, startY;
1112     GetViewStart(& startX, & startY);
1113
1114     wxSize clientSize = GetClientSize();
1115
1116     wxRect rect;
1117     if (!GetBoundingRect(item, rect))
1118         return false;
1119     if (rect.GetWidth() == 0 || rect.GetHeight() == 0)
1120         return false;
1121     if (rect.GetBottom() < 0 || rect.GetTop() > clientSize.y)
1122         return false;
1123     if (rect.GetRight() < 0 || rect.GetLeft() > clientSize.x)
1124         return false;
1125
1126     return true;
1127 }
1128
1129 bool wxGenericTreeCtrl::ItemHasChildren(const wxTreeItemId& item) const
1130 {
1131     wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") );
1132
1133     // consider that the item does have children if it has the "+" button: it
1134     // might not have them (if it had never been expanded yet) but then it
1135     // could have them as well and it's better to err on this side rather than
1136     // disabling some operations which are restricted to the items with
1137     // children for an item which does have them
1138     return ((wxGenericTreeItem*) item.m_pItem)->HasPlus();
1139 }
1140
1141 bool wxGenericTreeCtrl::IsExpanded(const wxTreeItemId& item) const
1142 {
1143     wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") );
1144
1145     return ((wxGenericTreeItem*) item.m_pItem)->IsExpanded();
1146 }
1147
1148 bool wxGenericTreeCtrl::IsSelected(const wxTreeItemId& item) const
1149 {
1150     wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") );
1151
1152     return ((wxGenericTreeItem*) item.m_pItem)->IsSelected();
1153 }
1154
1155 bool wxGenericTreeCtrl::IsBold(const wxTreeItemId& item) const
1156 {
1157     wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") );
1158
1159     return ((wxGenericTreeItem*) item.m_pItem)->IsBold();
1160 }
1161
1162 // -----------------------------------------------------------------------------
1163 // navigation
1164 // -----------------------------------------------------------------------------
1165
1166 wxTreeItemId wxGenericTreeCtrl::GetItemParent(const wxTreeItemId& item) const
1167 {
1168     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1169
1170     return ((wxGenericTreeItem*) item.m_pItem)->GetParent();
1171 }
1172
1173 wxTreeItemId wxGenericTreeCtrl::GetFirstChild(const wxTreeItemId& item,
1174                                               wxTreeItemIdValue& cookie) const
1175 {
1176     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1177
1178     cookie = 0;
1179     return GetNextChild(item, cookie);
1180 }
1181
1182 wxTreeItemId wxGenericTreeCtrl::GetNextChild(const wxTreeItemId& item,
1183                                              wxTreeItemIdValue& cookie) const
1184 {
1185     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1186
1187     wxArrayGenericTreeItems& children = ((wxGenericTreeItem*) item.m_pItem)->GetChildren();
1188
1189     // it's ok to cast cookie to size_t, we never have indices big enough to
1190     // overflow "void *"
1191     size_t *pIndex = (size_t *)&cookie;
1192     if ( *pIndex < children.Count() )
1193     {
1194         return children.Item((*pIndex)++);
1195     }
1196     else
1197     {
1198         // there are no more of them
1199         return wxTreeItemId();
1200     }
1201 }
1202
1203 #if WXWIN_COMPATIBILITY_2_4
1204
1205 wxTreeItemId wxGenericTreeCtrl::GetFirstChild(const wxTreeItemId& item,
1206                                               long& cookie) const
1207 {
1208     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1209
1210     cookie = 0;
1211     return GetNextChild(item, cookie);
1212 }
1213
1214 wxTreeItemId wxGenericTreeCtrl::GetNextChild(const wxTreeItemId& item,
1215                                              long& cookie) const
1216 {
1217     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1218
1219     wxArrayGenericTreeItems& children = ((wxGenericTreeItem*) item.m_pItem)->GetChildren();
1220     if ( (size_t)cookie < children.Count() )
1221     {
1222         return children.Item((size_t)cookie++);
1223     }
1224     else
1225     {
1226         // there are no more of them
1227         return wxTreeItemId();
1228     }
1229 }
1230
1231 #endif // WXWIN_COMPATIBILITY_2_4
1232
1233 wxTreeItemId wxGenericTreeCtrl::GetLastChild(const wxTreeItemId& item) const
1234 {
1235     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1236
1237     wxArrayGenericTreeItems& children = ((wxGenericTreeItem*) item.m_pItem)->GetChildren();
1238     return (children.IsEmpty() ? wxTreeItemId() : wxTreeItemId(children.Last()));
1239 }
1240
1241 wxTreeItemId wxGenericTreeCtrl::GetNextSibling(const wxTreeItemId& item) const
1242 {
1243     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1244
1245     wxGenericTreeItem *i = (wxGenericTreeItem*) item.m_pItem;
1246     wxGenericTreeItem *parent = i->GetParent();
1247     if ( parent == NULL )
1248     {
1249         // root item doesn't have any siblings
1250         return wxTreeItemId();
1251     }
1252
1253     wxArrayGenericTreeItems& siblings = parent->GetChildren();
1254     int index = siblings.Index(i);
1255     wxASSERT( index != wxNOT_FOUND ); // I'm not a child of my parent?
1256
1257     size_t n = (size_t)(index + 1);
1258     return n == siblings.Count() ? wxTreeItemId() : wxTreeItemId(siblings[n]);
1259 }
1260
1261 wxTreeItemId wxGenericTreeCtrl::GetPrevSibling(const wxTreeItemId& item) const
1262 {
1263     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1264
1265     wxGenericTreeItem *i = (wxGenericTreeItem*) item.m_pItem;
1266     wxGenericTreeItem *parent = i->GetParent();
1267     if ( parent == NULL )
1268     {
1269         // root item doesn't have any siblings
1270         return wxTreeItemId();
1271     }
1272
1273     wxArrayGenericTreeItems& siblings = parent->GetChildren();
1274     int index = siblings.Index(i);
1275     wxASSERT( index != wxNOT_FOUND ); // I'm not a child of my parent?
1276
1277     return index == 0 ? wxTreeItemId()
1278                       : wxTreeItemId(siblings[(size_t)(index - 1)]);
1279 }
1280
1281 // Only for internal use right now, but should probably be public
1282 wxTreeItemId wxGenericTreeCtrl::GetNext(const wxTreeItemId& item) const
1283 {
1284     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1285
1286     wxGenericTreeItem *i = (wxGenericTreeItem*) item.m_pItem;
1287
1288     // First see if there are any children.
1289     wxArrayGenericTreeItems& children = i->GetChildren();
1290     if (children.GetCount() > 0)
1291     {
1292          return children.Item(0);
1293     }
1294     else
1295     {
1296          // Try a sibling of this or ancestor instead
1297          wxTreeItemId p = item;
1298          wxTreeItemId toFind;
1299          do
1300          {
1301               toFind = GetNextSibling(p);
1302               p = GetItemParent(p);
1303          } while (p.IsOk() && !toFind.IsOk());
1304          return toFind;
1305     }
1306 }
1307
1308 wxTreeItemId wxGenericTreeCtrl::GetFirstVisibleItem() const
1309 {
1310     wxTreeItemId id = GetRootItem();
1311     if (!id.IsOk())
1312         return id;
1313
1314     do
1315     {
1316         if (IsVisible(id))
1317               return id;
1318         id = GetNext(id);
1319     } while (id.IsOk());
1320
1321     return wxTreeItemId();
1322 }
1323
1324 wxTreeItemId wxGenericTreeCtrl::GetNextVisible(const wxTreeItemId& item) const
1325 {
1326     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1327
1328     wxTreeItemId id = item;
1329     if (id.IsOk())
1330     {
1331         while (id = GetNext(id), id.IsOk())
1332         {
1333             if (IsVisible(id))
1334                 return id;
1335         }
1336     }
1337     return wxTreeItemId();
1338 }
1339
1340 wxTreeItemId wxGenericTreeCtrl::GetPrevVisible(const wxTreeItemId& item) const
1341 {
1342     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1343
1344     wxFAIL_MSG(wxT("not implemented"));
1345
1346     return wxTreeItemId();
1347 }
1348
1349 // called by wxTextTreeCtrl when it marks itself for deletion
1350 void wxGenericTreeCtrl::ResetTextControl()
1351 {
1352     m_textCtrl = NULL;
1353 }
1354
1355 // find the first item starting with the given prefix after the given item
1356 wxTreeItemId wxGenericTreeCtrl::FindItem(const wxTreeItemId& idParent,
1357                                          const wxString& prefixOrig) const
1358 {
1359     // match is case insensitive as this is more convenient to the user: having
1360     // to press Shift-letter to go to the item starting with a capital letter
1361     // would be too bothersome
1362     wxString prefix = prefixOrig.Lower();
1363
1364     // determine the starting point: we shouldn't take the current item (this
1365     // allows to switch between two items starting with the same letter just by
1366     // pressing it) but we shouldn't jump to the next one if the user is
1367     // continuing to type as otherwise he might easily skip the item he wanted
1368     wxTreeItemId id = idParent;
1369     if ( prefix.length() == 1 )
1370     {
1371         id = GetNext(id);
1372     }
1373
1374     // look for the item starting with the given prefix after it
1375     while ( id.IsOk() && !GetItemText(id).Lower().StartsWith(prefix) )
1376     {
1377         id = GetNext(id);
1378     }
1379
1380     // if we haven't found anything...
1381     if ( !id.IsOk() )
1382     {
1383         // ... wrap to the beginning
1384         id = GetRootItem();
1385         if ( HasFlag(wxTR_HIDE_ROOT) )
1386         {
1387             // can't select virtual root
1388             id = GetNext(id);
1389         }
1390
1391         // and try all the items (stop when we get to the one we started from)
1392         while ( id != idParent && !GetItemText(id).Lower().StartsWith(prefix) )
1393         {
1394             id = GetNext(id);
1395         }
1396     }
1397
1398     return id;
1399 }
1400
1401 // -----------------------------------------------------------------------------
1402 // operations
1403 // -----------------------------------------------------------------------------
1404
1405 wxTreeItemId wxGenericTreeCtrl::DoInsertItem(const wxTreeItemId& parentId,
1406                                              size_t previous,
1407                                              const wxString& text,
1408                                              int image,
1409                                              int selImage,
1410                                              wxTreeItemData *data)
1411 {
1412     wxGenericTreeItem *parent = (wxGenericTreeItem*) parentId.m_pItem;
1413     if ( !parent )
1414     {
1415         // should we give a warning here?
1416         return AddRoot(text, image, selImage, data);
1417     }
1418
1419     m_dirty = true;     // do this first so stuff below doesn't cause flicker
1420
1421     wxGenericTreeItem *item =
1422         new wxGenericTreeItem( parent, text, image, selImage, data );
1423
1424     if ( data != NULL )
1425     {
1426         data->m_pItem = item;
1427     }
1428
1429     parent->Insert( item, previous == (size_t)-1 ? parent->GetChildren().size()
1430                                                  : previous );
1431
1432     return item;
1433 }
1434
1435 wxTreeItemId wxGenericTreeCtrl::AddRoot(const wxString& text,
1436                                         int image,
1437                                         int selImage,
1438                                         wxTreeItemData *data)
1439 {
1440     wxCHECK_MSG( !m_anchor, wxTreeItemId(), wxT("tree can have only one root") );
1441
1442     m_dirty = true;     // do this first so stuff below doesn't cause flicker
1443
1444     m_anchor = new wxGenericTreeItem((wxGenericTreeItem *)NULL, text,
1445                                    image, selImage, data);
1446     if ( data != NULL )
1447     {
1448         data->m_pItem = m_anchor;
1449     }
1450
1451     if (HasFlag(wxTR_HIDE_ROOT))
1452     {
1453         // if root is hidden, make sure we can navigate
1454         // into children
1455         m_anchor->SetHasPlus();
1456         m_anchor->Expand();
1457         CalculatePositions();
1458     }
1459
1460     if (!HasFlag(wxTR_MULTIPLE))
1461     {
1462         m_current = m_key_current = m_anchor;
1463         m_current->SetHilight( true );
1464     }
1465
1466     return m_anchor;
1467 }
1468
1469 wxTreeItemId wxGenericTreeCtrl::DoInsertAfter(const wxTreeItemId& parentId,
1470                                               const wxTreeItemId& idPrevious,
1471                                               const wxString& text,
1472                                               int image, int selImage,
1473                                               wxTreeItemData *data)
1474 {
1475     wxGenericTreeItem *parent = (wxGenericTreeItem*) parentId.m_pItem;
1476     if ( !parent )
1477     {
1478         // should we give a warning here?
1479         return AddRoot(text, image, selImage, data);
1480     }
1481
1482     int index = -1;
1483     if (idPrevious.IsOk())
1484     {
1485         index = parent->GetChildren().Index((wxGenericTreeItem*) idPrevious.m_pItem);
1486         wxASSERT_MSG( index != wxNOT_FOUND,
1487                       wxT("previous item in wxGenericTreeCtrl::InsertItem() is not a sibling") );
1488     }
1489
1490     return DoInsertItem(parentId, (size_t)++index, text, image, selImage, data);
1491 }
1492
1493
1494 void wxGenericTreeCtrl::SendDeleteEvent(wxGenericTreeItem *item)
1495 {
1496     wxTreeEvent event(wxEVT_COMMAND_TREE_DELETE_ITEM, this, item);
1497     ProcessEvent( event );
1498 }
1499
1500 // Don't leave edit or selection on a child which is about to disappear
1501 void wxGenericTreeCtrl::ChildrenClosing(wxGenericTreeItem* item)
1502 {
1503     if (m_textCtrl != NULL && item != m_textCtrl->item() && IsDescendantOf(item, m_textCtrl->item())) {
1504         m_textCtrl->StopEditing();
1505     }
1506     if (item != m_key_current && IsDescendantOf(item, m_key_current)) {
1507         m_key_current = NULL;
1508     }
1509     if (IsDescendantOf(item, m_select_me)) {
1510         m_select_me = item;
1511     }
1512     if (item != m_current && IsDescendantOf(item, m_current)) {
1513         m_current->SetHilight( false );
1514         m_current = NULL;
1515         m_select_me = item;
1516     }
1517 }
1518
1519 void wxGenericTreeCtrl::DeleteChildren(const wxTreeItemId& itemId)
1520 {
1521     m_dirty = true;     // do this first so stuff below doesn't cause flicker
1522
1523     wxGenericTreeItem *item = (wxGenericTreeItem*) itemId.m_pItem;
1524     ChildrenClosing(item);
1525     item->DeleteChildren(this);
1526 }
1527
1528 void wxGenericTreeCtrl::Delete(const wxTreeItemId& itemId)
1529 {
1530     m_dirty = true;     // do this first so stuff below doesn't cause flicker
1531
1532     wxGenericTreeItem *item = (wxGenericTreeItem*) itemId.m_pItem;
1533
1534     if (m_textCtrl != NULL && IsDescendantOf(item, m_textCtrl->item()))
1535     {
1536         // can't delete the item being edited, cancel editing it first
1537         m_textCtrl->StopEditing();
1538     }
1539
1540     wxGenericTreeItem *parent = item->GetParent();
1541
1542     // don't keep stale pointers around!
1543     if ( IsDescendantOf(item, m_key_current) )
1544     {
1545         // Don't silently change the selection:
1546         // do it properly in idle time, so event
1547         // handlers get called.
1548
1549         // m_key_current = parent;
1550         m_key_current = NULL;
1551     }
1552
1553     // m_select_me records whether we need to select
1554     // a different item, in idle time.
1555     if ( m_select_me && IsDescendantOf(item, m_select_me) )
1556     {
1557         m_select_me = parent;
1558     }
1559
1560     if ( IsDescendantOf(item, m_current) )
1561     {
1562         // Don't silently change the selection:
1563         // do it properly in idle time, so event
1564         // handlers get called.
1565
1566         // m_current = parent;
1567         m_current = NULL;
1568         m_select_me = parent;
1569     }
1570
1571     // remove the item from the tree
1572     if ( parent )
1573     {
1574         parent->GetChildren().Remove( item );  // remove by value
1575     }
1576     else // deleting the root
1577     {
1578         // nothing will be left in the tree
1579         m_anchor = NULL;
1580     }
1581
1582     // and delete all of its children and the item itself now
1583     item->DeleteChildren(this);
1584     SendDeleteEvent(item);
1585
1586     if (item == m_select_me)
1587         m_select_me = NULL;
1588
1589     delete item;
1590 }
1591
1592 void wxGenericTreeCtrl::DeleteAllItems()
1593 {
1594     if ( m_anchor )
1595     {
1596         Delete(m_anchor);
1597     }
1598 }
1599
1600 void wxGenericTreeCtrl::Expand(const wxTreeItemId& itemId)
1601 {
1602     wxGenericTreeItem *item = (wxGenericTreeItem*) itemId.m_pItem;
1603
1604     wxCHECK_RET( item, _T("invalid item in wxGenericTreeCtrl::Expand") );
1605     wxCHECK_RET( !HasFlag(wxTR_HIDE_ROOT) || itemId != GetRootItem(),
1606                  _T("can't expand hidden root") );
1607
1608     if ( !item->HasPlus() )
1609         return;
1610
1611     if ( item->IsExpanded() )
1612         return;
1613
1614     wxTreeEvent event(wxEVT_COMMAND_TREE_ITEM_EXPANDING, this, item);
1615
1616     if ( ProcessEvent( event ) && !event.IsAllowed() )
1617     {
1618         // cancelled by program
1619         return;
1620     }
1621
1622     item->Expand();
1623     CalculatePositions();
1624
1625     RefreshSubtree(item);
1626
1627     event.SetEventType(wxEVT_COMMAND_TREE_ITEM_EXPANDED);
1628     ProcessEvent( event );
1629 }
1630
1631 void wxGenericTreeCtrl::Collapse(const wxTreeItemId& itemId)
1632 {
1633     wxCHECK_RET( !HasFlag(wxTR_HIDE_ROOT) || itemId != GetRootItem(),
1634                  _T("can't collapse hidden root") );
1635
1636     wxGenericTreeItem *item = (wxGenericTreeItem*) itemId.m_pItem;
1637
1638     if ( !item->IsExpanded() )
1639         return;
1640
1641     wxTreeEvent event(wxEVT_COMMAND_TREE_ITEM_COLLAPSING, this, item);
1642     if ( ProcessEvent( event ) && !event.IsAllowed() )
1643     {
1644         // cancelled by program
1645         return;
1646     }
1647
1648     ChildrenClosing(item);
1649     item->Collapse();
1650
1651 #if 0  // TODO why should items be collapsed recursively?
1652     wxArrayGenericTreeItems& children = item->GetChildren();
1653     size_t count = children.Count();
1654     for ( size_t n = 0; n < count; n++ )
1655     {
1656         Collapse(children[n]);
1657     }
1658 #endif
1659
1660     CalculatePositions();
1661
1662     RefreshSubtree(item);
1663
1664     event.SetEventType(wxEVT_COMMAND_TREE_ITEM_COLLAPSED);
1665     ProcessEvent( event );
1666 }
1667
1668 void wxGenericTreeCtrl::CollapseAndReset(const wxTreeItemId& item)
1669 {
1670     Collapse(item);
1671     DeleteChildren(item);
1672 }
1673
1674 void wxGenericTreeCtrl::Toggle(const wxTreeItemId& itemId)
1675 {
1676     wxGenericTreeItem *item = (wxGenericTreeItem*) itemId.m_pItem;
1677
1678     if (item->IsExpanded())
1679         Collapse(itemId);
1680     else
1681         Expand(itemId);
1682 }
1683
1684 void wxGenericTreeCtrl::Unselect()
1685 {
1686     if (m_current)
1687     {
1688         m_current->SetHilight( false );
1689         RefreshLine( m_current );
1690
1691         m_current = NULL;
1692         m_select_me = NULL;
1693     }
1694 }
1695
1696 void wxGenericTreeCtrl::UnselectAllChildren(wxGenericTreeItem *item)
1697 {
1698     if (item->IsSelected())
1699     {
1700         item->SetHilight(false);
1701         RefreshLine(item);
1702     }
1703
1704     if (item->HasChildren())
1705     {
1706         wxArrayGenericTreeItems& children = item->GetChildren();
1707         size_t count = children.Count();
1708         for ( size_t n = 0; n < count; ++n )
1709         {
1710             UnselectAllChildren(children[n]);
1711         }
1712     }
1713 }
1714
1715 void wxGenericTreeCtrl::UnselectAll()
1716 {
1717     wxTreeItemId rootItem = GetRootItem();
1718
1719     // the tree might not have the root item at all
1720     if ( rootItem )
1721     {
1722         UnselectAllChildren((wxGenericTreeItem*) rootItem.m_pItem);
1723     }
1724 }
1725
1726 // Recursive function !
1727 // To stop we must have crt_item<last_item
1728 // Algorithm :
1729 // Tag all next children, when no more children,
1730 // Move to parent (not to tag)
1731 // Keep going... if we found last_item, we stop.
1732 bool wxGenericTreeCtrl::TagNextChildren(wxGenericTreeItem *crt_item, wxGenericTreeItem *last_item, bool select)
1733 {
1734     wxGenericTreeItem *parent = crt_item->GetParent();
1735
1736     if (parent == NULL) // This is root item
1737         return TagAllChildrenUntilLast(crt_item, last_item, select);
1738
1739     wxArrayGenericTreeItems& children = parent->GetChildren();
1740     int index = children.Index(crt_item);
1741     wxASSERT( index != wxNOT_FOUND ); // I'm not a child of my parent?
1742
1743     size_t count = children.Count();
1744     for (size_t n=(size_t)(index+1); n<count; ++n)
1745     {
1746         if (TagAllChildrenUntilLast(children[n], last_item, select)) return true;
1747     }
1748
1749     return TagNextChildren(parent, last_item, select);
1750 }
1751
1752 bool wxGenericTreeCtrl::TagAllChildrenUntilLast(wxGenericTreeItem *crt_item, wxGenericTreeItem *last_item, bool select)
1753 {
1754     crt_item->SetHilight(select);
1755     RefreshLine(crt_item);
1756
1757     if (crt_item==last_item)
1758         return true;
1759
1760     if (crt_item->HasChildren())
1761     {
1762         wxArrayGenericTreeItems& children = crt_item->GetChildren();
1763         size_t count = children.Count();
1764         for ( size_t n = 0; n < count; ++n )
1765         {
1766             if (TagAllChildrenUntilLast(children[n], last_item, select))
1767                 return true;
1768         }
1769     }
1770
1771   return false;
1772 }
1773
1774 void wxGenericTreeCtrl::SelectItemRange(wxGenericTreeItem *item1, wxGenericTreeItem *item2)
1775 {
1776     m_select_me = NULL;
1777
1778     // item2 is not necessary after item1
1779     // choice first' and 'last' between item1 and item2
1780     wxGenericTreeItem *first= (item1->GetY()<item2->GetY()) ? item1 : item2;
1781     wxGenericTreeItem *last = (item1->GetY()<item2->GetY()) ? item2 : item1;
1782
1783     bool select = m_current->IsSelected();
1784
1785     if ( TagAllChildrenUntilLast(first,last,select) )
1786         return;
1787
1788     TagNextChildren(first,last,select);
1789 }
1790
1791 void wxGenericTreeCtrl::DoSelectItem(const wxTreeItemId& itemId,
1792                                      bool unselect_others,
1793                                      bool extended_select)
1794 {
1795     wxCHECK_RET( itemId.IsOk(), wxT("invalid tree item") );
1796
1797     m_select_me = NULL;
1798
1799     bool is_single=!(GetWindowStyleFlag() & wxTR_MULTIPLE);
1800     wxGenericTreeItem *item = (wxGenericTreeItem*) itemId.m_pItem;
1801
1802     //wxCHECK_RET( ( (!unselect_others) && is_single),
1803     //           wxT("this is a single selection tree") );
1804
1805     // to keep going anyhow !!!
1806     if (is_single)
1807     {
1808         if (item->IsSelected())
1809             return; // nothing to do
1810         unselect_others = true;
1811         extended_select = false;
1812     }
1813     else if ( unselect_others && item->IsSelected() )
1814     {
1815         // selection change if there is more than one item currently selected
1816         wxArrayTreeItemIds selected_items;
1817         if ( GetSelections(selected_items) == 1 )
1818             return;
1819     }
1820
1821     wxTreeEvent event(wxEVT_COMMAND_TREE_SEL_CHANGING, this, item);
1822     event.m_itemOld = m_current;
1823     // TODO : Here we don't send any selection mode yet !
1824
1825     if ( GetEventHandler()->ProcessEvent( event ) && !event.IsAllowed() )
1826         return;
1827
1828     wxTreeItemId parent = GetItemParent( itemId );
1829     while (parent.IsOk())
1830     {
1831         if (!IsExpanded(parent))
1832             Expand( parent );
1833
1834         parent = GetItemParent( parent );
1835     }
1836
1837     // ctrl press
1838     if (unselect_others)
1839     {
1840         if (is_single) Unselect(); // to speed up thing
1841         else UnselectAll();
1842     }
1843
1844     // shift press
1845     if (extended_select)
1846     {
1847         if ( !m_current )
1848         {
1849             m_current = m_key_current = (wxGenericTreeItem*) GetRootItem().m_pItem;
1850         }
1851
1852         // don't change the mark (m_current)
1853         SelectItemRange(m_current, item);
1854     }
1855     else
1856     {
1857         bool select = true; // the default
1858
1859         // Check if we need to toggle hilight (ctrl mode)
1860         if (!unselect_others)
1861             select=!item->IsSelected();
1862
1863         m_current = m_key_current = item;
1864         m_current->SetHilight(select);
1865         RefreshLine( m_current );
1866     }
1867
1868     // This can cause idle processing to select the root
1869     // if no item is selected, so it must be after the
1870     // selection is set
1871     EnsureVisible( itemId );
1872
1873     event.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED);
1874     GetEventHandler()->ProcessEvent( event );
1875 }
1876
1877 void wxGenericTreeCtrl::SelectItem(const wxTreeItemId& itemId, bool select)
1878 {
1879     if ( select )
1880     {
1881         DoSelectItem(itemId, !HasFlag(wxTR_MULTIPLE));
1882     }
1883     else // deselect
1884     {
1885         wxGenericTreeItem *item = (wxGenericTreeItem*) itemId.m_pItem;
1886         wxCHECK_RET( item, wxT("SelectItem(): invalid tree item") );
1887
1888         item->SetHilight(false);
1889         RefreshLine(item);
1890     }
1891 }
1892
1893 void wxGenericTreeCtrl::FillArray(wxGenericTreeItem *item,
1894                                   wxArrayTreeItemIds &array) const
1895 {
1896     if ( item->IsSelected() )
1897         array.Add(wxTreeItemId(item));
1898
1899     if ( item->HasChildren() )
1900     {
1901         wxArrayGenericTreeItems& children = item->GetChildren();
1902         size_t count = children.GetCount();
1903         for ( size_t n = 0; n < count; ++n )
1904             FillArray(children[n], array);
1905     }
1906 }
1907
1908 size_t wxGenericTreeCtrl::GetSelections(wxArrayTreeItemIds &array) const
1909 {
1910     array.Empty();
1911     wxTreeItemId idRoot = GetRootItem();
1912     if ( idRoot.IsOk() )
1913     {
1914         FillArray((wxGenericTreeItem*) idRoot.m_pItem, array);
1915     }
1916     //else: the tree is empty, so no selections
1917
1918     return array.Count();
1919 }
1920
1921 void wxGenericTreeCtrl::EnsureVisible(const wxTreeItemId& item)
1922 {
1923     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
1924
1925     if (!item.IsOk()) return;
1926
1927     wxGenericTreeItem *gitem = (wxGenericTreeItem*) item.m_pItem;
1928
1929     // first expand all parent branches
1930     wxGenericTreeItem *parent = gitem->GetParent();
1931
1932     if ( HasFlag(wxTR_HIDE_ROOT) )
1933     {
1934         while ( parent && parent != m_anchor )
1935         {
1936             Expand(parent);
1937             parent = parent->GetParent();
1938         }
1939     }
1940     else
1941     {
1942         while ( parent )
1943         {
1944             Expand(parent);
1945             parent = parent->GetParent();
1946         }
1947     }
1948
1949     //if (parent) CalculatePositions();
1950
1951     ScrollTo(item);
1952 }
1953
1954 void wxGenericTreeCtrl::ScrollTo(const wxTreeItemId &item)
1955 {
1956     if (!item.IsOk()) return;
1957
1958     // We have to call this here because the label in
1959     // question might just have been added and no screen
1960     // update taken place.
1961     if (m_dirty)
1962 #if defined( __WXMSW__ ) || defined(__WXMAC__)
1963         Update();
1964 #else
1965         wxYieldIfNeeded();
1966 #endif
1967     wxGenericTreeItem *gitem = (wxGenericTreeItem*) item.m_pItem;
1968
1969     // now scroll to the item
1970     int item_y = gitem->GetY();
1971
1972     int start_x = 0;
1973     int start_y = 0;
1974     GetViewStart( &start_x, &start_y );
1975     start_y *= PIXELS_PER_UNIT;
1976
1977     int client_h = 0;
1978     int client_w = 0;
1979     GetClientSize( &client_w, &client_h );
1980
1981     if (item_y < start_y+3)
1982     {
1983         // going down
1984         int x = 0;
1985         int y = 0;
1986         m_anchor->GetSize( x, y, this );
1987         y += PIXELS_PER_UNIT+2; // one more scrollbar unit + 2 pixels
1988         x += PIXELS_PER_UNIT+2; // one more scrollbar unit + 2 pixels
1989         int x_pos = GetScrollPos( wxHORIZONTAL );
1990         // Item should appear at top
1991         SetScrollbars( PIXELS_PER_UNIT, PIXELS_PER_UNIT, x/PIXELS_PER_UNIT, y/PIXELS_PER_UNIT, x_pos, item_y/PIXELS_PER_UNIT );
1992     }
1993     else if (item_y+GetLineHeight(gitem) > start_y+client_h)
1994     {
1995         // going up
1996         int x = 0;
1997         int y = 0;
1998         m_anchor->GetSize( x, y, this );
1999         y += PIXELS_PER_UNIT+2; // one more scrollbar unit + 2 pixels
2000         x += PIXELS_PER_UNIT+2; // one more scrollbar unit + 2 pixels
2001         item_y += PIXELS_PER_UNIT+2;
2002         int x_pos = GetScrollPos( wxHORIZONTAL );
2003         // Item should appear at bottom
2004         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 );
2005     }
2006 }
2007
2008 // FIXME: tree sorting functions are not reentrant and not MT-safe!
2009 static wxGenericTreeCtrl *s_treeBeingSorted = NULL;
2010
2011 static int LINKAGEMODE tree_ctrl_compare_func(wxGenericTreeItem **item1,
2012                                   wxGenericTreeItem **item2)
2013 {
2014     wxCHECK_MSG( s_treeBeingSorted, 0, wxT("bug in wxGenericTreeCtrl::SortChildren()") );
2015
2016     return s_treeBeingSorted->OnCompareItems(*item1, *item2);
2017 }
2018
2019 void wxGenericTreeCtrl::SortChildren(const wxTreeItemId& itemId)
2020 {
2021     wxCHECK_RET( itemId.IsOk(), wxT("invalid tree item") );
2022
2023     wxGenericTreeItem *item = (wxGenericTreeItem*) itemId.m_pItem;
2024
2025     wxCHECK_RET( !s_treeBeingSorted,
2026                  wxT("wxGenericTreeCtrl::SortChildren is not reentrant") );
2027
2028     wxArrayGenericTreeItems& children = item->GetChildren();
2029     if ( children.Count() > 1 )
2030     {
2031         m_dirty = true;
2032
2033         s_treeBeingSorted = this;
2034         children.Sort(tree_ctrl_compare_func);
2035         s_treeBeingSorted = NULL;
2036     }
2037     //else: don't make the tree dirty as nothing changed
2038 }
2039
2040 void wxGenericTreeCtrl::CalculateLineHeight()
2041 {
2042     wxClientDC dc(this);
2043     m_lineHeight = (int)(dc.GetCharHeight() + 4);
2044
2045     if ( m_imageListNormal )
2046     {
2047         // Calculate a m_lineHeight value from the normal Image sizes.
2048         // May be toggle off. Then wxGenericTreeCtrl will spread when
2049         // necessary (which might look ugly).
2050         int n = m_imageListNormal->GetImageCount();
2051         for (int i = 0; i < n ; i++)
2052         {
2053             int width = 0, height = 0;
2054             m_imageListNormal->GetSize(i, width, height);
2055             if (height > m_lineHeight) m_lineHeight = height;
2056         }
2057     }
2058
2059     if (m_imageListButtons)
2060     {
2061         // Calculate a m_lineHeight value from the Button image sizes.
2062         // May be toggle off. Then wxGenericTreeCtrl will spread when
2063         // necessary (which might look ugly).
2064         int n = m_imageListButtons->GetImageCount();
2065         for (int i = 0; i < n ; i++)
2066         {
2067             int width = 0, height = 0;
2068             m_imageListButtons->GetSize(i, width, height);
2069             if (height > m_lineHeight) m_lineHeight = height;
2070         }
2071     }
2072
2073     if (m_lineHeight < 30)
2074         m_lineHeight += 2;                 // at least 2 pixels
2075     else
2076         m_lineHeight += m_lineHeight/10;   // otherwise 10% extra spacing
2077 }
2078
2079 void wxGenericTreeCtrl::SetImageList(wxImageList *imageList)
2080 {
2081     if (m_ownsImageListNormal) delete m_imageListNormal;
2082     m_imageListNormal = imageList;
2083     m_ownsImageListNormal = false;
2084     m_dirty = true;
2085     // Don't do any drawing if we're setting the list to NULL,
2086     // since we may be in the process of deleting the tree control.
2087     if (imageList)
2088         CalculateLineHeight();
2089 }
2090
2091 void wxGenericTreeCtrl::SetStateImageList(wxImageList *imageList)
2092 {
2093     if (m_ownsImageListState) delete m_imageListState;
2094     m_imageListState = imageList;
2095     m_ownsImageListState = false;
2096 }
2097
2098 void wxGenericTreeCtrl::SetButtonsImageList(wxImageList *imageList)
2099 {
2100     if (m_ownsImageListButtons) delete m_imageListButtons;
2101     m_imageListButtons = imageList;
2102     m_ownsImageListButtons = false;
2103     m_dirty = true;
2104     CalculateLineHeight();
2105 }
2106
2107 void wxGenericTreeCtrl::AssignButtonsImageList(wxImageList *imageList)
2108 {
2109     SetButtonsImageList(imageList);
2110     m_ownsImageListButtons = true;
2111 }
2112
2113 // -----------------------------------------------------------------------------
2114 // helpers
2115 // -----------------------------------------------------------------------------
2116
2117 void wxGenericTreeCtrl::AdjustMyScrollbars()
2118 {
2119     if (m_anchor)
2120     {
2121         int x = 0, y = 0;
2122         m_anchor->GetSize( x, y, this );
2123         y += PIXELS_PER_UNIT+2; // one more scrollbar unit + 2 pixels
2124         x += PIXELS_PER_UNIT+2; // one more scrollbar unit + 2 pixels
2125         int x_pos = GetScrollPos( wxHORIZONTAL );
2126         int y_pos = GetScrollPos( wxVERTICAL );
2127         SetScrollbars( PIXELS_PER_UNIT, PIXELS_PER_UNIT, x/PIXELS_PER_UNIT, y/PIXELS_PER_UNIT, x_pos, y_pos );
2128     }
2129     else
2130     {
2131         SetScrollbars( 0, 0, 0, 0 );
2132     }
2133 }
2134
2135 int wxGenericTreeCtrl::GetLineHeight(wxGenericTreeItem *item) const
2136 {
2137     if (GetWindowStyleFlag() & wxTR_HAS_VARIABLE_ROW_HEIGHT)
2138         return item->GetHeight();
2139     else
2140         return m_lineHeight;
2141 }
2142
2143 void wxGenericTreeCtrl::PaintItem(wxGenericTreeItem *item, wxDC& dc)
2144 {
2145     // TODO implement "state" icon on items
2146
2147     wxTreeItemAttr *attr = item->GetAttributes();
2148     if ( attr && attr->HasFont() )
2149         dc.SetFont(attr->GetFont());
2150     else if (item->IsBold())
2151         dc.SetFont(m_boldFont);
2152
2153     long text_w = 0, text_h = 0;
2154     dc.GetTextExtent( item->GetText(), &text_w, &text_h );
2155
2156     int image_h = 0, image_w = 0;
2157     int image = item->GetCurrentImage();
2158     if ( image != NO_IMAGE )
2159     {
2160         if ( m_imageListNormal )
2161         {
2162             m_imageListNormal->GetSize( image, image_w, image_h );
2163             image_w += MARGIN_BETWEEN_IMAGE_AND_TEXT;
2164         }
2165         else
2166         {
2167             image = NO_IMAGE;
2168         }
2169     }
2170
2171     int total_h = GetLineHeight(item);
2172     bool drawItemBackground = false;
2173
2174     if ( item->IsSelected() )
2175     {
2176 // under mac selections are only a rectangle in case they don't have the focus
2177 #ifdef __WXMAC__
2178         if ( !m_hasFocus )
2179         {
2180             dc.SetBrush( *wxTRANSPARENT_BRUSH ) ;
2181             dc.SetPen( wxPen( wxSystemSettings::GetColour( wxSYS_COLOUR_HIGHLIGHT ) , 1 , wxSOLID ) ) ;
2182         }
2183         else
2184         {
2185             dc.SetBrush( *m_hilightBrush ) ;
2186         }
2187 #else
2188         dc.SetBrush(*(m_hasFocus ? m_hilightBrush : m_hilightUnfocusedBrush));
2189 #endif
2190         drawItemBackground = true;
2191     }
2192     else
2193     {
2194         wxColour colBg;
2195         if ( attr && attr->HasBackgroundColour() )
2196         {
2197             drawItemBackground = true;
2198             colBg = attr->GetBackgroundColour();
2199         }
2200         else
2201         {
2202             colBg = GetBackgroundColour();
2203         }
2204         dc.SetBrush(wxBrush(colBg, wxSOLID));
2205     }
2206
2207     int offset = HasFlag(wxTR_ROW_LINES) ? 1 : 0;
2208
2209     if ( HasFlag(wxTR_FULL_ROW_HIGHLIGHT) )
2210     {
2211         int x, y, w, h;
2212
2213         DoGetPosition(&x, &y);
2214         DoGetSize(&w, &h);
2215         dc.DrawRectangle(x, item->GetY()+offset, w, total_h-offset);
2216     }
2217     else
2218     {
2219         if ( item->IsSelected() && image != NO_IMAGE )
2220         {
2221             // If it's selected, and there's an image, then we should
2222             // take care to leave the area under the image painted in the
2223             // background colour.
2224             dc.DrawRectangle( item->GetX() + image_w - 2, item->GetY()+offset,
2225                               item->GetWidth() - image_w + 2, total_h-offset );
2226         }
2227         // On GTK+ 2, drawing a 'normal' background is wrong for themes that
2228         // don't allow backgrounds to be customized. Not drawing the background,
2229         // except for custom item backgrounds, works for both kinds of theme.
2230         else if (drawItemBackground)
2231         {
2232             dc.DrawRectangle( item->GetX()-2, item->GetY()+offset,
2233                               item->GetWidth()+2, total_h-offset );
2234         }
2235     }
2236
2237     if ( image != NO_IMAGE )
2238     {
2239         dc.SetClippingRegion( item->GetX(), item->GetY(), image_w-2, total_h );
2240         m_imageListNormal->Draw( image, dc,
2241                                  item->GetX(),
2242                                  item->GetY() +((total_h > image_h)?((total_h-image_h)/2):0),
2243                                  wxIMAGELIST_DRAW_TRANSPARENT );
2244         dc.DestroyClippingRegion();
2245     }
2246
2247     dc.SetBackgroundMode(wxTRANSPARENT);
2248     int extraH = (total_h > text_h) ? (total_h - text_h)/2 : 0;
2249     dc.DrawText( item->GetText(),
2250                  (wxCoord)(image_w + item->GetX()),
2251                  (wxCoord)(item->GetY() + extraH));
2252
2253     // restore normal font
2254     dc.SetFont( m_normalFont );
2255 }
2256
2257 // Now y stands for the top of the item, whereas it used to stand for middle !
2258 void wxGenericTreeCtrl::PaintLevel( wxGenericTreeItem *item, wxDC &dc, int level, int &y )
2259 {
2260     int x = level*m_indent;
2261     if (!HasFlag(wxTR_HIDE_ROOT))
2262     {
2263         x += m_indent;
2264     }
2265     else if (level == 0)
2266     {
2267         // always expand hidden root
2268         int origY = y;
2269         wxArrayGenericTreeItems& children = item->GetChildren();
2270         int count = children.Count();
2271         if (count > 0)
2272         {
2273             int n = 0, oldY;
2274             do {
2275                 oldY = y;
2276                 PaintLevel(children[n], dc, 1, y);
2277             } while (++n < count);
2278
2279             if (!HasFlag(wxTR_NO_LINES) && HasFlag(wxTR_LINES_AT_ROOT) && count > 0)
2280             {
2281                 // draw line down to last child
2282                 origY += GetLineHeight(children[0])>>1;
2283                 oldY += GetLineHeight(children[n-1])>>1;
2284                 dc.DrawLine(3, origY, 3, oldY);
2285             }
2286         }
2287         return;
2288     }
2289
2290     item->SetX(x+m_spacing);
2291     item->SetY(y);
2292
2293     int h = GetLineHeight(item);
2294     int y_top = y;
2295     int y_mid = y_top + (h>>1);
2296     y += h;
2297
2298     int exposed_x = dc.LogicalToDeviceX(0);
2299     int exposed_y = dc.LogicalToDeviceY(y_top);
2300
2301     if (IsExposed(exposed_x, exposed_y, 10000, h))  // 10000 = very much
2302     {
2303         const wxPen *pen =
2304 #ifndef __WXMAC__
2305             // don't draw rect outline if we already have the
2306             // background color under Mac
2307             (item->IsSelected() && m_hasFocus) ? wxBLACK_PEN :
2308 #endif // !__WXMAC__
2309             wxTRANSPARENT_PEN;
2310
2311         wxColour colText;
2312         if ( item->IsSelected()
2313 #ifdef __WXMAC__
2314             // On wxMac, if the tree doesn't have the focus we draw an empty
2315             // rectangle, so we want to make sure that the text is visible
2316             // against the normal background, not the highlightbackground, so
2317             // don't use the highlight text colour unless we have the focus.
2318              && m_hasFocus
2319 #endif
2320             )
2321         {
2322             colText = wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHTTEXT);
2323         }
2324         else
2325         {
2326             wxTreeItemAttr *attr = item->GetAttributes();
2327             if (attr && attr->HasTextColour())
2328                 colText = attr->GetTextColour();
2329             else
2330                 colText = GetForegroundColour();
2331         }
2332
2333         // prepare to draw
2334         dc.SetTextForeground(colText);
2335         dc.SetPen(*pen);
2336
2337         // draw
2338         PaintItem(item, dc);
2339
2340         if (HasFlag(wxTR_ROW_LINES))
2341         {
2342             // if the background colour is white, choose a
2343             // contrasting color for the lines
2344             dc.SetPen(*((GetBackgroundColour() == *wxWHITE)
2345                          ? wxMEDIUM_GREY_PEN : wxWHITE_PEN));
2346             dc.DrawLine(0, y_top, 10000, y_top);
2347             dc.DrawLine(0, y, 10000, y);
2348         }
2349
2350         // restore DC objects
2351         dc.SetBrush(*wxWHITE_BRUSH);
2352         dc.SetPen(m_dottedPen);
2353         dc.SetTextForeground(*wxBLACK);
2354
2355         if ( !HasFlag(wxTR_NO_LINES) )
2356         {
2357             // draw the horizontal line here
2358             int x_start = x;
2359             if (x > (signed)m_indent)
2360                 x_start -= m_indent;
2361             else if (HasFlag(wxTR_LINES_AT_ROOT))
2362                 x_start = 3;
2363             dc.DrawLine(x_start, y_mid, x + m_spacing, y_mid);
2364         }
2365
2366         // should the item show a button?
2367         if ( item->HasPlus() && HasButtons() )
2368         {
2369             if ( m_imageListButtons )
2370             {
2371                 // draw the image button here
2372                 int image_h = 0,
2373                     image_w = 0;
2374                 int image = item->IsExpanded() ? wxTreeItemIcon_Expanded
2375                                                : wxTreeItemIcon_Normal;
2376                 if ( item->IsSelected() )
2377                     image += wxTreeItemIcon_Selected - wxTreeItemIcon_Normal;
2378
2379                 m_imageListButtons->GetSize(image, image_w, image_h);
2380                 int xx = x - image_w/2;
2381                 int yy = y_mid - image_h/2;
2382
2383                 wxDCClipper clip(dc, xx, yy, image_w, image_h);
2384                 m_imageListButtons->Draw(image, dc, xx, yy,
2385                                          wxIMAGELIST_DRAW_TRANSPARENT);
2386             }
2387             else // no custom buttons
2388             {
2389                 static const int wImage = 9;
2390                 static const int hImage = 9;
2391
2392                 int flag = 0;
2393                 if (item->IsExpanded())
2394                     flag |= wxCONTROL_EXPANDED;
2395                 if (item == m_underMouse)
2396                     flag |= wxCONTROL_CURRENT;
2397
2398                 wxRendererNative::Get().DrawTreeItemButton
2399                                         (
2400                                             this,
2401                                             dc,
2402                                             wxRect(x - wImage/2,
2403                                                    y_mid - hImage/2,
2404                                                    wImage, hImage),
2405                                             flag
2406                                         );
2407             }
2408         }
2409     }
2410
2411     if (item->IsExpanded())
2412     {
2413         wxArrayGenericTreeItems& children = item->GetChildren();
2414         int count = children.Count();
2415         if (count > 0)
2416         {
2417             int n = 0, oldY;
2418             ++level;
2419             do {
2420                 oldY = y;
2421                 PaintLevel(children[n], dc, level, y);
2422             } while (++n < count);
2423
2424             if (!HasFlag(wxTR_NO_LINES) && count > 0)
2425             {
2426                 // draw line down to last child
2427                 oldY += GetLineHeight(children[n-1])>>1;
2428                 if (HasButtons()) y_mid += 5;
2429
2430                 // Only draw the portion of the line that is visible, in case it is huge
2431                 wxCoord xOrigin=0, yOrigin=0, width, height;
2432                 dc.GetDeviceOrigin(&xOrigin, &yOrigin);
2433                 yOrigin = abs(yOrigin);
2434                 GetClientSize(&width, &height);
2435
2436                 // Move end points to the begining/end of the view?
2437                 if (y_mid < yOrigin)
2438                     y_mid = yOrigin;
2439                 if (oldY > yOrigin + height)
2440                     oldY = yOrigin + height;
2441
2442                 // after the adjustments if y_mid is larger than oldY then the line
2443                 // isn't visible at all so don't draw anything
2444                 if (y_mid < oldY)
2445                     dc.DrawLine(x, y_mid, x, oldY);
2446             }
2447         }
2448     }
2449 }
2450
2451 void wxGenericTreeCtrl::DrawDropEffect(wxGenericTreeItem *item)
2452 {
2453     if ( item )
2454     {
2455         if ( item->HasPlus() )
2456         {
2457             // it's a folder, indicate it by a border
2458             DrawBorder(item);
2459         }
2460         else
2461         {
2462             // draw a line under the drop target because the item will be
2463             // dropped there
2464             DrawLine(item, !m_dropEffectAboveItem );
2465         }
2466
2467         SetCursor(wxCURSOR_BULLSEYE);
2468     }
2469     else
2470     {
2471         // can't drop here
2472         SetCursor(wxCURSOR_NO_ENTRY);
2473     }
2474 }
2475
2476 void wxGenericTreeCtrl::DrawBorder(const wxTreeItemId &item)
2477 {
2478     wxCHECK_RET( item.IsOk(), _T("invalid item in wxGenericTreeCtrl::DrawLine") );
2479
2480     wxGenericTreeItem *i = (wxGenericTreeItem*) item.m_pItem;
2481
2482     wxClientDC dc(this);
2483     PrepareDC( dc );
2484     dc.SetLogicalFunction(wxINVERT);
2485     dc.SetBrush(*wxTRANSPARENT_BRUSH);
2486
2487     int w = i->GetWidth() + 2;
2488     int h = GetLineHeight(i) + 2;
2489
2490     dc.DrawRectangle( i->GetX() - 1, i->GetY() - 1, w, h);
2491 }
2492
2493 void wxGenericTreeCtrl::DrawLine(const wxTreeItemId &item, bool below)
2494 {
2495     wxCHECK_RET( item.IsOk(), _T("invalid item in wxGenericTreeCtrl::DrawLine") );
2496
2497     wxGenericTreeItem *i = (wxGenericTreeItem*) item.m_pItem;
2498
2499     wxClientDC dc(this);
2500     PrepareDC( dc );
2501     dc.SetLogicalFunction(wxINVERT);
2502
2503     int x = i->GetX(),
2504         y = i->GetY();
2505     if ( below )
2506     {
2507         y += GetLineHeight(i) - 1;
2508     }
2509
2510     dc.DrawLine( x, y, x + i->GetWidth(), y);
2511 }
2512
2513 // -----------------------------------------------------------------------------
2514 // wxWidgets callbacks
2515 // -----------------------------------------------------------------------------
2516
2517 void wxGenericTreeCtrl::OnPaint( wxPaintEvent &WXUNUSED(event) )
2518 {
2519     wxPaintDC dc(this);
2520     PrepareDC( dc );
2521
2522     if ( !m_anchor)
2523         return;
2524
2525     dc.SetFont( m_normalFont );
2526     dc.SetPen( m_dottedPen );
2527
2528     // this is now done dynamically
2529     //if(GetImageList() == NULL)
2530     // m_lineHeight = (int)(dc.GetCharHeight() + 4);
2531
2532     int y = 2;
2533     PaintLevel( m_anchor, dc, 0, y );
2534 }
2535
2536 void wxGenericTreeCtrl::OnSetFocus( wxFocusEvent &event )
2537 {
2538     m_hasFocus = true;
2539
2540     RefreshSelected();
2541
2542     event.Skip();
2543 }
2544
2545 void wxGenericTreeCtrl::OnKillFocus( wxFocusEvent &event )
2546 {
2547     m_hasFocus = false;
2548
2549     RefreshSelected();
2550
2551     event.Skip();
2552 }
2553
2554 void wxGenericTreeCtrl::OnChar( wxKeyEvent &event )
2555 {
2556     wxTreeEvent te( wxEVT_COMMAND_TREE_KEY_DOWN, this);
2557     te.m_evtKey = event;
2558     if ( GetEventHandler()->ProcessEvent( te ) )
2559     {
2560         // intercepted by the user code
2561         return;
2562     }
2563
2564     if ( (m_current == 0) || (m_key_current == 0) )
2565     {
2566         event.Skip();
2567         return;
2568     }
2569
2570     // how should the selection work for this event?
2571     bool is_multiple, extended_select, unselect_others;
2572     EventFlagsToSelType(GetWindowStyleFlag(),
2573                         event.ShiftDown(),
2574                         event.CmdDown(),
2575                         is_multiple, extended_select, unselect_others);
2576
2577     // + : Expand
2578     // - : Collaspe
2579     // * : Expand all/Collapse all
2580     // ' ' | return : activate
2581     // up    : go up (not last children!)
2582     // down  : go down
2583     // left  : go to parent
2584     // right : open if parent and go next
2585     // home  : go to root
2586     // end   : go to last item without opening parents
2587     // alnum : start or continue searching for the item with this prefix
2588     int keyCode = event.GetKeyCode();
2589     switch ( keyCode )
2590     {
2591         case '+':
2592         case WXK_ADD:
2593             if (m_current->HasPlus() && !IsExpanded(m_current))
2594             {
2595                 Expand(m_current);
2596             }
2597             break;
2598
2599         case '*':
2600         case WXK_MULTIPLY:
2601             if ( !IsExpanded(m_current) )
2602             {
2603                 // expand all
2604                 ExpandAllChildren(m_current);
2605                 break;
2606             }
2607             //else: fall through to Collapse() it
2608
2609         case '-':
2610         case WXK_SUBTRACT:
2611             if (IsExpanded(m_current))
2612             {
2613                 Collapse(m_current);
2614             }
2615             break;
2616
2617         case WXK_MENU:
2618             {
2619                 // Use the item's bounding rectangle to determine position for the event
2620                 wxRect ItemRect;
2621                 GetBoundingRect(m_current, ItemRect, true);
2622
2623                 wxTreeEvent eventMenu(wxEVT_COMMAND_TREE_ITEM_MENU, this, m_current);
2624                 // Use the left edge, vertical middle
2625                 eventMenu.m_pointDrag = wxPoint(ItemRect.GetX(),
2626                                                 ItemRect.GetY() + ItemRect.GetHeight() / 2);
2627                 GetEventHandler()->ProcessEvent( eventMenu );
2628             }
2629             break;
2630
2631         case ' ':
2632         case WXK_RETURN:
2633             if ( !event.HasModifiers() )
2634             {
2635                 wxTreeEvent eventAct(wxEVT_COMMAND_TREE_ITEM_ACTIVATED, this, m_current);
2636                 GetEventHandler()->ProcessEvent( eventAct );
2637             }
2638
2639             // in any case, also generate the normal key event for this key,
2640             // even if we generated the ACTIVATED event above: this is what
2641             // wxMSW does and it makes sense because you might not want to
2642             // process ACTIVATED event at all and handle Space and Return
2643             // directly (and differently) which would be impossible otherwise
2644             event.Skip();
2645             break;
2646
2647             // up goes to the previous sibling or to the last
2648             // of its children if it's expanded
2649         case WXK_UP:
2650             {
2651                 wxTreeItemId prev = GetPrevSibling( m_key_current );
2652                 if (!prev)
2653                 {
2654                     prev = GetItemParent( m_key_current );
2655                     if ((prev == GetRootItem()) && HasFlag(wxTR_HIDE_ROOT))
2656                     {
2657                         break;  // don't go to root if it is hidden
2658                     }
2659                     if (prev)
2660                     {
2661                         wxTreeItemIdValue cookie;
2662                         wxTreeItemId current = m_key_current;
2663                         // TODO: Huh?  If we get here, we'd better be the first child of our parent.  How else could it be?
2664                         if (current == GetFirstChild( prev, cookie ))
2665                         {
2666                             // otherwise we return to where we came from
2667                             DoSelectItem( prev, unselect_others, extended_select );
2668                             m_key_current= (wxGenericTreeItem*) prev.m_pItem;
2669                             break;
2670                         }
2671                     }
2672                 }
2673                 if (prev)
2674                 {
2675                     while ( IsExpanded(prev) && HasChildren(prev) )
2676                     {
2677                         wxTreeItemId child = GetLastChild(prev);
2678                         if ( child )
2679                         {
2680                             prev = child;
2681                         }
2682                     }
2683
2684                     DoSelectItem( prev, unselect_others, extended_select );
2685                     m_key_current=(wxGenericTreeItem*) prev.m_pItem;
2686                 }
2687             }
2688             break;
2689
2690             // left arrow goes to the parent
2691         case WXK_LEFT:
2692             {
2693                 wxTreeItemId prev = GetItemParent( m_current );
2694                 if ((prev == GetRootItem()) && HasFlag(wxTR_HIDE_ROOT))
2695                 {
2696                     // don't go to root if it is hidden
2697                     prev = GetPrevSibling( m_current );
2698                 }
2699                 if (prev)
2700                 {
2701                     DoSelectItem( prev, unselect_others, extended_select );
2702                 }
2703             }
2704             break;
2705
2706         case WXK_RIGHT:
2707             // this works the same as the down arrow except that we
2708             // also expand the item if it wasn't expanded yet
2709             Expand(m_current);
2710             // fall through
2711
2712         case WXK_DOWN:
2713             {
2714                 if (IsExpanded(m_key_current) && HasChildren(m_key_current))
2715                 {
2716                     wxTreeItemIdValue cookie;
2717                     wxTreeItemId child = GetFirstChild( m_key_current, cookie );
2718                     DoSelectItem( child, unselect_others, extended_select );
2719                     m_key_current=(wxGenericTreeItem*) child.m_pItem;
2720                 }
2721                 else
2722                 {
2723                     wxTreeItemId next = GetNextSibling( m_key_current );
2724                     if (!next)
2725                     {
2726                         wxTreeItemId current = m_key_current;
2727                         while (current.IsOk() && !next)
2728                         {
2729                             current = GetItemParent( current );
2730                             if (current) next = GetNextSibling( current );
2731                         }
2732                     }
2733                     if (next)
2734                     {
2735                         DoSelectItem( next, unselect_others, extended_select );
2736                         m_key_current=(wxGenericTreeItem*) next.m_pItem;
2737                     }
2738                 }
2739             }
2740             break;
2741
2742             // <End> selects the last visible tree item
2743         case WXK_END:
2744             {
2745                 wxTreeItemId last = GetRootItem();
2746
2747                 while ( last.IsOk() && IsExpanded(last) )
2748                 {
2749                     wxTreeItemId lastChild = GetLastChild(last);
2750
2751                     // it may happen if the item was expanded but then all of
2752                     // its children have been deleted - so IsExpanded() returned
2753                     // true, but GetLastChild() returned invalid item
2754                     if ( !lastChild )
2755                         break;
2756
2757                     last = lastChild;
2758                 }
2759
2760                 if ( last.IsOk() )
2761                 {
2762                     DoSelectItem( last, unselect_others, extended_select );
2763                 }
2764             }
2765             break;
2766
2767             // <Home> selects the root item
2768         case WXK_HOME:
2769             {
2770                 wxTreeItemId prev = GetRootItem();
2771                 if (!prev)
2772                     break;
2773
2774                 if ( HasFlag(wxTR_HIDE_ROOT) )
2775                 {
2776                     wxTreeItemIdValue cookie;
2777                     prev = GetFirstChild(prev, cookie);
2778                     if (!prev)
2779                         break;
2780                 }
2781
2782                 DoSelectItem( prev, unselect_others, extended_select );
2783             }
2784             break;
2785
2786         default:
2787             // do not use wxIsalnum() here
2788             if ( !event.HasModifiers() &&
2789                  ((keyCode >= '0' && keyCode <= '9') ||
2790                   (keyCode >= 'a' && keyCode <= 'z') ||
2791                   (keyCode >= 'A' && keyCode <= 'Z' )))
2792             {
2793                 // find the next item starting with the given prefix
2794                 wxChar ch = (wxChar)keyCode;
2795
2796                 wxTreeItemId id = FindItem(m_current, m_findPrefix + ch);
2797                 if ( !id.IsOk() )
2798                 {
2799                     // no such item
2800                     break;
2801                 }
2802
2803                 SelectItem(id);
2804
2805                 m_findPrefix += ch;
2806
2807                 // also start the timer to reset the current prefix if the user
2808                 // doesn't press any more alnum keys soon -- we wouldn't want
2809                 // to use this prefix for a new item search
2810                 if ( !m_findTimer )
2811                 {
2812                     m_findTimer = new wxTreeFindTimer(this);
2813                 }
2814
2815                 m_findTimer->Start(wxTreeFindTimer::DELAY, wxTIMER_ONE_SHOT);
2816             }
2817             else
2818             {
2819                 event.Skip();
2820             }
2821     }
2822 }
2823
2824 wxTreeItemId
2825 wxGenericTreeCtrl::DoTreeHitTest(const wxPoint& point, int& flags) const
2826 {
2827     int w, h;
2828     GetSize(&w, &h);
2829     flags=0;
2830     if (point.x<0) flags |= wxTREE_HITTEST_TOLEFT;
2831     if (point.x>w) flags |= wxTREE_HITTEST_TORIGHT;
2832     if (point.y<0) flags |= wxTREE_HITTEST_ABOVE;
2833     if (point.y>h) flags |= wxTREE_HITTEST_BELOW;
2834     if (flags) return wxTreeItemId();
2835
2836     if (m_anchor == NULL)
2837     {
2838         flags = wxTREE_HITTEST_NOWHERE;
2839         return wxTreeItemId();
2840     }
2841
2842     wxGenericTreeItem *hit =  m_anchor->HitTest(CalcUnscrolledPosition(point),
2843                                                 this, flags, 0);
2844     if (hit == NULL)
2845     {
2846         flags = wxTREE_HITTEST_NOWHERE;
2847         return wxTreeItemId();
2848     }
2849     return hit;
2850 }
2851
2852 // get the bounding rectangle of the item (or of its label only)
2853 bool wxGenericTreeCtrl::GetBoundingRect(const wxTreeItemId& item,
2854                                         wxRect& rect,
2855                                         bool textOnly) const
2856 {
2857     wxCHECK_MSG( item.IsOk(), false, _T("invalid item in wxGenericTreeCtrl::GetBoundingRect") );
2858
2859     wxGenericTreeItem *i = (wxGenericTreeItem*) item.m_pItem;
2860
2861     if ( textOnly )
2862     {
2863         rect.x = i->GetX();
2864         rect.width = i->GetWidth();
2865
2866         if ( m_imageListNormal )
2867         {
2868             int image_w, image_h;
2869             m_imageListNormal->GetSize( 0, image_w, image_h );
2870             rect.width += image_w + MARGIN_BETWEEN_IMAGE_AND_TEXT;
2871         }
2872     }
2873     else // the entire line
2874     {
2875         rect.x = 0;
2876         rect.width = GetClientSize().x;
2877     }
2878
2879     rect.y = i->GetY();
2880     rect.height = GetLineHeight(i);
2881
2882     // we have to return the logical coordinates, not physical ones
2883     rect.SetTopLeft(CalcScrolledPosition(rect.GetTopLeft()));
2884
2885     return true;
2886 }
2887
2888 wxTextCtrl *wxGenericTreeCtrl::EditLabel(const wxTreeItemId& item,
2889                                   wxClassInfo * WXUNUSED(textCtrlClass))
2890 {
2891     wxCHECK_MSG( item.IsOk(), NULL, _T("can't edit an invalid item") );
2892
2893     wxGenericTreeItem *itemEdit = (wxGenericTreeItem *)item.m_pItem;
2894
2895     wxTreeEvent te(wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, this, itemEdit);
2896     if ( GetEventHandler()->ProcessEvent( te ) && !te.IsAllowed() )
2897     {
2898         // vetoed by user
2899         return NULL;
2900     }
2901
2902     // We have to call this here because the label in
2903     // question might just have been added and no screen
2904     // update taken place.
2905     if ( m_dirty )
2906 #if defined( __WXMSW__ ) || defined(__WXMAC__)
2907         Update();
2908 #else
2909         wxYieldIfNeeded();
2910 #endif
2911
2912     // TODO: use textCtrlClass here to create the control of correct class
2913     m_textCtrl = new wxTreeTextCtrl(this, itemEdit);
2914
2915     m_textCtrl->SetFocus();
2916
2917     return m_textCtrl;
2918 }
2919
2920 // returns a pointer to the text edit control if the item is being
2921 // edited, NULL otherwise (it's assumed that no more than one item may
2922 // be edited simultaneously)
2923 wxTextCtrl* wxGenericTreeCtrl::GetEditControl() const
2924 {
2925     return m_textCtrl;
2926 }
2927
2928 void wxGenericTreeCtrl::EndEditLabel(const wxTreeItemId& WXUNUSED(item),
2929                                      bool discardChanges)
2930 {
2931     wxCHECK_RET( m_textCtrl, _T("not editing label") );
2932
2933     m_textCtrl->EndEdit(discardChanges);
2934 }
2935
2936 bool wxGenericTreeCtrl::OnRenameAccept(wxGenericTreeItem *item,
2937                                        const wxString& value)
2938 {
2939     wxTreeEvent le(wxEVT_COMMAND_TREE_END_LABEL_EDIT, this, item);
2940     le.m_label = value;
2941     le.m_editCancelled = false;
2942
2943     return !GetEventHandler()->ProcessEvent( le ) || le.IsAllowed();
2944 }
2945
2946 void wxGenericTreeCtrl::OnRenameCancelled(wxGenericTreeItem *item)
2947 {
2948     // let owner know that the edit was cancelled
2949     wxTreeEvent le(wxEVT_COMMAND_TREE_END_LABEL_EDIT, this, item);
2950     le.m_label = wxEmptyString;
2951     le.m_editCancelled = true;
2952
2953     GetEventHandler()->ProcessEvent( le );
2954 }
2955
2956 void wxGenericTreeCtrl::OnRenameTimer()
2957 {
2958     EditLabel( m_current );
2959 }
2960
2961 void wxGenericTreeCtrl::OnMouse( wxMouseEvent &event )
2962 {
2963     if ( !m_anchor )return;
2964
2965     wxPoint pt = CalcUnscrolledPosition(event.GetPosition());
2966
2967     // Is the mouse over a tree item button?
2968     int flags = 0;
2969     wxGenericTreeItem *thisItem = m_anchor->HitTest(pt, this, flags, 0);
2970     wxGenericTreeItem *underMouse = thisItem;
2971 #if wxUSE_TOOLTIPS
2972     bool underMouseChanged = (underMouse != m_underMouse) ;
2973 #endif // wxUSE_TOOLTIPS
2974
2975     if ((underMouse) &&
2976         (flags & wxTREE_HITTEST_ONITEMBUTTON) &&
2977         (!event.LeftIsDown()) &&
2978         (!m_isDragging) &&
2979         (!m_renameTimer || !m_renameTimer->IsRunning()))
2980     {
2981     }
2982     else
2983     {
2984         underMouse = NULL;
2985     }
2986
2987     if (underMouse != m_underMouse)
2988     {
2989          if (m_underMouse)
2990          {
2991             // unhighlight old item
2992             wxGenericTreeItem *tmp = m_underMouse;
2993             m_underMouse = NULL;
2994             RefreshLine( tmp );
2995          }
2996
2997          m_underMouse = underMouse;
2998          if (m_underMouse)
2999             RefreshLine( m_underMouse );
3000     }
3001
3002 #if wxUSE_TOOLTIPS
3003     // Determines what item we are hovering over and need a tooltip for
3004     wxTreeItemId hoverItem = thisItem;
3005
3006     // We do not want a tooltip if we are dragging, or if the rename timer is running
3007     if (underMouseChanged && hoverItem.IsOk() && !m_isDragging && (!m_renameTimer || !m_renameTimer->IsRunning()))
3008     {
3009         // Ask the tree control what tooltip (if any) should be shown
3010         wxTreeEvent hevent(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP,  this, hoverItem);
3011
3012         if ( GetEventHandler()->ProcessEvent(hevent) && hevent.IsAllowed() )
3013         {
3014             SetToolTip(hevent.m_label);
3015         }
3016     }
3017 #endif
3018
3019     // we process left mouse up event (enables in-place edit), right down
3020     // (pass to the user code), left dbl click (activate item) and
3021     // dragging/moving events for items drag-and-drop
3022     if ( !(event.LeftDown() ||
3023            event.LeftUp() ||
3024            event.RightDown() ||
3025            event.LeftDClick() ||
3026            event.Dragging() ||
3027            ((event.Moving() || event.RightUp()) && m_isDragging)) )
3028     {
3029         event.Skip();
3030
3031         return;
3032     }
3033
3034
3035     flags = 0;
3036     wxGenericTreeItem *item = m_anchor->HitTest(pt, this, flags, 0);
3037
3038     if ( event.Dragging() && !m_isDragging )
3039     {
3040         if (m_dragCount == 0)
3041             m_dragStart = pt;
3042
3043         m_dragCount++;
3044
3045         if (m_dragCount != 3)
3046         {
3047             // wait until user drags a bit further...
3048             return;
3049         }
3050
3051         wxEventType command = event.RightIsDown()
3052                               ? wxEVT_COMMAND_TREE_BEGIN_RDRAG
3053                               : wxEVT_COMMAND_TREE_BEGIN_DRAG;
3054
3055         wxTreeEvent nevent(command,  this, m_current);
3056         nevent.SetPoint(CalcScrolledPosition(pt));
3057
3058         // by default the dragging is not supported, the user code must
3059         // explicitly allow the event for it to take place
3060         nevent.Veto();
3061
3062         if ( GetEventHandler()->ProcessEvent(nevent) && nevent.IsAllowed() )
3063         {
3064             // we're going to drag this item
3065             m_isDragging = true;
3066
3067             // remember the old cursor because we will change it while
3068             // dragging
3069             m_oldCursor = m_cursor;
3070
3071             // in a single selection control, hide the selection temporarily
3072             if ( !(GetWindowStyleFlag() & wxTR_MULTIPLE) )
3073             {
3074                 m_oldSelection = (wxGenericTreeItem*) GetSelection().m_pItem;
3075
3076                 if ( m_oldSelection )
3077                 {
3078                     m_oldSelection->SetHilight(false);
3079                     RefreshLine(m_oldSelection);
3080                 }
3081             }
3082
3083             CaptureMouse();
3084         }
3085     }
3086     else if ( event.Dragging() )
3087     {
3088         if ( item != m_dropTarget )
3089         {
3090             // unhighlight the previous drop target
3091             DrawDropEffect(m_dropTarget);
3092
3093             m_dropTarget = item;
3094
3095             // highlight the current drop target if any
3096             DrawDropEffect(m_dropTarget);
3097
3098 #if defined(__WXMSW__) || defined(__WXMAC__) || defined(__WXGTK20__)
3099             Update();
3100 #else
3101             wxYieldIfNeeded();
3102 #endif
3103         }
3104     }
3105     else if ( (event.LeftUp() || event.RightUp()) && m_isDragging )
3106     {
3107         ReleaseMouse();
3108
3109         // erase the highlighting
3110         DrawDropEffect(m_dropTarget);
3111
3112         if ( m_oldSelection )
3113         {
3114             m_oldSelection->SetHilight(true);
3115             RefreshLine(m_oldSelection);
3116             m_oldSelection = (wxGenericTreeItem *)NULL;
3117         }
3118
3119         // generate the drag end event
3120         wxTreeEvent eventEndDrag(wxEVT_COMMAND_TREE_END_DRAG,  this, item);
3121
3122         eventEndDrag.m_pointDrag = CalcScrolledPosition(pt);
3123
3124         (void)GetEventHandler()->ProcessEvent(eventEndDrag);
3125
3126         m_isDragging = false;
3127         m_dropTarget = (wxGenericTreeItem *)NULL;
3128
3129         SetCursor(m_oldCursor);
3130
3131 #if defined( __WXMSW__ ) || defined(__WXMAC__)
3132         Update();
3133 #else
3134         wxYieldIfNeeded();
3135 #endif
3136     }
3137     else
3138     {
3139         // If we got to this point, we are not dragging or moving the mouse.
3140         // Because the code in carbon/toplevel.cpp will only set focus to the tree
3141         // if we skip for EVT_LEFT_DOWN, we MUST skip this event here for focus to work.
3142         // We skip even if we didn't hit an item because we still should
3143         // restore focus to the tree control even if we didn't exactly hit an item.
3144         if ( event.LeftDown() )
3145         {
3146             event.Skip();
3147         }
3148
3149         // here we process only the messages which happen on tree items
3150
3151         m_dragCount = 0;
3152
3153         if (item == NULL) return;  /* we hit the blank area */
3154
3155         if ( event.RightDown() )
3156         {
3157             // If the item is already selected, do not update the selection.
3158             // Multi-selections should not be cleared if a selected item is clicked.
3159             if (!IsSelected(item))
3160             {
3161                 DoSelectItem(item, true, false);
3162             }
3163
3164             wxTreeEvent nevent(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK,  this, item);
3165             nevent.m_pointDrag = CalcScrolledPosition(pt);
3166             event.Skip(!GetEventHandler()->ProcessEvent(nevent));
3167
3168             // Consistent with MSW (for now), send the ITEM_MENU *after*
3169             // the RIGHT_CLICK event. TODO: This behavior may change.
3170             wxTreeEvent nevent2(wxEVT_COMMAND_TREE_ITEM_MENU,  this, item);
3171             nevent2.m_pointDrag = CalcScrolledPosition(pt);
3172             GetEventHandler()->ProcessEvent(nevent2);
3173         }
3174         else if ( event.LeftUp() )
3175         {
3176             // this facilitates multiple-item drag-and-drop
3177
3178             if ( /* item && */ HasFlag(wxTR_MULTIPLE))
3179             {
3180                 wxArrayTreeItemIds selections;
3181                 size_t count = GetSelections(selections);
3182
3183                 if (count > 1 &&
3184                     !event.CmdDown() &&
3185                     !event.ShiftDown())
3186                 {
3187                     DoSelectItem(item, true, false);
3188                 }
3189             }
3190
3191             if ( m_lastOnSame )
3192             {
3193                 if ( (item == m_current) &&
3194                      (flags & wxTREE_HITTEST_ONITEMLABEL) &&
3195                      HasFlag(wxTR_EDIT_LABELS) )
3196                 {
3197                     if ( m_renameTimer )
3198                     {
3199                         if ( m_renameTimer->IsRunning() )
3200                             m_renameTimer->Stop();
3201                     }
3202                     else
3203                     {
3204                         m_renameTimer = new wxTreeRenameTimer( this );
3205                     }
3206
3207                     m_renameTimer->Start( wxTreeRenameTimer::DELAY, true );
3208                 }
3209
3210                 m_lastOnSame = false;
3211             }
3212         }
3213         else // !RightDown() && !LeftUp() ==> LeftDown() || LeftDClick()
3214         {
3215             if ( event.LeftDown() )
3216             {
3217                 m_lastOnSame = item == m_current;
3218             }
3219
3220             if ( flags & wxTREE_HITTEST_ONITEMBUTTON )
3221             {
3222                 // only toggle the item for a single click, double click on
3223                 // the button doesn't do anything (it toggles the item twice)
3224                 if ( event.LeftDown() )
3225                 {
3226                     Toggle( item );
3227                 }
3228
3229                 // don't select the item if the button was clicked
3230                 return;
3231             }
3232
3233
3234             // clear the previously selected items, if the
3235             // user clicked outside of the present selection.
3236             // otherwise, perform the deselection on mouse-up.
3237             // this allows multiple drag and drop to work.
3238             // but if Cmd is down, toggle selection of the clicked item
3239             if (!IsSelected(item) || event.CmdDown())
3240             {
3241                 // how should the selection work for this event?
3242                 bool is_multiple, extended_select, unselect_others;
3243                 EventFlagsToSelType(GetWindowStyleFlag(),
3244                                     event.ShiftDown(),
3245                                     event.CmdDown(),
3246                                     is_multiple, extended_select, unselect_others);
3247
3248                 DoSelectItem(item, unselect_others, extended_select);
3249             }
3250
3251
3252             // For some reason, Windows isn't recognizing a left double-click,
3253             // so we need to simulate it here.  Allow 200 milliseconds for now.
3254             if ( event.LeftDClick() )
3255             {
3256                 // double clicking should not start editing the item label
3257                 if ( m_renameTimer )
3258                     m_renameTimer->Stop();
3259
3260                 m_lastOnSame = false;
3261
3262                 // send activate event first
3263                 wxTreeEvent nevent(wxEVT_COMMAND_TREE_ITEM_ACTIVATED,  this, item);
3264                 nevent.m_pointDrag = CalcScrolledPosition(pt);
3265                 if ( !GetEventHandler()->ProcessEvent( nevent ) )
3266                 {
3267                     // if the user code didn't process the activate event,
3268                     // handle it ourselves by toggling the item when it is
3269                     // double clicked
3270                     if ( item->HasPlus() )
3271                     {
3272                         Toggle(item);
3273                     }
3274                 }
3275             }
3276         }
3277     }
3278 }
3279
3280 void wxGenericTreeCtrl::OnInternalIdle()
3281 {
3282     wxWindow::OnInternalIdle();
3283
3284     // Check if we need to select the root item
3285     // because nothing else has been selected.
3286     // Delaying it means that we can invoke event handlers
3287     // as required, when a first item is selected.
3288     if (!HasFlag(wxTR_MULTIPLE) && !GetSelection().IsOk())
3289     {
3290         if (m_select_me)
3291             SelectItem(m_select_me);
3292         else if (GetRootItem().IsOk())
3293             SelectItem(GetRootItem());
3294     }
3295
3296     /* after all changes have been done to the tree control,
3297      * we actually redraw the tree when everything is over */
3298
3299     if (!m_dirty) return;
3300     if (m_freezeCount) return;
3301
3302     m_dirty = false;
3303
3304     CalculatePositions();
3305     Refresh();
3306     AdjustMyScrollbars();
3307 }
3308
3309 void wxGenericTreeCtrl::CalculateSize( wxGenericTreeItem *item, wxDC &dc )
3310 {
3311     wxCoord text_w = 0;
3312     wxCoord text_h = 0;
3313
3314     wxTreeItemAttr *attr = item->GetAttributes();
3315     if ( attr && attr->HasFont() )
3316         dc.SetFont(attr->GetFont());
3317     else if ( item->IsBold() )
3318         dc.SetFont(m_boldFont);
3319     else
3320         dc.SetFont(m_normalFont);
3321
3322     dc.GetTextExtent( item->GetText(), &text_w, &text_h );
3323     text_h+=2;
3324
3325     // restore normal font
3326     dc.SetFont( m_normalFont );
3327
3328     int image_h = 0;
3329     int image_w = 0;
3330     int image = item->GetCurrentImage();
3331     if ( image != NO_IMAGE )
3332     {
3333         if ( m_imageListNormal )
3334         {
3335             m_imageListNormal->GetSize( image, image_w, image_h );
3336             image_w += MARGIN_BETWEEN_IMAGE_AND_TEXT;
3337         }
3338     }
3339
3340     int total_h = (image_h > text_h) ? image_h : text_h;
3341
3342     if (total_h < 30)
3343         total_h += 2;            // at least 2 pixels
3344     else
3345         total_h += total_h/10;   // otherwise 10% extra spacing
3346
3347     item->SetHeight(total_h);
3348     if (total_h>m_lineHeight)
3349         m_lineHeight=total_h;
3350
3351     item->SetWidth(image_w+text_w+2);
3352 }
3353
3354 // -----------------------------------------------------------------------------
3355 // for developper : y is now the top of the level
3356 // not the middle of it !
3357 void wxGenericTreeCtrl::CalculateLevel( wxGenericTreeItem *item, wxDC &dc, int level, int &y )
3358 {
3359     int x = level*m_indent;
3360     if (!HasFlag(wxTR_HIDE_ROOT))
3361     {
3362         x += m_indent;
3363     }
3364     else if (level == 0)
3365     {
3366         // a hidden root is not evaluated, but its
3367         // children are always calculated
3368         goto Recurse;
3369     }
3370
3371     CalculateSize( item, dc );
3372
3373     // set its position
3374     item->SetX( x+m_spacing );
3375     item->SetY( y );
3376     y += GetLineHeight(item);
3377
3378     if ( !item->IsExpanded() )
3379     {
3380         // we don't need to calculate collapsed branches
3381         return;
3382     }
3383
3384   Recurse:
3385     wxArrayGenericTreeItems& children = item->GetChildren();
3386     size_t n, count = children.Count();
3387     ++level;
3388     for (n = 0; n < count; ++n )
3389         CalculateLevel( children[n], dc, level, y );  // recurse
3390 }
3391
3392 void wxGenericTreeCtrl::CalculatePositions()
3393 {
3394     if ( !m_anchor ) return;
3395
3396     wxClientDC dc(this);
3397     PrepareDC( dc );
3398
3399     dc.SetFont( m_normalFont );
3400
3401     dc.SetPen( m_dottedPen );
3402     //if(GetImageList() == NULL)
3403     // m_lineHeight = (int)(dc.GetCharHeight() + 4);
3404
3405     int y = 2;
3406     CalculateLevel( m_anchor, dc, 0, y ); // start recursion
3407 }
3408
3409 void wxGenericTreeCtrl::RefreshSubtree(wxGenericTreeItem *item)
3410 {
3411     if (m_dirty) return;
3412     if (m_freezeCount) return;
3413
3414     wxSize client = GetClientSize();
3415
3416     wxRect rect;
3417     CalcScrolledPosition(0, item->GetY(), NULL, &rect.y);
3418     rect.width = client.x;
3419     rect.height = client.y;
3420
3421     Refresh(true, &rect);
3422
3423     AdjustMyScrollbars();
3424 }
3425
3426 void wxGenericTreeCtrl::RefreshLine( wxGenericTreeItem *item )
3427 {
3428     if (m_dirty) return;
3429     if (m_freezeCount) return;
3430
3431     wxRect rect;
3432     CalcScrolledPosition(0, item->GetY(), NULL, &rect.y);
3433     rect.width = GetClientSize().x;
3434     rect.height = GetLineHeight(item); //dc.GetCharHeight() + 6;
3435
3436     Refresh(true, &rect);
3437 }
3438
3439 void wxGenericTreeCtrl::RefreshSelected()
3440 {
3441     if (m_freezeCount) return;
3442
3443     // TODO: this is awfully inefficient, we should keep the list of all
3444     //       selected items internally, should be much faster
3445     if ( m_anchor )
3446         RefreshSelectedUnder(m_anchor);
3447 }
3448
3449 void wxGenericTreeCtrl::RefreshSelectedUnder(wxGenericTreeItem *item)
3450 {
3451     if (m_freezeCount) return;
3452
3453     if ( item->IsSelected() )
3454         RefreshLine(item);
3455
3456     const wxArrayGenericTreeItems& children = item->GetChildren();
3457     size_t count = children.GetCount();
3458     for ( size_t n = 0; n < count; n++ )
3459     {
3460         RefreshSelectedUnder(children[n]);
3461     }
3462 }
3463
3464 void wxGenericTreeCtrl::Freeze()
3465 {
3466     m_freezeCount++;
3467 }
3468
3469 void wxGenericTreeCtrl::Thaw()
3470 {
3471     wxCHECK_RET( m_freezeCount > 0, _T("thawing unfrozen tree control?") );
3472
3473     if ( --m_freezeCount == 0 )
3474     {
3475         Refresh();
3476     }
3477 }
3478
3479 // ----------------------------------------------------------------------------
3480 // changing colours: we need to refresh the tree control
3481 // ----------------------------------------------------------------------------
3482
3483 bool wxGenericTreeCtrl::SetBackgroundColour(const wxColour& colour)
3484 {
3485     if ( !wxWindow::SetBackgroundColour(colour) )
3486         return false;
3487
3488     if (m_freezeCount) return true;
3489
3490     Refresh();
3491
3492     return true;
3493 }
3494
3495 bool wxGenericTreeCtrl::SetForegroundColour(const wxColour& colour)
3496 {
3497     if ( !wxWindow::SetForegroundColour(colour) )
3498         return false;
3499
3500     if (m_freezeCount) return true;
3501
3502     Refresh();
3503
3504     return true;
3505 }
3506
3507 // Process the tooltip event, to speed up event processing.
3508 // Doesn't actually get a tooltip.
3509 void wxGenericTreeCtrl::OnGetToolTip( wxTreeEvent &event )
3510 {
3511     event.Veto();
3512 }
3513
3514
3515 // NOTE: If using the wxListBox visual attributes works everywhere then this can
3516 // be removed, as well as the #else case below.
3517 #define _USE_VISATTR 0
3518
3519 //static
3520 wxVisualAttributes
3521 #if _USE_VISATTR
3522 wxGenericTreeCtrl::GetClassDefaultAttributes(wxWindowVariant variant)
3523 #else
3524 wxGenericTreeCtrl::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
3525 #endif
3526 {
3527 #if _USE_VISATTR
3528     // Use the same color scheme as wxListBox
3529     return wxListBox::GetClassDefaultAttributes(variant);
3530 #else
3531     wxVisualAttributes attr;
3532     attr.colFg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT);
3533     attr.colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_LISTBOX);
3534     attr.font  = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
3535     return attr;
3536 #endif
3537 }
3538
3539 #if WXWIN_COMPATIBILITY_2_4
3540
3541 int wxGenericTreeCtrl::GetItemSelectedImage(const wxTreeItemId& item) const
3542 {
3543     return GetItemImage(item, wxTreeItemIcon_Selected);
3544 }
3545
3546 void wxGenericTreeCtrl::SetItemSelectedImage(const wxTreeItemId& item, int image)
3547 {
3548     SetItemImage(item, image, wxTreeItemIcon_Selected);
3549 }
3550
3551 #endif // WXWIN_COMPATIBILITY_2_4
3552
3553 #endif // wxUSE_TREECTRL