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