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