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