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