src/generic/treectlg.cpp

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