1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/generic/treectlg.cpp
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 and Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // =============================================================================
14 // =============================================================================
16 // -----------------------------------------------------------------------------
18 // -----------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
29 #include "wx/treectrl.h"
32 #include "wx/dcclient.h"
34 #include "wx/settings.h"
35 #include "wx/listbox.h"
36 #include "wx/textctrl.h"
39 #include "wx/generic/treectlg.h"
40 #include "wx/imaglist.h"
42 #include "wx/renderer.h"
45 #include "wx/mac/private.h"
48 // -----------------------------------------------------------------------------
50 // -----------------------------------------------------------------------------
52 class WXDLLIMPEXP_FWD_CORE wxGenericTreeItem
;
54 WX_DEFINE_EXPORTED_ARRAY_PTR(wxGenericTreeItem
*, wxArrayGenericTreeItems
);
56 // ----------------------------------------------------------------------------
58 // ----------------------------------------------------------------------------
60 static const int NO_IMAGE
= -1;
62 static const int PIXELS_PER_UNIT
= 10;
64 // the margin between the item image and the item text
65 static const int MARGIN_BETWEEN_IMAGE_AND_TEXT
= 4;
67 // -----------------------------------------------------------------------------
69 // -----------------------------------------------------------------------------
71 // timer used for enabling in-place edit
72 class WXDLLEXPORT wxTreeRenameTimer
: public wxTimer
75 // start editing the current item after half a second (if the mouse hasn't
76 // been clicked/moved)
79 wxTreeRenameTimer( wxGenericTreeCtrl
*owner
);
81 virtual void Notify();
84 wxGenericTreeCtrl
*m_owner
;
86 DECLARE_NO_COPY_CLASS(wxTreeRenameTimer
)
89 // control used for in-place edit
90 class WXDLLEXPORT wxTreeTextCtrl
: public wxTextCtrl
93 wxTreeTextCtrl(wxGenericTreeCtrl
*owner
, wxGenericTreeItem
*item
);
95 void EndEdit(bool discardChanges
= false)
103 m_aboutToFinish
= true;
105 // Notify the owner about the changes
108 // Even if vetoed, close the control (consistent with MSW)
116 m_owner
->OnRenameCancelled(m_itemEdited
);
118 const wxGenericTreeItem
* item() const { return m_itemEdited
; }
121 void OnChar( wxKeyEvent
&event
);
122 void OnKeyUp( wxKeyEvent
&event
);
123 void OnKillFocus( wxFocusEvent
&event
);
125 bool AcceptChanges();
129 wxGenericTreeCtrl
*m_owner
;
130 wxGenericTreeItem
*m_itemEdited
;
131 wxString m_startValue
;
133 bool m_aboutToFinish
;
135 DECLARE_EVENT_TABLE()
136 DECLARE_NO_COPY_CLASS(wxTreeTextCtrl
)
139 // timer used to clear wxGenericTreeCtrl::m_findPrefix if no key was pressed
140 // for a sufficiently long time
141 class WXDLLEXPORT wxTreeFindTimer
: public wxTimer
144 // reset the current prefix after half a second of inactivity
145 enum { DELAY
= 500 };
147 wxTreeFindTimer( wxGenericTreeCtrl
*owner
) { m_owner
= owner
; }
149 virtual void Notify() { m_owner
->m_findPrefix
.clear(); }
152 wxGenericTreeCtrl
*m_owner
;
154 DECLARE_NO_COPY_CLASS(wxTreeFindTimer
)
158 class WXDLLEXPORT wxGenericTreeItem
162 wxGenericTreeItem() { m_data
= NULL
; }
163 wxGenericTreeItem( wxGenericTreeItem
*parent
,
164 const wxString
& text
,
167 wxTreeItemData
*data
);
169 ~wxGenericTreeItem();
172 wxArrayGenericTreeItems
& GetChildren() { return m_children
; }
174 const wxString
& GetText() const { return m_text
; }
175 int GetImage(wxTreeItemIcon which
= wxTreeItemIcon_Normal
) const
176 { return m_images
[which
]; }
177 wxTreeItemData
*GetData() const { return m_data
; }
179 // returns the current image for the item (depending on its
180 // selected/expanded/whatever state)
181 int GetCurrentImage() const;
183 void SetText( const wxString
&text
);
184 void SetImage(int image
, wxTreeItemIcon which
) { m_images
[which
] = image
; }
185 void SetData(wxTreeItemData
*data
) { m_data
= data
; }
187 void SetHasPlus(bool has
= true) { m_hasPlus
= has
; }
189 void SetBold(bool bold
) { m_isBold
= bold
; }
191 int GetX() const { return m_x
; }
192 int GetY() const { return m_y
; }
194 void SetX(int x
) { m_x
= x
; }
195 void SetY(int y
) { m_y
= y
; }
197 int GetHeight() const { return m_height
; }
198 int GetWidth() const { return m_width
; }
200 void SetHeight(int h
) { m_height
= h
; }
201 void SetWidth(int w
) { m_width
= w
; }
203 wxGenericTreeItem
*GetParent() const { return m_parent
; }
207 // deletes all children notifying the treectrl about it
208 void DeleteChildren(wxGenericTreeCtrl
*tree
);
210 // get count of all children (and grand children if 'recursively')
211 size_t GetChildrenCount(bool recursively
= true) const;
213 void Insert(wxGenericTreeItem
*child
, size_t index
)
214 { m_children
.Insert(child
, index
); }
216 void GetSize( int &x
, int &y
, const wxGenericTreeCtrl
* );
218 // return the item at given position (or NULL if no item), onButton is
219 // true if the point belongs to the item's button, otherwise it lies
220 // on the item's label
221 wxGenericTreeItem
*HitTest( const wxPoint
& point
,
222 const wxGenericTreeCtrl
*,
226 void Expand() { m_isCollapsed
= false; }
227 void Collapse() { m_isCollapsed
= true; }
229 void SetHilight( bool set
= true ) { m_hasHilight
= set
; }
232 bool HasChildren() const { return !m_children
.IsEmpty(); }
233 bool IsSelected() const { return m_hasHilight
!= 0; }
234 bool IsExpanded() const { return !m_isCollapsed
; }
235 bool HasPlus() const { return m_hasPlus
|| HasChildren(); }
236 bool IsBold() const { return m_isBold
!= 0; }
239 // get them - may be NULL
240 wxTreeItemAttr
*GetAttributes() const { return m_attr
; }
241 // get them ensuring that the pointer is not NULL
242 wxTreeItemAttr
& Attr()
246 m_attr
= new wxTreeItemAttr
;
252 void SetAttributes(wxTreeItemAttr
*attr
)
254 if ( m_ownsAttr
) delete m_attr
;
258 // set them and delete when done
259 void AssignAttributes(wxTreeItemAttr
*attr
)
266 // since there can be very many of these, we save size by chosing
267 // the smallest representation for the elements and by ordering
268 // the members to avoid padding.
269 wxString m_text
; // label to be rendered for item
271 wxTreeItemData
*m_data
; // user-provided data
273 wxArrayGenericTreeItems m_children
; // list of children
274 wxGenericTreeItem
*m_parent
; // parent of this item
276 wxTreeItemAttr
*m_attr
; // attributes???
278 // tree ctrl images for the normal, selected, expanded and
279 // expanded+selected states
280 int m_images
[wxTreeItemIcon_Max
];
282 wxCoord m_x
; // (virtual) offset from top
283 wxCoord m_y
; // (virtual) offset from left
284 int m_width
; // width of this item
285 int m_height
; // height of this item
287 // use bitfields to save size
288 unsigned int m_isCollapsed
:1;
289 unsigned int m_hasHilight
:1; // same as focused
290 unsigned int m_hasPlus
:1; // used for item which doesn't have
291 // children but has a [+] button
292 unsigned int m_isBold
:1; // render the label in bold font
293 unsigned int m_ownsAttr
:1; // delete attribute when done
295 DECLARE_NO_COPY_CLASS(wxGenericTreeItem
)
298 // =============================================================================
300 // =============================================================================
302 // ----------------------------------------------------------------------------
304 // ----------------------------------------------------------------------------
306 // translate the key or mouse event flags to the type of selection we're
308 static void EventFlagsToSelType(long style
,
312 bool &extended_select
,
313 bool &unselect_others
)
315 is_multiple
= (style
& wxTR_MULTIPLE
) != 0;
316 extended_select
= shiftDown
&& is_multiple
;
317 unselect_others
= !(extended_select
|| (ctrlDown
&& is_multiple
));
320 // check if the given item is under another one
321 static bool IsDescendantOf(const wxGenericTreeItem
*parent
, const wxGenericTreeItem
*item
)
325 if ( item
== parent
)
327 // item is a descendant of parent
331 item
= item
->GetParent();
337 // -----------------------------------------------------------------------------
338 // wxTreeRenameTimer (internal)
339 // -----------------------------------------------------------------------------
341 wxTreeRenameTimer::wxTreeRenameTimer( wxGenericTreeCtrl
*owner
)
346 void wxTreeRenameTimer::Notify()
348 m_owner
->OnRenameTimer();
351 //-----------------------------------------------------------------------------
352 // wxTreeTextCtrl (internal)
353 //-----------------------------------------------------------------------------
355 BEGIN_EVENT_TABLE(wxTreeTextCtrl
,wxTextCtrl
)
356 EVT_CHAR (wxTreeTextCtrl::OnChar
)
357 EVT_KEY_UP (wxTreeTextCtrl::OnKeyUp
)
358 EVT_KILL_FOCUS (wxTreeTextCtrl::OnKillFocus
)
361 wxTreeTextCtrl::wxTreeTextCtrl(wxGenericTreeCtrl
*owner
,
362 wxGenericTreeItem
*item
)
363 : m_itemEdited(item
), m_startValue(item
->GetText())
367 m_aboutToFinish
= false;
369 int w
= m_itemEdited
->GetWidth(),
370 h
= m_itemEdited
->GetHeight();
373 m_owner
->CalcScrolledPosition(item
->GetX(), item
->GetY(), &x
, &y
);
378 int image
= item
->GetCurrentImage();
379 if ( image
!= NO_IMAGE
)
381 if ( m_owner
->m_imageListNormal
)
383 m_owner
->m_imageListNormal
->GetSize( image
, image_w
, image_h
);
384 image_w
+= MARGIN_BETWEEN_IMAGE_AND_TEXT
;
388 wxFAIL_MSG(_T("you must create an image list to use images!"));
392 // FIXME: what are all these hardcoded 4, 8 and 11s really?
396 wxSize bs
= DoGetBestSize() ;
397 // edit control height
400 int diff
= h
- ( bs
.y
- 8 ) ;
406 (void)Create(m_owner
, wxID_ANY
, m_startValue
,
407 wxPoint(x
- 4, y
- 4), wxSize(w
+ 11, h
+ 8));
410 bool wxTreeTextCtrl::AcceptChanges()
412 const wxString value
= GetValue();
414 if ( value
== m_startValue
)
416 // nothing changed, always accept
417 // when an item remains unchanged, the owner
418 // needs to be notified that the user decided
419 // not to change the tree item label, and that
420 // the edit has been cancelled
422 m_owner
->OnRenameCancelled(m_itemEdited
);
426 if ( !m_owner
->OnRenameAccept(m_itemEdited
, value
) )
428 // vetoed by the user
432 // accepted, do rename the item
433 m_owner
->SetItemText(m_itemEdited
, value
);
438 void wxTreeTextCtrl::Finish()
442 m_owner
->ResetTextControl();
444 wxPendingDelete
.Append(this);
452 void wxTreeTextCtrl::OnChar( wxKeyEvent
&event
)
454 switch ( event
.m_keyCode
)
469 void wxTreeTextCtrl::OnKeyUp( wxKeyEvent
&event
)
473 // auto-grow the textctrl:
474 wxSize parentSize
= m_owner
->GetSize();
475 wxPoint myPos
= GetPosition();
476 wxSize mySize
= GetSize();
478 GetTextExtent(GetValue() + _T("M"), &sx
, &sy
);
479 if (myPos
.x
+ sx
> parentSize
.x
)
480 sx
= parentSize
.x
- myPos
.x
;
483 SetSize(sx
, wxDefaultCoord
);
489 void wxTreeTextCtrl::OnKillFocus( wxFocusEvent
&event
)
491 if ( !m_finished
&& !m_aboutToFinish
)
493 // We must finish regardless of success, otherwise we'll get
497 if ( !AcceptChanges() )
498 m_owner
->OnRenameCancelled( m_itemEdited
);
501 // We must let the native text control handle focus, too, otherwise
502 // it could have problems with the cursor (e.g., in wxGTK).
506 // -----------------------------------------------------------------------------
508 // -----------------------------------------------------------------------------
510 wxGenericTreeItem::wxGenericTreeItem(wxGenericTreeItem
*parent
,
511 const wxString
& text
,
512 int image
, int selImage
,
513 wxTreeItemData
*data
)
516 m_images
[wxTreeItemIcon_Normal
] = image
;
517 m_images
[wxTreeItemIcon_Selected
] = selImage
;
518 m_images
[wxTreeItemIcon_Expanded
] = NO_IMAGE
;
519 m_images
[wxTreeItemIcon_SelectedExpanded
] = NO_IMAGE
;
524 m_isCollapsed
= true;
525 m_hasHilight
= false;
531 m_attr
= (wxTreeItemAttr
*)NULL
;
534 // We don't know the height here yet.
539 wxGenericTreeItem::~wxGenericTreeItem()
543 if (m_ownsAttr
) delete m_attr
;
545 wxASSERT_MSG( m_children
.IsEmpty(),
546 wxT("please call DeleteChildren() before deleting the item") );
549 void wxGenericTreeItem::DeleteChildren(wxGenericTreeCtrl
*tree
)
551 size_t count
= m_children
.GetCount();
552 for ( size_t n
= 0; n
< count
; n
++ )
554 wxGenericTreeItem
*child
= m_children
[n
];
555 tree
->SendDeleteEvent(child
);
557 child
->DeleteChildren(tree
);
558 if ( child
== tree
->m_select_me
)
559 tree
->m_select_me
= NULL
;
566 void wxGenericTreeItem::SetText( const wxString
&text
)
571 size_t wxGenericTreeItem::GetChildrenCount(bool recursively
) const
573 size_t count
= m_children
.GetCount();
577 size_t total
= count
;
578 for (size_t n
= 0; n
< count
; ++n
)
580 total
+= m_children
[n
]->GetChildrenCount();
586 void wxGenericTreeItem::GetSize( int &x
, int &y
,
587 const wxGenericTreeCtrl
*theButton
)
589 int bottomY
=m_y
+theButton
->GetLineHeight(this);
590 if ( y
< bottomY
) y
= bottomY
;
591 int width
= m_x
+ m_width
;
592 if ( x
< width
) x
= width
;
596 size_t count
= m_children
.GetCount();
597 for ( size_t n
= 0; n
< count
; ++n
)
599 m_children
[n
]->GetSize( x
, y
, theButton
);
604 wxGenericTreeItem
*wxGenericTreeItem::HitTest(const wxPoint
& point
,
605 const wxGenericTreeCtrl
*theCtrl
,
609 // for a hidden root node, don't evaluate it, but do evaluate children
610 if ( !(level
== 0 && theCtrl
->HasFlag(wxTR_HIDE_ROOT
)) )
613 int h
= theCtrl
->GetLineHeight(this);
614 if ((point
.y
> m_y
) && (point
.y
< m_y
+ h
))
616 int y_mid
= m_y
+ h
/2;
617 if (point
.y
< y_mid
)
618 flags
|= wxTREE_HITTEST_ONITEMUPPERPART
;
620 flags
|= wxTREE_HITTEST_ONITEMLOWERPART
;
622 int xCross
= m_x
- theCtrl
->GetSpacing();
624 // according to the drawing code the triangels are drawn
625 // at -4 , -4 from the position up to +10/+10 max
626 if ((point
.x
> xCross
-4) && (point
.x
< xCross
+10) &&
627 (point
.y
> y_mid
-4) && (point
.y
< y_mid
+10) &&
628 HasPlus() && theCtrl
->HasButtons() )
630 // 5 is the size of the plus sign
631 if ((point
.x
> xCross
-6) && (point
.x
< xCross
+6) &&
632 (point
.y
> y_mid
-6) && (point
.y
< y_mid
+6) &&
633 HasPlus() && theCtrl
->HasButtons() )
636 flags
|= wxTREE_HITTEST_ONITEMBUTTON
;
640 if ((point
.x
>= m_x
) && (point
.x
<= m_x
+m_width
))
645 // assuming every image (normal and selected) has the same size!
646 if ( (GetImage() != NO_IMAGE
) && theCtrl
->m_imageListNormal
)
647 theCtrl
->m_imageListNormal
->GetSize(GetImage(),
650 if ((image_w
!= -1) && (point
.x
<= m_x
+ image_w
+ 1))
651 flags
|= wxTREE_HITTEST_ONITEMICON
;
653 flags
|= wxTREE_HITTEST_ONITEMLABEL
;
659 flags
|= wxTREE_HITTEST_ONITEMINDENT
;
660 if (point
.x
> m_x
+m_width
)
661 flags
|= wxTREE_HITTEST_ONITEMRIGHT
;
666 // if children are expanded, fall through to evaluate them
667 if (m_isCollapsed
) return (wxGenericTreeItem
*) NULL
;
671 size_t count
= m_children
.GetCount();
672 for ( size_t n
= 0; n
< count
; n
++ )
674 wxGenericTreeItem
*res
= m_children
[n
]->HitTest( point
,
682 return (wxGenericTreeItem
*) NULL
;
685 int wxGenericTreeItem::GetCurrentImage() const
687 int image
= NO_IMAGE
;
692 image
= GetImage(wxTreeItemIcon_SelectedExpanded
);
695 if ( image
== NO_IMAGE
)
697 // we usually fall back to the normal item, but try just the
698 // expanded one (and not selected) first in this case
699 image
= GetImage(wxTreeItemIcon_Expanded
);
705 image
= GetImage(wxTreeItemIcon_Selected
);
708 // maybe it doesn't have the specific image we want,
709 // try the default one instead
710 if ( image
== NO_IMAGE
) image
= GetImage();
715 // -----------------------------------------------------------------------------
716 // wxGenericTreeCtrl implementation
717 // -----------------------------------------------------------------------------
719 IMPLEMENT_DYNAMIC_CLASS(wxGenericTreeCtrl
, wxControl
)
721 BEGIN_EVENT_TABLE(wxGenericTreeCtrl
, wxTreeCtrlBase
)
722 EVT_PAINT (wxGenericTreeCtrl::OnPaint
)
723 EVT_SIZE (wxGenericTreeCtrl::OnSize
)
724 EVT_MOUSE_EVENTS (wxGenericTreeCtrl::OnMouse
)
725 EVT_CHAR (wxGenericTreeCtrl::OnChar
)
726 EVT_SET_FOCUS (wxGenericTreeCtrl::OnSetFocus
)
727 EVT_KILL_FOCUS (wxGenericTreeCtrl::OnKillFocus
)
728 EVT_TREE_ITEM_GETTOOLTIP(wxID_ANY
, wxGenericTreeCtrl::OnGetToolTip
)
731 #if !defined(__WXMSW__) || defined(__WXUNIVERSAL__)
733 * wxTreeCtrl has to be a real class or we have problems with
734 * the run-time information.
737 IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl
, wxGenericTreeCtrl
)
740 // -----------------------------------------------------------------------------
741 // construction/destruction
742 // -----------------------------------------------------------------------------
744 void wxGenericTreeCtrl::Init()
749 m_select_me
= (wxGenericTreeItem
*) NULL
;
757 m_hilightBrush
= new wxBrush
759 wxSystemSettings::GetColour
761 wxSYS_COLOUR_HIGHLIGHT
766 m_hilightUnfocusedBrush
= new wxBrush
768 wxSystemSettings::GetColour
770 wxSYS_COLOUR_BTNSHADOW
775 m_imageListButtons
= NULL
;
776 m_ownsImageListButtons
= false;
779 m_isDragging
= false;
780 m_dropTarget
= m_oldSelection
= NULL
;
784 m_renameTimer
= NULL
;
789 m_dropEffectAboveItem
= false;
791 m_lastOnSame
= false;
793 #ifdef __WXMAC_CARBON__
794 m_normalFont
.MacCreateThemeFont( kThemeViewsFont
) ;
796 m_normalFont
= wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT
);
798 m_boldFont
= wxFont(m_normalFont
.GetPointSize(),
799 m_normalFont
.GetFamily(),
800 m_normalFont
.GetStyle(),
802 m_normalFont
.GetUnderlined(),
803 m_normalFont
.GetFaceName(),
804 m_normalFont
.GetEncoding());
807 bool wxGenericTreeCtrl::Create(wxWindow
*parent
,
812 const wxValidator
& validator
,
813 const wxString
& name
)
817 wxGetOsVersion( &major
, &minor
);
819 style
&= ~wxTR_LINES_AT_ROOT
;
820 style
|= wxTR_NO_LINES
;
822 style
|= wxTR_ROW_LINES
;
824 if (style
== 0 || style
& wxTR_DEFAULT_STYLE
)
825 style
|= wxTR_FULL_ROW_HIGHLIGHT
;
829 style
|= wxTR_NO_LINES
;
832 if ( !wxControl::Create( parent
, id
, pos
, size
,
833 style
|wxHSCROLL
|wxVSCROLL
,
838 // If the tree display has no buttons, but does have
839 // connecting lines, we can use a narrower layout.
840 // It may not be a good idea to force this...
841 if (!HasButtons() && !HasFlag(wxTR_NO_LINES
))
847 wxVisualAttributes attr
= GetDefaultAttributes();
848 SetOwnForegroundColour( attr
.colFg
);
849 SetOwnBackgroundColour( attr
.colBg
);
851 SetOwnFont(attr
.font
);
853 // this is a misnomer: it's called "dotted pen" but uses (default) wxSOLID
854 // style because we apparently get performance problems when using dotted
855 // pen for drawing in some ports -- but under MSW it seems to work fine
857 m_dottedPen
= wxPen(*wxLIGHT_GREY
, 0, wxDOT
);
859 m_dottedPen
= *wxGREY_PEN
;
862 SetInitialSize(size
);
867 wxGenericTreeCtrl::~wxGenericTreeCtrl()
869 delete m_hilightBrush
;
870 delete m_hilightUnfocusedBrush
;
874 delete m_renameTimer
;
877 if (m_ownsImageListButtons
)
878 delete m_imageListButtons
;
881 // -----------------------------------------------------------------------------
883 // -----------------------------------------------------------------------------
885 unsigned int wxGenericTreeCtrl::GetCount() const
893 unsigned int count
= m_anchor
->GetChildrenCount();
894 if ( !HasFlag(wxTR_HIDE_ROOT
) )
896 // take the root itself into account
903 void wxGenericTreeCtrl::SetIndent(unsigned int indent
)
905 m_indent
= (unsigned short) indent
;
910 wxGenericTreeCtrl::GetChildrenCount(const wxTreeItemId
& item
,
911 bool recursively
) const
913 wxCHECK_MSG( item
.IsOk(), 0u, wxT("invalid tree item") );
915 return ((wxGenericTreeItem
*) item
.m_pItem
)->GetChildrenCount(recursively
);
918 void wxGenericTreeCtrl::SetWindowStyle(const long styles
)
920 // Do not try to expand the root node if it hasn't been created yet
921 if (m_anchor
&& !HasFlag(wxTR_HIDE_ROOT
) && (styles
& wxTR_HIDE_ROOT
))
923 // if we will hide the root, make sure children are visible
924 m_anchor
->SetHasPlus();
926 CalculatePositions();
929 // right now, just sets the styles. Eventually, we may
930 // want to update the inherited styles, but right now
931 // none of the parents has updatable styles
932 m_windowStyle
= styles
;
936 // -----------------------------------------------------------------------------
937 // functions to work with tree items
938 // -----------------------------------------------------------------------------
940 wxString
wxGenericTreeCtrl::GetItemText(const wxTreeItemId
& item
) const
942 wxCHECK_MSG( item
.IsOk(), wxEmptyString
, wxT("invalid tree item") );
944 return ((wxGenericTreeItem
*) item
.m_pItem
)->GetText();
947 int wxGenericTreeCtrl::GetItemImage(const wxTreeItemId
& item
,
948 wxTreeItemIcon which
) const
950 wxCHECK_MSG( item
.IsOk(), -1, wxT("invalid tree item") );
952 return ((wxGenericTreeItem
*) item
.m_pItem
)->GetImage(which
);
955 wxTreeItemData
*wxGenericTreeCtrl::GetItemData(const wxTreeItemId
& item
) const
957 wxCHECK_MSG( item
.IsOk(), NULL
, wxT("invalid tree item") );
959 return ((wxGenericTreeItem
*) item
.m_pItem
)->GetData();
962 wxColour
wxGenericTreeCtrl::GetItemTextColour(const wxTreeItemId
& item
) const
964 wxCHECK_MSG( item
.IsOk(), wxNullColour
, wxT("invalid tree item") );
966 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
967 return pItem
->Attr().GetTextColour();
970 wxColour
wxGenericTreeCtrl::GetItemBackgroundColour(const wxTreeItemId
& item
) const
972 wxCHECK_MSG( item
.IsOk(), wxNullColour
, wxT("invalid tree item") );
974 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
975 return pItem
->Attr().GetBackgroundColour();
978 wxFont
wxGenericTreeCtrl::GetItemFont(const wxTreeItemId
& item
) const
980 wxCHECK_MSG( item
.IsOk(), wxNullFont
, wxT("invalid tree item") );
982 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
983 return pItem
->Attr().GetFont();
986 void wxGenericTreeCtrl::SetItemText(const wxTreeItemId
& item
, const wxString
& text
)
988 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
991 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
992 pItem
->SetText(text
);
993 CalculateSize(pItem
, dc
);
997 void wxGenericTreeCtrl::SetItemImage(const wxTreeItemId
& item
,
999 wxTreeItemIcon which
)
1001 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1003 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1004 pItem
->SetImage(image
, which
);
1006 wxClientDC
dc(this);
1007 CalculateSize(pItem
, dc
);
1011 void wxGenericTreeCtrl::SetItemData(const wxTreeItemId
& item
, wxTreeItemData
*data
)
1013 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1016 data
->SetId( item
);
1018 ((wxGenericTreeItem
*) item
.m_pItem
)->SetData(data
);
1021 void wxGenericTreeCtrl::SetItemHasChildren(const wxTreeItemId
& item
, bool has
)
1023 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1025 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1026 pItem
->SetHasPlus(has
);
1030 void wxGenericTreeCtrl::SetItemBold(const wxTreeItemId
& item
, bool bold
)
1032 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1034 // avoid redrawing the tree if no real change
1035 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1036 if ( pItem
->IsBold() != bold
)
1038 pItem
->SetBold(bold
);
1040 // recalculate the item size as bold and non bold fonts have different
1042 wxClientDC
dc(this);
1043 CalculateSize(pItem
, dc
);
1049 void wxGenericTreeCtrl::SetItemDropHighlight(const wxTreeItemId
& item
,
1052 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1058 bg
= wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHT
);
1059 fg
= wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHTTEXT
);
1062 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1063 pItem
->Attr().SetTextColour(fg
);
1064 pItem
->Attr().SetBackgroundColour(bg
);
1068 void wxGenericTreeCtrl::SetItemTextColour(const wxTreeItemId
& item
,
1069 const wxColour
& col
)
1071 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1073 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1074 pItem
->Attr().SetTextColour(col
);
1078 void wxGenericTreeCtrl::SetItemBackgroundColour(const wxTreeItemId
& item
,
1079 const wxColour
& col
)
1081 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1083 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1084 pItem
->Attr().SetBackgroundColour(col
);
1088 void wxGenericTreeCtrl::SetItemFont(const wxTreeItemId
& item
, const wxFont
& font
)
1090 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1092 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1093 pItem
->Attr().SetFont(font
);
1097 bool wxGenericTreeCtrl::SetFont( const wxFont
&font
)
1099 wxTreeCtrlBase::SetFont(font
);
1101 m_normalFont
= font
;
1102 m_boldFont
= wxFont(m_normalFont
.GetPointSize(),
1103 m_normalFont
.GetFamily(),
1104 m_normalFont
.GetStyle(),
1106 m_normalFont
.GetUnderlined(),
1107 m_normalFont
.GetFaceName(),
1108 m_normalFont
.GetEncoding());
1114 // -----------------------------------------------------------------------------
1115 // item status inquiries
1116 // -----------------------------------------------------------------------------
1118 bool wxGenericTreeCtrl::IsVisible(const wxTreeItemId
& item
) const
1120 wxCHECK_MSG( item
.IsOk(), false, wxT("invalid tree item") );
1122 // An item is only visible if it's not a descendant of a collapsed item
1123 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1124 wxGenericTreeItem
* parent
= pItem
->GetParent();
1127 if (!parent
->IsExpanded())
1129 parent
= parent
->GetParent();
1133 GetViewStart(& startX
, & startY
);
1135 wxSize clientSize
= GetClientSize();
1138 if (!GetBoundingRect(item
, rect
))
1140 if (rect
.GetWidth() == 0 || rect
.GetHeight() == 0)
1142 if (rect
.GetBottom() < 0 || rect
.GetTop() > clientSize
.y
)
1144 if (rect
.GetRight() < 0 || rect
.GetLeft() > clientSize
.x
)
1150 bool wxGenericTreeCtrl::ItemHasChildren(const wxTreeItemId
& item
) const
1152 wxCHECK_MSG( item
.IsOk(), false, wxT("invalid tree item") );
1154 // consider that the item does have children if it has the "+" button: it
1155 // might not have them (if it had never been expanded yet) but then it
1156 // could have them as well and it's better to err on this side rather than
1157 // disabling some operations which are restricted to the items with
1158 // children for an item which does have them
1159 return ((wxGenericTreeItem
*) item
.m_pItem
)->HasPlus();
1162 bool wxGenericTreeCtrl::IsExpanded(const wxTreeItemId
& item
) const
1164 wxCHECK_MSG( item
.IsOk(), false, wxT("invalid tree item") );
1166 return ((wxGenericTreeItem
*) item
.m_pItem
)->IsExpanded();
1169 bool wxGenericTreeCtrl::IsSelected(const wxTreeItemId
& item
) const
1171 wxCHECK_MSG( item
.IsOk(), false, wxT("invalid tree item") );
1173 return ((wxGenericTreeItem
*) item
.m_pItem
)->IsSelected();
1176 bool wxGenericTreeCtrl::IsBold(const wxTreeItemId
& item
) const
1178 wxCHECK_MSG( item
.IsOk(), false, wxT("invalid tree item") );
1180 return ((wxGenericTreeItem
*) item
.m_pItem
)->IsBold();
1183 // -----------------------------------------------------------------------------
1185 // -----------------------------------------------------------------------------
1187 wxTreeItemId
wxGenericTreeCtrl::GetItemParent(const wxTreeItemId
& item
) const
1189 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1191 return ((wxGenericTreeItem
*) item
.m_pItem
)->GetParent();
1194 wxTreeItemId
wxGenericTreeCtrl::GetFirstChild(const wxTreeItemId
& item
,
1195 wxTreeItemIdValue
& cookie
) const
1197 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1200 return GetNextChild(item
, cookie
);
1203 wxTreeItemId
wxGenericTreeCtrl::GetNextChild(const wxTreeItemId
& item
,
1204 wxTreeItemIdValue
& cookie
) const
1206 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1208 wxArrayGenericTreeItems
& children
= ((wxGenericTreeItem
*) item
.m_pItem
)->GetChildren();
1210 // it's ok to cast cookie to size_t, we never have indices big enough to
1211 // overflow "void *"
1212 size_t *pIndex
= (size_t *)&cookie
;
1213 if ( *pIndex
< children
.GetCount() )
1215 return children
.Item((*pIndex
)++);
1219 // there are no more of them
1220 return wxTreeItemId();
1224 wxTreeItemId
wxGenericTreeCtrl::GetLastChild(const wxTreeItemId
& item
) const
1226 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1228 wxArrayGenericTreeItems
& children
= ((wxGenericTreeItem
*) item
.m_pItem
)->GetChildren();
1229 return (children
.IsEmpty() ? wxTreeItemId() : wxTreeItemId(children
.Last()));
1232 wxTreeItemId
wxGenericTreeCtrl::GetNextSibling(const wxTreeItemId
& item
) const
1234 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1236 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
1237 wxGenericTreeItem
*parent
= i
->GetParent();
1238 if ( parent
== NULL
)
1240 // root item doesn't have any siblings
1241 return wxTreeItemId();
1244 wxArrayGenericTreeItems
& siblings
= parent
->GetChildren();
1245 int index
= siblings
.Index(i
);
1246 wxASSERT( index
!= wxNOT_FOUND
); // I'm not a child of my parent?
1248 size_t n
= (size_t)(index
+ 1);
1249 return n
== siblings
.GetCount() ? wxTreeItemId() : wxTreeItemId(siblings
[n
]);
1252 wxTreeItemId
wxGenericTreeCtrl::GetPrevSibling(const wxTreeItemId
& item
) const
1254 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1256 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
1257 wxGenericTreeItem
*parent
= i
->GetParent();
1258 if ( parent
== NULL
)
1260 // root item doesn't have any siblings
1261 return wxTreeItemId();
1264 wxArrayGenericTreeItems
& siblings
= parent
->GetChildren();
1265 int index
= siblings
.Index(i
);
1266 wxASSERT( index
!= wxNOT_FOUND
); // I'm not a child of my parent?
1268 return index
== 0 ? wxTreeItemId()
1269 : wxTreeItemId(siblings
[(size_t)(index
- 1)]);
1272 // Only for internal use right now, but should probably be public
1273 wxTreeItemId
wxGenericTreeCtrl::GetNext(const wxTreeItemId
& item
) const
1275 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1277 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
1279 // First see if there are any children.
1280 wxArrayGenericTreeItems
& children
= i
->GetChildren();
1281 if (children
.GetCount() > 0)
1283 return children
.Item(0);
1287 // Try a sibling of this or ancestor instead
1288 wxTreeItemId p
= item
;
1289 wxTreeItemId toFind
;
1292 toFind
= GetNextSibling(p
);
1293 p
= GetItemParent(p
);
1294 } while (p
.IsOk() && !toFind
.IsOk());
1299 wxTreeItemId
wxGenericTreeCtrl::GetFirstVisibleItem() const
1301 wxTreeItemId id
= GetRootItem();
1310 } while (id
.IsOk());
1312 return wxTreeItemId();
1315 wxTreeItemId
wxGenericTreeCtrl::GetNextVisible(const wxTreeItemId
& item
) const
1317 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1318 wxASSERT_MSG( IsVisible(item
), wxT("this item itself should be visible") );
1320 wxTreeItemId id
= item
;
1323 while (id
= GetNext(id
), id
.IsOk())
1329 return wxTreeItemId();
1332 wxTreeItemId
wxGenericTreeCtrl::GetPrevVisible(const wxTreeItemId
& item
) const
1334 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1335 wxASSERT_MSG( IsVisible(item
), wxT("this item itself should be visible") );
1337 // find out the starting point
1338 wxTreeItemId prevItem
= GetPrevSibling(item
);
1339 if ( !prevItem
.IsOk() )
1341 prevItem
= GetItemParent(item
);
1344 // find the first visible item after it
1345 while ( prevItem
.IsOk() && !IsVisible(prevItem
) )
1347 prevItem
= GetNext(prevItem
);
1348 if ( !prevItem
.IsOk() || prevItem
== item
)
1350 // there are no visible items before item
1351 return wxTreeItemId();
1355 // from there we must be able to navigate until this item
1356 while ( prevItem
.IsOk() )
1358 const wxTreeItemId nextItem
= GetNextVisible(prevItem
);
1359 if ( !nextItem
.IsOk() || nextItem
== item
)
1362 prevItem
= nextItem
;
1368 // called by wxTextTreeCtrl when it marks itself for deletion
1369 void wxGenericTreeCtrl::ResetTextControl()
1374 // find the first item starting with the given prefix after the given item
1375 wxTreeItemId
wxGenericTreeCtrl::FindItem(const wxTreeItemId
& idParent
,
1376 const wxString
& prefixOrig
) const
1378 // match is case insensitive as this is more convenient to the user: having
1379 // to press Shift-letter to go to the item starting with a capital letter
1380 // would be too bothersome
1381 wxString prefix
= prefixOrig
.Lower();
1383 // determine the starting point: we shouldn't take the current item (this
1384 // allows to switch between two items starting with the same letter just by
1385 // pressing it) but we shouldn't jump to the next one if the user is
1386 // continuing to type as otherwise he might easily skip the item he wanted
1387 wxTreeItemId id
= idParent
;
1388 if ( prefix
.length() == 1 )
1393 // look for the item starting with the given prefix after it
1394 while ( id
.IsOk() && !GetItemText(id
).Lower().StartsWith(prefix
) )
1399 // if we haven't found anything...
1402 // ... wrap to the beginning
1404 if ( HasFlag(wxTR_HIDE_ROOT
) )
1406 // can't select virtual root
1410 // and try all the items (stop when we get to the one we started from)
1411 while (id
.IsOk() && id
!= idParent
&& !GetItemText(id
).Lower().StartsWith(prefix
) )
1415 // If we haven't found the item, id.IsOk() will be false, as per
1422 // -----------------------------------------------------------------------------
1424 // -----------------------------------------------------------------------------
1426 wxTreeItemId
wxGenericTreeCtrl::DoInsertItem(const wxTreeItemId
& parentId
,
1428 const wxString
& text
,
1431 wxTreeItemData
*data
)
1433 wxGenericTreeItem
*parent
= (wxGenericTreeItem
*) parentId
.m_pItem
;
1436 // should we give a warning here?
1437 return AddRoot(text
, image
, selImage
, data
);
1440 m_dirty
= true; // do this first so stuff below doesn't cause flicker
1442 wxGenericTreeItem
*item
=
1443 new wxGenericTreeItem( parent
, text
, image
, selImage
, data
);
1447 data
->m_pItem
= item
;
1450 parent
->Insert( item
, previous
== (size_t)-1 ? parent
->GetChildren().size()
1453 InvalidateBestSize();
1457 wxTreeItemId
wxGenericTreeCtrl::AddRoot(const wxString
& text
,
1460 wxTreeItemData
*data
)
1462 wxCHECK_MSG( !m_anchor
, wxTreeItemId(), wxT("tree can have only one root") );
1464 m_dirty
= true; // do this first so stuff below doesn't cause flicker
1466 m_anchor
= new wxGenericTreeItem((wxGenericTreeItem
*)NULL
, text
,
1467 image
, selImage
, data
);
1470 data
->m_pItem
= m_anchor
;
1473 if (HasFlag(wxTR_HIDE_ROOT
))
1475 // if root is hidden, make sure we can navigate
1477 m_anchor
->SetHasPlus();
1479 CalculatePositions();
1482 if (!HasFlag(wxTR_MULTIPLE
))
1484 m_current
= m_key_current
= m_anchor
;
1485 m_current
->SetHilight( true );
1488 InvalidateBestSize();
1492 wxTreeItemId
wxGenericTreeCtrl::DoInsertAfter(const wxTreeItemId
& parentId
,
1493 const wxTreeItemId
& idPrevious
,
1494 const wxString
& text
,
1495 int image
, int selImage
,
1496 wxTreeItemData
*data
)
1498 wxGenericTreeItem
*parent
= (wxGenericTreeItem
*) parentId
.m_pItem
;
1501 // should we give a warning here?
1502 return AddRoot(text
, image
, selImage
, data
);
1506 if (idPrevious
.IsOk())
1508 index
= parent
->GetChildren().Index((wxGenericTreeItem
*) idPrevious
.m_pItem
);
1509 wxASSERT_MSG( index
!= wxNOT_FOUND
,
1510 wxT("previous item in wxGenericTreeCtrl::InsertItem() is not a sibling") );
1513 return DoInsertItem(parentId
, (size_t)++index
, text
, image
, selImage
, data
);
1517 void wxGenericTreeCtrl::SendDeleteEvent(wxGenericTreeItem
*item
)
1519 wxTreeEvent
event(wxEVT_COMMAND_TREE_DELETE_ITEM
, this, item
);
1520 GetEventHandler()->ProcessEvent( event
);
1523 // Don't leave edit or selection on a child which is about to disappear
1524 void wxGenericTreeCtrl::ChildrenClosing(wxGenericTreeItem
* item
)
1526 if (m_textCtrl
!= NULL
&& item
!= m_textCtrl
->item() && IsDescendantOf(item
, m_textCtrl
->item())) {
1527 m_textCtrl
->StopEditing();
1529 if (item
!= m_key_current
&& IsDescendantOf(item
, m_key_current
)) {
1530 m_key_current
= NULL
;
1532 if (IsDescendantOf(item
, m_select_me
)) {
1535 if (item
!= m_current
&& IsDescendantOf(item
, m_current
)) {
1536 m_current
->SetHilight( false );
1542 void wxGenericTreeCtrl::DeleteChildren(const wxTreeItemId
& itemId
)
1544 m_dirty
= true; // do this first so stuff below doesn't cause flicker
1546 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1547 ChildrenClosing(item
);
1548 item
->DeleteChildren(this);
1549 InvalidateBestSize();
1552 void wxGenericTreeCtrl::Delete(const wxTreeItemId
& itemId
)
1554 m_dirty
= true; // do this first so stuff below doesn't cause flicker
1556 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1558 if (m_textCtrl
!= NULL
&& IsDescendantOf(item
, m_textCtrl
->item()))
1560 // can't delete the item being edited, cancel editing it first
1561 m_textCtrl
->StopEditing();
1564 wxGenericTreeItem
*parent
= item
->GetParent();
1566 // don't keep stale pointers around!
1567 if ( IsDescendantOf(item
, m_key_current
) )
1569 // Don't silently change the selection:
1570 // do it properly in idle time, so event
1571 // handlers get called.
1573 // m_key_current = parent;
1574 m_key_current
= NULL
;
1577 // m_select_me records whether we need to select
1578 // a different item, in idle time.
1579 if ( m_select_me
&& IsDescendantOf(item
, m_select_me
) )
1581 m_select_me
= parent
;
1584 if ( IsDescendantOf(item
, m_current
) )
1586 // Don't silently change the selection:
1587 // do it properly in idle time, so event
1588 // handlers get called.
1590 // m_current = parent;
1592 m_select_me
= parent
;
1595 // remove the item from the tree
1598 parent
->GetChildren().Remove( item
); // remove by value
1600 else // deleting the root
1602 // nothing will be left in the tree
1606 // and delete all of its children and the item itself now
1607 item
->DeleteChildren(this);
1608 SendDeleteEvent(item
);
1610 if (item
== m_select_me
)
1615 InvalidateBestSize();
1618 void wxGenericTreeCtrl::DeleteAllItems()
1626 void wxGenericTreeCtrl::Expand(const wxTreeItemId
& itemId
)
1628 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1630 wxCHECK_RET( item
, _T("invalid item in wxGenericTreeCtrl::Expand") );
1631 wxCHECK_RET( !HasFlag(wxTR_HIDE_ROOT
) || itemId
!= GetRootItem(),
1632 _T("can't expand hidden root") );
1634 if ( !item
->HasPlus() )
1637 if ( item
->IsExpanded() )
1640 wxTreeEvent
event(wxEVT_COMMAND_TREE_ITEM_EXPANDING
, this, item
);
1642 if ( GetEventHandler()->ProcessEvent( event
) && !event
.IsAllowed() )
1644 // cancelled by program
1649 CalculatePositions();
1651 RefreshSubtree(item
);
1653 event
.SetEventType(wxEVT_COMMAND_TREE_ITEM_EXPANDED
);
1654 GetEventHandler()->ProcessEvent( event
);
1657 void wxGenericTreeCtrl::Collapse(const wxTreeItemId
& itemId
)
1659 wxCHECK_RET( !HasFlag(wxTR_HIDE_ROOT
) || itemId
!= GetRootItem(),
1660 _T("can't collapse hidden root") );
1662 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1664 if ( !item
->IsExpanded() )
1667 wxTreeEvent
event(wxEVT_COMMAND_TREE_ITEM_COLLAPSING
, this, item
);
1668 if ( GetEventHandler()->ProcessEvent( event
) && !event
.IsAllowed() )
1670 // cancelled by program
1674 ChildrenClosing(item
);
1677 #if 0 // TODO why should items be collapsed recursively?
1678 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1679 size_t count
= children
.GetCount();
1680 for ( size_t n
= 0; n
< count
; n
++ )
1682 Collapse(children
[n
]);
1686 CalculatePositions();
1688 RefreshSubtree(item
);
1690 event
.SetEventType(wxEVT_COMMAND_TREE_ITEM_COLLAPSED
);
1691 GetEventHandler()->ProcessEvent( event
);
1694 void wxGenericTreeCtrl::CollapseAndReset(const wxTreeItemId
& item
)
1697 DeleteChildren(item
);
1700 void wxGenericTreeCtrl::Toggle(const wxTreeItemId
& itemId
)
1702 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1704 if (item
->IsExpanded())
1710 void wxGenericTreeCtrl::Unselect()
1714 m_current
->SetHilight( false );
1715 RefreshLine( m_current
);
1722 void wxGenericTreeCtrl::UnselectAllChildren(wxGenericTreeItem
*item
)
1724 if (item
->IsSelected())
1726 item
->SetHilight(false);
1730 if (item
->HasChildren())
1732 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1733 size_t count
= children
.GetCount();
1734 for ( size_t n
= 0; n
< count
; ++n
)
1736 UnselectAllChildren(children
[n
]);
1741 void wxGenericTreeCtrl::UnselectAll()
1743 wxTreeItemId rootItem
= GetRootItem();
1745 // the tree might not have the root item at all
1748 UnselectAllChildren((wxGenericTreeItem
*) rootItem
.m_pItem
);
1752 // Recursive function !
1753 // To stop we must have crt_item<last_item
1755 // Tag all next children, when no more children,
1756 // Move to parent (not to tag)
1757 // Keep going... if we found last_item, we stop.
1758 bool wxGenericTreeCtrl::TagNextChildren(wxGenericTreeItem
*crt_item
, wxGenericTreeItem
*last_item
, bool select
)
1760 wxGenericTreeItem
*parent
= crt_item
->GetParent();
1762 if (parent
== NULL
) // This is root item
1763 return TagAllChildrenUntilLast(crt_item
, last_item
, select
);
1765 wxArrayGenericTreeItems
& children
= parent
->GetChildren();
1766 int index
= children
.Index(crt_item
);
1767 wxASSERT( index
!= wxNOT_FOUND
); // I'm not a child of my parent?
1769 size_t count
= children
.GetCount();
1770 for (size_t n
=(size_t)(index
+1); n
<count
; ++n
)
1772 if (TagAllChildrenUntilLast(children
[n
], last_item
, select
)) return true;
1775 return TagNextChildren(parent
, last_item
, select
);
1778 bool wxGenericTreeCtrl::TagAllChildrenUntilLast(wxGenericTreeItem
*crt_item
, wxGenericTreeItem
*last_item
, bool select
)
1780 crt_item
->SetHilight(select
);
1781 RefreshLine(crt_item
);
1783 if (crt_item
==last_item
)
1786 if (crt_item
->HasChildren())
1788 wxArrayGenericTreeItems
& children
= crt_item
->GetChildren();
1789 size_t count
= children
.GetCount();
1790 for ( size_t n
= 0; n
< count
; ++n
)
1792 if (TagAllChildrenUntilLast(children
[n
], last_item
, select
))
1800 void wxGenericTreeCtrl::SelectItemRange(wxGenericTreeItem
*item1
, wxGenericTreeItem
*item2
)
1804 // item2 is not necessary after item1
1805 // choice first' and 'last' between item1 and item2
1806 wxGenericTreeItem
*first
= (item1
->GetY()<item2
->GetY()) ? item1
: item2
;
1807 wxGenericTreeItem
*last
= (item1
->GetY()<item2
->GetY()) ? item2
: item1
;
1809 bool select
= m_current
->IsSelected();
1811 if ( TagAllChildrenUntilLast(first
,last
,select
) )
1814 TagNextChildren(first
,last
,select
);
1817 void wxGenericTreeCtrl::DoSelectItem(const wxTreeItemId
& itemId
,
1818 bool unselect_others
,
1819 bool extended_select
)
1821 wxCHECK_RET( itemId
.IsOk(), wxT("invalid tree item") );
1825 bool is_single
=!(GetWindowStyleFlag() & wxTR_MULTIPLE
);
1826 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1828 //wxCHECK_RET( ( (!unselect_others) && is_single),
1829 // wxT("this is a single selection tree") );
1831 // to keep going anyhow !!!
1834 if (item
->IsSelected())
1835 return; // nothing to do
1836 unselect_others
= true;
1837 extended_select
= false;
1839 else if ( unselect_others
&& item
->IsSelected() )
1841 // selection change if there is more than one item currently selected
1842 wxArrayTreeItemIds selected_items
;
1843 if ( GetSelections(selected_items
) == 1 )
1847 wxTreeEvent
event(wxEVT_COMMAND_TREE_SEL_CHANGING
, this, item
);
1848 event
.m_itemOld
= m_current
;
1849 // TODO : Here we don't send any selection mode yet !
1851 if ( GetEventHandler()->ProcessEvent( event
) && !event
.IsAllowed() )
1854 wxTreeItemId parent
= GetItemParent( itemId
);
1855 while (parent
.IsOk())
1857 if (!IsExpanded(parent
))
1860 parent
= GetItemParent( parent
);
1864 if (unselect_others
)
1866 if (is_single
) Unselect(); // to speed up thing
1871 if (extended_select
)
1875 m_current
= m_key_current
= (wxGenericTreeItem
*) GetRootItem().m_pItem
;
1878 // don't change the mark (m_current)
1879 SelectItemRange(m_current
, item
);
1883 bool select
= true; // the default
1885 // Check if we need to toggle hilight (ctrl mode)
1886 if (!unselect_others
)
1887 select
=!item
->IsSelected();
1889 m_current
= m_key_current
= item
;
1890 m_current
->SetHilight(select
);
1891 RefreshLine( m_current
);
1894 // This can cause idle processing to select the root
1895 // if no item is selected, so it must be after the
1897 EnsureVisible( itemId
);
1899 event
.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED
);
1900 GetEventHandler()->ProcessEvent( event
);
1903 void wxGenericTreeCtrl::SelectItem(const wxTreeItemId
& itemId
, bool select
)
1907 DoSelectItem(itemId
, !HasFlag(wxTR_MULTIPLE
));
1911 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1912 wxCHECK_RET( item
, wxT("SelectItem(): invalid tree item") );
1914 wxTreeEvent
event(wxEVT_COMMAND_TREE_SEL_CHANGING
, this, item
);
1915 if ( GetEventHandler()->ProcessEvent( event
) && !event
.IsAllowed() )
1918 item
->SetHilight(false);
1921 event
.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED
);
1922 GetEventHandler()->ProcessEvent( event
);
1926 void wxGenericTreeCtrl::FillArray(wxGenericTreeItem
*item
,
1927 wxArrayTreeItemIds
&array
) const
1929 if ( item
->IsSelected() )
1930 array
.Add(wxTreeItemId(item
));
1932 if ( item
->HasChildren() )
1934 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1935 size_t count
= children
.GetCount();
1936 for ( size_t n
= 0; n
< count
; ++n
)
1937 FillArray(children
[n
], array
);
1941 size_t wxGenericTreeCtrl::GetSelections(wxArrayTreeItemIds
&array
) const
1944 wxTreeItemId idRoot
= GetRootItem();
1945 if ( idRoot
.IsOk() )
1947 FillArray((wxGenericTreeItem
*) idRoot
.m_pItem
, array
);
1949 //else: the tree is empty, so no selections
1951 return array
.GetCount();
1954 void wxGenericTreeCtrl::EnsureVisible(const wxTreeItemId
& item
)
1956 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1958 if (!item
.IsOk()) return;
1960 wxGenericTreeItem
*gitem
= (wxGenericTreeItem
*) item
.m_pItem
;
1962 // first expand all parent branches
1963 wxGenericTreeItem
*parent
= gitem
->GetParent();
1965 if ( HasFlag(wxTR_HIDE_ROOT
) )
1967 while ( parent
&& parent
!= m_anchor
)
1970 parent
= parent
->GetParent();
1978 parent
= parent
->GetParent();
1982 //if (parent) CalculatePositions();
1987 void wxGenericTreeCtrl::ScrollTo(const wxTreeItemId
&item
)
1989 if (!item
.IsOk()) return;
1991 // We have to call this here because the label in
1992 // question might just have been added and no screen
1993 // update taken place.
1995 #if defined( __WXMSW__ ) || defined(__WXMAC__)
1998 DoDirtyProcessing();
2000 wxGenericTreeItem
*gitem
= (wxGenericTreeItem
*) item
.m_pItem
;
2002 // now scroll to the item
2003 int item_y
= gitem
->GetY();
2007 GetViewStart( &start_x
, &start_y
);
2008 start_y
*= PIXELS_PER_UNIT
;
2012 GetClientSize( &client_w
, &client_h
);
2014 if (item_y
< start_y
+3)
2019 m_anchor
->GetSize( x
, y
, this );
2020 y
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
2021 x
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
2022 int x_pos
= GetScrollPos( wxHORIZONTAL
);
2023 // Item should appear at top
2024 SetScrollbars( PIXELS_PER_UNIT
, PIXELS_PER_UNIT
, x
/PIXELS_PER_UNIT
, y
/PIXELS_PER_UNIT
, x_pos
, item_y
/PIXELS_PER_UNIT
);
2026 else if (item_y
+GetLineHeight(gitem
) > start_y
+client_h
)
2031 m_anchor
->GetSize( x
, y
, this );
2032 y
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
2033 x
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
2034 item_y
+= PIXELS_PER_UNIT
+2;
2035 int x_pos
= GetScrollPos( wxHORIZONTAL
);
2036 // Item should appear at bottom
2037 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
);
2041 // FIXME: tree sorting functions are not reentrant and not MT-safe!
2042 static wxGenericTreeCtrl
*s_treeBeingSorted
= NULL
;
2044 static int LINKAGEMODE
tree_ctrl_compare_func(wxGenericTreeItem
**item1
,
2045 wxGenericTreeItem
**item2
)
2047 wxCHECK_MSG( s_treeBeingSorted
, 0, wxT("bug in wxGenericTreeCtrl::SortChildren()") );
2049 return s_treeBeingSorted
->OnCompareItems(*item1
, *item2
);
2052 void wxGenericTreeCtrl::SortChildren(const wxTreeItemId
& itemId
)
2054 wxCHECK_RET( itemId
.IsOk(), wxT("invalid tree item") );
2056 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
2058 wxCHECK_RET( !s_treeBeingSorted
,
2059 wxT("wxGenericTreeCtrl::SortChildren is not reentrant") );
2061 wxArrayGenericTreeItems
& children
= item
->GetChildren();
2062 if ( children
.GetCount() > 1 )
2066 s_treeBeingSorted
= this;
2067 children
.Sort(tree_ctrl_compare_func
);
2068 s_treeBeingSorted
= NULL
;
2070 //else: don't make the tree dirty as nothing changed
2073 void wxGenericTreeCtrl::CalculateLineHeight()
2075 wxClientDC
dc(this);
2076 m_lineHeight
= (int)(dc
.GetCharHeight() + 4);
2078 if ( m_imageListNormal
)
2080 // Calculate a m_lineHeight value from the normal Image sizes.
2081 // May be toggle off. Then wxGenericTreeCtrl will spread when
2082 // necessary (which might look ugly).
2083 int n
= m_imageListNormal
->GetImageCount();
2084 for (int i
= 0; i
< n
; i
++)
2086 int width
= 0, height
= 0;
2087 m_imageListNormal
->GetSize(i
, width
, height
);
2088 if (height
> m_lineHeight
) m_lineHeight
= height
;
2092 if (m_imageListButtons
)
2094 // Calculate a m_lineHeight value from the Button image sizes.
2095 // May be toggle off. Then wxGenericTreeCtrl will spread when
2096 // necessary (which might look ugly).
2097 int n
= m_imageListButtons
->GetImageCount();
2098 for (int i
= 0; i
< n
; i
++)
2100 int width
= 0, height
= 0;
2101 m_imageListButtons
->GetSize(i
, width
, height
);
2102 if (height
> m_lineHeight
) m_lineHeight
= height
;
2106 if (m_lineHeight
< 30)
2107 m_lineHeight
+= 2; // at least 2 pixels
2109 m_lineHeight
+= m_lineHeight
/10; // otherwise 10% extra spacing
2112 void wxGenericTreeCtrl::SetImageList(wxImageList
*imageList
)
2114 if (m_ownsImageListNormal
) delete m_imageListNormal
;
2115 m_imageListNormal
= imageList
;
2116 m_ownsImageListNormal
= false;
2118 // Don't do any drawing if we're setting the list to NULL,
2119 // since we may be in the process of deleting the tree control.
2121 CalculateLineHeight();
2124 void wxGenericTreeCtrl::SetStateImageList(wxImageList
*imageList
)
2126 if (m_ownsImageListState
) delete m_imageListState
;
2127 m_imageListState
= imageList
;
2128 m_ownsImageListState
= false;
2131 void wxGenericTreeCtrl::SetButtonsImageList(wxImageList
*imageList
)
2133 if (m_ownsImageListButtons
) delete m_imageListButtons
;
2134 m_imageListButtons
= imageList
;
2135 m_ownsImageListButtons
= false;
2137 CalculateLineHeight();
2140 void wxGenericTreeCtrl::AssignButtonsImageList(wxImageList
*imageList
)
2142 SetButtonsImageList(imageList
);
2143 m_ownsImageListButtons
= true;
2146 // -----------------------------------------------------------------------------
2148 // -----------------------------------------------------------------------------
2150 void wxGenericTreeCtrl::AdjustMyScrollbars()
2155 m_anchor
->GetSize( x
, y
, this );
2156 y
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
2157 x
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
2158 int x_pos
= GetScrollPos( wxHORIZONTAL
);
2159 int y_pos
= GetScrollPos( wxVERTICAL
);
2160 SetScrollbars( PIXELS_PER_UNIT
, PIXELS_PER_UNIT
, x
/PIXELS_PER_UNIT
, y
/PIXELS_PER_UNIT
, x_pos
, y_pos
);
2164 SetScrollbars( 0, 0, 0, 0 );
2168 int wxGenericTreeCtrl::GetLineHeight(wxGenericTreeItem
*item
) const
2170 if (GetWindowStyleFlag() & wxTR_HAS_VARIABLE_ROW_HEIGHT
)
2171 return item
->GetHeight();
2173 return m_lineHeight
;
2176 void wxGenericTreeCtrl::PaintItem(wxGenericTreeItem
*item
, wxDC
& dc
)
2178 // TODO implement "state" icon on items
2180 wxTreeItemAttr
*attr
= item
->GetAttributes();
2181 if ( attr
&& attr
->HasFont() )
2182 dc
.SetFont(attr
->GetFont());
2183 else if (item
->IsBold())
2184 dc
.SetFont(m_boldFont
);
2186 wxCoord text_w
= 0, text_h
= 0;
2187 dc
.GetTextExtent( item
->GetText(), &text_w
, &text_h
);
2189 int image_h
= 0, image_w
= 0;
2190 int image
= item
->GetCurrentImage();
2191 if ( image
!= NO_IMAGE
)
2193 if ( m_imageListNormal
)
2195 m_imageListNormal
->GetSize( image
, image_w
, image_h
);
2196 image_w
+= MARGIN_BETWEEN_IMAGE_AND_TEXT
;
2204 int total_h
= GetLineHeight(item
);
2205 bool drawItemBackground
= false;
2207 if ( item
->IsSelected() )
2209 dc
.SetBrush(*(m_hasFocus
? m_hilightBrush
: m_hilightUnfocusedBrush
));
2210 drawItemBackground
= true;
2215 if ( attr
&& attr
->HasBackgroundColour() )
2217 drawItemBackground
= true;
2218 colBg
= attr
->GetBackgroundColour();
2222 colBg
= GetBackgroundColour();
2224 dc
.SetBrush(wxBrush(colBg
, wxSOLID
));
2227 int offset
= HasFlag(wxTR_ROW_LINES
) ? 1 : 0;
2229 if ( HasFlag(wxTR_FULL_ROW_HIGHLIGHT
) )
2233 GetVirtualSize(&w
, &h
);
2234 wxRect
rect( x
, item
->GetY()+offset
, w
, total_h
-offset
);
2235 #if !defined(__WXGTK20__) && !defined(__WXMAC__)
2236 dc
.DrawRectangle(rect
);
2238 if (!item
->IsSelected())
2240 dc
.DrawRectangle(rect
);
2244 int flags
= wxCONTROL_SELECTED
;
2247 && IsControlActive( (ControlRef
)GetHandle() )
2250 flags
|= wxCONTROL_FOCUSED
;
2251 if ((item
== m_current
) && (m_hasFocus
))
2252 flags
|= wxCONTROL_CURRENT
;
2253 wxRendererNative::Get().DrawItemSelectionRect( this, dc
, rect
, flags
);
2259 if ( item
->IsSelected() && image
!= NO_IMAGE
)
2261 // If it's selected, and there's an image, then we should
2262 // take care to leave the area under the image painted in the
2263 // background colour.
2264 wxRect
rect( item
->GetX() + image_w
- 2, item
->GetY()+offset
,
2265 item
->GetWidth() - image_w
+ 2, total_h
-offset
);
2266 #if !defined(__WXGTK20__) && !defined(__WXMAC__)
2267 dc
.DrawRectangle( rect
);
2272 int flags
= wxCONTROL_SELECTED
;
2274 flags
|= wxCONTROL_FOCUSED
;
2275 if ((item
== m_current
) && (m_hasFocus
))
2276 flags
|= wxCONTROL_CURRENT
;
2277 wxRendererNative::Get().DrawItemSelectionRect( this, dc
, rect
, flags
);
2280 // On GTK+ 2, drawing a 'normal' background is wrong for themes that
2281 // don't allow backgrounds to be customized. Not drawing the background,
2282 // except for custom item backgrounds, works for both kinds of theme.
2283 else if (drawItemBackground
)
2285 wxRect
rect( item
->GetX()-2, item
->GetY()+offset
,
2286 item
->GetWidth()+2, total_h
-offset
);
2287 #if !defined(__WXGTK20__) && !defined(__WXMAC__)
2288 dc
.DrawRectangle( rect
);
2290 if ( attr
&& attr
->HasBackgroundColour() )
2292 dc
.DrawRectangle( rect
);
2299 int flags
= wxCONTROL_SELECTED
;
2301 flags
|= wxCONTROL_FOCUSED
;
2302 if ((item
== m_current
) && (m_hasFocus
))
2303 flags
|= wxCONTROL_CURRENT
;
2304 wxRendererNative::Get().DrawItemSelectionRect( this, dc
, rect
, flags
);
2310 if ( image
!= NO_IMAGE
)
2312 dc
.SetClippingRegion( item
->GetX(), item
->GetY(), image_w
-2, total_h
);
2313 m_imageListNormal
->Draw( image
, dc
,
2315 item
->GetY() +((total_h
> image_h
)?((total_h
-image_h
)/2):0),
2316 wxIMAGELIST_DRAW_TRANSPARENT
);
2317 dc
.DestroyClippingRegion();
2320 dc
.SetBackgroundMode(wxTRANSPARENT
);
2321 int extraH
= (total_h
> text_h
) ? (total_h
- text_h
)/2 : 0;
2322 dc
.DrawText( item
->GetText(),
2323 (wxCoord
)(image_w
+ item
->GetX()),
2324 (wxCoord
)(item
->GetY() + extraH
));
2326 // restore normal font
2327 dc
.SetFont( m_normalFont
);
2330 // Now y stands for the top of the item, whereas it used to stand for middle !
2331 void wxGenericTreeCtrl::PaintLevel( wxGenericTreeItem
*item
, wxDC
&dc
, int level
, int &y
)
2333 int x
= level
*m_indent
;
2334 if (!HasFlag(wxTR_HIDE_ROOT
))
2338 else if (level
== 0)
2340 // always expand hidden root
2342 wxArrayGenericTreeItems
& children
= item
->GetChildren();
2343 int count
= children
.GetCount();
2349 PaintLevel(children
[n
], dc
, 1, y
);
2350 } while (++n
< count
);
2352 if (!HasFlag(wxTR_NO_LINES
) && HasFlag(wxTR_LINES_AT_ROOT
) && count
> 0)
2354 // draw line down to last child
2355 origY
+= GetLineHeight(children
[0])>>1;
2356 oldY
+= GetLineHeight(children
[n
-1])>>1;
2357 dc
.DrawLine(3, origY
, 3, oldY
);
2363 item
->SetX(x
+m_spacing
);
2366 int h
= GetLineHeight(item
);
2368 int y_mid
= y_top
+ (h
>>1);
2371 int exposed_x
= dc
.LogicalToDeviceX(0);
2372 int exposed_y
= dc
.LogicalToDeviceY(y_top
);
2374 if (IsExposed(exposed_x
, exposed_y
, 10000, h
)) // 10000 = very much
2378 // don't draw rect outline if we already have the
2379 // background color under Mac
2380 (item
->IsSelected() && m_hasFocus
) ? wxBLACK_PEN
:
2381 #endif // !__WXMAC__
2385 if ( item
->IsSelected()
2387 // On wxMac, if the tree doesn't have the focus we draw an empty
2388 // rectangle, so we want to make sure that the text is visible
2389 // against the normal background, not the highlightbackground, so
2390 // don't use the highlight text colour unless we have the focus.
2391 && m_hasFocus
&& IsControlActive( (ControlRef
)GetHandle() )
2398 colText
= wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHTTEXT
);
2403 wxTreeItemAttr
*attr
= item
->GetAttributes();
2404 if (attr
&& attr
->HasTextColour())
2405 colText
= attr
->GetTextColour();
2407 colText
= GetForegroundColour();
2411 dc
.SetTextForeground(colText
);
2415 PaintItem(item
, dc
);
2417 if (HasFlag(wxTR_ROW_LINES
))
2419 // if the background colour is white, choose a
2420 // contrasting color for the lines
2421 dc
.SetPen(*((GetBackgroundColour() == *wxWHITE
)
2422 ? wxMEDIUM_GREY_PEN
: wxWHITE_PEN
));
2423 dc
.DrawLine(0, y_top
, 10000, y_top
);
2424 dc
.DrawLine(0, y
, 10000, y
);
2427 // restore DC objects
2428 dc
.SetBrush(*wxWHITE_BRUSH
);
2429 dc
.SetPen(m_dottedPen
);
2430 dc
.SetTextForeground(*wxBLACK
);
2432 if ( !HasFlag(wxTR_NO_LINES
) )
2434 // draw the horizontal line here
2436 if (x
> (signed)m_indent
)
2437 x_start
-= m_indent
;
2438 else if (HasFlag(wxTR_LINES_AT_ROOT
))
2440 dc
.DrawLine(x_start
, y_mid
, x
+ m_spacing
, y_mid
);
2443 // should the item show a button?
2444 if ( item
->HasPlus() && HasButtons() )
2446 if ( m_imageListButtons
)
2448 // draw the image button here
2451 int image
= item
->IsExpanded() ? wxTreeItemIcon_Expanded
2452 : wxTreeItemIcon_Normal
;
2453 if ( item
->IsSelected() )
2454 image
+= wxTreeItemIcon_Selected
- wxTreeItemIcon_Normal
;
2456 m_imageListButtons
->GetSize(image
, image_w
, image_h
);
2457 int xx
= x
- image_w
/2;
2458 int yy
= y_mid
- image_h
/2;
2460 wxDCClipper
clip(dc
, xx
, yy
, image_w
, image_h
);
2461 m_imageListButtons
->Draw(image
, dc
, xx
, yy
,
2462 wxIMAGELIST_DRAW_TRANSPARENT
);
2464 else // no custom buttons
2466 static const int wImage
= 9;
2467 static const int hImage
= 9;
2470 if (item
->IsExpanded())
2471 flag
|= wxCONTROL_EXPANDED
;
2472 if (item
== m_underMouse
)
2473 flag
|= wxCONTROL_CURRENT
;
2475 wxRendererNative::Get().DrawTreeItemButton
2479 wxRect(x
- wImage
/2,
2488 if (item
->IsExpanded())
2490 wxArrayGenericTreeItems
& children
= item
->GetChildren();
2491 int count
= children
.GetCount();
2498 PaintLevel(children
[n
], dc
, level
, y
);
2499 } while (++n
< count
);
2501 if (!HasFlag(wxTR_NO_LINES
) && count
> 0)
2503 // draw line down to last child
2504 oldY
+= GetLineHeight(children
[n
-1])>>1;
2505 if (HasButtons()) y_mid
+= 5;
2507 // Only draw the portion of the line that is visible, in case it is huge
2508 wxCoord xOrigin
=0, yOrigin
=0, width
, height
;
2509 dc
.GetDeviceOrigin(&xOrigin
, &yOrigin
);
2510 yOrigin
= abs(yOrigin
);
2511 GetClientSize(&width
, &height
);
2513 // Move end points to the begining/end of the view?
2514 if (y_mid
< yOrigin
)
2516 if (oldY
> yOrigin
+ height
)
2517 oldY
= yOrigin
+ height
;
2519 // after the adjustments if y_mid is larger than oldY then the line
2520 // isn't visible at all so don't draw anything
2522 dc
.DrawLine(x
, y_mid
, x
, oldY
);
2528 void wxGenericTreeCtrl::DrawDropEffect(wxGenericTreeItem
*item
)
2532 if ( item
->HasPlus() )
2534 // it's a folder, indicate it by a border
2539 // draw a line under the drop target because the item will be
2541 DrawLine(item
, !m_dropEffectAboveItem
);
2544 SetCursor(wxCURSOR_BULLSEYE
);
2549 SetCursor(wxCURSOR_NO_ENTRY
);
2553 void wxGenericTreeCtrl::DrawBorder(const wxTreeItemId
&item
)
2555 wxCHECK_RET( item
.IsOk(), _T("invalid item in wxGenericTreeCtrl::DrawLine") );
2557 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
2559 wxClientDC
dc(this);
2561 dc
.SetLogicalFunction(wxINVERT
);
2562 dc
.SetBrush(*wxTRANSPARENT_BRUSH
);
2564 int w
= i
->GetWidth() + 2;
2565 int h
= GetLineHeight(i
) + 2;
2567 dc
.DrawRectangle( i
->GetX() - 1, i
->GetY() - 1, w
, h
);
2570 void wxGenericTreeCtrl::DrawLine(const wxTreeItemId
&item
, bool below
)
2572 wxCHECK_RET( item
.IsOk(), _T("invalid item in wxGenericTreeCtrl::DrawLine") );
2574 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
2576 wxClientDC
dc(this);
2578 dc
.SetLogicalFunction(wxINVERT
);
2584 y
+= GetLineHeight(i
) - 1;
2587 dc
.DrawLine( x
, y
, x
+ i
->GetWidth(), y
);
2590 // -----------------------------------------------------------------------------
2591 // wxWidgets callbacks
2592 // -----------------------------------------------------------------------------
2594 void wxGenericTreeCtrl::OnSize( wxSizeEvent
&event
)
2597 if (HasFlag( wxTR_FULL_ROW_HIGHLIGHT
) && m_current
)
2598 RefreshLine( m_current
);
2604 void wxGenericTreeCtrl::OnPaint( wxPaintEvent
&WXUNUSED(event
) )
2612 dc
.SetFont( m_normalFont
);
2613 dc
.SetPen( m_dottedPen
);
2615 // this is now done dynamically
2616 //if(GetImageList() == NULL)
2617 // m_lineHeight = (int)(dc.GetCharHeight() + 4);
2620 PaintLevel( m_anchor
, dc
, 0, y
);
2623 void wxGenericTreeCtrl::OnSetFocus( wxFocusEvent
&event
)
2632 void wxGenericTreeCtrl::OnKillFocus( wxFocusEvent
&event
)
2641 void wxGenericTreeCtrl::OnChar( wxKeyEvent
&event
)
2643 wxTreeEvent
te( wxEVT_COMMAND_TREE_KEY_DOWN
, this);
2644 te
.m_evtKey
= event
;
2645 if ( GetEventHandler()->ProcessEvent( te
) )
2647 // intercepted by the user code
2651 if ( (m_current
== 0) || (m_key_current
== 0) )
2657 // how should the selection work for this event?
2658 bool is_multiple
, extended_select
, unselect_others
;
2659 EventFlagsToSelType(GetWindowStyleFlag(),
2662 is_multiple
, extended_select
, unselect_others
);
2664 if (GetLayoutDirection() == wxLayout_RightToLeft
)
2666 if (event
.GetKeyCode() == WXK_RIGHT
)
2667 event
.m_keyCode
= WXK_LEFT
;
2668 else if (event
.GetKeyCode() == WXK_LEFT
)
2669 event
.m_keyCode
= WXK_RIGHT
;
2674 // * : Expand all/Collapse all
2675 // ' ' | return : activate
2676 // up : go up (not last children!)
2678 // left : go to parent
2679 // right : open if parent and go next
2680 // home : go to root
2681 // end : go to last item without opening parents
2682 // alnum : start or continue searching for the item with this prefix
2683 int keyCode
= event
.GetKeyCode();
2688 if (m_current
->HasPlus() && !IsExpanded(m_current
))
2696 if ( !IsExpanded(m_current
) )
2699 ExpandAllChildren(m_current
);
2702 //else: fall through to Collapse() it
2706 if (IsExpanded(m_current
))
2708 Collapse(m_current
);
2714 // Use the item's bounding rectangle to determine position for the event
2716 GetBoundingRect(m_current
, ItemRect
, true);
2718 wxTreeEvent
eventMenu(wxEVT_COMMAND_TREE_ITEM_MENU
, this, m_current
);
2719 // Use the left edge, vertical middle
2720 eventMenu
.m_pointDrag
= wxPoint(ItemRect
.GetX(),
2721 ItemRect
.GetY() + ItemRect
.GetHeight() / 2);
2722 GetEventHandler()->ProcessEvent( eventMenu
);
2728 if ( !event
.HasModifiers() )
2730 wxTreeEvent
eventAct(wxEVT_COMMAND_TREE_ITEM_ACTIVATED
, this, m_current
);
2731 GetEventHandler()->ProcessEvent( eventAct
);
2734 // in any case, also generate the normal key event for this key,
2735 // even if we generated the ACTIVATED event above: this is what
2736 // wxMSW does and it makes sense because you might not want to
2737 // process ACTIVATED event at all and handle Space and Return
2738 // directly (and differently) which would be impossible otherwise
2742 // up goes to the previous sibling or to the last
2743 // of its children if it's expanded
2746 wxTreeItemId prev
= GetPrevSibling( m_key_current
);
2749 prev
= GetItemParent( m_key_current
);
2750 if ((prev
== GetRootItem()) && HasFlag(wxTR_HIDE_ROOT
))
2752 break; // don't go to root if it is hidden
2756 wxTreeItemIdValue cookie
;
2757 wxTreeItemId current
= m_key_current
;
2758 // TODO: Huh? If we get here, we'd better be the first child of our parent. How else could it be?
2759 if (current
== GetFirstChild( prev
, cookie
))
2761 // otherwise we return to where we came from
2762 DoSelectItem( prev
, unselect_others
, extended_select
);
2763 m_key_current
= (wxGenericTreeItem
*) prev
.m_pItem
;
2770 while ( IsExpanded(prev
) && HasChildren(prev
) )
2772 wxTreeItemId child
= GetLastChild(prev
);
2779 DoSelectItem( prev
, unselect_others
, extended_select
);
2780 m_key_current
=(wxGenericTreeItem
*) prev
.m_pItem
;
2785 // left arrow goes to the parent
2788 wxTreeItemId prev
= GetItemParent( m_current
);
2789 if ((prev
== GetRootItem()) && HasFlag(wxTR_HIDE_ROOT
))
2791 // don't go to root if it is hidden
2792 prev
= GetPrevSibling( m_current
);
2796 DoSelectItem( prev
, unselect_others
, extended_select
);
2802 // this works the same as the down arrow except that we
2803 // also expand the item if it wasn't expanded yet
2804 if (m_current
!= GetRootItem().m_pItem
|| !HasFlag(wxTR_HIDE_ROOT
))
2806 //else: don't try to expand hidden root item (which can be the
2807 // current one when the tree is empty)
2813 if (IsExpanded(m_key_current
) && HasChildren(m_key_current
))
2815 wxTreeItemIdValue cookie
;
2816 wxTreeItemId child
= GetFirstChild( m_key_current
, cookie
);
2820 DoSelectItem( child
, unselect_others
, extended_select
);
2821 m_key_current
=(wxGenericTreeItem
*) child
.m_pItem
;
2825 wxTreeItemId next
= GetNextSibling( m_key_current
);
2828 wxTreeItemId current
= m_key_current
;
2829 while (current
.IsOk() && !next
)
2831 current
= GetItemParent( current
);
2832 if (current
) next
= GetNextSibling( current
);
2837 DoSelectItem( next
, unselect_others
, extended_select
);
2838 m_key_current
=(wxGenericTreeItem
*) next
.m_pItem
;
2844 // <End> selects the last visible tree item
2847 wxTreeItemId last
= GetRootItem();
2849 while ( last
.IsOk() && IsExpanded(last
) )
2851 wxTreeItemId lastChild
= GetLastChild(last
);
2853 // it may happen if the item was expanded but then all of
2854 // its children have been deleted - so IsExpanded() returned
2855 // true, but GetLastChild() returned invalid item
2864 DoSelectItem( last
, unselect_others
, extended_select
);
2869 // <Home> selects the root item
2872 wxTreeItemId prev
= GetRootItem();
2876 if ( HasFlag(wxTR_HIDE_ROOT
) )
2878 wxTreeItemIdValue cookie
;
2879 prev
= GetFirstChild(prev
, cookie
);
2884 DoSelectItem( prev
, unselect_others
, extended_select
);
2889 // do not use wxIsalnum() here
2890 if ( !event
.HasModifiers() &&
2891 ((keyCode
>= '0' && keyCode
<= '9') ||
2892 (keyCode
>= 'a' && keyCode
<= 'z') ||
2893 (keyCode
>= 'A' && keyCode
<= 'Z' )))
2895 // find the next item starting with the given prefix
2896 wxChar ch
= (wxChar
)keyCode
;
2898 wxTreeItemId id
= FindItem(m_current
, m_findPrefix
+ ch
);
2909 // also start the timer to reset the current prefix if the user
2910 // doesn't press any more alnum keys soon -- we wouldn't want
2911 // to use this prefix for a new item search
2914 m_findTimer
= new wxTreeFindTimer(this);
2917 m_findTimer
->Start(wxTreeFindTimer::DELAY
, wxTIMER_ONE_SHOT
);
2927 wxGenericTreeCtrl::DoTreeHitTest(const wxPoint
& point
, int& flags
) const
2932 if (point
.x
<0) flags
|= wxTREE_HITTEST_TOLEFT
;
2933 if (point
.x
>w
) flags
|= wxTREE_HITTEST_TORIGHT
;
2934 if (point
.y
<0) flags
|= wxTREE_HITTEST_ABOVE
;
2935 if (point
.y
>h
) flags
|= wxTREE_HITTEST_BELOW
;
2936 if (flags
) return wxTreeItemId();
2938 if (m_anchor
== NULL
)
2940 flags
= wxTREE_HITTEST_NOWHERE
;
2941 return wxTreeItemId();
2944 wxGenericTreeItem
*hit
= m_anchor
->HitTest(CalcUnscrolledPosition(point
),
2948 flags
= wxTREE_HITTEST_NOWHERE
;
2949 return wxTreeItemId();
2954 // get the bounding rectangle of the item (or of its label only)
2955 bool wxGenericTreeCtrl::GetBoundingRect(const wxTreeItemId
& item
,
2957 bool textOnly
) const
2959 wxCHECK_MSG( item
.IsOk(), false, _T("invalid item in wxGenericTreeCtrl::GetBoundingRect") );
2961 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
2966 rect
.width
= i
->GetWidth();
2968 if ( m_imageListNormal
)
2970 int image_w
, image_h
;
2971 m_imageListNormal
->GetSize( 0, image_w
, image_h
);
2972 rect
.width
+= image_w
+ MARGIN_BETWEEN_IMAGE_AND_TEXT
;
2975 else // the entire line
2978 rect
.width
= GetClientSize().x
;
2982 rect
.height
= GetLineHeight(i
);
2984 // we have to return the logical coordinates, not physical ones
2985 rect
.SetTopLeft(CalcScrolledPosition(rect
.GetTopLeft()));
2990 wxTextCtrl
*wxGenericTreeCtrl::EditLabel(const wxTreeItemId
& item
,
2991 wxClassInfo
* WXUNUSED(textCtrlClass
))
2993 wxCHECK_MSG( item
.IsOk(), NULL
, _T("can't edit an invalid item") );
2995 wxGenericTreeItem
*itemEdit
= (wxGenericTreeItem
*)item
.m_pItem
;
2997 wxTreeEvent
te(wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT
, this, itemEdit
);
2998 if ( GetEventHandler()->ProcessEvent( te
) && !te
.IsAllowed() )
3004 // We have to call this here because the label in
3005 // question might just have been added and no screen
3006 // update taken place.
3008 #if defined( __WXMSW__ ) || defined(__WXMAC__)
3011 DoDirtyProcessing();
3014 // TODO: use textCtrlClass here to create the control of correct class
3015 m_textCtrl
= new wxTreeTextCtrl(this, itemEdit
);
3017 m_textCtrl
->SetFocus();
3022 // returns a pointer to the text edit control if the item is being
3023 // edited, NULL otherwise (it's assumed that no more than one item may
3024 // be edited simultaneously)
3025 wxTextCtrl
* wxGenericTreeCtrl::GetEditControl() const
3030 void wxGenericTreeCtrl::EndEditLabel(const wxTreeItemId
& WXUNUSED(item
),
3031 bool discardChanges
)
3033 wxCHECK_RET( m_textCtrl
, _T("not editing label") );
3035 m_textCtrl
->EndEdit(discardChanges
);
3038 bool wxGenericTreeCtrl::OnRenameAccept(wxGenericTreeItem
*item
,
3039 const wxString
& value
)
3041 wxTreeEvent
le(wxEVT_COMMAND_TREE_END_LABEL_EDIT
, this, item
);
3043 le
.m_editCancelled
= false;
3045 return !GetEventHandler()->ProcessEvent( le
) || le
.IsAllowed();
3048 void wxGenericTreeCtrl::OnRenameCancelled(wxGenericTreeItem
*item
)
3050 // let owner know that the edit was cancelled
3051 wxTreeEvent
le(wxEVT_COMMAND_TREE_END_LABEL_EDIT
, this, item
);
3052 le
.m_label
= wxEmptyString
;
3053 le
.m_editCancelled
= true;
3055 GetEventHandler()->ProcessEvent( le
);
3058 void wxGenericTreeCtrl::OnRenameTimer()
3060 EditLabel( m_current
);
3063 void wxGenericTreeCtrl::OnMouse( wxMouseEvent
&event
)
3065 if ( !m_anchor
)return;
3067 wxPoint pt
= CalcUnscrolledPosition(event
.GetPosition());
3069 // Is the mouse over a tree item button?
3071 wxGenericTreeItem
*thisItem
= m_anchor
->HitTest(pt
, this, flags
, 0);
3072 wxGenericTreeItem
*underMouse
= thisItem
;
3074 bool underMouseChanged
= (underMouse
!= m_underMouse
) ;
3075 #endif // wxUSE_TOOLTIPS
3078 (flags
& wxTREE_HITTEST_ONITEMBUTTON
) &&
3079 (!event
.LeftIsDown()) &&
3081 (!m_renameTimer
|| !m_renameTimer
->IsRunning()))
3089 if (underMouse
!= m_underMouse
)
3093 // unhighlight old item
3094 wxGenericTreeItem
*tmp
= m_underMouse
;
3095 m_underMouse
= NULL
;
3099 m_underMouse
= underMouse
;
3101 RefreshLine( m_underMouse
);
3105 // Determines what item we are hovering over and need a tooltip for
3106 wxTreeItemId hoverItem
= thisItem
;
3108 // We do not want a tooltip if we are dragging, or if the rename timer is running
3109 if (underMouseChanged
&& hoverItem
.IsOk() && !m_isDragging
&& (!m_renameTimer
|| !m_renameTimer
->IsRunning()))
3111 // Ask the tree control what tooltip (if any) should be shown
3112 wxTreeEvent
hevent(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP
, this, hoverItem
);
3114 if ( GetEventHandler()->ProcessEvent(hevent
) && hevent
.IsAllowed() )
3116 SetToolTip(hevent
.m_label
);
3121 // we process left mouse up event (enables in-place edit), middle/right down
3122 // (pass to the user code), left dbl click (activate item) and
3123 // dragging/moving events for items drag-and-drop
3124 if ( !(event
.LeftDown() ||
3126 event
.MiddleDown() ||
3127 event
.RightDown() ||
3128 event
.LeftDClick() ||
3130 ((event
.Moving() || event
.RightUp()) && m_isDragging
)) )
3139 wxGenericTreeItem
*item
= m_anchor
->HitTest(pt
, this, flags
, 0);
3141 if ( event
.Dragging() && !m_isDragging
)
3143 if (m_dragCount
== 0)
3148 if (m_dragCount
!= 3)
3150 // wait until user drags a bit further...
3154 wxEventType command
= event
.RightIsDown()
3155 ? wxEVT_COMMAND_TREE_BEGIN_RDRAG
3156 : wxEVT_COMMAND_TREE_BEGIN_DRAG
;
3158 wxTreeEvent
nevent(command
, this, m_current
);
3159 nevent
.SetPoint(CalcScrolledPosition(pt
));
3161 // by default the dragging is not supported, the user code must
3162 // explicitly allow the event for it to take place
3165 if ( GetEventHandler()->ProcessEvent(nevent
) && nevent
.IsAllowed() )
3167 // we're going to drag this item
3168 m_isDragging
= true;
3170 // remember the old cursor because we will change it while
3172 m_oldCursor
= m_cursor
;
3174 // in a single selection control, hide the selection temporarily
3175 if ( !(GetWindowStyleFlag() & wxTR_MULTIPLE
) )
3177 m_oldSelection
= (wxGenericTreeItem
*) GetSelection().m_pItem
;
3179 if ( m_oldSelection
)
3181 m_oldSelection
->SetHilight(false);
3182 RefreshLine(m_oldSelection
);
3189 else if ( event
.Dragging() )
3191 if ( item
!= m_dropTarget
)
3193 // unhighlight the previous drop target
3194 DrawDropEffect(m_dropTarget
);
3196 m_dropTarget
= item
;
3198 // highlight the current drop target if any
3199 DrawDropEffect(m_dropTarget
);
3201 #if defined(__WXMSW__) || defined(__WXMAC__) || defined(__WXGTK20__)
3208 else if ( (event
.LeftUp() || event
.RightUp()) && m_isDragging
)
3212 // erase the highlighting
3213 DrawDropEffect(m_dropTarget
);
3215 if ( m_oldSelection
)
3217 m_oldSelection
->SetHilight(true);
3218 RefreshLine(m_oldSelection
);
3219 m_oldSelection
= (wxGenericTreeItem
*)NULL
;
3222 // generate the drag end event
3223 wxTreeEvent
eventEndDrag(wxEVT_COMMAND_TREE_END_DRAG
, this, item
);
3225 eventEndDrag
.m_pointDrag
= CalcScrolledPosition(pt
);
3227 (void)GetEventHandler()->ProcessEvent(eventEndDrag
);
3229 m_isDragging
= false;
3230 m_dropTarget
= (wxGenericTreeItem
*)NULL
;
3232 SetCursor(m_oldCursor
);
3234 #if defined( __WXMSW__ ) || defined(__WXMAC__)
3242 // If we got to this point, we are not dragging or moving the mouse.
3243 // Because the code in carbon/toplevel.cpp will only set focus to the tree
3244 // if we skip for EVT_LEFT_DOWN, we MUST skip this event here for focus to work.
3245 // We skip even if we didn't hit an item because we still should
3246 // restore focus to the tree control even if we didn't exactly hit an item.
3247 if ( event
.LeftDown() )
3252 // here we process only the messages which happen on tree items
3256 if (item
== NULL
) return; /* we hit the blank area */
3258 if ( event
.RightDown() )
3260 // If the item is already selected, do not update the selection.
3261 // Multi-selections should not be cleared if a selected item is clicked.
3262 if (!IsSelected(item
))
3264 DoSelectItem(item
, true, false);
3267 wxTreeEvent
nevent(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK
, this, item
);
3268 nevent
.m_pointDrag
= CalcScrolledPosition(pt
);
3269 event
.Skip(!GetEventHandler()->ProcessEvent(nevent
));
3271 // Consistent with MSW (for now), send the ITEM_MENU *after*
3272 // the RIGHT_CLICK event. TODO: This behavior may change.
3273 wxTreeEvent
nevent2(wxEVT_COMMAND_TREE_ITEM_MENU
, this, item
);
3274 nevent2
.m_pointDrag
= CalcScrolledPosition(pt
);
3275 GetEventHandler()->ProcessEvent(nevent2
);
3277 else if ( event
.MiddleDown() )
3279 wxTreeEvent
nevent(wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK
, this, item
);
3280 nevent
.m_pointDrag
= CalcScrolledPosition(pt
);
3281 event
.Skip(!GetEventHandler()->ProcessEvent(nevent
));
3283 else if ( event
.LeftUp() )
3285 // this facilitates multiple-item drag-and-drop
3287 if ( /* item && */ HasFlag(wxTR_MULTIPLE
))
3289 wxArrayTreeItemIds selections
;
3290 size_t count
= GetSelections(selections
);
3296 DoSelectItem(item
, true, false);
3302 if ( (item
== m_current
) &&
3303 (flags
& wxTREE_HITTEST_ONITEMLABEL
) &&
3304 HasFlag(wxTR_EDIT_LABELS
) )
3306 if ( m_renameTimer
)
3308 if ( m_renameTimer
->IsRunning() )
3309 m_renameTimer
->Stop();
3313 m_renameTimer
= new wxTreeRenameTimer( this );
3316 m_renameTimer
->Start( wxTreeRenameTimer::DELAY
, true );
3319 m_lastOnSame
= false;
3322 else // !RightDown() && !MiddleDown() && !LeftUp() ==> LeftDown() || LeftDClick()
3324 if ( event
.LeftDown() )
3326 m_lastOnSame
= item
== m_current
;
3329 if ( flags
& wxTREE_HITTEST_ONITEMBUTTON
)
3331 // only toggle the item for a single click, double click on
3332 // the button doesn't do anything (it toggles the item twice)
3333 if ( event
.LeftDown() )
3338 // don't select the item if the button was clicked
3343 // clear the previously selected items, if the
3344 // user clicked outside of the present selection.
3345 // otherwise, perform the deselection on mouse-up.
3346 // this allows multiple drag and drop to work.
3347 // but if Cmd is down, toggle selection of the clicked item
3348 if (!IsSelected(item
) || event
.CmdDown())
3350 // how should the selection work for this event?
3351 bool is_multiple
, extended_select
, unselect_others
;
3352 EventFlagsToSelType(GetWindowStyleFlag(),
3355 is_multiple
, extended_select
, unselect_others
);
3357 DoSelectItem(item
, unselect_others
, extended_select
);
3361 // For some reason, Windows isn't recognizing a left double-click,
3362 // so we need to simulate it here. Allow 200 milliseconds for now.
3363 if ( event
.LeftDClick() )
3365 // double clicking should not start editing the item label
3366 if ( m_renameTimer
)
3367 m_renameTimer
->Stop();
3369 m_lastOnSame
= false;
3371 // send activate event first
3372 wxTreeEvent
nevent(wxEVT_COMMAND_TREE_ITEM_ACTIVATED
, this, item
);
3373 nevent
.m_pointDrag
= CalcScrolledPosition(pt
);
3374 if ( !GetEventHandler()->ProcessEvent( nevent
) )
3376 // if the user code didn't process the activate event,
3377 // handle it ourselves by toggling the item when it is
3379 if ( item
->HasPlus() )
3389 void wxGenericTreeCtrl::OnInternalIdle()
3391 wxWindow::OnInternalIdle();
3393 // Check if we need to select the root item
3394 // because nothing else has been selected.
3395 // Delaying it means that we can invoke event handlers
3396 // as required, when a first item is selected.
3397 if (!HasFlag(wxTR_MULTIPLE
) && !GetSelection().IsOk())
3400 SelectItem(m_select_me
);
3401 else if (GetRootItem().IsOk())
3402 SelectItem(GetRootItem());
3405 // after all changes have been done to the tree control,
3406 // actually redraw the tree when everything is over
3408 DoDirtyProcessing();
3411 void wxGenericTreeCtrl::CalculateSize( wxGenericTreeItem
*item
, wxDC
&dc
)
3416 wxTreeItemAttr
*attr
= item
->GetAttributes();
3417 if ( attr
&& attr
->HasFont() )
3418 dc
.SetFont(attr
->GetFont());
3419 else if ( item
->IsBold() )
3420 dc
.SetFont(m_boldFont
);
3422 dc
.SetFont(m_normalFont
);
3424 dc
.GetTextExtent( item
->GetText(), &text_w
, &text_h
);
3427 // restore normal font
3428 dc
.SetFont( m_normalFont
);
3432 int image
= item
->GetCurrentImage();
3433 if ( image
!= NO_IMAGE
)
3435 if ( m_imageListNormal
)
3437 m_imageListNormal
->GetSize( image
, image_w
, image_h
);
3438 image_w
+= MARGIN_BETWEEN_IMAGE_AND_TEXT
;
3442 int total_h
= (image_h
> text_h
) ? image_h
: text_h
;
3445 total_h
+= 2; // at least 2 pixels
3447 total_h
+= total_h
/10; // otherwise 10% extra spacing
3449 item
->SetHeight(total_h
);
3450 if (total_h
>m_lineHeight
)
3451 m_lineHeight
=total_h
;
3453 item
->SetWidth(image_w
+text_w
+2);
3456 // -----------------------------------------------------------------------------
3457 // for developper : y is now the top of the level
3458 // not the middle of it !
3459 void wxGenericTreeCtrl::CalculateLevel( wxGenericTreeItem
*item
, wxDC
&dc
, int level
, int &y
)
3461 int x
= level
*m_indent
;
3462 if (!HasFlag(wxTR_HIDE_ROOT
))
3466 else if (level
== 0)
3468 // a hidden root is not evaluated, but its
3469 // children are always calculated
3473 CalculateSize( item
, dc
);
3476 item
->SetX( x
+m_spacing
);
3478 y
+= GetLineHeight(item
);
3480 if ( !item
->IsExpanded() )
3482 // we don't need to calculate collapsed branches
3487 wxArrayGenericTreeItems
& children
= item
->GetChildren();
3488 size_t n
, count
= children
.GetCount();
3490 for (n
= 0; n
< count
; ++n
)
3491 CalculateLevel( children
[n
], dc
, level
, y
); // recurse
3494 void wxGenericTreeCtrl::CalculatePositions()
3496 if ( !m_anchor
) return;
3498 wxClientDC
dc(this);
3501 dc
.SetFont( m_normalFont
);
3503 dc
.SetPen( m_dottedPen
);
3504 //if(GetImageList() == NULL)
3505 // m_lineHeight = (int)(dc.GetCharHeight() + 4);
3508 CalculateLevel( m_anchor
, dc
, 0, y
); // start recursion
3511 void wxGenericTreeCtrl::Refresh(bool eraseBackground
, const wxRect
*rect
)
3513 if ( !m_freezeCount
)
3514 wxTreeCtrlBase::Refresh(eraseBackground
, rect
);
3517 void wxGenericTreeCtrl::RefreshSubtree(wxGenericTreeItem
*item
)
3519 if (m_dirty
|| m_freezeCount
)
3522 wxSize client
= GetClientSize();
3525 CalcScrolledPosition(0, item
->GetY(), NULL
, &rect
.y
);
3526 rect
.width
= client
.x
;
3527 rect
.height
= client
.y
;
3529 Refresh(true, &rect
);
3531 AdjustMyScrollbars();
3534 void wxGenericTreeCtrl::RefreshLine( wxGenericTreeItem
*item
)
3536 if (m_dirty
|| m_freezeCount
)
3540 CalcScrolledPosition(0, item
->GetY(), NULL
, &rect
.y
);
3541 rect
.width
= GetClientSize().x
;
3542 rect
.height
= GetLineHeight(item
); //dc.GetCharHeight() + 6;
3544 Refresh(true, &rect
);
3547 void wxGenericTreeCtrl::RefreshSelected()
3552 // TODO: this is awfully inefficient, we should keep the list of all
3553 // selected items internally, should be much faster
3555 RefreshSelectedUnder(m_anchor
);
3558 void wxGenericTreeCtrl::RefreshSelectedUnder(wxGenericTreeItem
*item
)
3563 if ( item
->IsSelected() )
3566 const wxArrayGenericTreeItems
& children
= item
->GetChildren();
3567 size_t count
= children
.GetCount();
3568 for ( size_t n
= 0; n
< count
; n
++ )
3570 RefreshSelectedUnder(children
[n
]);
3574 void wxGenericTreeCtrl::Freeze()
3579 void wxGenericTreeCtrl::Thaw()
3581 wxCHECK_RET( m_freezeCount
> 0, _T("thawing unfrozen tree control?") );
3583 if ( --m_freezeCount
== 0 )
3589 // ----------------------------------------------------------------------------
3590 // changing colours: we need to refresh the tree control
3591 // ----------------------------------------------------------------------------
3593 bool wxGenericTreeCtrl::SetBackgroundColour(const wxColour
& colour
)
3595 if ( !wxWindow::SetBackgroundColour(colour
) )
3603 bool wxGenericTreeCtrl::SetForegroundColour(const wxColour
& colour
)
3605 if ( !wxWindow::SetForegroundColour(colour
) )
3613 // Process the tooltip event, to speed up event processing.
3614 // Doesn't actually get a tooltip.
3615 void wxGenericTreeCtrl::OnGetToolTip( wxTreeEvent
&event
)
3621 // NOTE: If using the wxListBox visual attributes works everywhere then this can
3622 // be removed, as well as the #else case below.
3623 #define _USE_VISATTR 0
3628 wxGenericTreeCtrl::GetClassDefaultAttributes(wxWindowVariant variant
)
3630 wxGenericTreeCtrl::GetClassDefaultAttributes(wxWindowVariant
WXUNUSED(variant
))
3634 // Use the same color scheme as wxListBox
3635 return wxListBox::GetClassDefaultAttributes(variant
);
3637 wxVisualAttributes attr
;
3638 attr
.colFg
= wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT
);
3639 attr
.colBg
= wxSystemSettings::GetColour(wxSYS_COLOUR_LISTBOX
);
3640 attr
.font
= wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
);
3645 void wxGenericTreeCtrl::DoDirtyProcessing()
3652 CalculatePositions();
3654 AdjustMyScrollbars();
3657 wxSize
wxGenericTreeCtrl::DoGetBestSize() const
3659 // make sure all positions are calculated as normally this only done during
3660 // idle time but we need them for base class DoGetBestSize() to return the
3662 wxConstCast(this, wxGenericTreeCtrl
)->CalculatePositions();
3664 wxSize size
= wxTreeCtrlBase::DoGetBestSize();
3666 // there seems to be an implicit extra border around the items, although
3667 // I'm not really sure where does it come from -- but without this, the
3668 // scrollbars appear in a tree with default/best size
3671 // and the border has to be rounded up to a multiple of PIXELS_PER_UNIT or
3672 // scrollbars still appear
3673 const wxSize
& borderSize
= GetWindowBorderSize();
3675 int dx
= (size
.x
- borderSize
.x
) % PIXELS_PER_UNIT
;
3677 size
.x
+= PIXELS_PER_UNIT
- dx
;
3678 int dy
= (size
.y
- borderSize
.y
) % PIXELS_PER_UNIT
;
3680 size
.y
+= PIXELS_PER_UNIT
- dy
;
3682 // we need to update the cache too as the base class cached its own value
3683 CacheBestSize(size
);
3688 #endif // wxUSE_TREECTRL