]> git.saurik.com Git - wxWidgets.git/blame_incremental - src/generic/treectrl.cpp
Tidied some doc references; added Stefan's Blit optimisation
[wxWidgets.git] / src / generic / treectrl.cpp
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: treectrl.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 "treectrl.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#include "wx/treectrl.h"
32#include "wx/generic/imaglist.h"
33#include "wx/settings.h"
34#include "wx/log.h"
35#include "wx/intl.h"
36#include "wx/dynarray.h"
37#include "wx/arrimpl.cpp"
38#include "wx/dcclient.h"
39#include "wx/msgdlg.h"
40
41// -----------------------------------------------------------------------------
42// array types
43// -----------------------------------------------------------------------------
44
45class WXDLLEXPORT wxGenericTreeItem;
46
47WX_DEFINE_ARRAY(wxGenericTreeItem *, wxArrayGenericTreeItems);
48WX_DEFINE_OBJARRAY(wxArrayTreeItemIds);
49
50// ----------------------------------------------------------------------------
51// constants
52// ----------------------------------------------------------------------------
53
54static const int NO_IMAGE = -1;
55
56// -----------------------------------------------------------------------------
57// private classes
58// -----------------------------------------------------------------------------
59
60// a tree item
61class WXDLLEXPORT wxGenericTreeItem
62{
63public:
64 // ctors & dtor
65 wxGenericTreeItem() { m_data = NULL; }
66 wxGenericTreeItem( wxGenericTreeItem *parent,
67 const wxString& text,
68 wxDC& dc,
69 int image, int selImage,
70 wxTreeItemData *data );
71
72 ~wxGenericTreeItem();
73
74 // trivial accessors
75 wxArrayGenericTreeItems& GetChildren() { return m_children; }
76
77 const wxString& GetText() const { return m_text; }
78 int GetImage(wxTreeItemIcon which = wxTreeItemIcon_Normal) const
79 { return m_images[which]; }
80 wxTreeItemData *GetData() const { return m_data; }
81
82 // returns the current image for the item (depending on its
83 // selected/expanded/whatever state)
84 int GetCurrentImage() const;
85
86 void SetText( const wxString &text );
87 void SetImage(int image, wxTreeItemIcon which) { m_images[which] = image; }
88 void SetData(wxTreeItemData *data) { m_data = data; }
89
90 void SetHasPlus(bool has = TRUE) { m_hasPlus = has; }
91
92 void SetBold(bool bold) { m_isBold = bold; }
93
94 int GetX() const { return m_x; }
95 int GetY() const { return m_y; }
96
97 void SetX(int x) { m_x = x; }
98 void SetY(int y) { m_y = y; }
99
100 int GetHeight() const { return m_height; }
101 int GetWidth() const { return m_width; }
102
103 void SetHeight(int h) { m_height = h; }
104 void SetWidth(int w) { m_width = w; }
105
106
107 wxGenericTreeItem *GetParent() const { return m_parent; }
108
109 // operations
110 // deletes all children notifying the treectrl about it if !NULL
111 // pointer given
112 void DeleteChildren(wxTreeCtrl *tree = NULL);
113 // FIXME don't know what is it for
114 void Reset();
115
116 // get count of all children (and grand children if 'recursively')
117 size_t GetChildrenCount(bool recursively = TRUE) const;
118
119 void Insert(wxGenericTreeItem *child, size_t index)
120 { m_children.Insert(child, index); }
121
122 void SetCross( int x, int y );
123 void GetSize( int &x, int &y, const wxTreeCtrl* );
124
125 // return the item at given position (or NULL if no item), onButton is
126 // TRUE if the point belongs to the item's button, otherwise it lies
127 // on the button's label
128 wxGenericTreeItem *HitTest( const wxPoint& point, const wxTreeCtrl *, int &flags);
129
130 void Expand() { m_isCollapsed = FALSE; }
131 void Collapse() { m_isCollapsed = TRUE; }
132
133 void SetHilight( bool set = TRUE ) { m_hasHilight = set; }
134
135 // status inquiries
136 bool HasChildren() const { return !m_children.IsEmpty(); }
137 bool IsSelected() const { return m_hasHilight; }
138 bool IsExpanded() const { return !m_isCollapsed; }
139 bool HasPlus() const { return m_hasPlus || HasChildren(); }
140 bool IsBold() const { return m_isBold; }
141
142 // attributes
143 // get them - may be NULL
144 wxTreeItemAttr *GetAttributes() const { return m_attr; }
145 // get them ensuring that the pointer is not NULL
146 wxTreeItemAttr& Attr()
147 {
148 if ( !m_attr )
149 m_attr = new wxTreeItemAttr;
150
151 return *m_attr;
152 }
153
154private:
155 wxString m_text;
156
157 // tree ctrl images for the normal, selected, expanded and
158 // expanded+selected states
159 int m_images[wxTreeItemIcon_Max];
160
161 wxTreeItemData *m_data;
162
163 // use bitfields to save size
164 int m_isCollapsed :1;
165 int m_hasHilight :1; // same as focused
166 int m_hasPlus :1; // used for item which doesn't have
167 // children but has a [+] button
168 int m_isBold :1; // render the label in bold font
169
170 int m_x, m_y;
171 long m_height, m_width;
172 int m_xCross, m_yCross;
173 int m_level;
174
175 wxArrayGenericTreeItems m_children;
176 wxGenericTreeItem *m_parent;
177
178 wxTreeItemAttr *m_attr;
179};
180
181// =============================================================================
182// implementation
183// =============================================================================
184
185
186// -----------------------------------------------------------------------------
187// wxTreeRenameTimer (internal)
188// -----------------------------------------------------------------------------
189
190wxTreeRenameTimer::wxTreeRenameTimer( wxTreeCtrl *owner )
191{
192 m_owner = owner;
193}
194
195void wxTreeRenameTimer::Notify()
196{
197 m_owner->OnRenameTimer();
198}
199
200//-----------------------------------------------------------------------------
201// wxTreeTextCtrl (internal)
202//-----------------------------------------------------------------------------
203
204IMPLEMENT_DYNAMIC_CLASS(wxTreeTextCtrl,wxTextCtrl);
205
206BEGIN_EVENT_TABLE(wxTreeTextCtrl,wxTextCtrl)
207 EVT_CHAR (wxTreeTextCtrl::OnChar)
208 EVT_KILL_FOCUS (wxTreeTextCtrl::OnKillFocus)
209END_EVENT_TABLE()
210
211wxTreeTextCtrl::wxTreeTextCtrl( wxWindow *parent, const wxWindowID id,
212 bool *accept, wxString *res, wxTreeCtrl *owner,
213 const wxString &value, const wxPoint &pos, const wxSize &size,
214#if wxUSE_VALIDATORS
215 int style, const wxValidator& validator, const wxString &name ) :
216#endif
217 wxTextCtrl( parent, id, value, pos, size, style, validator, name )
218{
219 m_res = res;
220 m_accept = accept;
221 m_owner = owner;
222 (*m_accept) = FALSE;
223 (*m_res) = "";
224 m_startValue = value;
225}
226
227void wxTreeTextCtrl::OnChar( wxKeyEvent &event )
228{
229 if (event.m_keyCode == WXK_RETURN)
230 {
231 (*m_accept) = TRUE;
232 (*m_res) = GetValue();
233 m_owner->SetFocus();
234 return;
235 }
236 if (event.m_keyCode == WXK_ESCAPE)
237 {
238 (*m_accept) = FALSE;
239 (*m_res) = "";
240 m_owner->SetFocus();
241 return;
242 }
243 event.Skip();
244}
245
246void wxTreeTextCtrl::OnKillFocus( wxFocusEvent &WXUNUSED(event) )
247{
248 if (wxPendingDelete.Member(this)) return;
249
250 wxPendingDelete.Append(this);
251
252 if ((*m_accept) && ((*m_res) != m_startValue))
253 m_owner->OnRenameAccept();
254}
255
256#define PIXELS_PER_UNIT 10
257// -----------------------------------------------------------------------------
258// wxTreeEvent
259// -----------------------------------------------------------------------------
260
261IMPLEMENT_DYNAMIC_CLASS(wxTreeEvent, wxNotifyEvent)
262
263wxTreeEvent::wxTreeEvent( wxEventType commandType, int id )
264 : wxNotifyEvent( commandType, id )
265{
266 m_code = 0;
267 m_itemOld = (wxGenericTreeItem *)NULL;
268}
269
270// -----------------------------------------------------------------------------
271// wxGenericTreeItem
272// -----------------------------------------------------------------------------
273
274wxGenericTreeItem::wxGenericTreeItem(wxGenericTreeItem *parent,
275 const wxString& text,
276 wxDC& WXUNUSED(dc),
277 int image, int selImage,
278 wxTreeItemData *data)
279 : m_text(text)
280{
281 m_images[wxTreeItemIcon_Normal] = image;
282 m_images[wxTreeItemIcon_Selected] = selImage;
283 m_images[wxTreeItemIcon_Expanded] = NO_IMAGE;
284 m_images[wxTreeItemIcon_SelectedExpanded] = NO_IMAGE;
285
286 m_data = data;
287 m_x = m_y = 0;
288 m_xCross = m_yCross = 0;
289
290 m_level = 0;
291
292 m_isCollapsed = TRUE;
293 m_hasHilight = FALSE;
294 m_hasPlus = FALSE;
295 m_isBold = FALSE;
296
297 m_parent = parent;
298
299 m_attr = (wxTreeItemAttr *)NULL;
300
301 // We don't know the height here yet.
302 m_width = 0;
303 m_height = 0;
304}
305
306wxGenericTreeItem::~wxGenericTreeItem()
307{
308 delete m_data;
309
310 delete m_attr;
311
312 wxASSERT_MSG( m_children.IsEmpty(),
313 wxT("please call DeleteChildren() before deleting the item") );
314}
315
316void wxGenericTreeItem::DeleteChildren(wxTreeCtrl *tree)
317{
318 size_t count = m_children.Count();
319 for ( size_t n = 0; n < count; n++ )
320 {
321 wxGenericTreeItem *child = m_children[n];
322 if (tree)
323 tree->SendDeleteEvent(child);
324
325 child->DeleteChildren(tree);
326 delete child;
327 }
328
329 m_children.Empty();
330}
331
332void wxGenericTreeItem::SetText( const wxString &text )
333{
334 m_text = text;
335}
336
337void wxGenericTreeItem::Reset()
338{
339 m_text.Empty();
340 for ( int i = 0; i < wxTreeItemIcon_Max; i++ )
341 {
342 m_images[i] = NO_IMAGE;
343 }
344
345 m_data = NULL;
346 m_x = m_y =
347 m_height = m_width = 0;
348 m_xCross =
349 m_yCross = 0;
350
351 m_level = 0;
352
353 DeleteChildren();
354 m_isCollapsed = TRUE;
355
356 m_parent = (wxGenericTreeItem *)NULL;
357}
358
359size_t wxGenericTreeItem::GetChildrenCount(bool recursively) const
360{
361 size_t count = m_children.Count();
362 if ( !recursively )
363 return count;
364
365 size_t total = count;
366 for (size_t n = 0; n < count; ++n)
367 {
368 total += m_children[n]->GetChildrenCount();
369 }
370
371 return total;
372}
373
374void wxGenericTreeItem::SetCross( int x, int y )
375{
376 m_xCross = x;
377 m_yCross = y;
378}
379
380void wxGenericTreeItem::GetSize( int &x, int &y, const wxTreeCtrl *theTree )
381{
382 int bottomY=m_y+theTree->GetLineHeight(this);
383 if ( y < bottomY ) y = bottomY;
384 int width = m_x + m_width;
385 if ( x < width ) x = width;
386
387 if (IsExpanded())
388 {
389 size_t count = m_children.Count();
390 for ( size_t n = 0; n < count; ++n )
391 {
392 m_children[n]->GetSize( x, y, theTree );
393 }
394 }
395}
396
397wxGenericTreeItem *wxGenericTreeItem::HitTest( const wxPoint& point,
398 const wxTreeCtrl *theTree,
399 int &flags)
400{
401 if ((point.y > m_y) && (point.y < m_y + theTree->GetLineHeight(this)))
402 {
403 if (point.y<m_y+theTree->GetLineHeight(this)/2)
404 flags |= wxTREE_HITTEST_ONITEMUPPERPART;
405 else
406 flags |= wxTREE_HITTEST_ONITEMLOWERPART;
407
408 // 5 is the size of the plus sign
409 if ((point.x > m_xCross-5) && (point.x < m_xCross+5) &&
410 (point.y > m_yCross-5) && (point.y < m_yCross+5) &&
411 (IsExpanded() || HasPlus()))
412 {
413 flags|=wxTREE_HITTEST_ONITEMBUTTON;
414 return this;
415 }
416
417 if ((point.x >= m_x) && (point.x <= m_x+m_width))
418 {
419 int image_w = -1;
420 int image_h;
421
422 // assuming every image (normal and selected ) has the same size !
423 if ( (GetImage() != NO_IMAGE) && theTree->m_imageListNormal )
424 theTree->m_imageListNormal->GetSize(GetImage(), image_w, image_h);
425
426 if ((image_w != -1) && (point.x <= m_x + image_w + 1))
427 flags |= wxTREE_HITTEST_ONITEMICON;
428 else
429 flags |= wxTREE_HITTEST_ONITEMLABEL;
430
431 return this;
432 }
433
434 if (point.x < m_x)
435 flags |= wxTREE_HITTEST_ONITEMINDENT;
436 if (point.x > m_x+m_width)
437 flags |= wxTREE_HITTEST_ONITEMRIGHT;
438
439 return this;
440 }
441 else
442 {
443 if (!m_isCollapsed)
444 {
445 size_t count = m_children.Count();
446 for ( size_t n = 0; n < count; n++ )
447 {
448 wxGenericTreeItem *res = m_children[n]->HitTest( point, theTree, flags );
449 if ( res != NULL )
450 return res;
451 }
452 }
453 }
454
455 flags|=wxTREE_HITTEST_NOWHERE;
456
457 return (wxGenericTreeItem*) NULL;
458}
459
460int wxGenericTreeItem::GetCurrentImage() const
461{
462 int image = NO_IMAGE;
463 if ( IsExpanded() )
464 {
465 if ( IsSelected() )
466 {
467 image = GetImage(wxTreeItemIcon_SelectedExpanded);
468 }
469
470 if ( image == NO_IMAGE )
471 {
472 // we usually fall back to the normal item, but try just the
473 // expanded one (and not selected) first in this case
474 image = GetImage(wxTreeItemIcon_Expanded);
475 }
476 }
477 else // not expanded
478 {
479 if ( IsSelected() )
480 image = GetImage(wxTreeItemIcon_Selected);
481 }
482
483 // may be it doesn't have the specific image we want, try the default one
484 // instead
485 if ( image == NO_IMAGE )
486 {
487 image = GetImage();
488 }
489
490 return image;
491}
492
493// -----------------------------------------------------------------------------
494// wxTreeCtrl implementation
495// -----------------------------------------------------------------------------
496
497IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl, wxScrolledWindow)
498
499BEGIN_EVENT_TABLE(wxTreeCtrl,wxScrolledWindow)
500 EVT_PAINT (wxTreeCtrl::OnPaint)
501 EVT_MOUSE_EVENTS (wxTreeCtrl::OnMouse)
502 EVT_CHAR (wxTreeCtrl::OnChar)
503 EVT_SET_FOCUS (wxTreeCtrl::OnSetFocus)
504 EVT_KILL_FOCUS (wxTreeCtrl::OnKillFocus)
505 EVT_IDLE (wxTreeCtrl::OnIdle)
506END_EVENT_TABLE()
507
508// -----------------------------------------------------------------------------
509// construction/destruction
510// -----------------------------------------------------------------------------
511
512void wxTreeCtrl::Init()
513{
514 m_current =
515 m_key_current =
516 m_anchor = (wxGenericTreeItem *) NULL;
517 m_hasFocus = FALSE;
518 m_dirty = FALSE;
519
520 m_xScroll = 0;
521 m_yScroll = 0;
522 m_lineHeight = 10;
523 m_indent = 15;
524 m_spacing = 18;
525
526 m_hilightBrush = new wxBrush
527 (
528 wxSystemSettings::GetSystemColour(wxSYS_COLOUR_HIGHLIGHT),
529 wxSOLID
530 );
531
532 m_imageListNormal =
533 m_imageListState = (wxImageList *) NULL;
534
535 m_dragCount = 0;
536
537 m_renameTimer = new wxTreeRenameTimer( this );
538
539 m_normalFont = wxSystemSettings::GetSystemFont( wxSYS_DEFAULT_GUI_FONT );
540 m_boldFont = wxFont( m_normalFont.GetPointSize(),
541 m_normalFont.GetFamily(),
542 m_normalFont.GetStyle(),
543 wxBOLD,
544 m_normalFont.GetUnderlined());
545}
546
547bool wxTreeCtrl::Create(wxWindow *parent, wxWindowID id,
548 const wxPoint& pos, const wxSize& size,
549 long style,
550#if wxUSE_VALIDATORS
551 const wxValidator &validator,
552#endif
553 const wxString& name )
554{
555 Init();
556
557 wxScrolledWindow::Create( parent, id, pos, size, style|wxHSCROLL|wxVSCROLL, name );
558
559#if wxUSE_VALIDATORS
560 SetValidator( validator );
561#endif
562
563 SetBackgroundColour( *wxWHITE );
564// m_dottedPen = wxPen( "grey", 0, wxDOT ); too slow under XFree86
565 m_dottedPen = wxPen( "grey", 0, 0 );
566
567 return TRUE;
568}
569
570wxTreeCtrl::~wxTreeCtrl()
571{
572 wxDELETE( m_hilightBrush );
573
574 DeleteAllItems();
575
576 delete m_renameTimer;
577}
578
579// -----------------------------------------------------------------------------
580// accessors
581// -----------------------------------------------------------------------------
582
583size_t wxTreeCtrl::GetCount() const
584{
585 return m_anchor == NULL ? 0u : m_anchor->GetChildrenCount();
586}
587
588void wxTreeCtrl::SetIndent(unsigned int indent)
589{
590 m_indent = indent;
591 m_dirty = TRUE;
592 Refresh();
593}
594
595void wxTreeCtrl::SetSpacing(unsigned int spacing)
596{
597 m_spacing = spacing;
598 m_dirty = TRUE;
599 Refresh();
600}
601
602size_t wxTreeCtrl::GetChildrenCount(const wxTreeItemId& item, bool recursively)
603{
604 wxCHECK_MSG( item.IsOk(), 0u, wxT("invalid tree item") );
605
606 return item.m_pItem->GetChildrenCount(recursively);
607}
608
609// -----------------------------------------------------------------------------
610// functions to work with tree items
611// -----------------------------------------------------------------------------
612
613wxString wxTreeCtrl::GetItemText(const wxTreeItemId& item) const
614{
615 wxCHECK_MSG( item.IsOk(), wxT(""), wxT("invalid tree item") );
616
617 return item.m_pItem->GetText();
618}
619
620int wxTreeCtrl::GetItemImage(const wxTreeItemId& item,
621 wxTreeItemIcon which) const
622{
623 wxCHECK_MSG( item.IsOk(), -1, wxT("invalid tree item") );
624
625 return item.m_pItem->GetImage(which);
626}
627
628wxTreeItemData *wxTreeCtrl::GetItemData(const wxTreeItemId& item) const
629{
630 wxCHECK_MSG( item.IsOk(), NULL, wxT("invalid tree item") );
631
632 return item.m_pItem->GetData();
633}
634
635void wxTreeCtrl::SetItemText(const wxTreeItemId& item, const wxString& text)
636{
637 wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
638
639 wxClientDC dc(this);
640 wxGenericTreeItem *pItem = item.m_pItem;
641 pItem->SetText(text);
642 CalculateSize(pItem, dc);
643 RefreshLine(pItem);
644}
645
646void wxTreeCtrl::SetItemImage(const wxTreeItemId& item,
647 int image,
648 wxTreeItemIcon which)
649{
650 wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
651
652 wxGenericTreeItem *pItem = item.m_pItem;
653 pItem->SetImage(image, which);
654
655 wxClientDC dc(this);
656 CalculateSize(pItem, dc);
657 RefreshLine(pItem);
658}
659
660void wxTreeCtrl::SetItemData(const wxTreeItemId& item, wxTreeItemData *data)
661{
662 wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
663
664 item.m_pItem->SetData(data);
665}
666
667void wxTreeCtrl::SetItemHasChildren(const wxTreeItemId& item, bool has)
668{
669 wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
670
671 wxGenericTreeItem *pItem = item.m_pItem;
672 pItem->SetHasPlus(has);
673 RefreshLine(pItem);
674}
675
676void wxTreeCtrl::SetItemBold(const wxTreeItemId& item, bool bold)
677{
678 wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
679
680 // avoid redrawing the tree if no real change
681 wxGenericTreeItem *pItem = item.m_pItem;
682 if ( pItem->IsBold() != bold )
683 {
684 pItem->SetBold(bold);
685 RefreshLine(pItem);
686 }
687}
688
689void wxTreeCtrl::SetItemTextColour(const wxTreeItemId& item,
690 const wxColour& col)
691{
692 wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
693
694 wxGenericTreeItem *pItem = item.m_pItem;
695 pItem->Attr().SetTextColour(col);
696 RefreshLine(pItem);
697}
698
699void wxTreeCtrl::SetItemBackgroundColour(const wxTreeItemId& item,
700 const wxColour& col)
701{
702 wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
703
704 wxGenericTreeItem *pItem = item.m_pItem;
705 pItem->Attr().SetBackgroundColour(col);
706 RefreshLine(pItem);
707}
708
709void wxTreeCtrl::SetItemFont(const wxTreeItemId& item, const wxFont& font)
710{
711 wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
712
713 wxGenericTreeItem *pItem = item.m_pItem;
714 pItem->Attr().SetFont(font);
715 RefreshLine(pItem);
716}
717
718// -----------------------------------------------------------------------------
719// item status inquiries
720// -----------------------------------------------------------------------------
721
722bool wxTreeCtrl::IsVisible(const wxTreeItemId& WXUNUSED(item)) const
723{
724 wxFAIL_MSG(wxT("not implemented"));
725
726 return TRUE;
727}
728
729bool wxTreeCtrl::ItemHasChildren(const wxTreeItemId& item) const
730{
731 wxCHECK_MSG( item.IsOk(), FALSE, wxT("invalid tree item") );
732
733 return !item.m_pItem->GetChildren().IsEmpty();
734}
735
736bool wxTreeCtrl::IsExpanded(const wxTreeItemId& item) const
737{
738 wxCHECK_MSG( item.IsOk(), FALSE, wxT("invalid tree item") );
739
740 return item.m_pItem->IsExpanded();
741}
742
743bool wxTreeCtrl::IsSelected(const wxTreeItemId& item) const
744{
745 wxCHECK_MSG( item.IsOk(), FALSE, wxT("invalid tree item") );
746
747 return item.m_pItem->IsSelected();
748}
749
750bool wxTreeCtrl::IsBold(const wxTreeItemId& item) const
751{
752 wxCHECK_MSG( item.IsOk(), FALSE, wxT("invalid tree item") );
753
754 return item.m_pItem->IsBold();
755}
756
757// -----------------------------------------------------------------------------
758// navigation
759// -----------------------------------------------------------------------------
760
761wxTreeItemId wxTreeCtrl::GetParent(const wxTreeItemId& item) const
762{
763 wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
764
765 return item.m_pItem->GetParent();
766}
767
768wxTreeItemId wxTreeCtrl::GetFirstChild(const wxTreeItemId& item, long& cookie) const
769{
770 wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
771
772 cookie = 0;
773 return GetNextChild(item, cookie);
774}
775
776wxTreeItemId wxTreeCtrl::GetNextChild(const wxTreeItemId& item, long& cookie) const
777{
778 wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
779
780 wxArrayGenericTreeItems& children = item.m_pItem->GetChildren();
781 if ( (size_t)cookie < children.Count() )
782 {
783 return children.Item(cookie++);
784 }
785 else
786 {
787 // there are no more of them
788 return wxTreeItemId();
789 }
790}
791
792wxTreeItemId wxTreeCtrl::GetLastChild(const wxTreeItemId& item) const
793{
794 wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
795
796 wxArrayGenericTreeItems& children = item.m_pItem->GetChildren();
797 return (children.IsEmpty() ? wxTreeItemId() : wxTreeItemId(children.Last()));
798}
799
800wxTreeItemId wxTreeCtrl::GetNextSibling(const wxTreeItemId& item) const
801{
802 wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
803
804 wxGenericTreeItem *i = item.m_pItem;
805 wxGenericTreeItem *parent = i->GetParent();
806 if ( parent == NULL )
807 {
808 // root item doesn't have any siblings
809 return wxTreeItemId();
810 }
811
812 wxArrayGenericTreeItems& siblings = parent->GetChildren();
813 int index = siblings.Index(i);
814 wxASSERT( index != wxNOT_FOUND ); // I'm not a child of my parent?
815
816 size_t n = (size_t)(index + 1);
817 return n == siblings.Count() ? wxTreeItemId() : wxTreeItemId(siblings[n]);
818}
819
820wxTreeItemId wxTreeCtrl::GetPrevSibling(const wxTreeItemId& item) const
821{
822 wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
823
824 wxGenericTreeItem *i = item.m_pItem;
825 wxGenericTreeItem *parent = i->GetParent();
826 if ( parent == NULL )
827 {
828 // root item doesn't have any siblings
829 return wxTreeItemId();
830 }
831
832 wxArrayGenericTreeItems& siblings = parent->GetChildren();
833 int index = siblings.Index(i);
834 wxASSERT( index != wxNOT_FOUND ); // I'm not a child of my parent?
835
836 return index == 0 ? wxTreeItemId()
837 : wxTreeItemId(siblings[(size_t)(index - 1)]);
838}
839
840wxTreeItemId wxTreeCtrl::GetFirstVisibleItem() const
841{
842 wxFAIL_MSG(wxT("not implemented"));
843
844 return wxTreeItemId();
845}
846
847wxTreeItemId wxTreeCtrl::GetNextVisible(const wxTreeItemId& item) const
848{
849 wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
850
851 wxFAIL_MSG(wxT("not implemented"));
852
853 return wxTreeItemId();
854}
855
856wxTreeItemId wxTreeCtrl::GetPrevVisible(const wxTreeItemId& item) const
857{
858 wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
859
860 wxFAIL_MSG(wxT("not implemented"));
861
862 return wxTreeItemId();
863}
864
865// -----------------------------------------------------------------------------
866// operations
867// -----------------------------------------------------------------------------
868
869wxTreeItemId wxTreeCtrl::DoInsertItem(const wxTreeItemId& parentId,
870 size_t previous,
871 const wxString& text,
872 int image, int selImage,
873 wxTreeItemData *data)
874{
875 wxGenericTreeItem *parent = parentId.m_pItem;
876 if ( !parent )
877 {
878 // should we give a warning here?
879 return AddRoot(text, image, selImage, data);
880 }
881
882 wxClientDC dc(this);
883 wxGenericTreeItem *item =
884 new wxGenericTreeItem( parent, text, dc, image, selImage, data );
885
886 if ( data != NULL )
887 {
888 data->m_pItem = item;
889 }
890
891 parent->Insert( item, previous );
892
893 m_dirty = TRUE;
894
895 return item;
896}
897
898wxTreeItemId wxTreeCtrl::AddRoot(const wxString& text,
899 int image, int selImage,
900 wxTreeItemData *data)
901{
902 wxCHECK_MSG( !m_anchor, wxTreeItemId(), wxT("tree can have only one root") );
903
904 wxClientDC dc(this);
905 m_anchor = new wxGenericTreeItem((wxGenericTreeItem *)NULL, text, dc,
906 image, selImage, data);
907 if ( data != NULL )
908 {
909 data->m_pItem = m_anchor;
910 }
911
912 if (!HasFlag(wxTR_MULTIPLE))
913 {
914 m_current = m_key_current = m_anchor;
915 m_current->SetHilight( TRUE );
916 }
917
918 Refresh();
919 AdjustMyScrollbars();
920
921 return m_anchor;
922}
923
924wxTreeItemId wxTreeCtrl::PrependItem(const wxTreeItemId& parent,
925 const wxString& text,
926 int image, int selImage,
927 wxTreeItemData *data)
928{
929 return DoInsertItem(parent, 0u, text, image, selImage, data);
930}
931
932wxTreeItemId wxTreeCtrl::InsertItem(const wxTreeItemId& parentId,
933 const wxTreeItemId& idPrevious,
934 const wxString& text,
935 int image, int selImage,
936 wxTreeItemData *data)
937{
938 wxGenericTreeItem *parent = parentId.m_pItem;
939 if ( !parent )
940 {
941 // should we give a warning here?
942 return AddRoot(text, image, selImage, data);
943 }
944
945 int index = parent->GetChildren().Index(idPrevious.m_pItem);
946 wxASSERT_MSG( index != wxNOT_FOUND,
947 wxT("previous item in wxTreeCtrl::InsertItem() is not a sibling") );
948
949 return DoInsertItem(parentId, (size_t)++index, text, image, selImage, data);
950}
951
952wxTreeItemId wxTreeCtrl::InsertItem(const wxTreeItemId& parentId,
953 size_t before,
954 const wxString& text,
955 int image, int selImage,
956 wxTreeItemData *data)
957{
958 wxGenericTreeItem *parent = parentId.m_pItem;
959 if ( !parent )
960 {
961 // should we give a warning here?
962 return AddRoot(text, image, selImage, data);
963 }
964
965 return DoInsertItem(parentId, before, text, image, selImage, data);
966}
967
968wxTreeItemId wxTreeCtrl::AppendItem(const wxTreeItemId& parentId,
969 const wxString& text,
970 int image, int selImage,
971 wxTreeItemData *data)
972{
973 wxGenericTreeItem *parent = parentId.m_pItem;
974 if ( !parent )
975 {
976 // should we give a warning here?
977 return AddRoot(text, image, selImage, data);
978 }
979
980 return DoInsertItem( parent, parent->GetChildren().Count(), text,
981 image, selImage, data);
982}
983
984void wxTreeCtrl::SendDeleteEvent(wxGenericTreeItem *item)
985{
986 wxTreeEvent event( wxEVT_COMMAND_TREE_DELETE_ITEM, GetId() );
987 event.m_item = item;
988 event.SetEventObject( this );
989 ProcessEvent( event );
990}
991
992void wxTreeCtrl::DeleteChildren(const wxTreeItemId& itemId)
993{
994 wxGenericTreeItem *item = itemId.m_pItem;
995 item->DeleteChildren(this);
996
997 m_dirty = TRUE;
998}
999
1000void wxTreeCtrl::Delete(const wxTreeItemId& itemId)
1001{
1002 wxGenericTreeItem *item = itemId.m_pItem;
1003 wxGenericTreeItem *parent = item->GetParent();
1004
1005 if ( parent )
1006 {
1007 parent->GetChildren().Remove( item ); // remove by value
1008 }
1009
1010 item->DeleteChildren(this);
1011 SendDeleteEvent(item);
1012 delete item;
1013
1014 m_dirty = TRUE;
1015}
1016
1017void wxTreeCtrl::DeleteAllItems()
1018{
1019 if ( m_anchor )
1020 {
1021 m_anchor->DeleteChildren(this);
1022 delete m_anchor;
1023
1024 m_anchor = NULL;
1025
1026 m_dirty = TRUE;
1027 }
1028}
1029
1030void wxTreeCtrl::Expand(const wxTreeItemId& itemId)
1031{
1032 wxGenericTreeItem *item = itemId.m_pItem;
1033
1034 if ( !item->HasPlus() )
1035 return;
1036
1037 if ( item->IsExpanded() )
1038 return;
1039
1040 wxTreeEvent event( wxEVT_COMMAND_TREE_ITEM_EXPANDING, GetId() );
1041 event.m_item = item;
1042 event.SetEventObject( this );
1043
1044// if ( ProcessEvent( event ) && event.m_code ) TODO: Was this a typo ?
1045 if ( ProcessEvent( event ) && !event.IsAllowed() )
1046 {
1047 // cancelled by program
1048 return;
1049 }
1050
1051 item->Expand();
1052 CalculatePositions();
1053
1054 RefreshSubtree(item);
1055
1056 event.SetEventType(wxEVT_COMMAND_TREE_ITEM_EXPANDED);
1057 ProcessEvent( event );
1058}
1059
1060void wxTreeCtrl::Collapse(const wxTreeItemId& itemId)
1061{
1062 wxGenericTreeItem *item = itemId.m_pItem;
1063
1064 if ( !item->IsExpanded() )
1065 return;
1066
1067 wxTreeEvent event( wxEVT_COMMAND_TREE_ITEM_COLLAPSING, GetId() );
1068 event.m_item = item;
1069 event.SetEventObject( this );
1070 if ( ProcessEvent( event ) && !event.IsAllowed() )
1071 {
1072 // cancelled by program
1073 return;
1074 }
1075
1076 item->Collapse();
1077
1078 wxArrayGenericTreeItems& children = item->GetChildren();
1079 size_t count = children.Count();
1080 for ( size_t n = 0; n < count; n++ )
1081 {
1082 Collapse(children[n]);
1083 }
1084
1085 CalculatePositions();
1086
1087 RefreshSubtree(item);
1088
1089 event.SetEventType(wxEVT_COMMAND_TREE_ITEM_COLLAPSED);
1090 ProcessEvent( event );
1091}
1092
1093void wxTreeCtrl::CollapseAndReset(const wxTreeItemId& item)
1094{
1095 Collapse(item);
1096 DeleteChildren(item);
1097}
1098
1099void wxTreeCtrl::Toggle(const wxTreeItemId& itemId)
1100{
1101 wxGenericTreeItem *item = itemId.m_pItem;
1102
1103 if (item->IsExpanded())
1104 Collapse(itemId);
1105 else
1106 Expand(itemId);
1107}
1108
1109void wxTreeCtrl::Unselect()
1110{
1111 if (m_current)
1112 {
1113 m_current->SetHilight( FALSE );
1114 RefreshLine( m_current );
1115 }
1116}
1117
1118void wxTreeCtrl::UnselectAllChildren(wxGenericTreeItem *item)
1119{
1120 if (item->IsSelected())
1121 {
1122 item->SetHilight(FALSE);
1123 RefreshLine(item);
1124 }
1125
1126 if (item->HasChildren())
1127 {
1128 wxArrayGenericTreeItems& children = item->GetChildren();
1129 size_t count = children.Count();
1130 for ( size_t n = 0; n < count; ++n )
1131 {
1132 UnselectAllChildren(children[n]);
1133 }
1134 }
1135}
1136
1137void wxTreeCtrl::UnselectAll()
1138{
1139 UnselectAllChildren(GetRootItem().m_pItem);
1140}
1141
1142// Recursive function !
1143// To stop we must have crt_item<last_item
1144// Algorithm :
1145// Tag all next children, when no more children,
1146// Move to parent (not to tag)
1147// Keep going... if we found last_item, we stop.
1148bool wxTreeCtrl::TagNextChildren(wxGenericTreeItem *crt_item, wxGenericTreeItem *last_item, bool select)
1149{
1150 wxGenericTreeItem *parent = crt_item->GetParent();
1151
1152 if (parent == NULL) // This is root item
1153 return TagAllChildrenUntilLast(crt_item, last_item, select);
1154
1155 wxArrayGenericTreeItems& children = parent->GetChildren();
1156 int index = children.Index(crt_item);
1157 wxASSERT( index != wxNOT_FOUND ); // I'm not a child of my parent?
1158
1159 size_t count = children.Count();
1160 for (size_t n=(size_t)(index+1); n<count; ++n)
1161 {
1162 if (TagAllChildrenUntilLast(children[n], last_item, select)) return TRUE;
1163 }
1164
1165 return TagNextChildren(parent, last_item, select);
1166}
1167
1168bool wxTreeCtrl::TagAllChildrenUntilLast(wxGenericTreeItem *crt_item, wxGenericTreeItem *last_item, bool select)
1169{
1170 crt_item->SetHilight(select);
1171 RefreshLine(crt_item);
1172
1173 if (crt_item==last_item)
1174 return TRUE;
1175
1176 if (crt_item->HasChildren())
1177 {
1178 wxArrayGenericTreeItems& children = crt_item->GetChildren();
1179 size_t count = children.Count();
1180 for ( size_t n = 0; n < count; ++n )
1181 {
1182 if (TagAllChildrenUntilLast(children[n], last_item, select))
1183 return TRUE;
1184 }
1185 }
1186
1187 return FALSE;
1188}
1189
1190void wxTreeCtrl::SelectItemRange(wxGenericTreeItem *item1, wxGenericTreeItem *item2)
1191{
1192 // item2 is not necessary after item1
1193 wxGenericTreeItem *first=NULL, *last=NULL;
1194
1195 // choice first' and 'last' between item1 and item2
1196 if (item1->GetY()<item2->GetY())
1197 {
1198 first=item1;
1199 last=item2;
1200 }
1201 else
1202 {
1203 first=item2;
1204 last=item1;
1205 }
1206
1207 bool select = m_current->IsSelected();
1208
1209 if ( TagAllChildrenUntilLast(first,last,select) )
1210 return;
1211
1212 TagNextChildren(first,last,select);
1213}
1214
1215void wxTreeCtrl::SelectItem(const wxTreeItemId& itemId,
1216 bool unselect_others,
1217 bool extended_select)
1218{
1219 wxCHECK_RET( itemId.IsOk(), wxT("invalid tree item") );
1220
1221 bool is_single=!(GetWindowStyleFlag() & wxTR_MULTIPLE);
1222 wxGenericTreeItem *item = itemId.m_pItem;
1223
1224 //wxCHECK_RET( ( (!unselect_others) && is_single),
1225 // wxT("this is a single selection tree") );
1226
1227 // to keep going anyhow !!!
1228 if (is_single)
1229 {
1230 if (item->IsSelected())
1231 return; // nothing to do
1232 unselect_others = TRUE;
1233 extended_select = FALSE;
1234 }
1235 else if ( unselect_others && item->IsSelected() )
1236 {
1237 // selection change if there is more than one item currently selected
1238 wxArrayTreeItemIds selected_items;
1239 if ( GetSelections(selected_items) == 1 )
1240 return;
1241 }
1242
1243 wxTreeEvent event( wxEVT_COMMAND_TREE_SEL_CHANGING, GetId() );
1244 event.m_item = item;
1245 event.m_itemOld = m_current;
1246 event.SetEventObject( this );
1247 // TODO : Here we don't send any selection mode yet !
1248
1249 if ( GetEventHandler()->ProcessEvent( event ) && !event.IsAllowed() )
1250 return;
1251
1252 // ctrl press
1253 if (unselect_others)
1254 {
1255 if (is_single) Unselect(); // to speed up thing
1256 else UnselectAll();
1257 }
1258
1259 // shift press
1260 if (extended_select)
1261 {
1262 if (m_current == NULL) m_current=m_key_current=GetRootItem().m_pItem;
1263 // don't change the mark (m_current)
1264 SelectItemRange(m_current, item);
1265 }
1266 else
1267 {
1268 bool select=TRUE; // the default
1269
1270 // Check if we need to toggle hilight (ctrl mode)
1271 if (!unselect_others)
1272 select=!item->IsSelected();
1273
1274 m_current = m_key_current = item;
1275 m_current->SetHilight(select);
1276 RefreshLine( m_current );
1277 }
1278
1279 event.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED);
1280 GetEventHandler()->ProcessEvent( event );
1281}
1282
1283void wxTreeCtrl::FillArray(wxGenericTreeItem *item,
1284 wxArrayTreeItemIds &array) const
1285{
1286 if ( item->IsSelected() )
1287 array.Add(wxTreeItemId(item));
1288
1289 if ( item->HasChildren() )
1290 {
1291 wxArrayGenericTreeItems& children = item->GetChildren();
1292 size_t count = children.GetCount();
1293 for ( size_t n = 0; n < count; ++n )
1294 FillArray(children[n],array);
1295 }
1296}
1297
1298size_t wxTreeCtrl::GetSelections(wxArrayTreeItemIds &array) const
1299{
1300 array.Empty();
1301 FillArray(GetRootItem().m_pItem, array);
1302
1303 return array.Count();
1304}
1305
1306void wxTreeCtrl::EnsureVisible(const wxTreeItemId& item)
1307{
1308 if (!item.IsOk()) return;
1309
1310 wxGenericTreeItem *gitem = item.m_pItem;
1311
1312 // first expand all parent branches
1313 wxGenericTreeItem *parent = gitem->GetParent();
1314 while ( parent )
1315 {
1316 Expand(parent);
1317 parent = parent->GetParent();
1318 }
1319
1320 //if (parent) CalculatePositions();
1321
1322 ScrollTo(item);
1323}
1324
1325void wxTreeCtrl::ScrollTo(const wxTreeItemId &item)
1326{
1327 if (!item.IsOk()) return;
1328
1329 // We have to call this here because the label in
1330 // question might just have been added and no screen
1331 // update taken place.
1332 if (m_dirty) wxYield();
1333
1334 wxGenericTreeItem *gitem = item.m_pItem;
1335
1336 // now scroll to the item
1337 int item_y = gitem->GetY();
1338
1339 int start_x = 0;
1340 int start_y = 0;
1341 ViewStart( &start_x, &start_y );
1342 start_y *= PIXELS_PER_UNIT;
1343
1344 int client_h = 0;
1345 int client_w = 0;
1346 GetClientSize( &client_w, &client_h );
1347
1348 if (item_y < start_y+3)
1349 {
1350 // going down
1351 int x = 0;
1352 int y = 0;
1353 m_anchor->GetSize( x, y, this );
1354 y += PIXELS_PER_UNIT+2; // one more scrollbar unit + 2 pixels
1355 x += PIXELS_PER_UNIT+2; // one more scrollbar unit + 2 pixels
1356 int x_pos = GetScrollPos( wxHORIZONTAL );
1357 // Item should appear at top
1358 SetScrollbars( PIXELS_PER_UNIT, PIXELS_PER_UNIT, x/PIXELS_PER_UNIT, y/PIXELS_PER_UNIT, x_pos, item_y/PIXELS_PER_UNIT );
1359 }
1360 else if (item_y+GetLineHeight(gitem) > start_y+client_h)
1361 {
1362 // going up
1363 int x = 0;
1364 int y = 0;
1365 m_anchor->GetSize( x, y, this );
1366 y += PIXELS_PER_UNIT+2; // one more scrollbar unit + 2 pixels
1367 x += PIXELS_PER_UNIT+2; // one more scrollbar unit + 2 pixels
1368 item_y += PIXELS_PER_UNIT+2;
1369 int x_pos = GetScrollPos( wxHORIZONTAL );
1370 // Item should appear at bottom
1371 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 );
1372 }
1373}
1374
1375// FIXME: tree sorting functions are not reentrant and not MT-safe!
1376static wxTreeCtrl *s_treeBeingSorted = NULL;
1377
1378static int LINKAGEMODE tree_ctrl_compare_func(wxGenericTreeItem **item1,
1379 wxGenericTreeItem **item2)
1380{
1381 wxCHECK_MSG( s_treeBeingSorted, 0, wxT("bug in wxTreeCtrl::SortChildren()") );
1382
1383 return s_treeBeingSorted->OnCompareItems(*item1, *item2);
1384}
1385
1386int wxTreeCtrl::OnCompareItems(const wxTreeItemId& item1,
1387 const wxTreeItemId& item2)
1388{
1389 return wxStrcmp(GetItemText(item1), GetItemText(item2));
1390}
1391
1392void wxTreeCtrl::SortChildren(const wxTreeItemId& itemId)
1393{
1394 wxCHECK_RET( itemId.IsOk(), wxT("invalid tree item") );
1395
1396 wxGenericTreeItem *item = itemId.m_pItem;
1397
1398 wxCHECK_RET( !s_treeBeingSorted,
1399 wxT("wxTreeCtrl::SortChildren is not reentrant") );
1400
1401 wxArrayGenericTreeItems& children = item->GetChildren();
1402 if ( children.Count() > 1 )
1403 {
1404 s_treeBeingSorted = this;
1405 children.Sort(tree_ctrl_compare_func);
1406 s_treeBeingSorted = NULL;
1407
1408 m_dirty = TRUE;
1409 }
1410 //else: don't make the tree dirty as nothing changed
1411}
1412
1413wxImageList *wxTreeCtrl::GetImageList() const
1414{
1415 return m_imageListNormal;
1416}
1417
1418wxImageList *wxTreeCtrl::GetStateImageList() const
1419{
1420 return m_imageListState;
1421}
1422
1423void wxTreeCtrl::SetImageList(wxImageList *imageList)
1424{
1425 m_imageListNormal = imageList;
1426
1427 // Calculate a m_lineHeight value from the image sizes.
1428 // May be toggle off. Then wxTreeCtrl will spread when
1429 // necessary (which might look ugly).
1430#if 1
1431 wxClientDC dc(this);
1432 m_lineHeight = (int)(dc.GetCharHeight() + 4);
1433 int width = 0, height = 0,
1434 n = m_imageListNormal->GetImageCount();
1435
1436 for (int i = 0; i < n ; i++)
1437 {
1438 m_imageListNormal->GetSize(i, width, height);
1439 if (height > m_lineHeight) m_lineHeight = height;
1440 }
1441
1442 if (m_lineHeight < 40)
1443 m_lineHeight += 2; // at least 2 pixels
1444 else
1445 m_lineHeight += m_lineHeight/10; // otherwise 10% extra spacing
1446#endif
1447}
1448
1449void wxTreeCtrl::SetStateImageList(wxImageList *imageList)
1450{
1451 m_imageListState = imageList;
1452}
1453
1454// -----------------------------------------------------------------------------
1455// helpers
1456// -----------------------------------------------------------------------------
1457
1458void wxTreeCtrl::AdjustMyScrollbars()
1459{
1460 if (m_anchor)
1461 {
1462 int x = 0;
1463 int y = 0;
1464 m_anchor->GetSize( x, y, this );
1465 y += PIXELS_PER_UNIT+2; // one more scrollbar unit + 2 pixels
1466 x += PIXELS_PER_UNIT+2; // one more scrollbar unit + 2 pixels
1467 int x_pos = GetScrollPos( wxHORIZONTAL );
1468 int y_pos = GetScrollPos( wxVERTICAL );
1469 SetScrollbars( PIXELS_PER_UNIT, PIXELS_PER_UNIT, x/PIXELS_PER_UNIT, y/PIXELS_PER_UNIT, x_pos, y_pos );
1470 }
1471 else
1472 {
1473 SetScrollbars( 0, 0, 0, 0 );
1474 }
1475}
1476
1477int wxTreeCtrl::GetLineHeight(wxGenericTreeItem *item) const
1478{
1479 if (GetWindowStyleFlag() & wxTR_HAS_VARIABLE_ROW_HEIGHT)
1480 return item->GetHeight();
1481 else
1482 return m_lineHeight;
1483}
1484
1485void wxTreeCtrl::PaintItem(wxGenericTreeItem *item, wxDC& dc)
1486{
1487 wxTreeItemAttr *attr = item->GetAttributes();
1488 if ( attr && attr->HasFont() )
1489 dc.SetFont(attr->GetFont());
1490 else if (item->IsBold())
1491 dc.SetFont(m_boldFont);
1492
1493 long text_w = 0;
1494 long text_h = 0;
1495 dc.GetTextExtent( item->GetText(), &text_w, &text_h );
1496
1497 int image_h = 0;
1498 int image_w = 0;
1499 int image = item->GetCurrentImage();
1500 if ( image != NO_IMAGE )
1501 {
1502 m_imageListNormal->GetSize( image, image_w, image_h );
1503 image_w += 4;
1504 }
1505
1506 int total_h = GetLineHeight(item);
1507
1508 dc.DrawRectangle( item->GetX()-2, item->GetY(), item->GetWidth()+2, total_h );
1509
1510 if ( image != NO_IMAGE )
1511 {
1512 dc.SetClippingRegion( item->GetX(), item->GetY(), image_w-2, total_h );
1513 m_imageListNormal->Draw( image, dc,
1514 item->GetX(),
1515 item->GetY() +((total_h > image_h)?((total_h-image_h)/2):0),
1516 wxIMAGELIST_DRAW_TRANSPARENT );
1517 dc.DestroyClippingRegion();
1518 }
1519
1520 bool hasBgCol = attr && attr->HasBackgroundColour();
1521 dc.SetBackgroundMode(hasBgCol ? wxSOLID : wxTRANSPARENT);
1522 if ( hasBgCol )
1523 dc.SetTextBackground(attr->GetBackgroundColour());
1524 dc.DrawText( item->GetText(), image_w + item->GetX(), item->GetY()
1525 + ((total_h > text_h) ? (total_h - text_h)/2 : 0));
1526
1527 // restore normal font
1528 dc.SetFont( m_normalFont );
1529}
1530
1531// Now y stands for the top of the item, whereas it used to stand for middle !
1532void wxTreeCtrl::PaintLevel( wxGenericTreeItem *item, wxDC &dc, int level, int &y )
1533{
1534 int horizX = level*m_indent;
1535
1536 item->SetX( horizX+m_indent+m_spacing );
1537 item->SetY( y );
1538
1539 int oldY = y;
1540 y+=GetLineHeight(item)/2;
1541
1542 item->SetCross( horizX+m_indent, y );
1543
1544 int exposed_x = dc.LogicalToDeviceX( 0 );
1545 int exposed_y = dc.LogicalToDeviceY( item->GetY() );
1546
1547 if (IsExposed( exposed_x, exposed_y, 10000, GetLineHeight(item) )) // 10000 = very much
1548 {
1549 int startX = horizX;
1550 int endX = horizX + (m_indent-5);
1551
1552// if (!item->HasChildren()) endX += (m_indent+5);
1553 if (!item->HasChildren()) endX += 20;
1554
1555 dc.DrawLine( startX, y, endX, y );
1556
1557 if (item->HasPlus())
1558 {
1559 dc.DrawLine( horizX+(m_indent+5), y, horizX+(m_indent+15), y );
1560 dc.SetPen( *wxGREY_PEN );
1561 dc.SetBrush( *wxWHITE_BRUSH );
1562 dc.DrawRectangle( horizX+(m_indent-5), y-4, 11, 9 );
1563
1564 dc.SetPen( *wxBLACK_PEN );
1565 dc.DrawLine( horizX+(m_indent-2), y, horizX+(m_indent+3), y );
1566 if (!item->IsExpanded())
1567 dc.DrawLine( horizX+m_indent, y-2, horizX+m_indent, y+3 );
1568
1569 dc.SetPen( m_dottedPen );
1570 }
1571
1572 wxPen *pen = wxTRANSPARENT_PEN;
1573 wxBrush *brush; // FIXME is this really needed?
1574 wxColour colText;
1575
1576 if ( item->IsSelected() )
1577 {
1578 colText = wxSystemSettings::GetSystemColour( wxSYS_COLOUR_HIGHLIGHTTEXT );
1579
1580 brush = m_hilightBrush;
1581
1582 if ( m_hasFocus )
1583 pen = wxBLACK_PEN;
1584
1585 }
1586 else
1587 {
1588 wxTreeItemAttr *attr = item->GetAttributes();
1589 if ( attr && attr->HasTextColour() )
1590 colText = attr->GetTextColour();
1591 else
1592 colText = *wxBLACK;
1593
1594 brush = wxWHITE_BRUSH;
1595 }
1596
1597 // prepare to draw
1598 dc.SetTextForeground(colText);
1599 dc.SetPen(*pen);
1600 dc.SetBrush(*brush);
1601
1602 // draw
1603 PaintItem(item, dc);
1604
1605 // restore DC objects
1606 dc.SetBrush( *wxWHITE_BRUSH );
1607 dc.SetPen( m_dottedPen );
1608 dc.SetTextForeground( *wxBLACK );
1609 }
1610
1611 y = oldY+GetLineHeight(item);
1612
1613 if (item->IsExpanded())
1614 {
1615 oldY+=GetLineHeight(item)/2;
1616 int semiOldY=0;
1617
1618 wxArrayGenericTreeItems& children = item->GetChildren();
1619 size_t n, count = children.Count();
1620 for ( n = 0; n < count; ++n )
1621 {
1622 semiOldY=y;
1623 PaintLevel( children[n], dc, level+1, y );
1624 }
1625
1626 // it may happen that the item is expanded but has no items (when you
1627 // delete all its children for example) - don't draw the vertical line
1628 // in this case
1629 if (count > 0)
1630 {
1631 semiOldY+=GetLineHeight(children[--n])/2;
1632 dc.DrawLine( horizX+m_indent, oldY+5, horizX+m_indent, semiOldY );
1633 }
1634 }
1635}
1636
1637void wxTreeCtrl::DrawBorder(wxTreeItemId &item)
1638{
1639 if (!item) return;
1640
1641 wxGenericTreeItem *i=item.m_pItem;
1642
1643 wxClientDC dc(this);
1644 PrepareDC( dc );
1645 dc.SetLogicalFunction(wxINVERT);
1646
1647 int w,h,x;
1648 ViewStart(&x,&h); // we only need x
1649 GetClientSize(&w,&h); // we only need w
1650
1651 h=GetLineHeight(i)+1;
1652 // 2 white column at border
1653 dc.DrawRectangle( PIXELS_PER_UNIT*x+2, i->GetY()-1, w-6, h);
1654}
1655
1656void wxTreeCtrl::DrawLine(wxTreeItemId &item, bool below)
1657{
1658 if (!item) return;
1659
1660 wxGenericTreeItem *i=item.m_pItem;
1661
1662 wxClientDC dc(this);
1663 PrepareDC( dc );
1664 dc.SetLogicalFunction(wxINVERT);
1665
1666 int w,h,y;
1667 GetSize(&w,&h);
1668
1669 if (below) y=i->GetY()+GetLineHeight(i)-1;
1670 else y=i->GetY();
1671
1672 dc.DrawLine( 0, y, w, y);
1673}
1674
1675// -----------------------------------------------------------------------------
1676// wxWindows callbacks
1677// -----------------------------------------------------------------------------
1678
1679void wxTreeCtrl::OnPaint( wxPaintEvent &WXUNUSED(event) )
1680{
1681 if ( !m_anchor)
1682 return;
1683
1684 wxPaintDC dc(this);
1685 PrepareDC( dc );
1686
1687 dc.SetFont( m_normalFont );
1688 dc.SetPen( m_dottedPen );
1689
1690 // this is now done dynamically
1691 //if(GetImageList() == NULL)
1692 // m_lineHeight = (int)(dc.GetCharHeight() + 4);
1693
1694 int y = 2;
1695 PaintLevel( m_anchor, dc, 0, y );
1696}
1697
1698void wxTreeCtrl::OnSetFocus( wxFocusEvent &WXUNUSED(event) )
1699{
1700 m_hasFocus = TRUE;
1701
1702 if (m_current) RefreshLine( m_current );
1703}
1704
1705void wxTreeCtrl::OnKillFocus( wxFocusEvent &WXUNUSED(event) )
1706{
1707 m_hasFocus = FALSE;
1708
1709 if (m_current) RefreshLine( m_current );
1710}
1711
1712void wxTreeCtrl::OnChar( wxKeyEvent &event )
1713{
1714 wxTreeEvent te( wxEVT_COMMAND_TREE_KEY_DOWN, GetId() );
1715 te.m_code = event.KeyCode();
1716 te.SetEventObject( this );
1717 GetEventHandler()->ProcessEvent( te );
1718
1719 if ( (m_current == 0) || (m_key_current == 0) )
1720 {
1721 event.Skip();
1722 return;
1723 }
1724
1725 bool is_multiple=(GetWindowStyleFlag() & wxTR_MULTIPLE);
1726 bool extended_select=(event.ShiftDown() && is_multiple);
1727 bool unselect_others=!(extended_select || (event.ControlDown() && is_multiple));
1728
1729 switch (event.KeyCode())
1730 {
1731 case '+':
1732 case WXK_ADD:
1733 if (m_current->HasPlus() && !IsExpanded(m_current))
1734 {
1735 Expand(m_current);
1736 }
1737 break;
1738
1739 case '-':
1740 case WXK_SUBTRACT:
1741 if (IsExpanded(m_current))
1742 {
1743 Collapse(m_current);
1744 }
1745 break;
1746
1747 case '*':
1748 case WXK_MULTIPLY:
1749 Toggle(m_current);
1750 break;
1751
1752 case ' ':
1753 case WXK_RETURN:
1754 {
1755 wxTreeEvent event( wxEVT_COMMAND_TREE_ITEM_ACTIVATED, GetId() );
1756 event.m_item = m_current;
1757 event.m_code = 0;
1758 event.SetEventObject( this );
1759 GetEventHandler()->ProcessEvent( event );
1760 }
1761 break;
1762
1763 // up goes to the previous sibling or to the last of its children if
1764 // it's expanded
1765 case WXK_UP:
1766 {
1767 wxTreeItemId prev = GetPrevSibling( m_key_current );
1768 if (!prev)
1769 {
1770 prev = GetParent( m_key_current );
1771 if (prev)
1772 {
1773 long cockie = 0;
1774 wxTreeItemId current = m_key_current;
1775 if (current == GetFirstChild( prev, cockie ))
1776 {
1777 // otherwise we return to where we came from
1778 SelectItem( prev, unselect_others, extended_select );
1779 m_key_current=prev.m_pItem;
1780 EnsureVisible( prev );
1781 break;
1782 }
1783 }
1784 }
1785 if (prev)
1786 {
1787 while ( IsExpanded(prev) && HasChildren(prev) )
1788 {
1789 wxTreeItemId child = GetLastChild(prev);
1790 if ( child )
1791 {
1792 prev = child;
1793 }
1794 }
1795
1796 SelectItem( prev, unselect_others, extended_select );
1797 m_key_current=prev.m_pItem;
1798 EnsureVisible( prev );
1799 }
1800 }
1801 break;
1802
1803 // left arrow goes to the parent
1804 case WXK_LEFT:
1805 {
1806 wxTreeItemId prev = GetParent( m_current );
1807 if (prev)
1808 {
1809 EnsureVisible( prev );
1810 SelectItem( prev, unselect_others, extended_select );
1811 }
1812 }
1813 break;
1814
1815 case WXK_RIGHT:
1816 // this works the same as the down arrow except that we also expand the
1817 // item if it wasn't expanded yet
1818 Expand(m_current);
1819 // fall through
1820
1821 case WXK_DOWN:
1822 {
1823 if (IsExpanded(m_key_current) && HasChildren(m_key_current))
1824 {
1825 long cookie = 0;
1826 wxTreeItemId child = GetFirstChild( m_key_current, cookie );
1827 SelectItem( child, unselect_others, extended_select );
1828 m_key_current=child.m_pItem;
1829 EnsureVisible( child );
1830 }
1831 else
1832 {
1833 wxTreeItemId next = GetNextSibling( m_key_current );
1834// if (next == 0)
1835 if (!next)
1836 {
1837 wxTreeItemId current = m_key_current;
1838 while (current && !next)
1839 {
1840 current = GetParent( current );
1841 if (current) next = GetNextSibling( current );
1842 }
1843 }
1844// if (next != 0)
1845 if (next)
1846 {
1847 SelectItem( next, unselect_others, extended_select );
1848 m_key_current=next.m_pItem;
1849 EnsureVisible( next );
1850 }
1851 }
1852 }
1853 break;
1854
1855 // <End> selects the last visible tree item
1856 case WXK_END:
1857 {
1858 wxTreeItemId last = GetRootItem();
1859
1860 while ( last.IsOk() && IsExpanded(last) )
1861 {
1862 wxTreeItemId lastChild = GetLastChild(last);
1863
1864 // it may happen if the item was expanded but then all of
1865 // its children have been deleted - so IsExpanded() returned
1866 // TRUE, but GetLastChild() returned invalid item
1867 if ( !lastChild )
1868 break;
1869
1870 last = lastChild;
1871 }
1872
1873 if ( last.IsOk() )
1874 {
1875 EnsureVisible( last );
1876 SelectItem( last, unselect_others, extended_select );
1877 }
1878 }
1879 break;
1880
1881 // <Home> selects the root item
1882 case WXK_HOME:
1883 {
1884 wxTreeItemId prev = GetRootItem();
1885 if (prev)
1886 {
1887 EnsureVisible( prev );
1888 SelectItem( prev, unselect_others, extended_select );
1889 }
1890 }
1891 break;
1892
1893 default:
1894 event.Skip();
1895 }
1896}
1897
1898wxTreeItemId wxTreeCtrl::HitTest(const wxPoint& point, int& flags)
1899{
1900 // We have to call this here because the label in
1901 // question might just have been added and no screen
1902 // update taken place.
1903 if (m_dirty) wxYield();
1904
1905 wxClientDC dc(this);
1906 PrepareDC(dc);
1907 long x = dc.DeviceToLogicalX( (long)point.x );
1908 long y = dc.DeviceToLogicalY( (long)point.y );
1909 int w, h;
1910 GetSize(&w, &h);
1911
1912 flags=0;
1913 if (point.x<0) flags|=wxTREE_HITTEST_TOLEFT;
1914 if (point.x>w) flags|=wxTREE_HITTEST_TORIGHT;
1915 if (point.y<0) flags|=wxTREE_HITTEST_ABOVE;
1916 if (point.y>h) flags|=wxTREE_HITTEST_BELOW;
1917
1918 return m_anchor->HitTest( wxPoint(x, y), this, flags);
1919}
1920
1921/* **** */
1922
1923void wxTreeCtrl::Edit( const wxTreeItemId& item )
1924{
1925 if (!item.IsOk()) return;
1926
1927 m_currentEdit = item.m_pItem;
1928
1929 wxTreeEvent te( wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, GetId() );
1930 te.m_item = m_currentEdit;
1931 te.SetEventObject( this );
1932 GetEventHandler()->ProcessEvent( te );
1933
1934 if (!te.IsAllowed()) return;
1935
1936 // We have to call this here because the label in
1937 // question might just have been added and no screen
1938 // update taken place.
1939 if (m_dirty) wxYield();
1940
1941 wxString s = m_currentEdit->GetText();
1942 int x = m_currentEdit->GetX();
1943 int y = m_currentEdit->GetY();
1944 int w = m_currentEdit->GetWidth();
1945 int h = m_currentEdit->GetHeight();
1946
1947 int image_h = 0;
1948 int image_w = 0;
1949
1950 int image = m_currentEdit->GetCurrentImage();
1951 if ( image != NO_IMAGE )
1952 {
1953 m_imageListNormal->GetSize( image, image_w, image_h );
1954 image_w += 4;
1955 }
1956 x += image_w;
1957 w -= image_w + 4; // I don't know why +4 is needed
1958
1959 wxClientDC dc(this);
1960 PrepareDC( dc );
1961 x = dc.LogicalToDeviceX( x );
1962 y = dc.LogicalToDeviceY( y );
1963
1964 wxTreeTextCtrl *text = new wxTreeTextCtrl(
1965 this, -1, &m_renameAccept, &m_renameRes, this, s, wxPoint(x-4,y-4), wxSize(w+11,h+8) );
1966 text->SetFocus();
1967}
1968
1969void wxTreeCtrl::OnRenameTimer()
1970{
1971 Edit( m_current );
1972}
1973
1974void wxTreeCtrl::OnRenameAccept()
1975{
1976 wxTreeEvent le( wxEVT_COMMAND_TREE_END_LABEL_EDIT, GetId() );
1977 le.m_item = m_currentEdit;
1978 le.SetEventObject( this );
1979 le.m_label = m_renameRes;
1980 GetEventHandler()->ProcessEvent( le );
1981
1982 if (!le.IsAllowed()) return;
1983
1984 SetItemText( m_currentEdit, m_renameRes );
1985}
1986
1987void wxTreeCtrl::OnMouse( wxMouseEvent &event )
1988{
1989 if ( !(event.LeftUp() || event.RightDown() || event.LeftDClick() || event.Dragging()) ) return;
1990
1991 if ( !m_anchor ) return;
1992
1993 wxClientDC dc(this);
1994 PrepareDC(dc);
1995 long x = dc.DeviceToLogicalX( (long)event.GetX() );
1996 long y = dc.DeviceToLogicalY( (long)event.GetY() );
1997
1998 int flags=0;
1999 wxGenericTreeItem *item = m_anchor->HitTest( wxPoint(x,y), this, flags);
2000 bool onButton = flags & wxTREE_HITTEST_ONITEMBUTTON;
2001
2002 if (event.Dragging())
2003 {
2004 if (m_dragCount == 0)
2005 m_dragStart = wxPoint(x,y);
2006
2007 m_dragCount++;
2008
2009 if (m_dragCount != 3) return;
2010
2011 int command = wxEVT_COMMAND_TREE_BEGIN_DRAG;
2012 if (event.RightIsDown()) command = wxEVT_COMMAND_TREE_BEGIN_RDRAG;
2013
2014 wxTreeEvent nevent( command, GetId() );
2015 nevent.m_item = m_current;
2016 nevent.SetEventObject(this);
2017 GetEventHandler()->ProcessEvent(nevent);
2018 return;
2019 }
2020 else
2021 {
2022 m_dragCount = 0;
2023 }
2024
2025 if (item == NULL) return; /* we hit the blank area */
2026
2027 if (event.RightDown()) {
2028 wxTreeEvent nevent(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK,GetId());
2029 nevent.m_item=item;
2030 nevent.m_code=0;
2031 nevent.SetEventObject(this);
2032 GetEventHandler()->ProcessEvent(nevent);
2033 return;
2034 }
2035
2036 if (event.LeftUp() && (item == m_current) &&
2037 (flags & wxTREE_HITTEST_ONITEMLABEL) &&
2038 HasFlag(wxTR_EDIT_LABELS) )
2039 {
2040 m_renameTimer->Start( 100, TRUE );
2041 return;
2042 }
2043
2044 bool is_multiple=(GetWindowStyleFlag() & wxTR_MULTIPLE);
2045 bool extended_select=(event.ShiftDown() && is_multiple);
2046 bool unselect_others=!(extended_select || (event.ControlDown() && is_multiple));
2047
2048 if (onButton)
2049 {
2050 Toggle( item );
2051 if (is_multiple)
2052 return;
2053 }
2054
2055 SelectItem(item, unselect_others, extended_select);
2056
2057 if (event.LeftDClick())
2058 {
2059 wxTreeEvent event( wxEVT_COMMAND_TREE_ITEM_ACTIVATED, GetId() );
2060 event.m_item = item;
2061 event.m_code = 0;
2062 event.SetEventObject( this );
2063 GetEventHandler()->ProcessEvent( event );
2064 }
2065}
2066
2067void wxTreeCtrl::OnIdle( wxIdleEvent &WXUNUSED(event) )
2068{
2069 /* after all changes have been done to the tree control,
2070 * we actually redraw the tree when everything is over */
2071
2072 if (!m_dirty)
2073 return;
2074
2075 m_dirty = FALSE;
2076
2077 CalculatePositions();
2078 Refresh();
2079 AdjustMyScrollbars();
2080}
2081
2082void wxTreeCtrl::CalculateSize( wxGenericTreeItem *item, wxDC &dc )
2083{
2084 long text_w = 0;
2085 long text_h = 0;
2086
2087 if (item->IsBold())
2088 dc.SetFont(m_boldFont);
2089
2090 dc.GetTextExtent( item->GetText(), &text_w, &text_h );
2091 text_h+=2;
2092
2093 // restore normal font
2094 dc.SetFont( m_normalFont );
2095
2096 int image_h = 0;
2097 int image_w = 0;
2098 int image = item->GetCurrentImage();
2099 if ( image != NO_IMAGE )
2100 {
2101 m_imageListNormal->GetSize( image, image_w, image_h );
2102 image_w += 4;
2103 }
2104
2105 int total_h = (image_h > text_h) ? image_h : text_h;
2106
2107 if (total_h < 40)
2108 total_h += 2; // at least 2 pixels
2109 else
2110 total_h += total_h/10; // otherwise 10% extra spacing
2111
2112 item->SetHeight(total_h);
2113 if (total_h>m_lineHeight) m_lineHeight=total_h;
2114
2115 item->SetWidth(image_w+text_w+2);
2116}
2117
2118// -----------------------------------------------------------------------------
2119// for developper : y is now the top of the level
2120// not the middle of it !
2121void wxTreeCtrl::CalculateLevel( wxGenericTreeItem *item, wxDC &dc, int level, int &y )
2122{
2123 int horizX = level*m_indent;
2124
2125 CalculateSize( item, dc );
2126
2127 // set its position
2128 item->SetX( horizX+m_indent+m_spacing );
2129 item->SetY( y );
2130 y+=GetLineHeight(item);
2131
2132 if ( !item->IsExpanded() )
2133 {
2134 // we dont need to calculate collapsed branches
2135 return;
2136 }
2137
2138 wxArrayGenericTreeItems& children = item->GetChildren();
2139 size_t n, count = children.Count();
2140 for (n = 0; n < count; ++n )
2141 CalculateLevel( children[n], dc, level+1, y ); // recurse
2142}
2143
2144void wxTreeCtrl::CalculatePositions()
2145{
2146 if ( !m_anchor ) return;
2147
2148 wxClientDC dc(this);
2149 PrepareDC( dc );
2150
2151 dc.SetFont( m_normalFont );
2152
2153 dc.SetPen( m_dottedPen );
2154 //if(GetImageList() == NULL)
2155 // m_lineHeight = (int)(dc.GetCharHeight() + 4);
2156
2157 int y = 2;
2158 CalculateLevel( m_anchor, dc, 0, y ); // start recursion
2159}
2160
2161void wxTreeCtrl::RefreshSubtree(wxGenericTreeItem *item)
2162{
2163 wxClientDC dc(this);
2164 PrepareDC(dc);
2165
2166 int cw = 0;
2167 int ch = 0;
2168 GetClientSize( &cw, &ch );
2169
2170 wxRect rect;
2171 rect.x = dc.LogicalToDeviceX( 0 );
2172 rect.width = cw;
2173 rect.y = dc.LogicalToDeviceY( item->GetY() );
2174 rect.height = ch;
2175
2176 Refresh( TRUE, &rect );
2177
2178 AdjustMyScrollbars();
2179}
2180
2181void wxTreeCtrl::RefreshLine( wxGenericTreeItem *item )
2182{
2183 wxClientDC dc(this);
2184 PrepareDC( dc );
2185
2186 int cw = 0;
2187 int ch = 0;
2188 GetClientSize( &cw, &ch );
2189
2190 wxRect rect;
2191 rect.x = dc.LogicalToDeviceX( 0 );
2192 rect.y = dc.LogicalToDeviceY( item->GetY() );
2193 rect.width = cw;
2194 rect.height = GetLineHeight(item); //dc.GetCharHeight() + 6;
2195
2196 Refresh( TRUE, &rect );
2197}
2198