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