1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: generic tree control implementation
4 // Author: Robert Roebling
6 // Modified: 22/10/98 - almost total rewrite, simpler interface (VZ)
8 // Copyright: (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // =============================================================================
14 // =============================================================================
16 // -----------------------------------------------------------------------------
18 // -----------------------------------------------------------------------------
21 #pragma implementation "treectrl.h"
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
31 #include "wx/treectrl.h"
32 #include "wx/generic/imaglist.h"
33 #include "wx/settings.h"
36 #include "wx/dynarray.h"
37 #include "wx/arrimpl.cpp"
38 #include "wx/dcclient.h"
39 #include "wx/msgdlg.h"
41 // -----------------------------------------------------------------------------
43 // -----------------------------------------------------------------------------
45 class WXDLLEXPORT wxGenericTreeItem
;
47 WX_DEFINE_ARRAY(wxGenericTreeItem
*, wxArrayGenericTreeItems
);
48 WX_DEFINE_OBJARRAY(wxArrayTreeItemIds
);
50 // ----------------------------------------------------------------------------
52 // ----------------------------------------------------------------------------
54 static const int NO_IMAGE
= -1;
56 // -----------------------------------------------------------------------------
58 // -----------------------------------------------------------------------------
61 class WXDLLEXPORT wxGenericTreeItem
65 wxGenericTreeItem() { m_data
= NULL
; }
66 wxGenericTreeItem( wxGenericTreeItem
*parent
,
69 int image
, int selImage
,
70 wxTreeItemData
*data
);
75 wxArrayGenericTreeItems
& GetChildren() { return m_children
; }
77 const wxString
& GetText() const { return m_text
; }
78 int GetImage(wxTreeItemIcon which
= wxTreeItemIcon_Normal
) const
79 { return m_images
[which
]; }
80 wxTreeItemData
*GetData() const { return m_data
; }
82 // returns the current image for the item (depending on its
83 // selected/expanded/whatever state)
84 int GetCurrentImage() const;
86 void SetText( const wxString
&text
);
87 void SetImage(int image
, wxTreeItemIcon which
) { m_images
[which
] = image
; }
88 void SetData(wxTreeItemData
*data
) { m_data
= data
; }
90 void SetHasPlus(bool has
= TRUE
) { m_hasPlus
= has
; }
92 void SetBold(bool bold
) { m_isBold
= bold
; }
94 int GetX() const { return m_x
; }
95 int GetY() const { return m_y
; }
97 void SetX(int x
) { m_x
= x
; }
98 void SetY(int y
) { m_y
= y
; }
100 int GetHeight() const { return m_height
; }
101 int GetWidth() const { return m_width
; }
103 void SetHeight(int h
) { m_height
= h
; }
104 void SetWidth(int w
) { m_width
= w
; }
107 wxGenericTreeItem
*GetParent() const { return m_parent
; }
110 // deletes all children notifying the treectrl about it if !NULL
112 void DeleteChildren(wxTreeCtrl
*tree
= NULL
);
113 // FIXME don't know what is it for
116 // get count of all children (and grand children if 'recursively')
117 size_t GetChildrenCount(bool recursively
= TRUE
) const;
119 void Insert(wxGenericTreeItem
*child
, size_t index
)
120 { m_children
.Insert(child
, index
); }
122 void SetCross( int x
, int y
);
123 void GetSize( int &x
, int &y
, const wxTreeCtrl
* );
125 // return the item at given position (or NULL if no item), onButton is
126 // TRUE if the point belongs to the item's button, otherwise it lies
127 // on the button's label
128 wxGenericTreeItem
*HitTest( const wxPoint
& point
, const wxTreeCtrl
*, int &flags
);
130 void Expand() { m_isCollapsed
= FALSE
; }
131 void Collapse() { m_isCollapsed
= TRUE
; }
133 void SetHilight( bool set
= TRUE
) { m_hasHilight
= set
; }
136 bool HasChildren() const { return !m_children
.IsEmpty(); }
137 bool IsSelected() const { return m_hasHilight
; }
138 bool IsExpanded() const { return !m_isCollapsed
; }
139 bool HasPlus() const { return m_hasPlus
|| HasChildren(); }
140 bool IsBold() const { return m_isBold
; }
143 // get them - may be NULL
144 wxTreeItemAttr
*GetAttributes() const { return m_attr
; }
145 // get them ensuring that the pointer is not NULL
146 wxTreeItemAttr
& Attr()
149 m_attr
= new wxTreeItemAttr
;
157 // tree ctrl images for the normal, selected, expanded and
158 // expanded+selected states
159 int m_images
[wxTreeItemIcon_Max
];
161 wxTreeItemData
*m_data
;
163 // use bitfields to save size
164 int m_isCollapsed
:1;
165 int m_hasHilight
:1; // same as focused
166 int m_hasPlus
:1; // used for item which doesn't have
167 // children but has a [+] button
168 int m_isBold
:1; // render the label in bold font
171 long m_height
, m_width
;
172 int m_xCross
, m_yCross
;
175 wxArrayGenericTreeItems m_children
;
176 wxGenericTreeItem
*m_parent
;
178 wxTreeItemAttr
*m_attr
;
181 // =============================================================================
183 // =============================================================================
186 // -----------------------------------------------------------------------------
187 // wxTreeRenameTimer (internal)
188 // -----------------------------------------------------------------------------
190 wxTreeRenameTimer::wxTreeRenameTimer( wxTreeCtrl
*owner
)
195 void wxTreeRenameTimer::Notify()
197 m_owner
->OnRenameTimer();
200 //-----------------------------------------------------------------------------
201 // wxTreeTextCtrl (internal)
202 //-----------------------------------------------------------------------------
204 IMPLEMENT_DYNAMIC_CLASS(wxTreeTextCtrl
,wxTextCtrl
);
206 BEGIN_EVENT_TABLE(wxTreeTextCtrl
,wxTextCtrl
)
207 EVT_CHAR (wxTreeTextCtrl::OnChar
)
208 EVT_KILL_FOCUS (wxTreeTextCtrl::OnKillFocus
)
211 wxTreeTextCtrl::wxTreeTextCtrl( wxWindow
*parent
, const wxWindowID id
,
212 bool *accept
, wxString
*res
, wxTreeCtrl
*owner
,
213 const wxString
&value
, const wxPoint
&pos
, const wxSize
&size
,
215 int style
, const wxValidator
& validator
, const wxString
&name
) :
217 wxTextCtrl( parent
, id
, value
, pos
, size
, style
, validator
, name
)
224 m_startValue
= value
;
227 void wxTreeTextCtrl::OnChar( wxKeyEvent
&event
)
229 if (event
.m_keyCode
== WXK_RETURN
)
232 (*m_res
) = GetValue();
236 if (event
.m_keyCode
== WXK_ESCAPE
)
246 void wxTreeTextCtrl::OnKillFocus( wxFocusEvent
&WXUNUSED(event
) )
248 if (wxPendingDelete
.Member(this)) return;
250 wxPendingDelete
.Append(this);
252 if ((*m_accept
) && ((*m_res
) != m_startValue
))
253 m_owner
->OnRenameAccept();
256 #define PIXELS_PER_UNIT 10
257 // -----------------------------------------------------------------------------
259 // -----------------------------------------------------------------------------
261 IMPLEMENT_DYNAMIC_CLASS(wxTreeEvent
, wxNotifyEvent
)
263 wxTreeEvent::wxTreeEvent( wxEventType commandType
, int id
)
264 : wxNotifyEvent( commandType
, id
)
267 m_itemOld
= (wxGenericTreeItem
*)NULL
;
270 // -----------------------------------------------------------------------------
272 // -----------------------------------------------------------------------------
274 wxGenericTreeItem::wxGenericTreeItem(wxGenericTreeItem
*parent
,
275 const wxString
& text
,
277 int image
, int selImage
,
278 wxTreeItemData
*data
)
281 m_images
[wxTreeItemIcon_Normal
] = image
;
282 m_images
[wxTreeItemIcon_Selected
] = selImage
;
283 m_images
[wxTreeItemIcon_Expanded
] = NO_IMAGE
;
284 m_images
[wxTreeItemIcon_SelectedExpanded
] = NO_IMAGE
;
288 m_xCross
= m_yCross
= 0;
292 m_isCollapsed
= TRUE
;
293 m_hasHilight
= FALSE
;
299 m_attr
= (wxTreeItemAttr
*)NULL
;
305 wxGenericTreeItem::~wxGenericTreeItem()
311 wxASSERT_MSG( m_children
.IsEmpty(),
312 wxT("please call DeleteChildren() before deleting the item") );
315 void wxGenericTreeItem::DeleteChildren(wxTreeCtrl
*tree
)
317 size_t count
= m_children
.Count();
318 for ( size_t n
= 0; n
< count
; n
++ )
320 wxGenericTreeItem
*child
= m_children
[n
];
323 tree
->SendDeleteEvent(child
);
326 child
->DeleteChildren(tree
);
333 void wxGenericTreeItem::SetText( const wxString
&text
)
338 void wxGenericTreeItem::Reset()
341 for ( int i
= 0; i
< wxTreeItemIcon_Max
; i
++ )
343 m_images
[i
] = NO_IMAGE
;
348 m_height
= m_width
= 0;
355 m_isCollapsed
= TRUE
;
357 m_parent
= (wxGenericTreeItem
*)NULL
;
360 size_t wxGenericTreeItem::GetChildrenCount(bool recursively
) const
362 size_t count
= m_children
.Count();
366 size_t total
= count
;
367 for ( size_t n
= 0; n
< count
; ++n
)
369 total
+= m_children
[n
]->GetChildrenCount();
375 void wxGenericTreeItem::SetCross( int x
, int y
)
381 void wxGenericTreeItem::GetSize( int &x
, int &y
, const wxTreeCtrl
*theTree
)
383 int bottomY
=m_y
+theTree
->GetLineHeight(this);
384 if ( y
< bottomY
) y
= bottomY
;
385 int width
= m_x
+ m_width
;
386 if ( x
< width
) x
= width
;
390 size_t count
= m_children
.Count();
391 for ( size_t n
= 0; n
< count
; ++n
)
393 m_children
[n
]->GetSize( x
, y
, theTree
);
398 wxGenericTreeItem
*wxGenericTreeItem::HitTest( const wxPoint
& point
,
399 const wxTreeCtrl
*theTree
,
402 if ((point
.y
> m_y
) && (point
.y
< m_y
+ theTree
->GetLineHeight(this)))
404 if (point
.y
<m_y
+theTree
->GetLineHeight(this)/2)
405 flags
|= wxTREE_HITTEST_ONITEMUPPERPART
;
407 flags
|= wxTREE_HITTEST_ONITEMLOWERPART
;
409 // 5 is the size of the plus sign
410 if ((point
.x
> m_xCross
-5) && (point
.x
< m_xCross
+5) &&
411 (point
.y
> m_yCross
-5) && (point
.y
< m_yCross
+5) &&
412 (IsExpanded() || HasPlus()))
414 flags
|=wxTREE_HITTEST_ONITEMBUTTON
;
418 if ((point
.x
>= m_x
) && (point
.x
<= m_x
+m_width
))
423 // assuming every image (normal and selected ) has the same size !
424 if ( (GetImage() != NO_IMAGE
) && theTree
->m_imageListNormal
)
425 theTree
->m_imageListNormal
->GetSize(GetImage(), image_w
, image_h
);
427 if ((image_w
!= -1) && (point
.x
<= m_x
+ image_w
+ 1))
428 flags
|= wxTREE_HITTEST_ONITEMICON
;
430 flags
|= wxTREE_HITTEST_ONITEMLABEL
;
436 flags
|= wxTREE_HITTEST_ONITEMINDENT
;
437 if (point
.x
> m_x
+m_width
)
438 flags
|= wxTREE_HITTEST_ONITEMRIGHT
;
446 size_t count
= m_children
.Count();
447 for ( size_t n
= 0; n
< count
; n
++ )
449 wxGenericTreeItem
*res
= m_children
[n
]->HitTest( point
, theTree
, flags
);
456 flags
|=wxTREE_HITTEST_NOWHERE
;
460 int wxGenericTreeItem::GetCurrentImage() const
462 int image
= NO_IMAGE
;
467 image
= GetImage(wxTreeItemIcon_SelectedExpanded
);
470 if ( image
== NO_IMAGE
)
472 // we usually fall back to the normal item, but try just the
473 // expanded one (and not selected) first in this case
474 image
= GetImage(wxTreeItemIcon_Expanded
);
480 image
= GetImage(wxTreeItemIcon_Selected
);
483 // may be it doesn't have the specific image we want, try the default one
485 if ( image
== NO_IMAGE
)
493 // -----------------------------------------------------------------------------
494 // wxTreeCtrl implementation
495 // -----------------------------------------------------------------------------
497 IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl
, wxScrolledWindow
)
499 BEGIN_EVENT_TABLE(wxTreeCtrl
,wxScrolledWindow
)
500 EVT_PAINT (wxTreeCtrl::OnPaint
)
501 EVT_MOUSE_EVENTS (wxTreeCtrl::OnMouse
)
502 EVT_CHAR (wxTreeCtrl::OnChar
)
503 EVT_SET_FOCUS (wxTreeCtrl::OnSetFocus
)
504 EVT_KILL_FOCUS (wxTreeCtrl::OnKillFocus
)
505 EVT_IDLE (wxTreeCtrl::OnIdle
)
508 // -----------------------------------------------------------------------------
509 // construction/destruction
510 // -----------------------------------------------------------------------------
512 void wxTreeCtrl::Init()
516 m_anchor
= (wxGenericTreeItem
*) NULL
;
526 m_hilightBrush
= new wxBrush
528 wxSystemSettings::GetSystemColour(wxSYS_COLOUR_HIGHLIGHT
),
533 m_imageListState
= (wxImageList
*) NULL
;
537 m_renameTimer
= new wxTreeRenameTimer( this );
539 m_normalFont
= wxSystemSettings::GetSystemFont( wxSYS_DEFAULT_GUI_FONT
);
540 m_boldFont
= wxFont( m_normalFont
.GetPointSize(),
541 m_normalFont
.GetFamily(),
542 m_normalFont
.GetStyle(),
544 m_normalFont
.GetUnderlined());
547 bool wxTreeCtrl::Create(wxWindow
*parent
, wxWindowID id
,
548 const wxPoint
& pos
, const wxSize
& size
,
551 const wxValidator
&validator
,
553 const wxString
& name
)
557 wxScrolledWindow::Create( parent
, id
, pos
, size
, style
|wxHSCROLL
|wxVSCROLL
, name
);
560 SetValidator( validator
);
563 SetBackgroundColour( *wxWHITE
);
564 // m_dottedPen = wxPen( "grey", 0, wxDOT );
565 m_dottedPen
= wxPen( "grey", 0, 0 );
570 wxTreeCtrl::~wxTreeCtrl()
572 wxDELETE( m_hilightBrush
);
576 delete m_renameTimer
;
579 // -----------------------------------------------------------------------------
581 // -----------------------------------------------------------------------------
583 size_t wxTreeCtrl::GetCount() const
585 return m_anchor
== NULL
? 0u : m_anchor
->GetChildrenCount();
588 void wxTreeCtrl::SetIndent(unsigned int indent
)
595 void wxTreeCtrl::SetSpacing(unsigned int spacing
)
602 size_t wxTreeCtrl::GetChildrenCount(const wxTreeItemId
& item
, bool recursively
)
604 wxCHECK_MSG( item
.IsOk(), 0u, wxT("invalid tree item") );
606 return item
.m_pItem
->GetChildrenCount(recursively
);
609 // -----------------------------------------------------------------------------
610 // functions to work with tree items
611 // -----------------------------------------------------------------------------
613 wxString
wxTreeCtrl::GetItemText(const wxTreeItemId
& item
) const
615 wxCHECK_MSG( item
.IsOk(), wxT(""), wxT("invalid tree item") );
617 return item
.m_pItem
->GetText();
620 int wxTreeCtrl::GetItemImage(const wxTreeItemId
& item
,
621 wxTreeItemIcon which
) const
623 wxCHECK_MSG( item
.IsOk(), -1, wxT("invalid tree item") );
625 return item
.m_pItem
->GetImage(which
);
628 wxTreeItemData
*wxTreeCtrl::GetItemData(const wxTreeItemId
& item
) const
630 wxCHECK_MSG( item
.IsOk(), NULL
, wxT("invalid tree item") );
632 return item
.m_pItem
->GetData();
635 void wxTreeCtrl::SetItemText(const wxTreeItemId
& item
, const wxString
& text
)
637 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
640 wxGenericTreeItem
*pItem
= item
.m_pItem
;
641 pItem
->SetText(text
);
642 CalculateSize(pItem
, dc
);
646 void wxTreeCtrl::SetItemImage(const wxTreeItemId
& item
,
648 wxTreeItemIcon which
)
650 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
652 wxGenericTreeItem
*pItem
= item
.m_pItem
;
653 pItem
->SetImage(image
, which
);
656 CalculateSize(pItem
, dc
);
660 void wxTreeCtrl::SetItemData(const wxTreeItemId
& item
, wxTreeItemData
*data
)
662 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
664 item
.m_pItem
->SetData(data
);
667 void wxTreeCtrl::SetItemHasChildren(const wxTreeItemId
& item
, bool has
)
669 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
671 wxGenericTreeItem
*pItem
= item
.m_pItem
;
672 pItem
->SetHasPlus(has
);
676 void wxTreeCtrl::SetItemBold(const wxTreeItemId
& item
, bool bold
)
678 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
680 // avoid redrawing the tree if no real change
681 wxGenericTreeItem
*pItem
= item
.m_pItem
;
682 if ( pItem
->IsBold() != bold
)
684 pItem
->SetBold(bold
);
689 void wxTreeCtrl::SetItemTextColour(const wxTreeItemId
& item
,
692 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
694 wxGenericTreeItem
*pItem
= item
.m_pItem
;
695 pItem
->Attr().SetTextColour(col
);
699 void wxTreeCtrl::SetItemBackgroundColour(const wxTreeItemId
& item
,
702 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
704 wxGenericTreeItem
*pItem
= item
.m_pItem
;
705 pItem
->Attr().SetBackgroundColour(col
);
709 void wxTreeCtrl::SetItemFont(const wxTreeItemId
& item
, const wxFont
& font
)
711 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
713 wxGenericTreeItem
*pItem
= item
.m_pItem
;
714 pItem
->Attr().SetFont(font
);
718 // -----------------------------------------------------------------------------
719 // item status inquiries
720 // -----------------------------------------------------------------------------
722 bool wxTreeCtrl::IsVisible(const wxTreeItemId
& WXUNUSED(item
)) const
724 wxFAIL_MSG(wxT("not implemented"));
729 bool wxTreeCtrl::ItemHasChildren(const wxTreeItemId
& item
) const
731 wxCHECK_MSG( item
.IsOk(), FALSE
, wxT("invalid tree item") );
733 return !item
.m_pItem
->GetChildren().IsEmpty();
736 bool wxTreeCtrl::IsExpanded(const wxTreeItemId
& item
) const
738 wxCHECK_MSG( item
.IsOk(), FALSE
, wxT("invalid tree item") );
740 return item
.m_pItem
->IsExpanded();
743 bool wxTreeCtrl::IsSelected(const wxTreeItemId
& item
) const
745 wxCHECK_MSG( item
.IsOk(), FALSE
, wxT("invalid tree item") );
747 return item
.m_pItem
->IsSelected();
750 bool wxTreeCtrl::IsBold(const wxTreeItemId
& item
) const
752 wxCHECK_MSG( item
.IsOk(), FALSE
, wxT("invalid tree item") );
754 return item
.m_pItem
->IsBold();
757 // -----------------------------------------------------------------------------
759 // -----------------------------------------------------------------------------
761 wxTreeItemId
wxTreeCtrl::GetParent(const wxTreeItemId
& item
) const
763 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
765 return item
.m_pItem
->GetParent();
768 wxTreeItemId
wxTreeCtrl::GetFirstChild(const wxTreeItemId
& item
, long& cookie
) const
770 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
773 return GetNextChild(item
, cookie
);
776 wxTreeItemId
wxTreeCtrl::GetNextChild(const wxTreeItemId
& item
, long& cookie
) const
778 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
780 wxArrayGenericTreeItems
& children
= item
.m_pItem
->GetChildren();
781 if ( (size_t)cookie
< children
.Count() )
783 return children
.Item(cookie
++);
787 // there are no more of them
788 return wxTreeItemId();
792 wxTreeItemId
wxTreeCtrl::GetLastChild(const wxTreeItemId
& item
) const
794 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
796 wxArrayGenericTreeItems
& children
= item
.m_pItem
->GetChildren();
797 return (children
.IsEmpty() ? wxTreeItemId() : wxTreeItemId(children
.Last()));
800 wxTreeItemId
wxTreeCtrl::GetNextSibling(const wxTreeItemId
& item
) const
802 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
804 wxGenericTreeItem
*i
= item
.m_pItem
;
805 wxGenericTreeItem
*parent
= i
->GetParent();
806 if ( parent
== NULL
)
808 // root item doesn't have any siblings
809 return wxTreeItemId();
812 wxArrayGenericTreeItems
& siblings
= parent
->GetChildren();
813 int index
= siblings
.Index(i
);
814 wxASSERT( index
!= wxNOT_FOUND
); // I'm not a child of my parent?
816 size_t n
= (size_t)(index
+ 1);
817 return n
== siblings
.Count() ? wxTreeItemId() : wxTreeItemId(siblings
[n
]);
820 wxTreeItemId
wxTreeCtrl::GetPrevSibling(const wxTreeItemId
& item
) const
822 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
824 wxGenericTreeItem
*i
= item
.m_pItem
;
825 wxGenericTreeItem
*parent
= i
->GetParent();
826 if ( parent
== NULL
)
828 // root item doesn't have any siblings
829 return wxTreeItemId();
832 wxArrayGenericTreeItems
& siblings
= parent
->GetChildren();
833 int index
= siblings
.Index(i
);
834 wxASSERT( index
!= wxNOT_FOUND
); // I'm not a child of my parent?
836 return index
== 0 ? wxTreeItemId()
837 : wxTreeItemId(siblings
[(size_t)(index
- 1)]);
840 wxTreeItemId
wxTreeCtrl::GetFirstVisibleItem() const
842 wxFAIL_MSG(wxT("not implemented"));
844 return wxTreeItemId();
847 wxTreeItemId
wxTreeCtrl::GetNextVisible(const wxTreeItemId
& item
) const
849 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
851 wxFAIL_MSG(wxT("not implemented"));
853 return wxTreeItemId();
856 wxTreeItemId
wxTreeCtrl::GetPrevVisible(const wxTreeItemId
& item
) const
858 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
860 wxFAIL_MSG(wxT("not implemented"));
862 return wxTreeItemId();
865 // -----------------------------------------------------------------------------
867 // -----------------------------------------------------------------------------
869 wxTreeItemId
wxTreeCtrl::DoInsertItem(const wxTreeItemId
& parentId
,
871 const wxString
& text
,
872 int image
, int selImage
,
873 wxTreeItemData
*data
)
875 wxGenericTreeItem
*parent
= parentId
.m_pItem
;
878 // should we give a warning here?
879 return AddRoot(text
, image
, selImage
, data
);
883 wxGenericTreeItem
*item
=
884 new wxGenericTreeItem( parent
, text
, dc
, image
, selImage
, data
);
888 data
->m_pItem
= item
;
891 parent
->Insert( item
, previous
);
898 wxTreeItemId
wxTreeCtrl::AddRoot(const wxString
& text
,
899 int image
, int selImage
,
900 wxTreeItemData
*data
)
902 wxCHECK_MSG( !m_anchor
, wxTreeItemId(), wxT("tree can have only one root") );
905 m_anchor
= new wxGenericTreeItem((wxGenericTreeItem
*)NULL
, text
, dc
,
906 image
, selImage
, data
);
909 data
->m_pItem
= m_anchor
;
912 if (!HasFlag(wxTR_MULTIPLE
))
914 m_current
= m_key_current
= m_anchor
;
915 m_current
->SetHilight( TRUE
);
919 AdjustMyScrollbars();
924 wxTreeItemId
wxTreeCtrl::PrependItem(const wxTreeItemId
& parent
,
925 const wxString
& text
,
926 int image
, int selImage
,
927 wxTreeItemData
*data
)
929 return DoInsertItem(parent
, 0u, text
, image
, selImage
, data
);
932 wxTreeItemId
wxTreeCtrl::InsertItem(const wxTreeItemId
& parentId
,
933 const wxTreeItemId
& idPrevious
,
934 const wxString
& text
,
935 int image
, int selImage
,
936 wxTreeItemData
*data
)
938 wxGenericTreeItem
*parent
= parentId
.m_pItem
;
941 // should we give a warning here?
942 return AddRoot(text
, image
, selImage
, data
);
945 int index
= parent
->GetChildren().Index(idPrevious
.m_pItem
);
946 wxASSERT_MSG( index
!= wxNOT_FOUND
,
947 wxT("previous item in wxTreeCtrl::InsertItem() is not a sibling") );
948 return DoInsertItem(parentId
, (size_t)++index
, text
, image
, selImage
, data
);
951 wxTreeItemId
wxTreeCtrl::AppendItem(const wxTreeItemId
& parentId
,
952 const wxString
& text
,
953 int image
, int selImage
,
954 wxTreeItemData
*data
)
956 wxGenericTreeItem
*parent
= parentId
.m_pItem
;
959 // should we give a warning here?
960 return AddRoot(text
, image
, selImage
, data
);
963 return DoInsertItem(parent
, parent
->GetChildren().Count(), text
,
964 image
, selImage
, data
);
967 void wxTreeCtrl::SendDeleteEvent(wxGenericTreeItem
*item
)
969 wxTreeEvent
event( wxEVT_COMMAND_TREE_DELETE_ITEM
, GetId() );
971 event
.SetEventObject( this );
972 ProcessEvent( event
);
975 void wxTreeCtrl::DeleteChildren(const wxTreeItemId
& itemId
)
977 wxGenericTreeItem
*item
= itemId
.m_pItem
;
978 item
->DeleteChildren(this);
983 void wxTreeCtrl::Delete(const wxTreeItemId
& itemId
)
985 wxGenericTreeItem
*item
= itemId
.m_pItem
;
986 wxGenericTreeItem
*parent
= item
->GetParent();
990 parent
->GetChildren().Remove( item
); // remove by value
993 item
->DeleteChildren(this);
994 SendDeleteEvent(item
);
1000 void wxTreeCtrl::DeleteAllItems()
1004 m_anchor
->DeleteChildren(this);
1013 void wxTreeCtrl::Expand(const wxTreeItemId
& itemId
)
1015 wxGenericTreeItem
*item
= itemId
.m_pItem
;
1017 if ( !item
->HasPlus() )
1020 if ( item
->IsExpanded() )
1023 wxTreeEvent
event( wxEVT_COMMAND_TREE_ITEM_EXPANDING
, GetId() );
1024 event
.m_item
= item
;
1025 event
.SetEventObject( this );
1027 // if ( ProcessEvent( event ) && event.m_code ) TODO: Was this a typo ?
1028 if ( ProcessEvent( event
) && !event
.IsAllowed() )
1030 // cancelled by program
1035 CalculatePositions();
1037 RefreshSubtree(item
);
1039 event
.SetEventType(wxEVT_COMMAND_TREE_ITEM_EXPANDED
);
1040 ProcessEvent( event
);
1043 void wxTreeCtrl::Collapse(const wxTreeItemId
& itemId
)
1045 wxGenericTreeItem
*item
= itemId
.m_pItem
;
1047 if ( !item
->IsExpanded() )
1050 wxTreeEvent
event( wxEVT_COMMAND_TREE_ITEM_COLLAPSING
, GetId() );
1051 event
.m_item
= item
;
1052 event
.SetEventObject( this );
1053 if ( ProcessEvent( event
) && !event
.IsAllowed() )
1055 // cancelled by program
1061 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1062 size_t count
= children
.Count();
1063 for ( size_t n
= 0; n
< count
; n
++ )
1065 Collapse(children
[n
]);
1068 CalculatePositions();
1070 RefreshSubtree(item
);
1072 event
.SetEventType(wxEVT_COMMAND_TREE_ITEM_COLLAPSED
);
1073 ProcessEvent( event
);
1076 void wxTreeCtrl::CollapseAndReset(const wxTreeItemId
& item
)
1079 DeleteChildren(item
);
1082 void wxTreeCtrl::Toggle(const wxTreeItemId
& itemId
)
1084 wxGenericTreeItem
*item
= itemId
.m_pItem
;
1086 if ( item
->IsExpanded() )
1092 void wxTreeCtrl::Unselect()
1096 m_current
->SetHilight( FALSE
);
1097 RefreshLine( m_current
);
1101 void wxTreeCtrl::UnselectAllChildren(wxGenericTreeItem
*item
)
1103 item
->SetHilight(FALSE
);
1106 if (item
->HasChildren())
1108 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1109 size_t count
= children
.Count();
1110 for ( size_t n
= 0; n
< count
; ++n
)
1111 UnselectAllChildren(children
[n
]);
1115 void wxTreeCtrl::UnselectAll()
1117 UnselectAllChildren(GetRootItem().m_pItem
);
1120 // Recursive function !
1121 // To stop we must have crt_item<last_item
1123 // Tag all next children, when no more children,
1124 // Move to parent (not to tag)
1125 // Keep going... if we found last_item, we stop.
1126 bool wxTreeCtrl::TagNextChildren(wxGenericTreeItem
*crt_item
, wxGenericTreeItem
*last_item
, bool select
)
1128 wxGenericTreeItem
*parent
= crt_item
->GetParent();
1130 if ( parent
== NULL
) // This is root item
1131 return TagAllChildrenUntilLast(crt_item
, last_item
, select
);
1133 wxArrayGenericTreeItems
& children
= parent
->GetChildren();
1134 int index
= children
.Index(crt_item
);
1135 wxASSERT( index
!= wxNOT_FOUND
); // I'm not a child of my parent?
1137 size_t count
= children
.Count();
1138 for (size_t n
=(size_t)(index
+1); n
<count
; ++n
)
1139 if (TagAllChildrenUntilLast(children
[n
], last_item
, select
)) return TRUE
;
1141 return TagNextChildren(parent
, last_item
, select
);
1144 bool wxTreeCtrl::TagAllChildrenUntilLast(wxGenericTreeItem
*crt_item
, wxGenericTreeItem
*last_item
, bool select
)
1146 crt_item
->SetHilight(select
);
1147 RefreshLine(crt_item
);
1149 if (crt_item
==last_item
) return TRUE
;
1151 if (crt_item
->HasChildren())
1153 wxArrayGenericTreeItems
& children
= crt_item
->GetChildren();
1154 size_t count
= children
.Count();
1155 for ( size_t n
= 0; n
< count
; ++n
)
1156 if (TagAllChildrenUntilLast(children
[n
], last_item
, select
)) return TRUE
;
1162 void wxTreeCtrl::SelectItemRange(wxGenericTreeItem
*item1
, wxGenericTreeItem
*item2
)
1164 // item2 is not necessary after item1
1165 wxGenericTreeItem
*first
=NULL
, *last
=NULL
;
1167 // choice first' and 'last' between item1 and item2
1168 if (item1
->GetY()<item2
->GetY())
1179 bool select
= m_current
->IsSelected();
1181 if ( TagAllChildrenUntilLast(first
,last
,select
) )
1184 TagNextChildren(first
,last
,select
);
1187 void wxTreeCtrl::SelectItem(const wxTreeItemId
& itemId
,
1188 bool unselect_others
,
1189 bool extended_select
)
1191 wxCHECK_RET( itemId
.IsOk(), wxT("invalid tree item") );
1193 bool is_single
=!(GetWindowStyleFlag() & wxTR_MULTIPLE
);
1194 wxGenericTreeItem
*item
= itemId
.m_pItem
;
1196 //wxCHECK_RET( ( (!unselect_others) && is_single),
1197 // wxT("this is a single selection tree") );
1199 // to keep going anyhow !!!
1202 if (item
->IsSelected())
1203 return; // nothing to do
1204 unselect_others
= TRUE
;
1205 extended_select
= FALSE
;
1207 else if ( unselect_others
&& item
->IsSelected() )
1209 // selection change if there is more than one item currently selected
1210 wxArrayTreeItemIds selected_items
;
1211 if ( GetSelections(selected_items
) == 1 )
1215 wxTreeEvent
event( wxEVT_COMMAND_TREE_SEL_CHANGING
, GetId() );
1216 event
.m_item
= item
;
1217 event
.m_itemOld
= m_current
;
1218 event
.SetEventObject( this );
1219 // TODO : Here we don't send any selection mode yet !
1221 if ( GetEventHandler()->ProcessEvent( event
) && !event
.IsAllowed() )
1225 if (unselect_others
)
1227 if (is_single
) Unselect(); // to speed up thing
1232 if (extended_select
)
1234 if (m_current
== NULL
) m_current
=m_key_current
=GetRootItem().m_pItem
;
1235 // don't change the mark (m_current)
1236 SelectItemRange(m_current
, item
);
1240 bool select
=TRUE
; // the default
1242 // Check if we need to toggle hilight (ctrl mode)
1243 if (!unselect_others
)
1244 select
=!item
->IsSelected();
1246 m_current
= m_key_current
= item
;
1247 m_current
->SetHilight(select
);
1248 RefreshLine( m_current
);
1251 event
.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED
);
1252 GetEventHandler()->ProcessEvent( event
);
1255 void wxTreeCtrl::FillArray(wxGenericTreeItem
*item
,
1256 wxArrayTreeItemIds
&array
) const
1258 if ( item
->IsSelected() )
1259 array
.Add(wxTreeItemId(item
));
1261 if ( item
->HasChildren() )
1263 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1264 size_t count
= children
.GetCount();
1265 for ( size_t n
= 0; n
< count
; ++n
)
1266 FillArray(children
[n
],array
);
1270 size_t wxTreeCtrl::GetSelections(wxArrayTreeItemIds
&array
) const
1273 FillArray(GetRootItem().m_pItem
, array
);
1275 return array
.Count();
1278 void wxTreeCtrl::EnsureVisible(const wxTreeItemId
& item
)
1280 if (!item
.IsOk()) return;
1282 wxGenericTreeItem
*gitem
= item
.m_pItem
;
1284 // first expand all parent branches
1285 wxGenericTreeItem
*parent
= gitem
->GetParent();
1289 parent
= parent
->GetParent();
1292 //if (parent) CalculatePositions();
1297 void wxTreeCtrl::ScrollTo(const wxTreeItemId
&item
)
1299 if (!item
.IsOk()) return;
1301 // We have to call this here because the label in
1302 // question might just have been added and no screen
1303 // update taken place.
1304 if (m_dirty
) wxYield();
1306 wxGenericTreeItem
*gitem
= item
.m_pItem
;
1308 // now scroll to the item
1309 int item_y
= gitem
->GetY();
1313 ViewStart( &start_x
, &start_y
);
1314 start_y
*= PIXELS_PER_UNIT
;
1318 GetClientSize( &client_w
, &client_h
);
1320 if (item_y
< start_y
+3)
1325 m_anchor
->GetSize( x
, y
, this );
1326 y
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
1327 x
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
1328 int x_pos
= GetScrollPos( wxHORIZONTAL
);
1329 // Item should appear at top
1330 SetScrollbars( PIXELS_PER_UNIT
, PIXELS_PER_UNIT
, x
/PIXELS_PER_UNIT
, y
/PIXELS_PER_UNIT
, x_pos
, item_y
/PIXELS_PER_UNIT
);
1332 else if (item_y
+GetLineHeight(gitem
) > start_y
+client_h
)
1337 m_anchor
->GetSize( x
, y
, this );
1338 y
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
1339 x
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
1340 item_y
+= PIXELS_PER_UNIT
+2;
1341 int x_pos
= GetScrollPos( wxHORIZONTAL
);
1342 // Item should appear at bottom
1343 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
);
1347 // FIXME: tree sorting functions are not reentrant and not MT-safe!
1348 static wxTreeCtrl
*s_treeBeingSorted
= NULL
;
1350 static int LINKAGEMODE
tree_ctrl_compare_func(wxGenericTreeItem
**item1
,
1351 wxGenericTreeItem
**item2
)
1353 wxCHECK_MSG( s_treeBeingSorted
, 0, wxT("bug in wxTreeCtrl::SortChildren()") );
1355 return s_treeBeingSorted
->OnCompareItems(*item1
, *item2
);
1358 int wxTreeCtrl::OnCompareItems(const wxTreeItemId
& item1
,
1359 const wxTreeItemId
& item2
)
1361 return wxStrcmp(GetItemText(item1
), GetItemText(item2
));
1364 void wxTreeCtrl::SortChildren(const wxTreeItemId
& itemId
)
1366 wxCHECK_RET( itemId
.IsOk(), wxT("invalid tree item") );
1368 wxGenericTreeItem
*item
= itemId
.m_pItem
;
1370 wxCHECK_RET( !s_treeBeingSorted
,
1371 wxT("wxTreeCtrl::SortChildren is not reentrant") );
1373 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1374 if ( children
.Count() > 1 )
1376 s_treeBeingSorted
= this;
1377 children
.Sort(tree_ctrl_compare_func
);
1378 s_treeBeingSorted
= NULL
;
1382 //else: don't make the tree dirty as nothing changed
1385 wxImageList
*wxTreeCtrl::GetImageList() const
1387 return m_imageListNormal
;
1390 wxImageList
*wxTreeCtrl::GetStateImageList() const
1392 return m_imageListState
;
1395 void wxTreeCtrl::SetImageList(wxImageList
*imageList
)
1397 m_imageListNormal
= imageList
;
1399 // Calculate a m_lineHeight value from the image sizes.
1400 // May be toggle off. Then wxTreeCtrl will spread when
1401 // necessary (which might look ugly).
1403 wxClientDC
dc(this);
1404 m_lineHeight
= (int)(dc
.GetCharHeight() + 4);
1408 n
= m_imageListNormal
->GetImageCount();
1409 for(int i
= 0; i
< n
; i
++)
1411 m_imageListNormal
->GetSize(i
, width
, height
);
1412 if(height
> m_lineHeight
) m_lineHeight
= height
;
1415 if (m_lineHeight
<40) m_lineHeight
+=4; // at least 4 pixels (odd such that a line can be drawn in between)
1416 else m_lineHeight
+=m_lineHeight
/10; // otherwise 10% extra spacing
1421 void wxTreeCtrl::SetStateImageList(wxImageList
*imageList
)
1423 m_imageListState
= imageList
;
1426 // -----------------------------------------------------------------------------
1428 // -----------------------------------------------------------------------------
1430 void wxTreeCtrl::AdjustMyScrollbars()
1436 m_anchor
->GetSize( x
, y
, this );
1437 y
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
1438 x
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
1439 int x_pos
= GetScrollPos( wxHORIZONTAL
);
1440 int y_pos
= GetScrollPos( wxVERTICAL
);
1441 SetScrollbars( PIXELS_PER_UNIT
, PIXELS_PER_UNIT
, x
/PIXELS_PER_UNIT
, y
/PIXELS_PER_UNIT
, x_pos
, y_pos
);
1445 SetScrollbars( 0, 0, 0, 0 );
1449 int wxTreeCtrl::GetLineHeight(wxGenericTreeItem
*item
) const
1451 if (GetWindowStyleFlag() & wxTR_HAS_VARIABLE_ROW_HEIGHT
)
1452 return item
->GetHeight();
1454 return m_lineHeight
;
1457 void wxTreeCtrl::PaintItem(wxGenericTreeItem
*item
, wxDC
& dc
)
1459 wxTreeItemAttr
*attr
= item
->GetAttributes();
1460 if ( attr
&& attr
->HasFont() )
1461 dc
.SetFont(attr
->GetFont());
1462 else if (item
->IsBold())
1463 dc
.SetFont(m_boldFont
);
1467 dc
.GetTextExtent( item
->GetText(), &text_w
, &text_h
);
1471 int image
= item
->GetCurrentImage();
1472 if ( image
!= NO_IMAGE
)
1474 m_imageListNormal
->GetSize( image
, image_w
, image_h
);
1478 int total_h
= GetLineHeight(item
);
1480 dc
.DrawRectangle( item
->GetX()-2, item
->GetY(), item
->GetWidth()+2, total_h
);
1482 if ( image
!= NO_IMAGE
)
1484 dc
.SetClippingRegion( item
->GetX(), item
->GetY(), image_w
-2, total_h
);
1485 m_imageListNormal
->Draw( image
, dc
,
1487 item
->GetY() +((total_h
> image_h
)?((total_h
-image_h
)/2):0),
1488 wxIMAGELIST_DRAW_TRANSPARENT
);
1489 dc
.DestroyClippingRegion();
1492 bool hasBgCol
= attr
&& attr
->HasBackgroundColour();
1493 dc
.SetBackgroundMode(hasBgCol
? wxSOLID
: wxTRANSPARENT
);
1495 dc
.SetTextBackground(attr
->GetBackgroundColour());
1496 dc
.DrawText( item
->GetText(), image_w
+ item
->GetX(), item
->GetY()
1497 + ((total_h
> text_h
) ? (total_h
- text_h
)/2 : 0));
1499 // restore normal font
1500 dc
.SetFont( m_normalFont
);
1503 // Now y stands for the top of the item, whereas it used to stand for middle !
1504 void wxTreeCtrl::PaintLevel( wxGenericTreeItem
*item
, wxDC
&dc
, int level
, int &y
)
1506 int horizX
= level
*m_indent
;
1508 item
->SetX( horizX
+m_indent
+m_spacing
);
1512 y
+=GetLineHeight(item
)/2;
1514 item
->SetCross( horizX
+m_indent
, y
);
1516 int exposed_x
= dc
.LogicalToDeviceX( 0 );
1517 int exposed_y
= dc
.LogicalToDeviceY( item
->GetY() );
1519 if (IsExposed( exposed_x
, exposed_y
, 10000, GetLineHeight(item
) )) // 10000 = very much
1521 int startX
= horizX
;
1522 int endX
= horizX
+ (m_indent
-5);
1524 // if (!item->HasChildren()) endX += (m_indent+5);
1525 if (!item
->HasChildren()) endX
+= 20;
1527 dc
.DrawLine( startX
, y
, endX
, y
);
1529 if (item
->HasPlus())
1531 dc
.DrawLine( horizX
+(m_indent
+5), y
, horizX
+(m_indent
+15), y
);
1532 dc
.SetPen( *wxGREY_PEN
);
1533 dc
.SetBrush( *wxWHITE_BRUSH
);
1534 dc
.DrawRectangle( horizX
+(m_indent
-5), y
-4, 11, 9 );
1536 dc
.SetPen( *wxBLACK_PEN
);
1537 dc
.DrawLine( horizX
+(m_indent
-2), y
, horizX
+(m_indent
+3), y
);
1538 if (!item
->IsExpanded())
1539 dc
.DrawLine( horizX
+m_indent
, y
-2, horizX
+m_indent
, y
+3 );
1541 dc
.SetPen( m_dottedPen
);
1544 wxPen
*pen
= wxTRANSPARENT_PEN
;
1545 wxBrush
*brush
; // FIXME is this really needed?
1548 if ( item
->IsSelected() )
1550 colText
= wxSystemSettings::GetSystemColour( wxSYS_COLOUR_HIGHLIGHTTEXT
);
1552 brush
= m_hilightBrush
;
1560 wxTreeItemAttr
*attr
= item
->GetAttributes();
1561 if ( attr
&& attr
->HasTextColour() )
1562 colText
= attr
->GetTextColour();
1566 brush
= wxWHITE_BRUSH
;
1570 dc
.SetTextForeground(colText
);
1572 dc
.SetBrush(*brush
);
1575 PaintItem(item
, dc
);
1577 // restore DC objects
1578 dc
.SetBrush( *wxWHITE_BRUSH
);
1579 dc
.SetPen( m_dottedPen
);
1580 dc
.SetTextForeground( *wxBLACK
);
1583 y
= oldY
+GetLineHeight(item
);
1585 if (item
->IsExpanded())
1587 oldY
+=GetLineHeight(item
)/2;
1590 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1591 size_t n
, count
= children
.Count();
1592 for ( n
= 0; n
< count
; ++n
)
1595 PaintLevel( children
[n
], dc
, level
+1, y
);
1598 // it may happen that the item is expanded but has no items (when you
1599 // delete all its children for example) - don't draw the vertical line
1603 semiOldY
+=GetLineHeight(children
[--n
])/2;
1604 dc
.DrawLine( horizX
+m_indent
, oldY
+5, horizX
+m_indent
, semiOldY
);
1609 void wxTreeCtrl::DrawBorder(wxTreeItemId
&item
)
1613 wxGenericTreeItem
*i
=item
.m_pItem
;
1615 wxClientDC
dc(this);
1617 dc
.SetLogicalFunction(wxINVERT
);
1620 ViewStart(&x
,&h
); // we only need x
1621 GetClientSize(&w
,&h
); // we only need w
1623 h
=GetLineHeight(i
)+1;
1624 // 2 white column at border
1625 dc
.DrawRectangle( PIXELS_PER_UNIT
*x
+2, i
->GetY()-1, w
-6, h
);
1628 void wxTreeCtrl::DrawLine(wxTreeItemId
&item
, bool below
)
1632 wxGenericTreeItem
*i
=item
.m_pItem
;
1634 wxClientDC
dc(this);
1636 dc
.SetLogicalFunction(wxINVERT
);
1641 if (below
) y
=i
->GetY()+GetLineHeight(i
)-1;
1644 dc
.DrawLine( 0, y
, w
, y
);
1647 // -----------------------------------------------------------------------------
1648 // wxWindows callbacks
1649 // -----------------------------------------------------------------------------
1651 void wxTreeCtrl::OnPaint( wxPaintEvent
&WXUNUSED(event
) )
1659 dc
.SetFont( m_normalFont
);
1660 dc
.SetPen( m_dottedPen
);
1662 // this is now done dynamically
1663 //if(GetImageList() == NULL)
1664 // m_lineHeight = (int)(dc.GetCharHeight() + 4);
1667 PaintLevel( m_anchor
, dc
, 0, y
);
1670 void wxTreeCtrl::OnSetFocus( wxFocusEvent
&WXUNUSED(event
) )
1674 if (m_current
) RefreshLine( m_current
);
1677 void wxTreeCtrl::OnKillFocus( wxFocusEvent
&WXUNUSED(event
) )
1681 if (m_current
) RefreshLine( m_current
);
1684 void wxTreeCtrl::OnChar( wxKeyEvent
&event
)
1686 wxTreeEvent
te( wxEVT_COMMAND_TREE_KEY_DOWN
, GetId() );
1687 te
.m_code
= event
.KeyCode();
1688 te
.SetEventObject( this );
1689 GetEventHandler()->ProcessEvent( te
);
1691 if ( (m_current
== 0) || (m_key_current
== 0) )
1697 bool is_multiple
=(GetWindowStyleFlag() & wxTR_MULTIPLE
);
1698 bool extended_select
=(event
.ShiftDown() && is_multiple
);
1699 bool unselect_others
=!(extended_select
|| (event
.ControlDown() && is_multiple
));
1701 switch (event
.KeyCode())
1705 if (m_current
->HasPlus() && !IsExpanded(m_current
))
1713 if (IsExpanded(m_current
))
1715 Collapse(m_current
);
1727 wxTreeEvent
event( wxEVT_COMMAND_TREE_ITEM_ACTIVATED
, GetId() );
1728 event
.m_item
= m_current
;
1730 event
.SetEventObject( this );
1731 GetEventHandler()->ProcessEvent( event
);
1735 // up goes to the previous sibling or to the last of its children if
1739 wxTreeItemId prev
= GetPrevSibling( m_key_current
);
1742 prev
= GetParent( m_key_current
);
1746 wxTreeItemId current
= m_key_current
;
1747 if (current
== GetFirstChild( prev
, cockie
))
1749 // otherwise we return to where we came from
1750 SelectItem( prev
, unselect_others
, extended_select
);
1751 m_key_current
=prev
.m_pItem
;
1752 EnsureVisible( prev
);
1759 while ( IsExpanded(prev
) && HasChildren(prev
) )
1761 wxTreeItemId child
= GetLastChild(prev
);
1768 SelectItem( prev
, unselect_others
, extended_select
);
1769 m_key_current
=prev
.m_pItem
;
1770 EnsureVisible( prev
);
1775 // left arrow goes to the parent
1778 wxTreeItemId prev
= GetParent( m_current
);
1781 EnsureVisible( prev
);
1782 SelectItem( prev
, unselect_others
, extended_select
);
1788 // this works the same as the down arrow except that we also expand the
1789 // item if it wasn't expanded yet
1795 if (IsExpanded(m_key_current
) && HasChildren(m_key_current
))
1798 wxTreeItemId child
= GetFirstChild( m_key_current
, cookie
);
1799 SelectItem( child
, unselect_others
, extended_select
);
1800 m_key_current
=child
.m_pItem
;
1801 EnsureVisible( child
);
1805 wxTreeItemId next
= GetNextSibling( m_key_current
);
1809 wxTreeItemId current
= m_key_current
;
1810 while (current
&& !next
)
1812 current
= GetParent( current
);
1813 if (current
) next
= GetNextSibling( current
);
1819 SelectItem( next
, unselect_others
, extended_select
);
1820 m_key_current
=next
.m_pItem
;
1821 EnsureVisible( next
);
1827 // <End> selects the last visible tree item
1830 wxTreeItemId last
= GetRootItem();
1832 while ( last
.IsOk() && IsExpanded(last
) )
1834 wxTreeItemId lastChild
= GetLastChild(last
);
1836 // it may happen if the item was expanded but then all of
1837 // its children have been deleted - so IsExpanded() returned
1838 // TRUE, but GetLastChild() returned invalid item
1847 EnsureVisible( last
);
1848 SelectItem( last
, unselect_others
, extended_select
);
1853 // <Home> selects the root item
1856 wxTreeItemId prev
= GetRootItem();
1859 EnsureVisible( prev
);
1860 SelectItem( prev
, unselect_others
, extended_select
);
1870 wxTreeItemId
wxTreeCtrl::HitTest(const wxPoint
& point
, int& flags
)
1872 // We have to call this here because the label in
1873 // question might just have been added and no screen
1874 // update taken place.
1875 if (m_dirty
) wxYield();
1877 wxClientDC
dc(this);
1879 long x
= dc
.DeviceToLogicalX( (long)point
.x
);
1880 long y
= dc
.DeviceToLogicalY( (long)point
.y
);
1885 if (point
.x
<0) flags
|=wxTREE_HITTEST_TOLEFT
;
1886 if (point
.x
>w
) flags
|=wxTREE_HITTEST_TORIGHT
;
1887 if (point
.y
<0) flags
|=wxTREE_HITTEST_ABOVE
;
1888 if (point
.y
>h
) flags
|=wxTREE_HITTEST_BELOW
;
1890 return m_anchor
->HitTest( wxPoint(x
, y
), this, flags
);
1895 void wxTreeCtrl::Edit( const wxTreeItemId
& item
)
1897 if (!item
.IsOk()) return;
1899 m_currentEdit
= item
.m_pItem
;
1901 wxTreeEvent
te( wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT
, GetId() );
1902 te
.m_item
= m_currentEdit
;
1903 te
.SetEventObject( this );
1904 GetEventHandler()->ProcessEvent( te
);
1906 if (!te
.IsAllowed()) return;
1908 // We have to call this here because the label in
1909 // question might just have been added and no screen
1910 // update taken place.
1911 if (m_dirty
) wxYield();
1913 wxString s
= m_currentEdit
->GetText();
1914 int x
= m_currentEdit
->GetX();
1915 int y
= m_currentEdit
->GetY();
1916 int w
= m_currentEdit
->GetWidth();
1917 int h
= m_currentEdit
->GetHeight();
1922 int image
= m_currentEdit
->GetCurrentImage();
1923 if ( image
!= NO_IMAGE
)
1925 m_imageListNormal
->GetSize( image
, image_w
, image_h
);
1929 w
-= image_w
+ 4; // I don't know why +4 is needed
1931 wxClientDC
dc(this);
1933 x
= dc
.LogicalToDeviceX( x
);
1934 y
= dc
.LogicalToDeviceY( y
);
1936 wxTreeTextCtrl
*text
= new wxTreeTextCtrl(
1937 this, -1, &m_renameAccept
, &m_renameRes
, this, s
, wxPoint(x
-4,y
-4), wxSize(w
+11,h
+8) );
1941 void wxTreeCtrl::OnRenameTimer()
1946 void wxTreeCtrl::OnRenameAccept()
1948 wxTreeEvent
le( wxEVT_COMMAND_TREE_END_LABEL_EDIT
, GetId() );
1949 le
.m_item
= m_currentEdit
;
1950 le
.SetEventObject( this );
1951 le
.m_label
= m_renameRes
;
1952 GetEventHandler()->ProcessEvent( le
);
1954 if (!le
.IsAllowed()) return;
1956 SetItemText( m_currentEdit
, m_renameRes
);
1959 void wxTreeCtrl::OnMouse( wxMouseEvent
&event
)
1961 if ( !(event
.LeftUp() || event
.RightDown() || event
.LeftDClick() || event
.Dragging()) ) return;
1963 if ( !m_anchor
) return;
1965 wxClientDC
dc(this);
1967 long x
= dc
.DeviceToLogicalX( (long)event
.GetX() );
1968 long y
= dc
.DeviceToLogicalY( (long)event
.GetY() );
1971 wxGenericTreeItem
*item
= m_anchor
->HitTest( wxPoint(x
,y
), this, flags
);
1972 bool onButton
= flags
& wxTREE_HITTEST_ONITEMBUTTON
;
1974 if (event
.Dragging())
1976 if (m_dragCount
== 0)
1977 m_dragStart
= wxPoint(x
,y
);
1981 if (m_dragCount
!= 3) return;
1983 int command
= wxEVT_COMMAND_TREE_BEGIN_DRAG
;
1984 if (event
.RightIsDown()) command
= wxEVT_COMMAND_TREE_BEGIN_RDRAG
;
1986 wxTreeEvent
nevent( command
, GetId() );
1987 nevent
.m_item
= m_current
;
1988 nevent
.SetEventObject(this);
1989 GetEventHandler()->ProcessEvent(nevent
);
1997 if (item
== NULL
) return; /* we hit the blank area */
1999 if (event
.RightDown()) {
2000 wxTreeEvent
nevent(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK
,GetId());
2003 nevent
.SetEventObject(this);
2004 GetEventHandler()->ProcessEvent(nevent
);
2008 if (event
.LeftUp() && (item
== m_current
) &&
2009 (flags
& wxTREE_HITTEST_ONITEMLABEL
) &&
2010 HasFlag(wxTR_EDIT_LABELS
) )
2012 m_renameTimer
->Start( 100, TRUE
);
2016 bool is_multiple
=(GetWindowStyleFlag() & wxTR_MULTIPLE
);
2017 bool extended_select
=(event
.ShiftDown() && is_multiple
);
2018 bool unselect_others
=!(extended_select
|| (event
.ControlDown() && is_multiple
));
2027 SelectItem(item
, unselect_others
, extended_select
);
2029 if (event
.LeftDClick())
2031 wxTreeEvent
event( wxEVT_COMMAND_TREE_ITEM_ACTIVATED
, GetId() );
2032 event
.m_item
= item
;
2034 event
.SetEventObject( this );
2035 GetEventHandler()->ProcessEvent( event
);
2039 void wxTreeCtrl::OnIdle( wxIdleEvent
&WXUNUSED(event
) )
2041 /* after all changes have been done to the tree control,
2042 * we actually redraw the tree when everything is over */
2049 CalculatePositions();
2051 AdjustMyScrollbars();
2054 void wxTreeCtrl::CalculateSize( wxGenericTreeItem
*item
, wxDC
&dc
)
2060 dc
.SetFont(m_boldFont
);
2062 dc
.GetTextExtent( item
->GetText(), &text_w
, &text_h
);
2065 // restore normal font
2066 dc
.SetFont( m_normalFont
);
2070 int image
= item
->GetCurrentImage();
2071 if ( image
!= NO_IMAGE
)
2073 m_imageListNormal
->GetSize( image
, image_w
, image_h
);
2077 int total_h
= (image_h
> text_h
) ? image_h
: text_h
;
2079 if (total_h
<40) total_h
+=4; // at least 4 pixels
2080 else total_h
+=total_h
/10; // otherwise 10% extra spacing
2082 item
->SetHeight(total_h
);
2083 if (total_h
>m_lineHeight
) m_lineHeight
=total_h
;
2085 item
->SetWidth(image_w
+text_w
+2);
2088 // -----------------------------------------------------------------------------
2089 // for developper : y is now the top of the level
2090 // not the middle of it !
2091 void wxTreeCtrl::CalculateLevel( wxGenericTreeItem
*item
, wxDC
&dc
, int level
, int &y
)
2093 int horizX
= level
*m_indent
;
2095 CalculateSize( item
, dc
);
2098 item
->SetX( horizX
+m_indent
+m_spacing
);
2100 y
+=GetLineHeight(item
);
2102 if ( !item
->IsExpanded() )
2104 // we dont need to calculate collapsed branches
2108 wxArrayGenericTreeItems
& children
= item
->GetChildren();
2109 size_t n
, count
= children
.Count();
2110 for (n
= 0; n
< count
; ++n
)
2111 CalculateLevel( children
[n
], dc
, level
+1, y
); // recurse
2114 void wxTreeCtrl::CalculatePositions()
2116 if ( !m_anchor
) return;
2118 wxClientDC
dc(this);
2121 dc
.SetFont( m_normalFont
);
2123 dc
.SetPen( m_dottedPen
);
2124 //if(GetImageList() == NULL)
2125 // m_lineHeight = (int)(dc.GetCharHeight() + 4);
2128 CalculateLevel( m_anchor
, dc
, 0, y
); // start recursion
2131 void wxTreeCtrl::RefreshSubtree(wxGenericTreeItem
*item
)
2133 wxClientDC
dc(this);
2138 GetClientSize( &cw
, &ch
);
2141 rect
.x
= dc
.LogicalToDeviceX( 0 );
2143 rect
.y
= dc
.LogicalToDeviceY( item
->GetY() );
2146 Refresh( TRUE
, &rect
);
2148 AdjustMyScrollbars();
2151 void wxTreeCtrl::RefreshLine( wxGenericTreeItem
*item
)
2153 wxClientDC
dc(this);
2158 GetClientSize( &cw
, &ch
);
2161 rect
.x
= dc
.LogicalToDeviceX( 0 );
2162 rect
.y
= dc
.LogicalToDeviceY( item
->GetY() );
2164 rect
.height
= GetLineHeight(item
); //dc.GetCharHeight() + 6;
2166 Refresh( TRUE
, &rect
);