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