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 pointer
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 TRUE
126 // if the point belongs to the item's button, otherwise it lies on the
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
; }
145 // tree ctrl images for the normal, selected, expanded and expanded+selected
147 int m_images
[wxTreeItemIcon_Max
];
149 wxTreeItemData
*m_data
;
151 // use bitfields to save size
152 int m_isCollapsed
:1;
153 int m_hasHilight
:1; // same as focused
154 int m_hasPlus
:1; // used for item which doesn't have
155 // children but still has a [+] button
156 int m_isBold
:1; // render the label in bold font
159 long m_height
, m_width
;
160 int m_xCross
, m_yCross
;
162 wxArrayGenericTreeItems m_children
;
163 wxGenericTreeItem
*m_parent
;
166 // =============================================================================
168 // =============================================================================
171 // -----------------------------------------------------------------------------
172 // wxTreeRenameTimer (internal)
173 // -----------------------------------------------------------------------------
175 wxTreeRenameTimer::wxTreeRenameTimer( wxTreeCtrl
*owner
)
180 void wxTreeRenameTimer::Notify()
182 m_owner
->OnRenameTimer();
185 //-----------------------------------------------------------------------------
186 // wxTreeTextCtrl (internal)
187 //-----------------------------------------------------------------------------
189 IMPLEMENT_DYNAMIC_CLASS(wxTreeTextCtrl
,wxTextCtrl
);
191 BEGIN_EVENT_TABLE(wxTreeTextCtrl
,wxTextCtrl
)
192 EVT_CHAR (wxTreeTextCtrl::OnChar
)
193 EVT_KILL_FOCUS (wxTreeTextCtrl::OnKillFocus
)
196 wxTreeTextCtrl::wxTreeTextCtrl( wxWindow
*parent
, const wxWindowID id
,
197 bool *accept
, wxString
*res
, wxTreeCtrl
*owner
,
198 const wxString
&value
, const wxPoint
&pos
, const wxSize
&size
,
200 # if defined(__VISAGECPP__)
201 int style
, const wxValidator
* validator
, const wxString
&name
) :
203 int style
, const wxValidator
& validator
, const wxString
&name
) :
206 wxTextCtrl( parent
, id
, value
, pos
, size
, style
, validator
, name
)
213 m_startValue
= value
;
216 void wxTreeTextCtrl::OnChar( wxKeyEvent
&event
)
218 if (event
.m_keyCode
== WXK_RETURN
)
221 (*m_res
) = GetValue();
225 if (event
.m_keyCode
== WXK_ESCAPE
)
235 void wxTreeTextCtrl::OnKillFocus( wxFocusEvent
&WXUNUSED(event
) )
237 if (wxPendingDelete
.Member(this)) return;
239 wxPendingDelete
.Append(this);
241 if ((*m_accept
) && ((*m_res
) != m_startValue
))
242 m_owner
->OnRenameAccept();
245 #define PIXELS_PER_UNIT 10
246 // -----------------------------------------------------------------------------
248 // -----------------------------------------------------------------------------
250 IMPLEMENT_DYNAMIC_CLASS(wxTreeEvent
, wxNotifyEvent
)
252 wxTreeEvent::wxTreeEvent( wxEventType commandType
, int id
)
253 : wxNotifyEvent( commandType
, id
)
256 m_itemOld
= (wxGenericTreeItem
*)NULL
;
259 // -----------------------------------------------------------------------------
261 // -----------------------------------------------------------------------------
263 wxGenericTreeItem::wxGenericTreeItem(wxGenericTreeItem
*parent
,
264 const wxString
& text
,
266 int image
, int selImage
,
267 wxTreeItemData
*data
)
270 m_images
[wxTreeItemIcon_Normal
] = image
;
271 m_images
[wxTreeItemIcon_Selected
] = selImage
;
272 m_images
[wxTreeItemIcon_Expanded
] = NO_IMAGE
;
273 m_images
[wxTreeItemIcon_SelectedExpanded
] = NO_IMAGE
;
277 m_xCross
= m_yCross
= 0;
281 m_isCollapsed
= TRUE
;
282 m_hasHilight
= FALSE
;
288 dc
.GetTextExtent( m_text
, &m_width
, &m_height
);
289 // TODO : Add the width of the image
290 // PB : We don't know which image is shown (image, selImage)
291 // We don't even know imageList from the treectrl this item belongs to !!!
292 // At this point m_width doesn't mean much, this can be remove !
295 wxGenericTreeItem::~wxGenericTreeItem()
299 wxASSERT_MSG( m_children
.IsEmpty(),
300 wxT("please call DeleteChildren() before deleting the item") );
303 void wxGenericTreeItem::DeleteChildren(wxTreeCtrl
*tree
)
305 size_t count
= m_children
.Count();
306 for ( size_t n
= 0; n
< count
; n
++ )
308 wxGenericTreeItem
*child
= m_children
[n
];
311 tree
->SendDeleteEvent(child
);
314 child
->DeleteChildren(tree
);
321 void wxGenericTreeItem::SetText( const wxString
&text
)
326 void wxGenericTreeItem::Reset()
329 for ( int i
= 0; i
< wxTreeItemIcon_Max
; i
++ )
331 m_images
[i
] = NO_IMAGE
;
336 m_height
= m_width
= 0;
343 m_isCollapsed
= TRUE
;
345 m_parent
= (wxGenericTreeItem
*)NULL
;
348 size_t wxGenericTreeItem::GetChildrenCount(bool recursively
) const
350 size_t count
= m_children
.Count();
354 size_t total
= count
;
355 for ( size_t n
= 0; n
< count
; ++n
)
357 total
+= m_children
[n
]->GetChildrenCount();
363 void wxGenericTreeItem::SetCross( int x
, int y
)
369 void wxGenericTreeItem::GetSize( int &x
, int &y
, const wxTreeCtrl
*theTree
)
371 int bottomY
=m_y
+theTree
->GetLineHeight(this);
372 if ( y
< bottomY
) y
= bottomY
;
373 int width
= m_x
+ m_width
;
374 if ( x
< width
) x
= width
;
378 size_t count
= m_children
.Count();
379 for ( size_t n
= 0; n
< count
; ++n
)
381 m_children
[n
]->GetSize( x
, y
, theTree
);
386 wxGenericTreeItem
*wxGenericTreeItem::HitTest( const wxPoint
& point
,
387 const wxTreeCtrl
*theTree
,
390 if ((point
.y
> m_y
) && (point
.y
< m_y
+ theTree
->GetLineHeight(this)))
392 if (point
.y
<m_y
+theTree
->GetLineHeight(this)/2)
393 flags
|= wxTREE_HITTEST_ONITEMUPPERPART
;
395 flags
|= wxTREE_HITTEST_ONITEMLOWERPART
;
397 // 5 is the size of the plus sign
398 if ((point
.x
> m_xCross
-5) && (point
.x
< m_xCross
+5) &&
399 (point
.y
> m_yCross
-5) && (point
.y
< m_yCross
+5) &&
400 (IsExpanded() || HasPlus()))
402 flags
|=wxTREE_HITTEST_ONITEMBUTTON
;
406 if ((point
.x
>= m_x
) && (point
.x
<= m_x
+m_width
))
411 // assuming every image (normal and selected ) has the same size !
412 if ( (GetImage() != NO_IMAGE
) && theTree
->m_imageListNormal
)
413 theTree
->m_imageListNormal
->GetSize(GetImage(), image_w
, image_h
);
415 if ((image_w
!= -1) && (point
.x
<= m_x
+ image_w
+ 1))
416 flags
|= wxTREE_HITTEST_ONITEMICON
;
418 flags
|= wxTREE_HITTEST_ONITEMLABEL
;
424 flags
|= wxTREE_HITTEST_ONITEMIDENT
;
425 if (point
.x
> m_x
+m_width
)
426 flags
|= wxTREE_HITTEST_ONITEMRIGHT
;
434 size_t count
= m_children
.Count();
435 for ( size_t n
= 0; n
< count
; n
++ )
437 wxGenericTreeItem
*res
= m_children
[n
]->HitTest( point
, theTree
, flags
);
444 flags
|=wxTREE_HITTEST_NOWHERE
;
448 int wxGenericTreeItem::GetCurrentImage() const
450 int image
= NO_IMAGE
;
455 image
= GetImage(wxTreeItemIcon_SelectedExpanded
);
458 if ( image
== NO_IMAGE
)
460 // we usually fall back to the normal item, but try just the
461 // expanded one (and not selected) first in this case
462 image
= GetImage(wxTreeItemIcon_Expanded
);
468 image
= GetImage(wxTreeItemIcon_Selected
);
471 // may be it doesn't have the specific image we want, try the default one
473 if ( image
== NO_IMAGE
)
481 // -----------------------------------------------------------------------------
482 // wxTreeCtrl implementation
483 // -----------------------------------------------------------------------------
485 IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl
, wxScrolledWindow
)
487 BEGIN_EVENT_TABLE(wxTreeCtrl
,wxScrolledWindow
)
488 EVT_PAINT (wxTreeCtrl::OnPaint
)
489 EVT_MOUSE_EVENTS (wxTreeCtrl::OnMouse
)
490 EVT_CHAR (wxTreeCtrl::OnChar
)
491 EVT_SET_FOCUS (wxTreeCtrl::OnSetFocus
)
492 EVT_KILL_FOCUS (wxTreeCtrl::OnKillFocus
)
493 EVT_IDLE (wxTreeCtrl::OnIdle
)
496 // -----------------------------------------------------------------------------
497 // construction/destruction
498 // -----------------------------------------------------------------------------
500 void wxTreeCtrl::Init()
504 m_anchor
= (wxGenericTreeItem
*) NULL
;
514 m_hilightBrush
= new wxBrush
516 wxSystemSettings::GetSystemColour(wxSYS_COLOUR_HIGHLIGHT
),
521 m_imageListState
= (wxImageList
*) NULL
;
525 m_renameTimer
= new wxTreeRenameTimer( this );
527 m_normalFont
= wxSystemSettings::GetSystemFont( wxSYS_DEFAULT_GUI_FONT
);
528 m_boldFont
= wxFont( m_normalFont
.GetPointSize(),
529 m_normalFont
.GetFamily(),
530 m_normalFont
.GetStyle(),
532 m_normalFont
.GetUnderlined());
535 bool wxTreeCtrl::Create(wxWindow
*parent
, wxWindowID id
,
536 const wxPoint
& pos
, const wxSize
& size
,
539 # if defined(__VISAGECPP__)
540 const wxValidator
*validator
,
542 const wxValidator
&validator
,
545 const wxString
& name
)
549 wxScrolledWindow::Create( parent
, id
, pos
, size
, style
|wxHSCROLL
|wxVSCROLL
, name
);
552 SetValidator( validator
);
555 SetBackgroundColour( *wxWHITE
);
556 // m_dottedPen = wxPen( "grey", 0, wxDOT );
557 m_dottedPen
= wxPen( "grey", 0, 0 );
562 wxTreeCtrl::~wxTreeCtrl()
564 wxDELETE( m_hilightBrush
);
568 delete m_renameTimer
;
571 // -----------------------------------------------------------------------------
573 // -----------------------------------------------------------------------------
575 size_t wxTreeCtrl::GetCount() const
577 return m_anchor
== NULL
? 0u : m_anchor
->GetChildrenCount();
580 void wxTreeCtrl::SetIndent(unsigned int indent
)
587 void wxTreeCtrl::SetSpacing(unsigned int spacing
)
594 size_t wxTreeCtrl::GetChildrenCount(const wxTreeItemId
& item
, bool recursively
)
596 wxCHECK_MSG( item
.IsOk(), 0u, wxT("invalid tree item") );
598 return item
.m_pItem
->GetChildrenCount(recursively
);
601 // -----------------------------------------------------------------------------
602 // functions to work with tree items
603 // -----------------------------------------------------------------------------
605 wxString
wxTreeCtrl::GetItemText(const wxTreeItemId
& item
) const
607 wxCHECK_MSG( item
.IsOk(), wxT(""), wxT("invalid tree item") );
609 return item
.m_pItem
->GetText();
612 int wxTreeCtrl::GetItemImage(const wxTreeItemId
& item
,
613 wxTreeItemIcon which
) const
615 wxCHECK_MSG( item
.IsOk(), -1, wxT("invalid tree item") );
617 return item
.m_pItem
->GetImage(which
);
620 wxTreeItemData
*wxTreeCtrl::GetItemData(const wxTreeItemId
& item
) const
622 wxCHECK_MSG( item
.IsOk(), NULL
, wxT("invalid tree item") );
624 return item
.m_pItem
->GetData();
627 void wxTreeCtrl::SetItemText(const wxTreeItemId
& item
, const wxString
& text
)
629 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
632 wxGenericTreeItem
*pItem
= item
.m_pItem
;
633 pItem
->SetText(text
);
634 CalculateSize(pItem
, dc
);
638 void wxTreeCtrl::SetItemImage(const wxTreeItemId
& item
,
640 wxTreeItemIcon which
)
642 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
644 wxGenericTreeItem
*pItem
= item
.m_pItem
;
645 pItem
->SetImage(image
, which
);
648 CalculateSize(pItem
, dc
);
652 void wxTreeCtrl::SetItemData(const wxTreeItemId
& item
, wxTreeItemData
*data
)
654 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
656 item
.m_pItem
->SetData(data
);
659 void wxTreeCtrl::SetItemHasChildren(const wxTreeItemId
& item
, bool has
)
661 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
663 wxGenericTreeItem
*pItem
= item
.m_pItem
;
664 pItem
->SetHasPlus(has
);
668 void wxTreeCtrl::SetItemBold(const wxTreeItemId
& item
, bool bold
)
670 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
672 // avoid redrawing the tree if no real change
673 wxGenericTreeItem
*pItem
= item
.m_pItem
;
674 if ( pItem
->IsBold() != bold
)
676 pItem
->SetBold(bold
);
681 // -----------------------------------------------------------------------------
682 // item status inquiries
683 // -----------------------------------------------------------------------------
685 bool wxTreeCtrl::IsVisible(const wxTreeItemId
& WXUNUSED(item
)) const
687 wxFAIL_MSG(wxT("not implemented"));
692 bool wxTreeCtrl::ItemHasChildren(const wxTreeItemId
& item
) const
694 wxCHECK_MSG( item
.IsOk(), FALSE
, wxT("invalid tree item") );
696 return !item
.m_pItem
->GetChildren().IsEmpty();
699 bool wxTreeCtrl::IsExpanded(const wxTreeItemId
& item
) const
701 wxCHECK_MSG( item
.IsOk(), FALSE
, wxT("invalid tree item") );
703 return item
.m_pItem
->IsExpanded();
706 bool wxTreeCtrl::IsSelected(const wxTreeItemId
& item
) const
708 wxCHECK_MSG( item
.IsOk(), FALSE
, wxT("invalid tree item") );
710 return item
.m_pItem
->IsSelected();
713 bool wxTreeCtrl::IsBold(const wxTreeItemId
& item
) const
715 wxCHECK_MSG( item
.IsOk(), FALSE
, wxT("invalid tree item") );
717 return item
.m_pItem
->IsBold();
720 // -----------------------------------------------------------------------------
722 // -----------------------------------------------------------------------------
724 wxTreeItemId
wxTreeCtrl::GetParent(const wxTreeItemId
& item
) const
726 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
728 return item
.m_pItem
->GetParent();
731 wxTreeItemId
wxTreeCtrl::GetFirstChild(const wxTreeItemId
& item
, long& cookie
) const
733 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
736 return GetNextChild(item
, cookie
);
739 wxTreeItemId
wxTreeCtrl::GetNextChild(const wxTreeItemId
& item
, long& cookie
) const
741 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
743 wxArrayGenericTreeItems
& children
= item
.m_pItem
->GetChildren();
744 if ( (size_t)cookie
< children
.Count() )
746 return children
.Item(cookie
++);
750 // there are no more of them
751 return wxTreeItemId();
755 wxTreeItemId
wxTreeCtrl::GetLastChild(const wxTreeItemId
& item
) const
757 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
759 wxArrayGenericTreeItems
& children
= item
.m_pItem
->GetChildren();
760 return (children
.IsEmpty() ? wxTreeItemId() : wxTreeItemId(children
.Last()));
763 wxTreeItemId
wxTreeCtrl::GetNextSibling(const wxTreeItemId
& item
) const
765 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
767 wxGenericTreeItem
*i
= item
.m_pItem
;
768 wxGenericTreeItem
*parent
= i
->GetParent();
769 if ( parent
== NULL
)
771 // root item doesn't have any siblings
772 return wxTreeItemId();
775 wxArrayGenericTreeItems
& siblings
= parent
->GetChildren();
776 int index
= siblings
.Index(i
);
777 wxASSERT( index
!= wxNOT_FOUND
); // I'm not a child of my parent?
779 size_t n
= (size_t)(index
+ 1);
780 return n
== siblings
.Count() ? wxTreeItemId() : wxTreeItemId(siblings
[n
]);
783 wxTreeItemId
wxTreeCtrl::GetPrevSibling(const wxTreeItemId
& item
) const
785 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
787 wxGenericTreeItem
*i
= item
.m_pItem
;
788 wxGenericTreeItem
*parent
= i
->GetParent();
789 if ( parent
== NULL
)
791 // root item doesn't have any siblings
792 return wxTreeItemId();
795 wxArrayGenericTreeItems
& siblings
= parent
->GetChildren();
796 int index
= siblings
.Index(i
);
797 wxASSERT( index
!= wxNOT_FOUND
); // I'm not a child of my parent?
799 return index
== 0 ? wxTreeItemId()
800 : wxTreeItemId(siblings
[(size_t)(index
- 1)]);
803 wxTreeItemId
wxTreeCtrl::GetFirstVisibleItem() const
805 wxFAIL_MSG(wxT("not implemented"));
807 return wxTreeItemId();
810 wxTreeItemId
wxTreeCtrl::GetNextVisible(const wxTreeItemId
& item
) const
812 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
814 wxFAIL_MSG(wxT("not implemented"));
816 return wxTreeItemId();
819 wxTreeItemId
wxTreeCtrl::GetPrevVisible(const wxTreeItemId
& item
) const
821 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
823 wxFAIL_MSG(wxT("not implemented"));
825 return wxTreeItemId();
828 // -----------------------------------------------------------------------------
830 // -----------------------------------------------------------------------------
832 wxTreeItemId
wxTreeCtrl::DoInsertItem(const wxTreeItemId
& parentId
,
834 const wxString
& text
,
835 int image
, int selImage
,
836 wxTreeItemData
*data
)
838 wxGenericTreeItem
*parent
= parentId
.m_pItem
;
841 // should we give a warning here?
842 return AddRoot(text
, image
, selImage
, data
);
846 wxGenericTreeItem
*item
=
847 new wxGenericTreeItem( parent
, text
, dc
, image
, selImage
, data
);
851 data
->m_pItem
= item
;
854 parent
->Insert( item
, previous
);
861 wxTreeItemId
wxTreeCtrl::AddRoot(const wxString
& text
,
862 int image
, int selImage
,
863 wxTreeItemData
*data
)
865 wxCHECK_MSG( !m_anchor
, wxTreeItemId(), wxT("tree can have only one root") );
868 m_anchor
= new wxGenericTreeItem((wxGenericTreeItem
*)NULL
, text
, dc
,
869 image
, selImage
, data
);
872 data
->m_pItem
= m_anchor
;
875 if (!HasFlag(wxTR_MULTIPLE
))
877 m_current
= m_key_current
= m_anchor
;
878 m_current
->SetHilight( TRUE
);
882 AdjustMyScrollbars();
887 wxTreeItemId
wxTreeCtrl::PrependItem(const wxTreeItemId
& parent
,
888 const wxString
& text
,
889 int image
, int selImage
,
890 wxTreeItemData
*data
)
892 return DoInsertItem(parent
, 0u, text
, image
, selImage
, data
);
895 wxTreeItemId
wxTreeCtrl::InsertItem(const wxTreeItemId
& parentId
,
896 const wxTreeItemId
& idPrevious
,
897 const wxString
& text
,
898 int image
, int selImage
,
899 wxTreeItemData
*data
)
901 wxGenericTreeItem
*parent
= parentId
.m_pItem
;
904 // should we give a warning here?
905 return AddRoot(text
, image
, selImage
, data
);
908 int index
= parent
->GetChildren().Index(idPrevious
.m_pItem
);
909 wxASSERT_MSG( index
!= wxNOT_FOUND
,
910 wxT("previous item in wxTreeCtrl::InsertItem() is not a sibling") );
911 return DoInsertItem(parentId
, (size_t)++index
, text
, image
, selImage
, data
);
914 wxTreeItemId
wxTreeCtrl::AppendItem(const wxTreeItemId
& parentId
,
915 const wxString
& text
,
916 int image
, int selImage
,
917 wxTreeItemData
*data
)
919 wxGenericTreeItem
*parent
= parentId
.m_pItem
;
922 // should we give a warning here?
923 return AddRoot(text
, image
, selImage
, data
);
926 return DoInsertItem(parent
, parent
->GetChildren().Count(), text
,
927 image
, selImage
, data
);
930 void wxTreeCtrl::SendDeleteEvent(wxGenericTreeItem
*item
)
932 wxTreeEvent
event( wxEVT_COMMAND_TREE_DELETE_ITEM
, GetId() );
934 event
.SetEventObject( this );
935 ProcessEvent( event
);
938 void wxTreeCtrl::DeleteChildren(const wxTreeItemId
& itemId
)
940 wxGenericTreeItem
*item
= itemId
.m_pItem
;
941 item
->DeleteChildren(this);
946 void wxTreeCtrl::Delete(const wxTreeItemId
& itemId
)
948 wxGenericTreeItem
*item
= itemId
.m_pItem
;
949 wxGenericTreeItem
*parent
= item
->GetParent();
953 parent
->GetChildren().Remove(item
);
956 item
->DeleteChildren(this);
957 SendDeleteEvent(item
);
963 void wxTreeCtrl::DeleteAllItems()
967 m_anchor
->DeleteChildren(this);
976 void wxTreeCtrl::Expand(const wxTreeItemId
& itemId
)
978 wxGenericTreeItem
*item
= itemId
.m_pItem
;
980 if ( !item
->HasPlus() )
983 if ( item
->IsExpanded() )
986 wxTreeEvent
event( wxEVT_COMMAND_TREE_ITEM_EXPANDING
, GetId() );
988 event
.SetEventObject( this );
990 // if ( ProcessEvent( event ) && event.m_code ) TODO: Was this a typo ?
991 if ( ProcessEvent( event
) && !event
.IsAllowed() )
993 // cancelled by program
998 CalculatePositions();
1000 RefreshSubtree(item
);
1002 event
.SetEventType(wxEVT_COMMAND_TREE_ITEM_EXPANDED
);
1003 ProcessEvent( event
);
1006 void wxTreeCtrl::Collapse(const wxTreeItemId
& itemId
)
1008 wxGenericTreeItem
*item
= itemId
.m_pItem
;
1010 if ( !item
->IsExpanded() )
1013 wxTreeEvent
event( wxEVT_COMMAND_TREE_ITEM_COLLAPSING
, GetId() );
1014 event
.m_item
= item
;
1015 event
.SetEventObject( this );
1016 if ( ProcessEvent( event
) && !event
.IsAllowed() )
1018 // cancelled by program
1024 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1025 size_t count
= children
.Count();
1026 for ( size_t n
= 0; n
< count
; n
++ )
1028 Collapse(children
[n
]);
1031 CalculatePositions();
1033 RefreshSubtree(item
);
1035 event
.SetEventType(wxEVT_COMMAND_TREE_ITEM_COLLAPSED
);
1036 ProcessEvent( event
);
1039 void wxTreeCtrl::CollapseAndReset(const wxTreeItemId
& item
)
1042 DeleteChildren(item
);
1045 void wxTreeCtrl::Toggle(const wxTreeItemId
& itemId
)
1047 wxGenericTreeItem
*item
= itemId
.m_pItem
;
1049 if ( item
->IsExpanded() )
1055 void wxTreeCtrl::Unselect()
1059 m_current
->SetHilight( FALSE
);
1060 RefreshLine( m_current
);
1064 void wxTreeCtrl::UnselectAllChildren(wxGenericTreeItem
*item
)
1066 item
->SetHilight(FALSE
);
1069 if (item
->HasChildren())
1071 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1072 size_t count
= children
.Count();
1073 for ( size_t n
= 0; n
< count
; ++n
)
1074 UnselectAllChildren(children
[n
]);
1078 void wxTreeCtrl::UnselectAll()
1080 UnselectAllChildren(GetRootItem().m_pItem
);
1083 // Recursive function !
1084 // To stop we must have crt_item<last_item
1086 // Tag all next children, when no more children,
1087 // Move to parent (not to tag)
1088 // Keep going... if we found last_item, we stop.
1089 bool wxTreeCtrl::TagNextChildren(wxGenericTreeItem
*crt_item
, wxGenericTreeItem
*last_item
, bool select
)
1091 wxGenericTreeItem
*parent
= crt_item
->GetParent();
1093 if ( parent
== NULL
) // This is root item
1094 return TagAllChildrenUntilLast(crt_item
, last_item
, select
);
1096 wxArrayGenericTreeItems
& children
= parent
->GetChildren();
1097 int index
= children
.Index(crt_item
);
1098 wxASSERT( index
!= wxNOT_FOUND
); // I'm not a child of my parent?
1100 size_t count
= children
.Count();
1101 for (size_t n
=(size_t)(index
+1); n
<count
; ++n
)
1102 if (TagAllChildrenUntilLast(children
[n
], last_item
, select
)) return TRUE
;
1104 return TagNextChildren(parent
, last_item
, select
);
1107 bool wxTreeCtrl::TagAllChildrenUntilLast(wxGenericTreeItem
*crt_item
, wxGenericTreeItem
*last_item
, bool select
)
1109 crt_item
->SetHilight(select
);
1110 RefreshLine(crt_item
);
1112 if (crt_item
==last_item
) return TRUE
;
1114 if (crt_item
->HasChildren())
1116 wxArrayGenericTreeItems
& children
= crt_item
->GetChildren();
1117 size_t count
= children
.Count();
1118 for ( size_t n
= 0; n
< count
; ++n
)
1119 if (TagAllChildrenUntilLast(children
[n
], last_item
, select
)) return TRUE
;
1125 void wxTreeCtrl::SelectItemRange(wxGenericTreeItem
*item1
, wxGenericTreeItem
*item2
)
1127 // item2 is not necessary after item1
1128 wxGenericTreeItem
*first
=NULL
, *last
=NULL
;
1130 // choice first' and 'last' between item1 and item2
1131 if (item1
->GetY()<item2
->GetY())
1142 bool select
= m_current
->IsSelected();
1144 if ( TagAllChildrenUntilLast(first
,last
,select
) )
1147 TagNextChildren(first
,last
,select
);
1150 void wxTreeCtrl::SelectItem(const wxTreeItemId
& itemId
,
1151 bool unselect_others
,
1152 bool extended_select
)
1154 wxCHECK_RET( itemId
.IsOk(), wxT("invalid tree item") );
1156 bool is_single
=!(GetWindowStyleFlag() & wxTR_MULTIPLE
);
1157 wxGenericTreeItem
*item
= itemId
.m_pItem
;
1159 //wxCHECK_RET( ( (!unselect_others) && is_single),
1160 // wxT("this is a single selection tree") );
1162 // to keep going anyhow !!!
1165 if (item
->IsSelected())
1166 return; // nothing to do
1167 unselect_others
= TRUE
;
1168 extended_select
= FALSE
;
1170 else if ( unselect_others
&& item
->IsSelected() )
1172 // selection change if there is more than one item currently selected
1173 wxArrayTreeItemIds selected_items
;
1174 if ( GetSelections(selected_items
) == 1 )
1178 wxTreeEvent
event( wxEVT_COMMAND_TREE_SEL_CHANGING
, GetId() );
1179 event
.m_item
= item
;
1180 event
.m_itemOld
= m_current
;
1181 event
.SetEventObject( this );
1182 // TODO : Here we don't send any selection mode yet !
1184 if ( GetEventHandler()->ProcessEvent( event
) && !event
.IsAllowed() )
1188 if (unselect_others
)
1190 if (is_single
) Unselect(); // to speed up thing
1195 if (extended_select
)
1197 if (m_current
== NULL
) m_current
=m_key_current
=GetRootItem().m_pItem
;
1198 // don't change the mark (m_current)
1199 SelectItemRange(m_current
, item
);
1203 bool select
=TRUE
; // the default
1205 // Check if we need to toggle hilight (ctrl mode)
1206 if (!unselect_others
)
1207 select
=!item
->IsSelected();
1209 m_current
= m_key_current
= item
;
1210 m_current
->SetHilight(select
);
1211 RefreshLine( m_current
);
1214 event
.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED
);
1215 GetEventHandler()->ProcessEvent( event
);
1218 void wxTreeCtrl::FillArray(wxGenericTreeItem
*item
,
1219 wxArrayTreeItemIds
&array
) const
1221 if ( item
->IsSelected() )
1222 array
.Add(wxTreeItemId(item
));
1224 if ( item
->HasChildren() )
1226 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1227 size_t count
= children
.GetCount();
1228 for ( size_t n
= 0; n
< count
; ++n
)
1229 FillArray(children
[n
],array
);
1233 size_t wxTreeCtrl::GetSelections(wxArrayTreeItemIds
&array
) const
1236 FillArray(GetRootItem().m_pItem
, array
);
1238 return array
.Count();
1241 void wxTreeCtrl::EnsureVisible(const wxTreeItemId
& item
)
1243 if (!item
.IsOk()) return;
1245 wxGenericTreeItem
*gitem
= item
.m_pItem
;
1247 // first expand all parent branches
1248 wxGenericTreeItem
*parent
= gitem
->GetParent();
1252 parent
= parent
->GetParent();
1255 //if (parent) CalculatePositions();
1260 void wxTreeCtrl::ScrollTo(const wxTreeItemId
&item
)
1262 if (!item
.IsOk()) return;
1264 // We have to call this here because the label in
1265 // question might just have been added and no screen
1266 // update taken place.
1267 if (m_dirty
) wxYield();
1269 wxGenericTreeItem
*gitem
= item
.m_pItem
;
1271 // now scroll to the item
1272 int item_y
= gitem
->GetY();
1276 ViewStart( &start_x
, &start_y
);
1277 start_y
*= PIXELS_PER_UNIT
;
1281 GetClientSize( &client_w
, &client_h
);
1283 if (item_y
< start_y
+3)
1288 m_anchor
->GetSize( x
, y
, this );
1289 y
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
1290 int x_pos
= GetScrollPos( wxHORIZONTAL
);
1291 // Item should appear at top
1292 SetScrollbars( PIXELS_PER_UNIT
, PIXELS_PER_UNIT
, x
/PIXELS_PER_UNIT
, y
/PIXELS_PER_UNIT
, x_pos
, item_y
/PIXELS_PER_UNIT
);
1294 else if (item_y
+GetLineHeight(gitem
) > start_y
+client_h
)
1299 m_anchor
->GetSize( x
, y
, this );
1300 y
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
1301 item_y
+= PIXELS_PER_UNIT
+2;
1302 int x_pos
= GetScrollPos( wxHORIZONTAL
);
1303 // Item should appear at bottom
1304 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
);
1308 // FIXME: tree sorting functions are not reentrant and not MT-safe!
1309 static wxTreeCtrl
*s_treeBeingSorted
= NULL
;
1311 static int LINKAGEMODE
tree_ctrl_compare_func(wxGenericTreeItem
**item1
,
1312 wxGenericTreeItem
**item2
)
1314 wxCHECK_MSG( s_treeBeingSorted
, 0, wxT("bug in wxTreeCtrl::SortChildren()") );
1316 return s_treeBeingSorted
->OnCompareItems(*item1
, *item2
);
1319 int wxTreeCtrl::OnCompareItems(const wxTreeItemId
& item1
,
1320 const wxTreeItemId
& item2
)
1322 return wxStrcmp(GetItemText(item1
), GetItemText(item2
));
1325 void wxTreeCtrl::SortChildren(const wxTreeItemId
& itemId
)
1327 wxCHECK_RET( itemId
.IsOk(), wxT("invalid tree item") );
1329 wxGenericTreeItem
*item
= itemId
.m_pItem
;
1331 wxCHECK_RET( !s_treeBeingSorted
,
1332 wxT("wxTreeCtrl::SortChildren is not reentrant") );
1334 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1335 if ( children
.Count() > 1 )
1337 s_treeBeingSorted
= this;
1338 children
.Sort(tree_ctrl_compare_func
);
1339 s_treeBeingSorted
= NULL
;
1343 //else: don't make the tree dirty as nothing changed
1346 wxImageList
*wxTreeCtrl::GetImageList() const
1348 return m_imageListNormal
;
1351 wxImageList
*wxTreeCtrl::GetStateImageList() const
1353 return m_imageListState
;
1356 void wxTreeCtrl::SetImageList(wxImageList
*imageList
)
1358 m_imageListNormal
= imageList
;
1360 // Calculate a m_lineHeight value from the image sizes.
1361 // May be toggle off. Then wxTreeCtrl will spread when
1362 // necessary (which might look ugly).
1364 wxClientDC
dc(this);
1365 m_lineHeight
= (int)(dc
.GetCharHeight() + 4);
1369 n
= m_imageListNormal
->GetImageCount();
1370 for(int i
= 0; i
< n
; i
++)
1372 m_imageListNormal
->GetSize(i
, width
, height
);
1373 if(height
> m_lineHeight
) m_lineHeight
= height
;
1376 if (m_lineHeight
<40) m_lineHeight
+=4; // at least 4 pixels (odd such that a line can be drawn in between)
1377 else m_lineHeight
+=m_lineHeight
/10; // otherwise 10% extra spacing
1382 void wxTreeCtrl::SetStateImageList(wxImageList
*imageList
)
1384 m_imageListState
= imageList
;
1387 // -----------------------------------------------------------------------------
1389 // -----------------------------------------------------------------------------
1391 void wxTreeCtrl::AdjustMyScrollbars()
1397 m_anchor
->GetSize( x
, y
, this );
1398 //y += GetLineHeight(m_anchor);
1399 y
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
1400 int x_pos
= GetScrollPos( wxHORIZONTAL
);
1401 int y_pos
= GetScrollPos( wxVERTICAL
);
1402 SetScrollbars( PIXELS_PER_UNIT
, PIXELS_PER_UNIT
, x
/PIXELS_PER_UNIT
, y
/PIXELS_PER_UNIT
, x_pos
, y_pos
);
1406 SetScrollbars( 0, 0, 0, 0 );
1410 int wxTreeCtrl::GetLineHeight(wxGenericTreeItem
*item
) const
1412 if (GetWindowStyleFlag() & wxTR_HAS_VARIABLE_ROW_HEIGHT
)
1413 return item
->GetHeight();
1415 return m_lineHeight
;
1418 void wxTreeCtrl::PaintItem(wxGenericTreeItem
*item
, wxDC
& dc
)
1421 dc
.SetFont(m_boldFont
);
1425 dc
.GetTextExtent( item
->GetText(), &text_w
, &text_h
);
1429 int image
= item
->GetCurrentImage();
1430 if ( image
!= NO_IMAGE
)
1432 m_imageListNormal
->GetSize( image
, image_w
, image_h
);
1436 int total_h
= GetLineHeight(item
);
1438 dc
.DrawRectangle( item
->GetX()-2, item
->GetY(), item
->GetWidth()+2, total_h
);
1440 if ( image
!= NO_IMAGE
)
1442 dc
.SetClippingRegion( item
->GetX(), item
->GetY(), image_w
-2, total_h
);
1443 m_imageListNormal
->Draw( image
, dc
,
1445 item
->GetY() +((total_h
> image_h
)?((total_h
-image_h
)/2):0),
1446 wxIMAGELIST_DRAW_TRANSPARENT
);
1447 dc
.DestroyClippingRegion();
1450 dc
.SetBackgroundMode(wxTRANSPARENT
);
1451 dc
.DrawText( item
->GetText(), image_w
+ item
->GetX(), item
->GetY()
1452 + ((total_h
> text_h
) ? (total_h
- text_h
)/2 : 0));
1454 // restore normal font
1455 dc
.SetFont( m_normalFont
);
1458 // Now y stands for the top of the item, whereas it used to stand for middle !
1459 void wxTreeCtrl::PaintLevel( wxGenericTreeItem
*item
, wxDC
&dc
, int level
, int &y
)
1461 int horizX
= level
*m_indent
;
1463 item
->SetX( horizX
+m_indent
+m_spacing
);
1467 y
+=GetLineHeight(item
)/2;
1469 item
->SetCross( horizX
+m_indent
, y
);
1471 int exposed_x
= dc
.LogicalToDeviceX( 0 );
1472 int exposed_y
= dc
.LogicalToDeviceY( item
->GetY() );
1474 if (IsExposed( exposed_x
, exposed_y
, 10000, GetLineHeight(item
) )) // 10000 = very much
1476 int startX
= horizX
;
1477 int endX
= horizX
+ (m_indent
-5);
1479 // if (!item->HasChildren()) endX += (m_indent+5);
1480 if (!item
->HasChildren()) endX
+= 20;
1482 dc
.DrawLine( startX
, y
, endX
, y
);
1484 if (item
->HasPlus())
1486 dc
.DrawLine( horizX
+(m_indent
+5), y
, horizX
+(m_indent
+15), y
);
1487 dc
.SetPen( *wxGREY_PEN
);
1488 dc
.SetBrush( *wxWHITE_BRUSH
);
1489 dc
.DrawRectangle( horizX
+(m_indent
-5), y
-4, 11, 9 );
1491 dc
.SetPen( *wxBLACK_PEN
);
1492 dc
.DrawLine( horizX
+(m_indent
-2), y
, horizX
+(m_indent
+3), y
);
1493 if (!item
->IsExpanded())
1494 dc
.DrawLine( horizX
+m_indent
, y
-2, horizX
+m_indent
, y
+3 );
1496 dc
.SetPen( m_dottedPen
);
1499 if (item
->IsSelected())
1501 dc
.SetTextForeground( wxSystemSettings::GetSystemColour( wxSYS_COLOUR_HIGHLIGHTTEXT
) );
1503 dc
.SetBrush( *m_hilightBrush
);
1506 dc
.SetPen( *wxBLACK_PEN
);
1508 dc
.SetPen( *wxTRANSPARENT_PEN
);
1510 PaintItem(item
, dc
);
1512 dc
.SetPen( m_dottedPen
);
1513 dc
.SetTextForeground( *wxBLACK
);
1514 dc
.SetBrush( *wxWHITE_BRUSH
);
1518 dc
.SetBrush( *wxWHITE_BRUSH
);
1519 dc
.SetPen( *wxTRANSPARENT_PEN
);
1521 PaintItem(item
, dc
);
1523 dc
.SetPen( m_dottedPen
);
1527 y
= oldY
+GetLineHeight(item
);
1529 if (item
->IsExpanded())
1531 oldY
+=GetLineHeight(item
)/2;
1532 int semiOldY
=y
; // (=y) for stupid compilator
1534 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1535 size_t n
, count
= children
.Count();
1536 for ( n
= 0; n
< count
; ++n
)
1539 PaintLevel( children
[n
], dc
, level
+1, y
);
1542 // it may happen that the item is expanded but has no items (when you
1543 // delete all its children for example) - don't draw the vertical line
1547 semiOldY
+=GetLineHeight(children
[--n
])/2;
1548 dc
.DrawLine( horizX
+m_indent
, oldY
+5, horizX
+m_indent
, semiOldY
);
1553 void wxTreeCtrl::DrawBorder(wxTreeItemId
&item
)
1557 wxGenericTreeItem
*i
=item
.m_pItem
;
1559 wxClientDC
dc(this);
1561 dc
.SetLogicalFunction(wxINVERT
);
1564 ViewStart(&x
,&h
); // we only need x
1565 GetClientSize(&w
,&h
); // we only need w
1567 h
=GetLineHeight(i
)+1;
1568 // 2 white column at border
1569 dc
.DrawRectangle( PIXELS_PER_UNIT
*x
+2, i
->GetY()-1, w
-6, h
);
1572 void wxTreeCtrl::DrawLine(wxTreeItemId
&item
, bool below
)
1576 wxGenericTreeItem
*i
=item
.m_pItem
;
1578 wxClientDC
dc(this);
1580 dc
.SetLogicalFunction(wxINVERT
);
1585 if (below
) y
=i
->GetY()+GetLineHeight(i
)-1;
1588 dc
.DrawLine( 0, y
, w
, y
);
1591 // -----------------------------------------------------------------------------
1592 // wxWindows callbacks
1593 // -----------------------------------------------------------------------------
1595 void wxTreeCtrl::OnPaint( wxPaintEvent
&WXUNUSED(event
) )
1603 dc
.SetFont( m_normalFont
);
1604 dc
.SetPen( m_dottedPen
);
1606 // this is now done dynamically
1607 //if(GetImageList() == NULL)
1608 // m_lineHeight = (int)(dc.GetCharHeight() + 4);
1611 PaintLevel( m_anchor
, dc
, 0, y
);
1614 void wxTreeCtrl::OnSetFocus( wxFocusEvent
&WXUNUSED(event
) )
1618 if (m_current
) RefreshLine( m_current
);
1621 void wxTreeCtrl::OnKillFocus( wxFocusEvent
&WXUNUSED(event
) )
1625 if (m_current
) RefreshLine( m_current
);
1628 void wxTreeCtrl::OnChar( wxKeyEvent
&event
)
1630 wxTreeEvent
te( wxEVT_COMMAND_TREE_KEY_DOWN
, GetId() );
1631 te
.m_code
= event
.KeyCode();
1632 te
.SetEventObject( this );
1633 GetEventHandler()->ProcessEvent( te
);
1635 if ( (m_current
== 0) || (m_key_current
== 0) )
1641 bool is_multiple
=(GetWindowStyleFlag() & wxTR_MULTIPLE
);
1642 bool extended_select
=(event
.ShiftDown() && is_multiple
);
1643 bool unselect_others
=!(extended_select
|| (event
.ControlDown() && is_multiple
));
1645 switch (event
.KeyCode())
1649 if (m_current
->HasPlus() && !IsExpanded(m_current
))
1657 if (IsExpanded(m_current
))
1659 Collapse(m_current
);
1671 wxTreeEvent
event( wxEVT_COMMAND_TREE_ITEM_ACTIVATED
, GetId() );
1672 event
.m_item
= m_current
;
1674 event
.SetEventObject( this );
1675 GetEventHandler()->ProcessEvent( event
);
1679 // up goes to the previous sibling or to the last of its children if
1683 wxTreeItemId prev
= GetPrevSibling( m_key_current
);
1686 prev
= GetParent( m_key_current
);
1690 wxTreeItemId current
= m_key_current
;
1691 if (current
== GetFirstChild( prev
, cockie
))
1693 // otherwise we return to where we came from
1694 SelectItem( prev
, unselect_others
, extended_select
);
1695 m_key_current
=prev
.m_pItem
;
1696 EnsureVisible( prev
);
1703 while ( IsExpanded(prev
) && HasChildren(prev
) )
1705 wxTreeItemId child
= GetLastChild(prev
);
1712 SelectItem( prev
, unselect_others
, extended_select
);
1713 m_key_current
=prev
.m_pItem
;
1714 EnsureVisible( prev
);
1719 // left arrow goes to the parent
1722 wxTreeItemId prev
= GetParent( m_current
);
1725 EnsureVisible( prev
);
1726 SelectItem( prev
, unselect_others
, extended_select
);
1732 // this works the same as the down arrow except that we also expand the
1733 // item if it wasn't expanded yet
1739 if (IsExpanded(m_key_current
) && HasChildren(m_key_current
))
1742 wxTreeItemId child
= GetFirstChild( m_key_current
, cookie
);
1743 SelectItem( child
, unselect_others
, extended_select
);
1744 m_key_current
=child
.m_pItem
;
1745 EnsureVisible( child
);
1749 wxTreeItemId next
= GetNextSibling( m_key_current
);
1753 wxTreeItemId current
= m_key_current
;
1754 while (current
&& !next
)
1756 current
= GetParent( current
);
1757 if (current
) next
= GetNextSibling( current
);
1763 SelectItem( next
, unselect_others
, extended_select
);
1764 m_key_current
=next
.m_pItem
;
1765 EnsureVisible( next
);
1771 // <End> selects the last visible tree item
1774 wxTreeItemId last
= GetRootItem();
1776 while ( last
.IsOk() && IsExpanded(last
) )
1778 wxTreeItemId lastChild
= GetLastChild(last
);
1780 // it may happen if the item was expanded but then all of
1781 // its children have been deleted - so IsExpanded() returned
1782 // TRUE, but GetLastChild() returned invalid item
1791 EnsureVisible( last
);
1792 SelectItem( last
, unselect_others
, extended_select
);
1797 // <Home> selects the root item
1800 wxTreeItemId prev
= GetRootItem();
1803 EnsureVisible( prev
);
1804 SelectItem( prev
, unselect_others
, extended_select
);
1814 wxTreeItemId
wxTreeCtrl::HitTest(const wxPoint
& point
, int& flags
)
1816 // We have to call this here because the label in
1817 // question might just have been added and no screen
1818 // update taken place.
1819 if (m_dirty
) wxYield();
1821 wxClientDC
dc(this);
1823 long x
= dc
.DeviceToLogicalX( (long)point
.x
);
1824 long y
= dc
.DeviceToLogicalY( (long)point
.y
);
1829 if (point
.x
<0) flags
|=wxTREE_HITTEST_TOLEFT
;
1830 if (point
.x
>w
) flags
|=wxTREE_HITTEST_TORIGHT
;
1831 if (point
.y
<0) flags
|=wxTREE_HITTEST_ABOVE
;
1832 if (point
.y
>h
) flags
|=wxTREE_HITTEST_BELOW
;
1834 return m_anchor
->HitTest( wxPoint(x
, y
), this, flags
);
1839 void wxTreeCtrl::Edit( const wxTreeItemId
& item
)
1841 if (!item
.IsOk()) return;
1843 m_currentEdit
= item
.m_pItem
;
1845 wxTreeEvent
te( wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT
, GetId() );
1846 te
.m_item
= m_currentEdit
;
1847 te
.SetEventObject( this );
1848 GetEventHandler()->ProcessEvent( te
);
1850 if (!te
.IsAllowed()) return;
1852 // We have to call this here because the label in
1853 // question might just have been added and no screen
1854 // update taken place.
1855 if (m_dirty
) wxYield();
1857 wxString s
= m_currentEdit
->GetText();
1858 int x
= m_currentEdit
->GetX();
1859 int y
= m_currentEdit
->GetY();
1860 int w
= m_currentEdit
->GetWidth();
1861 int h
= m_currentEdit
->GetHeight();
1866 int image
= m_currentEdit
->GetCurrentImage();
1867 if ( image
!= NO_IMAGE
)
1869 m_imageListNormal
->GetSize( image
, image_w
, image_h
);
1873 w
-= image_w
+ 4; // I don't know why +4 is needed
1875 wxClientDC
dc(this);
1877 x
= dc
.LogicalToDeviceX( x
);
1878 y
= dc
.LogicalToDeviceY( y
);
1880 wxTreeTextCtrl
*text
= new wxTreeTextCtrl(
1881 this, -1, &m_renameAccept
, &m_renameRes
, this, s
, wxPoint(x
-4,y
-4), wxSize(w
+11,h
+8) );
1885 void wxTreeCtrl::OnRenameTimer()
1890 void wxTreeCtrl::OnRenameAccept()
1892 wxTreeEvent
le( wxEVT_COMMAND_TREE_END_LABEL_EDIT
, GetId() );
1893 le
.m_item
= m_currentEdit
;
1894 le
.SetEventObject( this );
1895 le
.m_label
= m_renameRes
;
1896 GetEventHandler()->ProcessEvent( le
);
1898 if (!le
.IsAllowed()) return;
1900 SetItemText( m_currentEdit
, m_renameRes
);
1903 void wxTreeCtrl::OnMouse( wxMouseEvent
&event
)
1905 if ( !(event
.LeftUp() || event
.RightDown() || event
.LeftDClick() || event
.Dragging()) ) return;
1907 if ( !m_anchor
) return;
1909 wxClientDC
dc(this);
1911 long x
= dc
.DeviceToLogicalX( (long)event
.GetX() );
1912 long y
= dc
.DeviceToLogicalY( (long)event
.GetY() );
1915 wxGenericTreeItem
*item
= m_anchor
->HitTest( wxPoint(x
,y
), this, flags
);
1916 bool onButton
= flags
& wxTREE_HITTEST_ONITEMBUTTON
;
1918 if (event
.Dragging())
1920 if (m_dragCount
== 0)
1921 m_dragStart
= wxPoint(x
,y
);
1925 if (m_dragCount
!= 3) return;
1927 int command
= wxEVT_COMMAND_TREE_BEGIN_DRAG
;
1928 if (event
.RightIsDown()) command
= wxEVT_COMMAND_TREE_BEGIN_RDRAG
;
1930 wxTreeEvent
nevent( command
, GetId() );
1931 nevent
.m_item
= m_current
;
1932 nevent
.SetEventObject(this);
1933 GetEventHandler()->ProcessEvent(nevent
);
1941 if (item
== NULL
) return; /* we hit the blank area */
1943 if (event
.RightDown()) {
1944 wxTreeEvent
nevent(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK
,GetId());
1947 nevent
.SetEventObject(this);
1948 GetEventHandler()->ProcessEvent(nevent
);
1952 if (event
.LeftUp() && (item
== m_current
) &&
1953 (flags
& wxTREE_HITTEST_ONITEMLABEL
) &&
1954 HasFlag(wxTR_EDIT_LABELS
) )
1956 m_renameTimer
->Start( 100, TRUE
);
1960 bool is_multiple
=(GetWindowStyleFlag() & wxTR_MULTIPLE
);
1961 bool extended_select
=(event
.ShiftDown() && is_multiple
);
1962 bool unselect_others
=!(extended_select
|| (event
.ControlDown() && is_multiple
));
1971 SelectItem(item
, unselect_others
, extended_select
);
1973 if (event
.LeftDClick())
1975 wxTreeEvent
event( wxEVT_COMMAND_TREE_ITEM_ACTIVATED
, GetId() );
1976 event
.m_item
= item
;
1978 event
.SetEventObject( this );
1979 GetEventHandler()->ProcessEvent( event
);
1983 void wxTreeCtrl::OnIdle( wxIdleEvent
&WXUNUSED(event
) )
1985 /* after all changes have been done to the tree control,
1986 * we actually redraw the tree when everything is over */
1993 CalculatePositions();
1995 AdjustMyScrollbars();
1998 void wxTreeCtrl::CalculateSize( wxGenericTreeItem
*item
, wxDC
&dc
)
2004 dc
.SetFont(m_boldFont
);
2006 dc
.GetTextExtent( item
->GetText(), &text_w
, &text_h
);
2009 // restore normal font
2010 dc
.SetFont( m_normalFont
);
2014 int image
= item
->GetCurrentImage();
2015 if ( image
!= NO_IMAGE
)
2017 m_imageListNormal
->GetSize( image
, image_w
, image_h
);
2021 int total_h
= (image_h
> text_h
) ? image_h
: text_h
;
2023 if (total_h
<40) total_h
+=4; // at least 4 pixels
2024 else total_h
+=total_h
/10; // otherwise 10% extra spacing
2026 item
->SetHeight(total_h
);
2027 if (total_h
>m_lineHeight
) m_lineHeight
=total_h
;
2029 item
->SetWidth(image_w
+text_w
+2);
2032 // -----------------------------------------------------------------------------
2033 // for developper : y is now the top of the level
2034 // not the middle of it !
2035 void wxTreeCtrl::CalculateLevel( wxGenericTreeItem
*item
, wxDC
&dc
, int level
, int &y
)
2037 int horizX
= level
*m_indent
;
2039 CalculateSize( item
, dc
);
2042 item
->SetX( horizX
+m_indent
+m_spacing
);
2044 y
+=GetLineHeight(item
);
2046 if ( !item
->IsExpanded() )
2048 // we dont need to calculate collapsed branches
2052 wxArrayGenericTreeItems
& children
= item
->GetChildren();
2053 size_t n
, count
= children
.Count();
2054 for (n
= 0; n
< count
; ++n
)
2055 CalculateLevel( children
[n
], dc
, level
+1, y
); // recurse
2058 void wxTreeCtrl::CalculatePositions()
2060 if ( !m_anchor
) return;
2062 wxClientDC
dc(this);
2065 dc
.SetFont( m_normalFont
);
2067 dc
.SetPen( m_dottedPen
);
2068 //if(GetImageList() == NULL)
2069 // m_lineHeight = (int)(dc.GetCharHeight() + 4);
2072 CalculateLevel( m_anchor
, dc
, 0, y
); // start recursion
2075 void wxTreeCtrl::RefreshSubtree(wxGenericTreeItem
*item
)
2077 wxClientDC
dc(this);
2082 GetClientSize( &cw
, &ch
);
2085 rect
.x
= dc
.LogicalToDeviceX( 0 );
2087 rect
.y
= dc
.LogicalToDeviceY( item
->GetY() );
2090 Refresh( TRUE
, &rect
);
2092 AdjustMyScrollbars();
2095 void wxTreeCtrl::RefreshLine( wxGenericTreeItem
*item
)
2097 wxClientDC
dc(this);
2102 GetClientSize( &cw
, &ch
);
2105 rect
.x
= dc
.LogicalToDeviceX( 0 );
2106 rect
.y
= dc
.LogicalToDeviceY( item
->GetY() );
2108 rect
.height
= GetLineHeight(item
); //dc.GetCharHeight() + 6;
2110 Refresh( TRUE
, &rect
);