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