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 and Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // =============================================================================
14 // =============================================================================
16 // -----------------------------------------------------------------------------
18 // -----------------------------------------------------------------------------
20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
21 #pragma implementation "treectlg.h"
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
33 #include "wx/treebase.h"
34 #include "wx/generic/treectlg.h"
36 #include "wx/textctrl.h"
37 #include "wx/imaglist.h"
38 #include "wx/settings.h"
39 #include "wx/dcclient.h"
41 #include "wx/renderer.h"
44 #include "wx/mac/private.h"
47 // -----------------------------------------------------------------------------
49 // -----------------------------------------------------------------------------
51 class WXDLLEXPORT wxGenericTreeItem
;
53 WX_DEFINE_EXPORTED_ARRAY_PTR(wxGenericTreeItem
*, wxArrayGenericTreeItems
);
55 // ----------------------------------------------------------------------------
57 // ----------------------------------------------------------------------------
59 static const int NO_IMAGE
= -1;
61 static const int PIXELS_PER_UNIT
= 10;
63 // -----------------------------------------------------------------------------
65 // -----------------------------------------------------------------------------
67 // timer used for enabling in-place edit
68 class WXDLLEXPORT wxTreeRenameTimer
: public wxTimer
71 // start editing the current item after half a second (if the mouse hasn't
72 // been clicked/moved)
75 wxTreeRenameTimer( wxGenericTreeCtrl
*owner
);
77 virtual void Notify();
80 wxGenericTreeCtrl
*m_owner
;
82 DECLARE_NO_COPY_CLASS(wxTreeRenameTimer
)
85 // control used for in-place edit
86 class WXDLLEXPORT wxTreeTextCtrl
: public wxTextCtrl
89 wxTreeTextCtrl(wxGenericTreeCtrl
*owner
, wxGenericTreeItem
*item
);
92 void OnChar( wxKeyEvent
&event
);
93 void OnKeyUp( wxKeyEvent
&event
);
94 void OnKillFocus( wxFocusEvent
&event
);
100 wxGenericTreeCtrl
*m_owner
;
101 wxGenericTreeItem
*m_itemEdited
;
102 wxString m_startValue
;
105 DECLARE_EVENT_TABLE()
106 DECLARE_NO_COPY_CLASS(wxTreeTextCtrl
)
109 // timer used to clear wxGenericTreeCtrl::m_findPrefix if no key was pressed
110 // for a sufficiently long time
111 class WXDLLEXPORT wxTreeFindTimer
: public wxTimer
114 // reset the current prefix after half a second of inactivity
115 enum { DELAY
= 500 };
117 wxTreeFindTimer( wxGenericTreeCtrl
*owner
) { m_owner
= owner
; }
119 virtual void Notify() { m_owner
->m_findPrefix
.clear(); }
122 wxGenericTreeCtrl
*m_owner
;
124 DECLARE_NO_COPY_CLASS(wxTreeFindTimer
)
128 class WXDLLEXPORT wxGenericTreeItem
132 wxGenericTreeItem() { m_data
= NULL
; }
133 wxGenericTreeItem( wxGenericTreeItem
*parent
,
134 const wxString
& text
,
137 wxTreeItemData
*data
);
139 ~wxGenericTreeItem();
142 wxArrayGenericTreeItems
& GetChildren() { return m_children
; }
144 const wxString
& GetText() const { return m_text
; }
145 int GetImage(wxTreeItemIcon which
= wxTreeItemIcon_Normal
) const
146 { return m_images
[which
]; }
147 wxTreeItemData
*GetData() const { return m_data
; }
149 // returns the current image for the item (depending on its
150 // selected/expanded/whatever state)
151 int GetCurrentImage() const;
153 void SetText( const wxString
&text
);
154 void SetImage(int image
, wxTreeItemIcon which
) { m_images
[which
] = image
; }
155 void SetData(wxTreeItemData
*data
) { m_data
= data
; }
157 void SetHasPlus(bool has
= TRUE
) { m_hasPlus
= has
; }
159 void SetBold(bool bold
) { m_isBold
= bold
; }
161 int GetX() const { return m_x
; }
162 int GetY() const { return m_y
; }
164 void SetX(int x
) { m_x
= x
; }
165 void SetY(int y
) { m_y
= y
; }
167 int GetHeight() const { return m_height
; }
168 int GetWidth() const { return m_width
; }
170 void SetHeight(int h
) { m_height
= h
; }
171 void SetWidth(int w
) { m_width
= w
; }
173 wxGenericTreeItem
*GetParent() const { return m_parent
; }
176 // deletes all children notifying the treectrl about it if !NULL
178 void DeleteChildren(wxGenericTreeCtrl
*tree
= NULL
);
180 // get count of all children (and grand children if 'recursively')
181 size_t GetChildrenCount(bool recursively
= TRUE
) const;
183 void Insert(wxGenericTreeItem
*child
, size_t index
)
184 { m_children
.Insert(child
, index
); }
186 void GetSize( int &x
, int &y
, const wxGenericTreeCtrl
* );
188 // return the item at given position (or NULL if no item), onButton is
189 // TRUE if the point belongs to the item's button, otherwise it lies
190 // on the item's label
191 wxGenericTreeItem
*HitTest( const wxPoint
& point
,
192 const wxGenericTreeCtrl
*,
196 void Expand() { m_isCollapsed
= FALSE
; }
197 void Collapse() { m_isCollapsed
= TRUE
; }
199 void SetHilight( bool set
= TRUE
) { m_hasHilight
= set
; }
202 bool HasChildren() const { return !m_children
.IsEmpty(); }
203 bool IsSelected() const { return m_hasHilight
!= 0; }
204 bool IsExpanded() const { return !m_isCollapsed
; }
205 bool HasPlus() const { return m_hasPlus
|| HasChildren(); }
206 bool IsBold() const { return m_isBold
!= 0; }
209 // get them - may be NULL
210 wxTreeItemAttr
*GetAttributes() const { return m_attr
; }
211 // get them ensuring that the pointer is not NULL
212 wxTreeItemAttr
& Attr()
216 m_attr
= new wxTreeItemAttr
;
222 void SetAttributes(wxTreeItemAttr
*attr
)
224 if ( m_ownsAttr
) delete m_attr
;
228 // set them and delete when done
229 void AssignAttributes(wxTreeItemAttr
*attr
)
236 // since there can be very many of these, we save size by chosing
237 // the smallest representation for the elements and by ordering
238 // the members to avoid padding.
239 wxString m_text
; // label to be rendered for item
241 wxTreeItemData
*m_data
; // user-provided data
243 wxArrayGenericTreeItems m_children
; // list of children
244 wxGenericTreeItem
*m_parent
; // parent of this item
246 wxTreeItemAttr
*m_attr
; // attributes???
248 // tree ctrl images for the normal, selected, expanded and
249 // expanded+selected states
250 short m_images
[wxTreeItemIcon_Max
];
252 wxCoord m_x
; // (virtual) offset from top
253 wxCoord m_y
; // (virtual) offset from left
254 short m_width
; // width of this item
255 unsigned char m_height
; // height of this item
257 // use bitfields to save size
258 int m_isCollapsed
:1;
259 int m_hasHilight
:1; // same as focused
260 int m_hasPlus
:1; // used for item which doesn't have
261 // children but has a [+] button
262 int m_isBold
:1; // render the label in bold font
263 int m_ownsAttr
:1; // delete attribute when done
265 DECLARE_NO_COPY_CLASS(wxGenericTreeItem
)
268 // =============================================================================
270 // =============================================================================
272 // ----------------------------------------------------------------------------
274 // ----------------------------------------------------------------------------
276 // translate the key or mouse event flags to the type of selection we're
278 static void EventFlagsToSelType(long style
,
282 bool &extended_select
,
283 bool &unselect_others
)
285 is_multiple
= (style
& wxTR_MULTIPLE
) != 0;
286 extended_select
= shiftDown
&& is_multiple
;
287 unselect_others
= !(extended_select
|| (ctrlDown
&& is_multiple
));
290 // check if the given item is under another one
291 static bool IsDescendantOf(wxGenericTreeItem
*parent
, wxGenericTreeItem
*item
)
295 if ( item
== parent
)
297 // item is a descendant of parent
301 item
= item
->GetParent();
307 // -----------------------------------------------------------------------------
308 // wxTreeRenameTimer (internal)
309 // -----------------------------------------------------------------------------
311 wxTreeRenameTimer::wxTreeRenameTimer( wxGenericTreeCtrl
*owner
)
316 void wxTreeRenameTimer::Notify()
318 m_owner
->OnRenameTimer();
321 //-----------------------------------------------------------------------------
322 // wxTreeTextCtrl (internal)
323 //-----------------------------------------------------------------------------
325 BEGIN_EVENT_TABLE(wxTreeTextCtrl
,wxTextCtrl
)
326 EVT_CHAR (wxTreeTextCtrl::OnChar
)
327 EVT_KEY_UP (wxTreeTextCtrl::OnKeyUp
)
328 EVT_KILL_FOCUS (wxTreeTextCtrl::OnKillFocus
)
331 wxTreeTextCtrl::wxTreeTextCtrl(wxGenericTreeCtrl
*owner
,
332 wxGenericTreeItem
*item
)
333 : m_itemEdited(item
), m_startValue(item
->GetText())
338 int w
= m_itemEdited
->GetWidth(),
339 h
= m_itemEdited
->GetHeight();
342 m_owner
->CalcScrolledPosition(item
->GetX(), item
->GetY(), &x
, &y
);
347 int image
= item
->GetCurrentImage();
348 if ( image
!= NO_IMAGE
)
350 if ( m_owner
->m_imageListNormal
)
352 m_owner
->m_imageListNormal
->GetSize( image
, image_w
, image_h
);
357 wxFAIL_MSG(_T("you must create an image list to use images!"));
361 // FIXME: what are all these hardcoded 4, 8 and 11s really?
365 (void)Create(m_owner
, wxID_ANY
, m_startValue
,
366 wxPoint(x
- 4, y
- 4), wxSize(w
+ 11, h
+ 8));
369 bool wxTreeTextCtrl::AcceptChanges()
371 const wxString value
= GetValue();
373 if ( value
== m_startValue
)
375 // nothing changed, always accept
379 if ( !m_owner
->OnRenameAccept(m_itemEdited
, value
) )
381 // vetoed by the user
385 // accepted, do rename the item
386 m_owner
->SetItemText(m_itemEdited
, value
);
391 void wxTreeTextCtrl::Finish()
395 m_owner
->ResetTextControl();
397 wxPendingDelete
.Append(this);
401 m_owner
->SetFocus(); // This doesn't work. TODO.
405 void wxTreeTextCtrl::OnChar( wxKeyEvent
&event
)
407 switch ( event
.m_keyCode
)
410 if ( !AcceptChanges() )
412 // vetoed by the user, don't disappear
419 m_owner
->OnRenameCancelled(m_itemEdited
);
427 void wxTreeTextCtrl::OnKeyUp( wxKeyEvent
&event
)
431 // auto-grow the textctrl:
432 wxSize parentSize
= m_owner
->GetSize();
433 wxPoint myPos
= GetPosition();
434 wxSize mySize
= GetSize();
436 GetTextExtent(GetValue() + _T("M"), &sx
, &sy
);
437 if (myPos
.x
+ sx
> parentSize
.x
)
438 sx
= parentSize
.x
- myPos
.x
;
447 void wxTreeTextCtrl::OnKillFocus( wxFocusEvent
&event
)
455 if ( AcceptChanges() )
461 // -----------------------------------------------------------------------------
463 // -----------------------------------------------------------------------------
465 wxGenericTreeItem::wxGenericTreeItem(wxGenericTreeItem
*parent
,
466 const wxString
& text
,
467 int image
, int selImage
,
468 wxTreeItemData
*data
)
471 m_images
[wxTreeItemIcon_Normal
] = image
;
472 m_images
[wxTreeItemIcon_Selected
] = selImage
;
473 m_images
[wxTreeItemIcon_Expanded
] = NO_IMAGE
;
474 m_images
[wxTreeItemIcon_SelectedExpanded
] = NO_IMAGE
;
479 m_isCollapsed
= TRUE
;
480 m_hasHilight
= FALSE
;
486 m_attr
= (wxTreeItemAttr
*)NULL
;
489 // We don't know the height here yet.
494 wxGenericTreeItem::~wxGenericTreeItem()
498 if (m_ownsAttr
) delete m_attr
;
500 wxASSERT_MSG( m_children
.IsEmpty(),
501 wxT("please call DeleteChildren() before deleting the item") );
504 void wxGenericTreeItem::DeleteChildren(wxGenericTreeCtrl
*tree
)
506 size_t count
= m_children
.Count();
507 for ( size_t n
= 0; n
< count
; n
++ )
509 wxGenericTreeItem
*child
= m_children
[n
];
511 tree
->SendDeleteEvent(child
);
513 child
->DeleteChildren(tree
);
520 void wxGenericTreeItem::SetText( const wxString
&text
)
525 size_t wxGenericTreeItem::GetChildrenCount(bool recursively
) const
527 size_t count
= m_children
.Count();
531 size_t total
= count
;
532 for (size_t n
= 0; n
< count
; ++n
)
534 total
+= m_children
[n
]->GetChildrenCount();
540 void wxGenericTreeItem::GetSize( int &x
, int &y
,
541 const wxGenericTreeCtrl
*theButton
)
543 int bottomY
=m_y
+theButton
->GetLineHeight(this);
544 if ( y
< bottomY
) y
= bottomY
;
545 int width
= m_x
+ m_width
;
546 if ( x
< width
) x
= width
;
550 size_t count
= m_children
.Count();
551 for ( size_t n
= 0; n
< count
; ++n
)
553 m_children
[n
]->GetSize( x
, y
, theButton
);
558 wxGenericTreeItem
*wxGenericTreeItem::HitTest(const wxPoint
& point
,
559 const wxGenericTreeCtrl
*theCtrl
,
563 // for a hidden root node, don't evaluate it, but do evaluate children
564 if ( !(level
== 0 && theCtrl
->HasFlag(wxTR_HIDE_ROOT
)) )
567 int h
= theCtrl
->GetLineHeight(this);
568 if ((point
.y
> m_y
) && (point
.y
< m_y
+ h
))
570 int y_mid
= m_y
+ h
/2;
571 if (point
.y
< y_mid
)
572 flags
|= wxTREE_HITTEST_ONITEMUPPERPART
;
574 flags
|= wxTREE_HITTEST_ONITEMLOWERPART
;
576 int xCross
= m_x
- theCtrl
->GetSpacing();
578 // according to the drawing code the triangels are drawn
579 // at -4 , -4 from the position up to +10/+10 max
580 if ((point
.x
> xCross
-4) && (point
.x
< xCross
+10) &&
581 (point
.y
> y_mid
-4) && (point
.y
< y_mid
+10) &&
582 HasPlus() && theCtrl
->HasButtons() )
584 // 5 is the size of the plus sign
585 if ((point
.x
> xCross
-6) && (point
.x
< xCross
+6) &&
586 (point
.y
> y_mid
-6) && (point
.y
< y_mid
+6) &&
587 HasPlus() && theCtrl
->HasButtons() )
590 flags
|= wxTREE_HITTEST_ONITEMBUTTON
;
594 if ((point
.x
>= m_x
) && (point
.x
<= m_x
+m_width
))
599 // assuming every image (normal and selected) has the same size!
600 if ( (GetImage() != NO_IMAGE
) && theCtrl
->m_imageListNormal
)
601 theCtrl
->m_imageListNormal
->GetSize(GetImage(),
604 if ((image_w
!= -1) && (point
.x
<= m_x
+ image_w
+ 1))
605 flags
|= wxTREE_HITTEST_ONITEMICON
;
607 flags
|= wxTREE_HITTEST_ONITEMLABEL
;
613 flags
|= wxTREE_HITTEST_ONITEMINDENT
;
614 if (point
.x
> m_x
+m_width
)
615 flags
|= wxTREE_HITTEST_ONITEMRIGHT
;
620 // if children are expanded, fall through to evaluate them
621 if (m_isCollapsed
) return (wxGenericTreeItem
*) NULL
;
625 size_t count
= m_children
.Count();
626 for ( size_t n
= 0; n
< count
; n
++ )
628 wxGenericTreeItem
*res
= m_children
[n
]->HitTest( point
,
636 return (wxGenericTreeItem
*) NULL
;
639 int wxGenericTreeItem::GetCurrentImage() const
641 int image
= NO_IMAGE
;
646 image
= GetImage(wxTreeItemIcon_SelectedExpanded
);
649 if ( image
== NO_IMAGE
)
651 // we usually fall back to the normal item, but try just the
652 // expanded one (and not selected) first in this case
653 image
= GetImage(wxTreeItemIcon_Expanded
);
659 image
= GetImage(wxTreeItemIcon_Selected
);
662 // maybe it doesn't have the specific image we want,
663 // try the default one instead
664 if ( image
== NO_IMAGE
) image
= GetImage();
669 // -----------------------------------------------------------------------------
670 // wxGenericTreeCtrl implementation
671 // -----------------------------------------------------------------------------
673 IMPLEMENT_DYNAMIC_CLASS(wxGenericTreeCtrl
, wxScrolledWindow
)
675 BEGIN_EVENT_TABLE(wxGenericTreeCtrl
,wxScrolledWindow
)
676 EVT_PAINT (wxGenericTreeCtrl::OnPaint
)
677 EVT_MOUSE_EVENTS (wxGenericTreeCtrl::OnMouse
)
678 EVT_CHAR (wxGenericTreeCtrl::OnChar
)
679 EVT_SET_FOCUS (wxGenericTreeCtrl::OnSetFocus
)
680 EVT_KILL_FOCUS (wxGenericTreeCtrl::OnKillFocus
)
681 EVT_TREE_ITEM_GETTOOLTIP(-1, wxGenericTreeCtrl::OnGetToolTip
)
684 #if !defined(__WXMSW__) || defined(__WXUNIVERSAL__)
686 * wxTreeCtrl has to be a real class or we have problems with
687 * the run-time information.
690 IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl
, wxGenericTreeCtrl
)
693 // -----------------------------------------------------------------------------
694 // construction/destruction
695 // -----------------------------------------------------------------------------
697 void wxGenericTreeCtrl::Init()
699 m_current
= m_key_current
= m_anchor
= m_select_me
= (wxGenericTreeItem
*) NULL
;
707 m_hilightBrush
= new wxBrush
709 wxSystemSettings::GetColour
711 wxSYS_COLOUR_HIGHLIGHT
716 m_hilightUnfocusedBrush
= new wxBrush
718 wxSystemSettings::GetColour
720 wxSYS_COLOUR_BTNSHADOW
725 m_imageListNormal
= m_imageListButtons
=
726 m_imageListState
= (wxImageList
*) NULL
;
727 m_ownsImageListNormal
= m_ownsImageListButtons
=
728 m_ownsImageListState
= FALSE
;
731 m_isDragging
= FALSE
;
732 m_dropTarget
= m_oldSelection
= NULL
;
736 m_renameTimer
= NULL
;
741 m_lastOnSame
= FALSE
;
743 #if defined( __WXMAC__ ) && __WXMAC_CARBON__
744 m_normalFont
.MacCreateThemeFont( kThemeViewsFont
) ;
746 m_normalFont
= wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT
);
748 m_boldFont
= wxFont(m_normalFont
.GetPointSize(),
749 m_normalFont
.GetFamily(),
750 m_normalFont
.GetStyle(),
752 m_normalFont
.GetUnderlined(),
753 m_normalFont
.GetFaceName(),
754 m_normalFont
.GetEncoding());
757 bool wxGenericTreeCtrl::Create(wxWindow
*parent
,
762 const wxValidator
& wxVALIDATOR_PARAM(validator
),
763 const wxString
& name
)
767 wxGetOsVersion( &major
, &minor
);
769 style
&= ~wxTR_LINES_AT_ROOT
;
770 style
|= wxTR_NO_LINES
;
772 style
|= wxTR_ROW_LINES
;
775 wxScrolledWindow::Create( parent
, id
, pos
, size
,
776 style
|wxHSCROLL
|wxVSCROLL
, name
);
778 // If the tree display has no buttons, but does have
779 // connecting lines, we can use a narrower layout.
780 // It may not be a good idea to force this...
781 if (!HasButtons() && !HasFlag(wxTR_NO_LINES
))
788 SetValidator( validator
);
791 SetForegroundColour( wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT
) );
792 SetBackgroundColour( wxSystemSettings::GetColour(wxSYS_COLOUR_LISTBOX
) );
794 // m_dottedPen = wxPen( "grey", 0, wxDOT ); too slow under XFree86
795 m_dottedPen
= wxPen( wxT("grey"), 0, 0 );
800 wxGenericTreeCtrl::~wxGenericTreeCtrl()
802 delete m_hilightBrush
;
803 delete m_hilightUnfocusedBrush
;
807 delete m_renameTimer
;
810 if (m_ownsImageListNormal
)
811 delete m_imageListNormal
;
812 if (m_ownsImageListState
)
813 delete m_imageListState
;
814 if (m_ownsImageListButtons
)
815 delete m_imageListButtons
;
818 // -----------------------------------------------------------------------------
820 // -----------------------------------------------------------------------------
822 size_t wxGenericTreeCtrl::GetCount() const
824 return m_anchor
== NULL
? 0u : m_anchor
->GetChildrenCount();
827 void wxGenericTreeCtrl::SetIndent(unsigned int indent
)
829 m_indent
= (unsigned short) indent
;
833 void wxGenericTreeCtrl::SetSpacing(unsigned int spacing
)
835 m_spacing
= (unsigned short) spacing
;
840 wxGenericTreeCtrl::GetChildrenCount(const wxTreeItemId
& item
,
841 bool recursively
) const
843 wxCHECK_MSG( item
.IsOk(), 0u, wxT("invalid tree item") );
845 return ((wxGenericTreeItem
*) item
.m_pItem
)->GetChildrenCount(recursively
);
848 void wxGenericTreeCtrl::SetWindowStyle(const long styles
)
850 if (!HasFlag(wxTR_HIDE_ROOT
) && (styles
& wxTR_HIDE_ROOT
))
852 // if we will hide the root, make sure children are visible
853 m_anchor
->SetHasPlus();
855 CalculatePositions();
858 // right now, just sets the styles. Eventually, we may
859 // want to update the inherited styles, but right now
860 // none of the parents has updatable styles
861 m_windowStyle
= styles
;
865 // -----------------------------------------------------------------------------
866 // functions to work with tree items
867 // -----------------------------------------------------------------------------
869 wxString
wxGenericTreeCtrl::GetItemText(const wxTreeItemId
& item
) const
871 wxCHECK_MSG( item
.IsOk(), wxT(""), wxT("invalid tree item") );
873 return ((wxGenericTreeItem
*) item
.m_pItem
)->GetText();
876 int wxGenericTreeCtrl::GetItemImage(const wxTreeItemId
& item
,
877 wxTreeItemIcon which
) const
879 wxCHECK_MSG( item
.IsOk(), -1, wxT("invalid tree item") );
881 return ((wxGenericTreeItem
*) item
.m_pItem
)->GetImage(which
);
884 wxTreeItemData
*wxGenericTreeCtrl::GetItemData(const wxTreeItemId
& item
) const
886 wxCHECK_MSG( item
.IsOk(), NULL
, wxT("invalid tree item") );
888 return ((wxGenericTreeItem
*) item
.m_pItem
)->GetData();
891 wxColour
wxGenericTreeCtrl::GetItemTextColour(const wxTreeItemId
& item
) const
893 wxCHECK_MSG( item
.IsOk(), wxNullColour
, wxT("invalid tree item") );
895 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
896 return pItem
->Attr().GetTextColour();
899 wxColour
wxGenericTreeCtrl::GetItemBackgroundColour(const wxTreeItemId
& item
) const
901 wxCHECK_MSG( item
.IsOk(), wxNullColour
, wxT("invalid tree item") );
903 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
904 return pItem
->Attr().GetBackgroundColour();
907 wxFont
wxGenericTreeCtrl::GetItemFont(const wxTreeItemId
& item
) const
909 wxCHECK_MSG( item
.IsOk(), wxNullFont
, wxT("invalid tree item") );
911 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
912 return pItem
->Attr().GetFont();
915 void wxGenericTreeCtrl::SetItemText(const wxTreeItemId
& item
, const wxString
& text
)
917 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
920 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
921 pItem
->SetText(text
);
922 CalculateSize(pItem
, dc
);
926 void wxGenericTreeCtrl::SetItemImage(const wxTreeItemId
& item
,
928 wxTreeItemIcon which
)
930 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
932 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
933 pItem
->SetImage(image
, which
);
936 CalculateSize(pItem
, dc
);
940 void wxGenericTreeCtrl::SetItemData(const wxTreeItemId
& item
, wxTreeItemData
*data
)
942 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
947 ((wxGenericTreeItem
*) item
.m_pItem
)->SetData(data
);
950 void wxGenericTreeCtrl::SetItemHasChildren(const wxTreeItemId
& item
, bool has
)
952 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
954 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
955 pItem
->SetHasPlus(has
);
959 void wxGenericTreeCtrl::SetItemBold(const wxTreeItemId
& item
, bool bold
)
961 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
963 // avoid redrawing the tree if no real change
964 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
965 if ( pItem
->IsBold() != bold
)
967 pItem
->SetBold(bold
);
972 void wxGenericTreeCtrl::SetItemTextColour(const wxTreeItemId
& item
,
975 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
977 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
978 pItem
->Attr().SetTextColour(col
);
982 void wxGenericTreeCtrl::SetItemBackgroundColour(const wxTreeItemId
& item
,
985 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
987 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
988 pItem
->Attr().SetBackgroundColour(col
);
992 void wxGenericTreeCtrl::SetItemFont(const wxTreeItemId
& item
, const wxFont
& font
)
994 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
996 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
997 pItem
->Attr().SetFont(font
);
1001 bool wxGenericTreeCtrl::SetFont( const wxFont
&font
)
1003 wxScrolledWindow::SetFont(font
);
1005 m_normalFont
= font
;
1006 m_boldFont
= wxFont(m_normalFont
.GetPointSize(),
1007 m_normalFont
.GetFamily(),
1008 m_normalFont
.GetStyle(),
1010 m_normalFont
.GetUnderlined(),
1011 m_normalFont
.GetFaceName(),
1012 m_normalFont
.GetEncoding());
1018 // -----------------------------------------------------------------------------
1019 // item status inquiries
1020 // -----------------------------------------------------------------------------
1022 bool wxGenericTreeCtrl::IsVisible(const wxTreeItemId
& item
) const
1024 wxCHECK_MSG( item
.IsOk(), FALSE
, wxT("invalid tree item") );
1026 // An item is only visible if it's not a descendant of a collapsed item
1027 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1028 wxGenericTreeItem
* parent
= pItem
->GetParent();
1031 if (!parent
->IsExpanded())
1033 parent
= parent
->GetParent();
1037 GetViewStart(& startX
, & startY
);
1039 wxSize clientSize
= GetClientSize();
1042 if (!GetBoundingRect(item
, rect
))
1044 if (rect
.GetWidth() == 0 || rect
.GetHeight() == 0)
1046 if (rect
.GetBottom() < 0 || rect
.GetTop() > clientSize
.y
)
1048 if (rect
.GetRight() < 0 || rect
.GetLeft() > clientSize
.x
)
1054 bool wxGenericTreeCtrl::ItemHasChildren(const wxTreeItemId
& item
) const
1056 wxCHECK_MSG( item
.IsOk(), FALSE
, wxT("invalid tree item") );
1058 // consider that the item does have children if it has the "+" button: it
1059 // might not have them (if it had never been expanded yet) but then it
1060 // could have them as well and it's better to err on this side rather than
1061 // disabling some operations which are restricted to the items with
1062 // children for an item which does have them
1063 return ((wxGenericTreeItem
*) item
.m_pItem
)->HasPlus();
1066 bool wxGenericTreeCtrl::IsExpanded(const wxTreeItemId
& item
) const
1068 wxCHECK_MSG( item
.IsOk(), FALSE
, wxT("invalid tree item") );
1070 return ((wxGenericTreeItem
*) item
.m_pItem
)->IsExpanded();
1073 bool wxGenericTreeCtrl::IsSelected(const wxTreeItemId
& item
) const
1075 wxCHECK_MSG( item
.IsOk(), FALSE
, wxT("invalid tree item") );
1077 return ((wxGenericTreeItem
*) item
.m_pItem
)->IsSelected();
1080 bool wxGenericTreeCtrl::IsBold(const wxTreeItemId
& item
) const
1082 wxCHECK_MSG( item
.IsOk(), FALSE
, wxT("invalid tree item") );
1084 return ((wxGenericTreeItem
*) item
.m_pItem
)->IsBold();
1087 // -----------------------------------------------------------------------------
1089 // -----------------------------------------------------------------------------
1091 wxTreeItemId
wxGenericTreeCtrl::GetItemParent(const wxTreeItemId
& item
) const
1093 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1095 return ((wxGenericTreeItem
*) item
.m_pItem
)->GetParent();
1098 wxTreeItemId
wxGenericTreeCtrl::GetFirstChild(const wxTreeItemId
& item
,
1099 wxTreeItemIdValue
& cookie
) const
1101 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1104 return GetNextChild(item
, cookie
);
1107 wxTreeItemId
wxGenericTreeCtrl::GetNextChild(const wxTreeItemId
& item
,
1108 wxTreeItemIdValue
& cookie
) const
1110 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1112 wxArrayGenericTreeItems
& children
= ((wxGenericTreeItem
*) item
.m_pItem
)->GetChildren();
1114 // it's ok to cast cookie to size_t, we never have indices big enough to
1115 // overflow "void *"
1116 size_t *pIndex
= (size_t *)&cookie
;
1117 if ( *pIndex
< children
.Count() )
1119 return children
.Item((*pIndex
)++);
1123 // there are no more of them
1124 return wxTreeItemId();
1128 #if WXWIN_COMPATIBILITY_2_4
1130 wxTreeItemId
wxGenericTreeCtrl::GetFirstChild(const wxTreeItemId
& item
,
1133 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1136 return GetNextChild(item
, cookie
);
1139 wxTreeItemId
wxGenericTreeCtrl::GetNextChild(const wxTreeItemId
& item
,
1142 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1144 wxArrayGenericTreeItems
& children
= ((wxGenericTreeItem
*) item
.m_pItem
)->GetChildren();
1145 if ( (size_t)cookie
< children
.Count() )
1147 return children
.Item((size_t)cookie
++);
1151 // there are no more of them
1152 return wxTreeItemId();
1156 #endif // WXWIN_COMPATIBILITY_2_4
1158 wxTreeItemId
wxGenericTreeCtrl::GetLastChild(const wxTreeItemId
& item
) const
1160 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1162 wxArrayGenericTreeItems
& children
= ((wxGenericTreeItem
*) item
.m_pItem
)->GetChildren();
1163 return (children
.IsEmpty() ? wxTreeItemId() : wxTreeItemId(children
.Last()));
1166 wxTreeItemId
wxGenericTreeCtrl::GetNextSibling(const wxTreeItemId
& item
) const
1168 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1170 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
1171 wxGenericTreeItem
*parent
= i
->GetParent();
1172 if ( parent
== NULL
)
1174 // root item doesn't have any siblings
1175 return wxTreeItemId();
1178 wxArrayGenericTreeItems
& siblings
= parent
->GetChildren();
1179 int index
= siblings
.Index(i
);
1180 wxASSERT( index
!= wxNOT_FOUND
); // I'm not a child of my parent?
1182 size_t n
= (size_t)(index
+ 1);
1183 return n
== siblings
.Count() ? wxTreeItemId() : wxTreeItemId(siblings
[n
]);
1186 wxTreeItemId
wxGenericTreeCtrl::GetPrevSibling(const wxTreeItemId
& item
) const
1188 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1190 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
1191 wxGenericTreeItem
*parent
= i
->GetParent();
1192 if ( parent
== NULL
)
1194 // root item doesn't have any siblings
1195 return wxTreeItemId();
1198 wxArrayGenericTreeItems
& siblings
= parent
->GetChildren();
1199 int index
= siblings
.Index(i
);
1200 wxASSERT( index
!= wxNOT_FOUND
); // I'm not a child of my parent?
1202 return index
== 0 ? wxTreeItemId()
1203 : wxTreeItemId(siblings
[(size_t)(index
- 1)]);
1206 // Only for internal use right now, but should probably be public
1207 wxTreeItemId
wxGenericTreeCtrl::GetNext(const wxTreeItemId
& item
) const
1209 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1211 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
1213 // First see if there are any children.
1214 wxArrayGenericTreeItems
& children
= i
->GetChildren();
1215 if (children
.GetCount() > 0)
1217 return children
.Item(0);
1221 // Try a sibling of this or ancestor instead
1222 wxTreeItemId p
= item
;
1223 wxTreeItemId toFind
;
1226 toFind
= GetNextSibling(p
);
1227 p
= GetItemParent(p
);
1228 } while (p
.IsOk() && !toFind
.IsOk());
1233 wxTreeItemId
wxGenericTreeCtrl::GetFirstVisibleItem() const
1235 wxTreeItemId id
= GetRootItem();
1244 } while (id
.IsOk());
1246 return wxTreeItemId();
1249 wxTreeItemId
wxGenericTreeCtrl::GetNextVisible(const wxTreeItemId
& item
) const
1251 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1253 wxTreeItemId id
= item
;
1256 while (id
= GetNext(id
), id
.IsOk())
1262 return wxTreeItemId();
1265 wxTreeItemId
wxGenericTreeCtrl::GetPrevVisible(const wxTreeItemId
& item
) const
1267 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1269 wxFAIL_MSG(wxT("not implemented"));
1271 return wxTreeItemId();
1274 // called by wxTextTreeCtrl when it marks itself for deletion
1275 void wxGenericTreeCtrl::ResetTextControl()
1280 // find the first item starting with the given prefix after the given item
1281 wxTreeItemId
wxGenericTreeCtrl::FindItem(const wxTreeItemId
& idParent
,
1282 const wxString
& prefixOrig
) const
1284 // match is case insensitive as this is more convenient to the user: having
1285 // to press Shift-letter to go to the item starting with a capital letter
1286 // would be too bothersome
1287 wxString prefix
= prefixOrig
.Lower();
1289 // determine the starting point: we shouldn't take the current item (this
1290 // allows to switch between two items starting with the same letter just by
1291 // pressing it) but we shouldn't jump to the next one if the user is
1292 // continuing to type as otherwise he might easily skip the item he wanted
1293 wxTreeItemId id
= idParent
;
1294 if ( prefix
.length() == 1 )
1299 // look for the item starting with the given prefix after it
1300 while ( id
.IsOk() && !GetItemText(id
).Lower().StartsWith(prefix
) )
1305 // if we haven't found anything...
1308 // ... wrap to the beginning
1310 if ( HasFlag(wxTR_HIDE_ROOT
) )
1312 // can't select virtual root
1316 // and try all the items (stop when we get to the one we started from)
1317 while ( id
!= idParent
&& !GetItemText(id
).Lower().StartsWith(prefix
) )
1326 // -----------------------------------------------------------------------------
1328 // -----------------------------------------------------------------------------
1330 wxTreeItemId
wxGenericTreeCtrl::DoInsertItem(const wxTreeItemId
& parentId
,
1332 const wxString
& text
,
1333 int image
, int selImage
,
1334 wxTreeItemData
*data
)
1336 wxGenericTreeItem
*parent
= (wxGenericTreeItem
*) parentId
.m_pItem
;
1339 // should we give a warning here?
1340 return AddRoot(text
, image
, selImage
, data
);
1343 m_dirty
= TRUE
; // do this first so stuff below doesn't cause flicker
1345 wxGenericTreeItem
*item
=
1346 new wxGenericTreeItem( parent
, text
, image
, selImage
, data
);
1350 data
->m_pItem
= item
;
1353 parent
->Insert( item
, previous
);
1358 wxTreeItemId
wxGenericTreeCtrl::AddRoot(const wxString
& text
,
1359 int image
, int selImage
,
1360 wxTreeItemData
*data
)
1362 wxCHECK_MSG( !m_anchor
, wxTreeItemId(), wxT("tree can have only one root") );
1364 m_dirty
= TRUE
; // do this first so stuff below doesn't cause flicker
1366 m_anchor
= new wxGenericTreeItem((wxGenericTreeItem
*)NULL
, text
,
1367 image
, selImage
, data
);
1370 data
->m_pItem
= m_anchor
;
1373 if (HasFlag(wxTR_HIDE_ROOT
))
1375 // if root is hidden, make sure we can navigate
1377 m_anchor
->SetHasPlus();
1379 CalculatePositions();
1382 if (!HasFlag(wxTR_MULTIPLE
))
1384 m_current
= m_key_current
= m_anchor
;
1385 m_current
->SetHilight( TRUE
);
1391 wxTreeItemId
wxGenericTreeCtrl::PrependItem(const wxTreeItemId
& parent
,
1392 const wxString
& text
,
1393 int image
, int selImage
,
1394 wxTreeItemData
*data
)
1396 return DoInsertItem(parent
, 0u, text
, image
, selImage
, data
);
1399 wxTreeItemId
wxGenericTreeCtrl::InsertItem(const wxTreeItemId
& parentId
,
1400 const wxTreeItemId
& idPrevious
,
1401 const wxString
& text
,
1402 int image
, int selImage
,
1403 wxTreeItemData
*data
)
1405 wxGenericTreeItem
*parent
= (wxGenericTreeItem
*) parentId
.m_pItem
;
1408 // should we give a warning here?
1409 return AddRoot(text
, image
, selImage
, data
);
1413 if (idPrevious
.IsOk())
1415 index
= parent
->GetChildren().Index((wxGenericTreeItem
*) idPrevious
.m_pItem
);
1416 wxASSERT_MSG( index
!= wxNOT_FOUND
,
1417 wxT("previous item in wxGenericTreeCtrl::InsertItem() is not a sibling") );
1420 return DoInsertItem(parentId
, (size_t)++index
, text
, image
, selImage
, data
);
1423 wxTreeItemId
wxGenericTreeCtrl::InsertItem(const wxTreeItemId
& parentId
,
1425 const wxString
& text
,
1426 int image
, int selImage
,
1427 wxTreeItemData
*data
)
1429 wxGenericTreeItem
*parent
= (wxGenericTreeItem
*) parentId
.m_pItem
;
1432 // should we give a warning here?
1433 return AddRoot(text
, image
, selImage
, data
);
1436 return DoInsertItem(parentId
, before
, text
, image
, selImage
, data
);
1439 wxTreeItemId
wxGenericTreeCtrl::AppendItem(const wxTreeItemId
& parentId
,
1440 const wxString
& text
,
1441 int image
, int selImage
,
1442 wxTreeItemData
*data
)
1444 wxGenericTreeItem
*parent
= (wxGenericTreeItem
*) parentId
.m_pItem
;
1447 // should we give a warning here?
1448 return AddRoot(text
, image
, selImage
, data
);
1451 return DoInsertItem( parent
, parent
->GetChildren().Count(), text
,
1452 image
, selImage
, data
);
1455 void wxGenericTreeCtrl::SendDeleteEvent(wxGenericTreeItem
*item
)
1457 wxTreeEvent
event( wxEVT_COMMAND_TREE_DELETE_ITEM
, GetId() );
1458 event
.m_item
= item
;
1459 event
.SetEventObject( this );
1460 ProcessEvent( event
);
1463 void wxGenericTreeCtrl::DeleteChildren(const wxTreeItemId
& itemId
)
1465 m_dirty
= TRUE
; // do this first so stuff below doesn't cause flicker
1467 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1468 item
->DeleteChildren(this);
1471 void wxGenericTreeCtrl::Delete(const wxTreeItemId
& itemId
)
1473 m_dirty
= TRUE
; // do this first so stuff below doesn't cause flicker
1475 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1477 wxGenericTreeItem
*parent
= item
->GetParent();
1479 // don't keep stale pointers around!
1480 if ( IsDescendantOf(item
, m_key_current
) )
1482 // Don't silently change the selection:
1483 // do it properly in idle time, so event
1484 // handlers get called.
1486 // m_key_current = parent;
1487 m_key_current
= NULL
;
1490 // m_select_me records whether we need to select
1491 // a different item, in idle time.
1492 if ( m_select_me
&& IsDescendantOf(item
, m_select_me
) )
1494 m_select_me
= parent
;
1497 if ( IsDescendantOf(item
, m_current
) )
1499 // Don't silently change the selection:
1500 // do it properly in idle time, so event
1501 // handlers get called.
1503 // m_current = parent;
1505 m_select_me
= parent
;
1508 // remove the item from the tree
1511 parent
->GetChildren().Remove( item
); // remove by value
1513 else // deleting the root
1515 // nothing will be left in the tree
1519 // and delete all of its children and the item itself now
1520 item
->DeleteChildren(this);
1521 SendDeleteEvent(item
);
1525 void wxGenericTreeCtrl::DeleteAllItems()
1533 void wxGenericTreeCtrl::Expand(const wxTreeItemId
& itemId
)
1535 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1537 wxCHECK_RET( item
, _T("invalid item in wxGenericTreeCtrl::Expand") );
1538 wxCHECK_RET( !HasFlag(wxTR_HIDE_ROOT
) || itemId
!= GetRootItem(),
1539 _T("can't expand hidden root") );
1541 if ( !item
->HasPlus() )
1544 if ( item
->IsExpanded() )
1547 wxTreeEvent
event( wxEVT_COMMAND_TREE_ITEM_EXPANDING
, GetId() );
1548 event
.m_item
= item
;
1549 event
.SetEventObject( this );
1551 if ( ProcessEvent( event
) && !event
.IsAllowed() )
1553 // cancelled by program
1558 CalculatePositions();
1560 RefreshSubtree(item
);
1562 event
.SetEventType(wxEVT_COMMAND_TREE_ITEM_EXPANDED
);
1563 ProcessEvent( event
);
1566 void wxGenericTreeCtrl::ExpandAll(const wxTreeItemId
& item
)
1568 if ( !HasFlag(wxTR_HIDE_ROOT
) || item
!= GetRootItem())
1571 if ( !IsExpanded(item
) )
1575 wxTreeItemIdValue cookie
;
1576 wxTreeItemId child
= GetFirstChild(item
, cookie
);
1577 while ( child
.IsOk() )
1581 child
= GetNextChild(item
, cookie
);
1585 void wxGenericTreeCtrl::Collapse(const wxTreeItemId
& itemId
)
1587 wxCHECK_RET( !HasFlag(wxTR_HIDE_ROOT
) || itemId
!= GetRootItem(),
1588 _T("can't collapse hidden root") );
1590 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1592 if ( !item
->IsExpanded() )
1595 wxTreeEvent
event( wxEVT_COMMAND_TREE_ITEM_COLLAPSING
, GetId() );
1596 event
.m_item
= item
;
1597 event
.SetEventObject( this );
1598 if ( ProcessEvent( event
) && !event
.IsAllowed() )
1600 // cancelled by program
1606 #if 0 // TODO why should items be collapsed recursively?
1607 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1608 size_t count
= children
.Count();
1609 for ( size_t n
= 0; n
< count
; n
++ )
1611 Collapse(children
[n
]);
1615 CalculatePositions();
1617 RefreshSubtree(item
);
1619 event
.SetEventType(wxEVT_COMMAND_TREE_ITEM_COLLAPSED
);
1620 ProcessEvent( event
);
1623 void wxGenericTreeCtrl::CollapseAndReset(const wxTreeItemId
& item
)
1626 DeleteChildren(item
);
1629 void wxGenericTreeCtrl::Toggle(const wxTreeItemId
& itemId
)
1631 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1633 if (item
->IsExpanded())
1639 void wxGenericTreeCtrl::Unselect()
1643 m_current
->SetHilight( FALSE
);
1644 RefreshLine( m_current
);
1651 void wxGenericTreeCtrl::UnselectAllChildren(wxGenericTreeItem
*item
)
1653 if (item
->IsSelected())
1655 item
->SetHilight(FALSE
);
1659 if (item
->HasChildren())
1661 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1662 size_t count
= children
.Count();
1663 for ( size_t n
= 0; n
< count
; ++n
)
1665 UnselectAllChildren(children
[n
]);
1670 void wxGenericTreeCtrl::UnselectAll()
1672 wxTreeItemId rootItem
= GetRootItem();
1674 // the tree might not have the root item at all
1677 UnselectAllChildren((wxGenericTreeItem
*) rootItem
.m_pItem
);
1681 // Recursive function !
1682 // To stop we must have crt_item<last_item
1684 // Tag all next children, when no more children,
1685 // Move to parent (not to tag)
1686 // Keep going... if we found last_item, we stop.
1687 bool wxGenericTreeCtrl::TagNextChildren(wxGenericTreeItem
*crt_item
, wxGenericTreeItem
*last_item
, bool select
)
1689 wxGenericTreeItem
*parent
= crt_item
->GetParent();
1691 if (parent
== NULL
) // This is root item
1692 return TagAllChildrenUntilLast(crt_item
, last_item
, select
);
1694 wxArrayGenericTreeItems
& children
= parent
->GetChildren();
1695 int index
= children
.Index(crt_item
);
1696 wxASSERT( index
!= wxNOT_FOUND
); // I'm not a child of my parent?
1698 size_t count
= children
.Count();
1699 for (size_t n
=(size_t)(index
+1); n
<count
; ++n
)
1701 if (TagAllChildrenUntilLast(children
[n
], last_item
, select
)) return TRUE
;
1704 return TagNextChildren(parent
, last_item
, select
);
1707 bool wxGenericTreeCtrl::TagAllChildrenUntilLast(wxGenericTreeItem
*crt_item
, wxGenericTreeItem
*last_item
, bool select
)
1709 crt_item
->SetHilight(select
);
1710 RefreshLine(crt_item
);
1712 if (crt_item
==last_item
)
1715 if (crt_item
->HasChildren())
1717 wxArrayGenericTreeItems
& children
= crt_item
->GetChildren();
1718 size_t count
= children
.Count();
1719 for ( size_t n
= 0; n
< count
; ++n
)
1721 if (TagAllChildrenUntilLast(children
[n
], last_item
, select
))
1729 void wxGenericTreeCtrl::SelectItemRange(wxGenericTreeItem
*item1
, wxGenericTreeItem
*item2
)
1733 // item2 is not necessary after item1
1734 // choice first' and 'last' between item1 and item2
1735 wxGenericTreeItem
*first
= (item1
->GetY()<item2
->GetY()) ? item1
: item2
;
1736 wxGenericTreeItem
*last
= (item1
->GetY()<item2
->GetY()) ? item2
: item1
;
1738 bool select
= m_current
->IsSelected();
1740 if ( TagAllChildrenUntilLast(first
,last
,select
) )
1743 TagNextChildren(first
,last
,select
);
1746 void wxGenericTreeCtrl::DoSelectItem(const wxTreeItemId
& itemId
,
1747 bool unselect_others
,
1748 bool extended_select
)
1750 wxCHECK_RET( itemId
.IsOk(), wxT("invalid tree item") );
1754 bool is_single
=!(GetWindowStyleFlag() & wxTR_MULTIPLE
);
1755 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1757 //wxCHECK_RET( ( (!unselect_others) && is_single),
1758 // wxT("this is a single selection tree") );
1760 // to keep going anyhow !!!
1763 if (item
->IsSelected())
1764 return; // nothing to do
1765 unselect_others
= TRUE
;
1766 extended_select
= FALSE
;
1768 else if ( unselect_others
&& item
->IsSelected() )
1770 // selection change if there is more than one item currently selected
1771 wxArrayTreeItemIds selected_items
;
1772 if ( GetSelections(selected_items
) == 1 )
1776 wxTreeEvent
event( wxEVT_COMMAND_TREE_SEL_CHANGING
, GetId() );
1777 event
.m_item
= item
;
1778 event
.m_itemOld
= m_current
;
1779 event
.SetEventObject( this );
1780 // TODO : Here we don't send any selection mode yet !
1782 if ( GetEventHandler()->ProcessEvent( event
) && !event
.IsAllowed() )
1785 wxTreeItemId parent
= GetItemParent( itemId
);
1786 while (parent
.IsOk())
1788 if (!IsExpanded(parent
))
1791 parent
= GetItemParent( parent
);
1794 EnsureVisible( itemId
);
1797 if (unselect_others
)
1799 if (is_single
) Unselect(); // to speed up thing
1804 if (extended_select
)
1808 m_current
= m_key_current
= (wxGenericTreeItem
*) GetRootItem().m_pItem
;
1811 // don't change the mark (m_current)
1812 SelectItemRange(m_current
, item
);
1816 bool select
=TRUE
; // the default
1818 // Check if we need to toggle hilight (ctrl mode)
1819 if (!unselect_others
)
1820 select
=!item
->IsSelected();
1822 m_current
= m_key_current
= item
;
1823 m_current
->SetHilight(select
);
1824 RefreshLine( m_current
);
1827 event
.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED
);
1828 GetEventHandler()->ProcessEvent( event
);
1831 void wxGenericTreeCtrl::SelectItem(const wxTreeItemId
& itemId
, bool select
)
1835 DoSelectItem(itemId
);
1839 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1840 wxCHECK_RET( item
, wxT("SelectItem(): invalid tree item") );
1842 item
->SetHilight(FALSE
);
1847 void wxGenericTreeCtrl::FillArray(wxGenericTreeItem
*item
,
1848 wxArrayTreeItemIds
&array
) const
1850 if ( item
->IsSelected() )
1851 array
.Add(wxTreeItemId(item
));
1853 if ( item
->HasChildren() )
1855 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1856 size_t count
= children
.GetCount();
1857 for ( size_t n
= 0; n
< count
; ++n
)
1858 FillArray(children
[n
], array
);
1862 size_t wxGenericTreeCtrl::GetSelections(wxArrayTreeItemIds
&array
) const
1865 wxTreeItemId idRoot
= GetRootItem();
1866 if ( idRoot
.IsOk() )
1868 FillArray((wxGenericTreeItem
*) idRoot
.m_pItem
, array
);
1870 //else: the tree is empty, so no selections
1872 return array
.Count();
1875 void wxGenericTreeCtrl::EnsureVisible(const wxTreeItemId
& item
)
1877 if (!item
.IsOk()) return;
1879 wxGenericTreeItem
*gitem
= (wxGenericTreeItem
*) item
.m_pItem
;
1881 // first expand all parent branches
1882 wxGenericTreeItem
*parent
= gitem
->GetParent();
1884 if ( HasFlag(wxTR_HIDE_ROOT
) )
1886 while ( parent
&& parent
!= m_anchor
)
1889 parent
= parent
->GetParent();
1897 parent
= parent
->GetParent();
1901 //if (parent) CalculatePositions();
1906 void wxGenericTreeCtrl::ScrollTo(const wxTreeItemId
&item
)
1908 if (!item
.IsOk()) return;
1910 // We have to call this here because the label in
1911 // question might just have been added and no screen
1912 // update taken place.
1914 #if defined( __WXMSW__ ) || defined(__WXMAC__)
1919 wxGenericTreeItem
*gitem
= (wxGenericTreeItem
*) item
.m_pItem
;
1921 // now scroll to the item
1922 int item_y
= gitem
->GetY();
1926 GetViewStart( &start_x
, &start_y
);
1927 start_y
*= PIXELS_PER_UNIT
;
1931 GetClientSize( &client_w
, &client_h
);
1933 if (item_y
< start_y
+3)
1938 m_anchor
->GetSize( x
, y
, this );
1939 y
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
1940 x
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
1941 int x_pos
= GetScrollPos( wxHORIZONTAL
);
1942 // Item should appear at top
1943 SetScrollbars( PIXELS_PER_UNIT
, PIXELS_PER_UNIT
, x
/PIXELS_PER_UNIT
, y
/PIXELS_PER_UNIT
, x_pos
, item_y
/PIXELS_PER_UNIT
);
1945 else if (item_y
+GetLineHeight(gitem
) > start_y
+client_h
)
1950 m_anchor
->GetSize( x
, y
, this );
1951 y
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
1952 x
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
1953 item_y
+= PIXELS_PER_UNIT
+2;
1954 int x_pos
= GetScrollPos( wxHORIZONTAL
);
1955 // Item should appear at bottom
1956 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
);
1960 // FIXME: tree sorting functions are not reentrant and not MT-safe!
1961 static wxGenericTreeCtrl
*s_treeBeingSorted
= NULL
;
1963 static int LINKAGEMODE
tree_ctrl_compare_func(wxGenericTreeItem
**item1
,
1964 wxGenericTreeItem
**item2
)
1966 wxCHECK_MSG( s_treeBeingSorted
, 0, wxT("bug in wxGenericTreeCtrl::SortChildren()") );
1968 return s_treeBeingSorted
->OnCompareItems(*item1
, *item2
);
1971 int wxGenericTreeCtrl::OnCompareItems(const wxTreeItemId
& item1
,
1972 const wxTreeItemId
& item2
)
1974 return wxStrcmp(GetItemText(item1
), GetItemText(item2
));
1977 void wxGenericTreeCtrl::SortChildren(const wxTreeItemId
& itemId
)
1979 wxCHECK_RET( itemId
.IsOk(), wxT("invalid tree item") );
1981 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1983 wxCHECK_RET( !s_treeBeingSorted
,
1984 wxT("wxGenericTreeCtrl::SortChildren is not reentrant") );
1986 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1987 if ( children
.Count() > 1 )
1991 s_treeBeingSorted
= this;
1992 children
.Sort(tree_ctrl_compare_func
);
1993 s_treeBeingSorted
= NULL
;
1995 //else: don't make the tree dirty as nothing changed
1998 wxImageList
*wxGenericTreeCtrl::GetImageList() const
2000 return m_imageListNormal
;
2003 wxImageList
*wxGenericTreeCtrl::GetButtonsImageList() const
2005 return m_imageListButtons
;
2008 wxImageList
*wxGenericTreeCtrl::GetStateImageList() const
2010 return m_imageListState
;
2013 void wxGenericTreeCtrl::CalculateLineHeight()
2015 wxClientDC
dc(this);
2016 m_lineHeight
= (int)(dc
.GetCharHeight() + 4);
2018 if ( m_imageListNormal
)
2020 // Calculate a m_lineHeight value from the normal Image sizes.
2021 // May be toggle off. Then wxGenericTreeCtrl will spread when
2022 // necessary (which might look ugly).
2023 int n
= m_imageListNormal
->GetImageCount();
2024 for (int i
= 0; i
< n
; i
++)
2026 int width
= 0, height
= 0;
2027 m_imageListNormal
->GetSize(i
, width
, height
);
2028 if (height
> m_lineHeight
) m_lineHeight
= height
;
2032 if (m_imageListButtons
)
2034 // Calculate a m_lineHeight value from the Button image sizes.
2035 // May be toggle off. Then wxGenericTreeCtrl will spread when
2036 // necessary (which might look ugly).
2037 int n
= m_imageListButtons
->GetImageCount();
2038 for (int i
= 0; i
< n
; i
++)
2040 int width
= 0, height
= 0;
2041 m_imageListButtons
->GetSize(i
, width
, height
);
2042 if (height
> m_lineHeight
) m_lineHeight
= height
;
2046 if (m_lineHeight
< 30)
2047 m_lineHeight
+= 2; // at least 2 pixels
2049 m_lineHeight
+= m_lineHeight
/10; // otherwise 10% extra spacing
2052 void wxGenericTreeCtrl::SetImageList(wxImageList
*imageList
)
2054 if (m_ownsImageListNormal
) delete m_imageListNormal
;
2055 m_imageListNormal
= imageList
;
2056 m_ownsImageListNormal
= FALSE
;
2058 // Don't do any drawing if we're setting the list to NULL,
2059 // since we may be in the process of deleting the tree control.
2061 CalculateLineHeight();
2064 void wxGenericTreeCtrl::SetStateImageList(wxImageList
*imageList
)
2066 if (m_ownsImageListState
) delete m_imageListState
;
2067 m_imageListState
= imageList
;
2068 m_ownsImageListState
= FALSE
;
2071 void wxGenericTreeCtrl::SetButtonsImageList(wxImageList
*imageList
)
2073 if (m_ownsImageListButtons
) delete m_imageListButtons
;
2074 m_imageListButtons
= imageList
;
2075 m_ownsImageListButtons
= FALSE
;
2077 CalculateLineHeight();
2080 void wxGenericTreeCtrl::AssignImageList(wxImageList
*imageList
)
2082 SetImageList(imageList
);
2083 m_ownsImageListNormal
= TRUE
;
2086 void wxGenericTreeCtrl::AssignStateImageList(wxImageList
*imageList
)
2088 SetStateImageList(imageList
);
2089 m_ownsImageListState
= TRUE
;
2092 void wxGenericTreeCtrl::AssignButtonsImageList(wxImageList
*imageList
)
2094 SetButtonsImageList(imageList
);
2095 m_ownsImageListButtons
= TRUE
;
2098 // -----------------------------------------------------------------------------
2100 // -----------------------------------------------------------------------------
2102 void wxGenericTreeCtrl::AdjustMyScrollbars()
2107 m_anchor
->GetSize( x
, y
, this );
2108 y
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
2109 x
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
2110 int x_pos
= GetScrollPos( wxHORIZONTAL
);
2111 int y_pos
= GetScrollPos( wxVERTICAL
);
2112 SetScrollbars( PIXELS_PER_UNIT
, PIXELS_PER_UNIT
, x
/PIXELS_PER_UNIT
, y
/PIXELS_PER_UNIT
, x_pos
, y_pos
);
2116 SetScrollbars( 0, 0, 0, 0 );
2120 int wxGenericTreeCtrl::GetLineHeight(wxGenericTreeItem
*item
) const
2122 if (GetWindowStyleFlag() & wxTR_HAS_VARIABLE_ROW_HEIGHT
)
2123 return item
->GetHeight();
2125 return m_lineHeight
;
2128 void wxGenericTreeCtrl::PaintItem(wxGenericTreeItem
*item
, wxDC
& dc
)
2130 // TODO implement "state" icon on items
2132 wxTreeItemAttr
*attr
= item
->GetAttributes();
2133 if ( attr
&& attr
->HasFont() )
2134 dc
.SetFont(attr
->GetFont());
2135 else if (item
->IsBold())
2136 dc
.SetFont(m_boldFont
);
2138 long text_w
= 0, text_h
= 0;
2139 dc
.GetTextExtent( item
->GetText(), &text_w
, &text_h
);
2141 int image_h
= 0, image_w
= 0;
2142 int image
= item
->GetCurrentImage();
2143 if ( image
!= NO_IMAGE
)
2145 if ( m_imageListNormal
)
2147 m_imageListNormal
->GetSize( image
, image_w
, image_h
);
2156 int total_h
= GetLineHeight(item
);
2158 if ( item
->IsSelected() )
2160 // under mac selections are only a rectangle in case they don't have the focus
2164 dc
.SetBrush( *wxTRANSPARENT_BRUSH
) ;
2165 dc
.SetPen( wxPen( wxSystemSettings::GetColour( wxSYS_COLOUR_HIGHLIGHT
) , 1 , wxSOLID
) ) ;
2169 dc
.SetBrush( *m_hilightBrush
) ;
2172 dc
.SetBrush(*(m_hasFocus
? m_hilightBrush
: m_hilightUnfocusedBrush
));
2178 if ( attr
&& attr
->HasBackgroundColour() )
2179 colBg
= attr
->GetBackgroundColour();
2181 colBg
= m_backgroundColour
;
2182 dc
.SetBrush(wxBrush(colBg
, wxSOLID
));
2185 int offset
= HasFlag(wxTR_ROW_LINES
) ? 1 : 0;
2187 if ( HasFlag(wxTR_FULL_ROW_HIGHLIGHT
) )
2191 DoGetPosition(&x
, &y
);
2193 dc
.DrawRectangle(x
, item
->GetY()+offset
, w
, total_h
-offset
);
2197 if ( item
->IsSelected() && image
!= NO_IMAGE
)
2199 // If it's selected, and there's an image, then we should
2200 // take care to leave the area under the image painted in the
2201 // background colour.
2202 dc
.DrawRectangle( item
->GetX() + image_w
- 2, item
->GetY()+offset
,
2203 item
->GetWidth() - image_w
+ 2, total_h
-offset
);
2207 dc
.DrawRectangle( item
->GetX()-2, item
->GetY()+offset
,
2208 item
->GetWidth()+2, total_h
-offset
);
2212 if ( image
!= NO_IMAGE
)
2214 dc
.SetClippingRegion( item
->GetX(), item
->GetY(), image_w
-2, total_h
);
2215 m_imageListNormal
->Draw( image
, dc
,
2217 item
->GetY() +((total_h
> image_h
)?((total_h
-image_h
)/2):0),
2218 wxIMAGELIST_DRAW_TRANSPARENT
);
2219 dc
.DestroyClippingRegion();
2222 dc
.SetBackgroundMode(wxTRANSPARENT
);
2223 int extraH
= (total_h
> text_h
) ? (total_h
- text_h
)/2 : 0;
2224 dc
.DrawText( item
->GetText(),
2225 (wxCoord
)(image_w
+ item
->GetX()),
2226 (wxCoord
)(item
->GetY() + extraH
));
2228 // restore normal font
2229 dc
.SetFont( m_normalFont
);
2232 // Now y stands for the top of the item, whereas it used to stand for middle !
2233 void wxGenericTreeCtrl::PaintLevel( wxGenericTreeItem
*item
, wxDC
&dc
, int level
, int &y
)
2235 int x
= level
*m_indent
;
2236 if (!HasFlag(wxTR_HIDE_ROOT
))
2240 else if (level
== 0)
2242 // always expand hidden root
2244 wxArrayGenericTreeItems
& children
= item
->GetChildren();
2245 int count
= children
.Count();
2251 PaintLevel(children
[n
], dc
, 1, y
);
2252 } while (++n
< count
);
2254 if (!HasFlag(wxTR_NO_LINES
) && HasFlag(wxTR_LINES_AT_ROOT
) && count
> 0)
2256 // draw line down to last child
2257 origY
+= GetLineHeight(children
[0])>>1;
2258 oldY
+= GetLineHeight(children
[n
-1])>>1;
2259 dc
.DrawLine(3, origY
, 3, oldY
);
2265 item
->SetX(x
+m_spacing
);
2268 int h
= GetLineHeight(item
);
2270 int y_mid
= y_top
+ (h
>>1);
2273 int exposed_x
= dc
.LogicalToDeviceX(0);
2274 int exposed_y
= dc
.LogicalToDeviceY(y_top
);
2276 if (IsExposed(exposed_x
, exposed_y
, 10000, h
)) // 10000 = very much
2280 // don't draw rect outline if we already have the
2281 // background color under Mac
2282 (item
->IsSelected() && m_hasFocus
) ? wxBLACK_PEN
:
2283 #endif // !__WXMAC__
2287 if ( item
->IsSelected() )
2289 colText
= wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHTTEXT
);
2293 wxTreeItemAttr
*attr
= item
->GetAttributes();
2294 if (attr
&& attr
->HasTextColour())
2295 colText
= attr
->GetTextColour();
2297 colText
= GetForegroundColour();
2301 dc
.SetTextForeground(colText
);
2305 PaintItem(item
, dc
);
2307 if (HasFlag(wxTR_ROW_LINES
))
2309 // if the background colour is white, choose a
2310 // contrasting color for the lines
2311 dc
.SetPen(*((GetBackgroundColour() == *wxWHITE
)
2312 ? wxMEDIUM_GREY_PEN
: wxWHITE_PEN
));
2313 dc
.DrawLine(0, y_top
, 10000, y_top
);
2314 dc
.DrawLine(0, y
, 10000, y
);
2317 // restore DC objects
2318 dc
.SetBrush(*wxWHITE_BRUSH
);
2319 dc
.SetPen(m_dottedPen
);
2320 dc
.SetTextForeground(*wxBLACK
);
2322 if ( !HasFlag(wxTR_NO_LINES
) )
2324 // draw the horizontal line here
2326 if (x
> (signed)m_indent
)
2327 x_start
-= m_indent
;
2328 else if (HasFlag(wxTR_LINES_AT_ROOT
))
2330 dc
.DrawLine(x_start
, y_mid
, x
+ m_spacing
, y_mid
);
2333 // should the item show a button?
2334 if ( item
->HasPlus() && HasButtons() )
2336 if ( m_imageListButtons
)
2338 // draw the image button here
2341 int image
= item
->IsExpanded() ? wxTreeItemIcon_Expanded
2342 : wxTreeItemIcon_Normal
;
2343 if ( item
->IsSelected() )
2344 image
+= wxTreeItemIcon_Selected
- wxTreeItemIcon_Normal
;
2346 m_imageListButtons
->GetSize(image
, image_w
, image_h
);
2347 int xx
= x
- image_w
/2;
2348 int yy
= y_mid
- image_h
/2;
2350 wxDCClipper
clip(dc
, xx
, yy
, image_w
, image_h
);
2351 m_imageListButtons
->Draw(image
, dc
, xx
, yy
,
2352 wxIMAGELIST_DRAW_TRANSPARENT
);
2354 else // no custom buttons
2356 static const int wImage
= 9;
2357 static const int hImage
= 9;
2360 if (item
->IsExpanded())
2361 flag
|= wxCONTROL_EXPANDED
;
2362 if (item
== m_underMouse
)
2363 flag
|= wxCONTROL_CURRENT
;
2365 wxRendererNative::Get().DrawTreeItemButton
2369 wxRect(x
- wImage
/2,
2378 if (item
->IsExpanded())
2380 wxArrayGenericTreeItems
& children
= item
->GetChildren();
2381 int count
= children
.Count();
2388 PaintLevel(children
[n
], dc
, level
, y
);
2389 } while (++n
< count
);
2391 if (!HasFlag(wxTR_NO_LINES
) && count
> 0)
2393 // draw line down to last child
2394 oldY
+= GetLineHeight(children
[n
-1])>>1;
2395 if (HasButtons()) y_mid
+= 5;
2397 // Only draw the portion of the line that is visible, in case it is huge
2398 wxCoord xOrigin
=0, yOrigin
=0, width
, height
;
2399 dc
.GetDeviceOrigin(&xOrigin
, &yOrigin
);
2400 yOrigin
= abs(yOrigin
);
2401 GetClientSize(&width
, &height
);
2403 // Move end points to the begining/end of the view?
2404 if (y_mid
< yOrigin
)
2406 if (oldY
> yOrigin
+ height
)
2407 oldY
= yOrigin
+ height
;
2409 // after the adjustments if y_mid is larger than oldY then the line
2410 // isn't visible at all so don't draw anything
2412 dc
.DrawLine(x
, y_mid
, x
, oldY
);
2418 void wxGenericTreeCtrl::DrawDropEffect(wxGenericTreeItem
*item
)
2422 if ( item
->HasPlus() )
2424 // it's a folder, indicate it by a border
2429 // draw a line under the drop target because the item will be
2431 DrawLine(item
, TRUE
/* below */);
2434 SetCursor(wxCURSOR_BULLSEYE
);
2439 SetCursor(wxCURSOR_NO_ENTRY
);
2443 void wxGenericTreeCtrl::DrawBorder(const wxTreeItemId
&item
)
2445 wxCHECK_RET( item
.IsOk(), _T("invalid item in wxGenericTreeCtrl::DrawLine") );
2447 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
2449 wxClientDC
dc(this);
2451 dc
.SetLogicalFunction(wxINVERT
);
2452 dc
.SetBrush(*wxTRANSPARENT_BRUSH
);
2454 int w
= i
->GetWidth() + 2;
2455 int h
= GetLineHeight(i
) + 2;
2457 dc
.DrawRectangle( i
->GetX() - 1, i
->GetY() - 1, w
, h
);
2460 void wxGenericTreeCtrl::DrawLine(const wxTreeItemId
&item
, bool below
)
2462 wxCHECK_RET( item
.IsOk(), _T("invalid item in wxGenericTreeCtrl::DrawLine") );
2464 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
2466 wxClientDC
dc(this);
2468 dc
.SetLogicalFunction(wxINVERT
);
2474 y
+= GetLineHeight(i
) - 1;
2477 dc
.DrawLine( x
, y
, x
+ i
->GetWidth(), y
);
2480 // -----------------------------------------------------------------------------
2481 // wxWindows callbacks
2482 // -----------------------------------------------------------------------------
2484 void wxGenericTreeCtrl::OnPaint( wxPaintEvent
&WXUNUSED(event
) )
2492 dc
.SetFont( m_normalFont
);
2493 dc
.SetPen( m_dottedPen
);
2495 // this is now done dynamically
2496 //if(GetImageList() == NULL)
2497 // m_lineHeight = (int)(dc.GetCharHeight() + 4);
2500 PaintLevel( m_anchor
, dc
, 0, y
);
2503 void wxGenericTreeCtrl::OnSetFocus( wxFocusEvent
&event
)
2512 void wxGenericTreeCtrl::OnKillFocus( wxFocusEvent
&event
)
2521 void wxGenericTreeCtrl::OnChar( wxKeyEvent
&event
)
2523 wxTreeEvent
te( wxEVT_COMMAND_TREE_KEY_DOWN
, GetId() );
2524 te
.m_evtKey
= event
;
2525 te
.SetEventObject( this );
2526 if ( GetEventHandler()->ProcessEvent( te
) )
2528 // intercepted by the user code
2532 if ( (m_current
== 0) || (m_key_current
== 0) )
2538 // how should the selection work for this event?
2539 bool is_multiple
, extended_select
, unselect_others
;
2540 EventFlagsToSelType(GetWindowStyleFlag(),
2542 event
.ControlDown(),
2543 is_multiple
, extended_select
, unselect_others
);
2547 // * : Expand all/Collapse all
2548 // ' ' | return : activate
2549 // up : go up (not last children!)
2551 // left : go to parent
2552 // right : open if parent and go next
2553 // home : go to root
2554 // end : go to last item without opening parents
2555 // alnum : start or continue searching for the item with this prefix
2556 int keyCode
= event
.GetKeyCode();
2561 if (m_current
->HasPlus() && !IsExpanded(m_current
))
2569 if ( !IsExpanded(m_current
) )
2572 ExpandAll(m_current
);
2575 //else: fall through to Collapse() it
2579 if (IsExpanded(m_current
))
2581 Collapse(m_current
);
2587 if ( !event
.HasModifiers() )
2589 wxTreeEvent
event( wxEVT_COMMAND_TREE_ITEM_ACTIVATED
, GetId() );
2590 event
.m_item
= m_current
;
2591 event
.SetEventObject( this );
2592 GetEventHandler()->ProcessEvent( event
);
2595 // in any case, also generate the normal key event for this key,
2596 // even if we generated the ACTIVATED event above: this is what
2597 // wxMSW does and it makes sense because you might not want to
2598 // process ACTIVATED event at all and handle Space and Return
2599 // directly (and differently) which would be impossible otherwise
2603 // up goes to the previous sibling or to the last
2604 // of its children if it's expanded
2607 wxTreeItemId prev
= GetPrevSibling( m_key_current
);
2610 prev
= GetItemParent( m_key_current
);
2611 if ((prev
== GetRootItem()) && HasFlag(wxTR_HIDE_ROOT
))
2613 break; // don't go to root if it is hidden
2617 wxTreeItemIdValue cookie
;
2618 wxTreeItemId current
= m_key_current
;
2619 // TODO: Huh? If we get here, we'd better be the first child of our parent. How else could it be?
2620 if (current
== GetFirstChild( prev
, cookie
))
2622 // otherwise we return to where we came from
2623 DoSelectItem( prev
, unselect_others
, extended_select
);
2624 m_key_current
= (wxGenericTreeItem
*) prev
.m_pItem
;
2631 while ( IsExpanded(prev
) && HasChildren(prev
) )
2633 wxTreeItemId child
= GetLastChild(prev
);
2640 DoSelectItem( prev
, unselect_others
, extended_select
);
2641 m_key_current
=(wxGenericTreeItem
*) prev
.m_pItem
;
2646 // left arrow goes to the parent
2649 wxTreeItemId prev
= GetItemParent( m_current
);
2650 if ((prev
== GetRootItem()) && HasFlag(wxTR_HIDE_ROOT
))
2652 // don't go to root if it is hidden
2653 prev
= GetPrevSibling( m_current
);
2657 DoSelectItem( prev
, unselect_others
, extended_select
);
2663 // this works the same as the down arrow except that we
2664 // also expand the item if it wasn't expanded yet
2670 if (IsExpanded(m_key_current
) && HasChildren(m_key_current
))
2672 wxTreeItemIdValue cookie
;
2673 wxTreeItemId child
= GetFirstChild( m_key_current
, cookie
);
2674 DoSelectItem( child
, unselect_others
, extended_select
);
2675 m_key_current
=(wxGenericTreeItem
*) child
.m_pItem
;
2679 wxTreeItemId next
= GetNextSibling( m_key_current
);
2682 wxTreeItemId current
= m_key_current
;
2683 while (current
.IsOk() && !next
)
2685 current
= GetItemParent( current
);
2686 if (current
) next
= GetNextSibling( current
);
2691 DoSelectItem( next
, unselect_others
, extended_select
);
2692 m_key_current
=(wxGenericTreeItem
*) next
.m_pItem
;
2698 // <End> selects the last visible tree item
2701 wxTreeItemId last
= GetRootItem();
2703 while ( last
.IsOk() && IsExpanded(last
) )
2705 wxTreeItemId lastChild
= GetLastChild(last
);
2707 // it may happen if the item was expanded but then all of
2708 // its children have been deleted - so IsExpanded() returned
2709 // TRUE, but GetLastChild() returned invalid item
2718 DoSelectItem( last
, unselect_others
, extended_select
);
2723 // <Home> selects the root item
2726 wxTreeItemId prev
= GetRootItem();
2730 if ( HasFlag(wxTR_HIDE_ROOT
) )
2732 wxTreeItemIdValue cookie
;
2733 prev
= GetFirstChild(prev
, cookie
);
2738 DoSelectItem( prev
, unselect_others
, extended_select
);
2743 // do not use wxIsalnum() here
2744 if ( !event
.HasModifiers() &&
2745 ((keyCode
>= '0' && keyCode
<= '9') ||
2746 (keyCode
>= 'a' && keyCode
<= 'z') ||
2747 (keyCode
>= 'A' && keyCode
<= 'Z' )))
2749 // find the next item starting with the given prefix
2750 char ch
= (char)keyCode
;
2752 wxTreeItemId id
= FindItem(m_current
, m_findPrefix
+ (wxChar
)ch
);
2763 // also start the timer to reset the current prefix if the user
2764 // doesn't press any more alnum keys soon -- we wouldn't want
2765 // to use this prefix for a new item search
2768 m_findTimer
= new wxTreeFindTimer(this);
2771 m_findTimer
->Start(wxTreeFindTimer::DELAY
, wxTIMER_ONE_SHOT
);
2780 wxTreeItemId
wxGenericTreeCtrl::HitTest(const wxPoint
& point
, int& flags
)
2782 // JACS: removed wxYieldIfNeeded() because it can cause the window
2783 // to be deleted from under us if a close window event is pending
2788 if (point
.x
<0) flags
|= wxTREE_HITTEST_TOLEFT
;
2789 if (point
.x
>w
) flags
|= wxTREE_HITTEST_TORIGHT
;
2790 if (point
.y
<0) flags
|= wxTREE_HITTEST_ABOVE
;
2791 if (point
.y
>h
) flags
|= wxTREE_HITTEST_BELOW
;
2792 if (flags
) return wxTreeItemId();
2794 if (m_anchor
== NULL
)
2796 flags
= wxTREE_HITTEST_NOWHERE
;
2797 return wxTreeItemId();
2800 wxGenericTreeItem
*hit
= m_anchor
->HitTest(CalcUnscrolledPosition(point
),
2804 flags
= wxTREE_HITTEST_NOWHERE
;
2805 return wxTreeItemId();
2810 // get the bounding rectangle of the item (or of its label only)
2811 bool wxGenericTreeCtrl::GetBoundingRect(const wxTreeItemId
& item
,
2813 bool WXUNUSED(textOnly
)) const
2815 wxCHECK_MSG( item
.IsOk(), FALSE
, _T("invalid item in wxGenericTreeCtrl::GetBoundingRect") );
2817 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
2820 GetViewStart(& startX
, & startY
);
2822 rect
.x
= i
->GetX() - startX
*PIXELS_PER_UNIT
;
2823 rect
.y
= i
->GetY() - startY
*PIXELS_PER_UNIT
;
2824 rect
.width
= i
->GetWidth();
2825 //rect.height = i->GetHeight();
2826 rect
.height
= GetLineHeight(i
);
2831 void wxGenericTreeCtrl::Edit( const wxTreeItemId
& item
)
2833 wxCHECK_RET( item
.IsOk(), _T("can't edit an invalid item") );
2835 wxGenericTreeItem
*itemEdit
= (wxGenericTreeItem
*)item
.m_pItem
;
2837 wxTreeEvent
te( wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT
, GetId() );
2838 te
.m_item
= itemEdit
;
2839 te
.SetEventObject( this );
2840 if ( GetEventHandler()->ProcessEvent( te
) && !te
.IsAllowed() )
2846 // We have to call this here because the label in
2847 // question might just have been added and no screen
2848 // update taken place.
2850 #if defined( __WXMSW__ ) || defined(__WXMAC__)
2856 m_textCtrl
= new wxTreeTextCtrl(this, itemEdit
);
2858 m_textCtrl
->SetFocus();
2861 // returns a pointer to the text edit control if the item is being
2862 // edited, NULL otherwise (it's assumed that no more than one item may
2863 // be edited simultaneously)
2864 wxTextCtrl
* wxGenericTreeCtrl::GetEditControl() const
2869 bool wxGenericTreeCtrl::OnRenameAccept(wxGenericTreeItem
*item
,
2870 const wxString
& value
)
2872 wxTreeEvent
le( wxEVT_COMMAND_TREE_END_LABEL_EDIT
, GetId() );
2874 le
.SetEventObject( this );
2876 le
.m_editCancelled
= FALSE
;
2878 return !GetEventHandler()->ProcessEvent( le
) || le
.IsAllowed();
2881 void wxGenericTreeCtrl::OnRenameCancelled(wxGenericTreeItem
*item
)
2883 // let owner know that the edit was cancelled
2884 wxTreeEvent
le( wxEVT_COMMAND_TREE_END_LABEL_EDIT
, GetId() );
2886 le
.SetEventObject( this );
2887 le
.m_label
= wxEmptyString
;
2888 le
.m_editCancelled
= TRUE
;
2890 GetEventHandler()->ProcessEvent( le
);
2896 void wxGenericTreeCtrl::OnRenameTimer()
2901 void wxGenericTreeCtrl::OnMouse( wxMouseEvent
&event
)
2903 if ( !m_anchor
) return;
2905 wxPoint pt
= CalcUnscrolledPosition(event
.GetPosition());
2907 // Is the mouse over a tree item button?
2909 wxGenericTreeItem
*thisItem
= m_anchor
->HitTest(pt
, this, flags
, 0);
2910 wxGenericTreeItem
*underMouse
= thisItem
;
2912 bool underMouseChanged
= (underMouse
!= m_underMouse
) ;
2913 #endif // wxUSE_TOOLTIPS
2916 (flags
& wxTREE_HITTEST_ONITEMBUTTON
) &&
2917 (!event
.LeftIsDown()) &&
2919 (!m_renameTimer
|| !m_renameTimer
->IsRunning()))
2927 if (underMouse
!= m_underMouse
)
2931 // unhighlight old item
2932 wxGenericTreeItem
*tmp
= m_underMouse
;
2933 m_underMouse
= NULL
;
2937 m_underMouse
= underMouse
;
2939 RefreshLine( m_underMouse
);
2943 // Determines what item we are hovering over and need a tooltip for
2944 wxTreeItemId hoverItem
= thisItem
;
2946 // We do not want a tooltip if we are dragging, or if the rename timer is running
2947 if (underMouseChanged
&& hoverItem
.IsOk() && !m_isDragging
&& (!m_renameTimer
|| !m_renameTimer
->IsRunning()))
2949 // Ask the tree control what tooltip (if any) should be shown
2950 wxTreeEvent
hevent(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP
, GetId());
2951 hevent
.m_item
= hoverItem
;
2952 hevent
.SetEventObject(this);
2954 if ( GetEventHandler()->ProcessEvent(hevent
) && hevent
.IsAllowed() )
2956 SetToolTip(hevent
.m_label
);
2961 // we process left mouse up event (enables in-place edit), right down
2962 // (pass to the user code), left dbl click (activate item) and
2963 // dragging/moving events for items drag-and-drop
2964 if ( !(event
.LeftDown() ||
2966 event
.RightDown() ||
2967 event
.LeftDClick() ||
2969 ((event
.Moving() || event
.RightUp()) && m_isDragging
)) )
2978 wxGenericTreeItem
*item
= m_anchor
->HitTest(pt
, this, flags
, 0);
2980 if ( event
.Dragging() && !m_isDragging
)
2982 if (m_dragCount
== 0)
2987 if (m_dragCount
!= 3)
2989 // wait until user drags a bit further...
2993 wxEventType command
= event
.RightIsDown()
2994 ? wxEVT_COMMAND_TREE_BEGIN_RDRAG
2995 : wxEVT_COMMAND_TREE_BEGIN_DRAG
;
2997 wxTreeEvent
nevent( command
, GetId() );
2998 nevent
.m_item
= m_current
;
2999 nevent
.SetEventObject(this);
3001 // by default the dragging is not supported, the user code must
3002 // explicitly allow the event for it to take place
3005 if ( GetEventHandler()->ProcessEvent(nevent
) && nevent
.IsAllowed() )
3007 // we're going to drag this item
3008 m_isDragging
= TRUE
;
3010 // remember the old cursor because we will change it while
3012 m_oldCursor
= m_cursor
;
3014 // in a single selection control, hide the selection temporarily
3015 if ( !(GetWindowStyleFlag() & wxTR_MULTIPLE
) )
3017 m_oldSelection
= (wxGenericTreeItem
*) GetSelection().m_pItem
;
3019 if ( m_oldSelection
)
3021 m_oldSelection
->SetHilight(FALSE
);
3022 RefreshLine(m_oldSelection
);
3029 else if ( event
.Moving() )
3031 if ( item
!= m_dropTarget
)
3033 // unhighlight the previous drop target
3034 DrawDropEffect(m_dropTarget
);
3036 m_dropTarget
= item
;
3038 // highlight the current drop target if any
3039 DrawDropEffect(m_dropTarget
);
3041 #if defined( __WXMSW__ ) || defined(__WXMAC__)
3048 else if ( (event
.LeftUp() || event
.RightUp()) && m_isDragging
)
3050 // erase the highlighting
3051 DrawDropEffect(m_dropTarget
);
3053 if ( m_oldSelection
)
3055 m_oldSelection
->SetHilight(TRUE
);
3056 RefreshLine(m_oldSelection
);
3057 m_oldSelection
= (wxGenericTreeItem
*)NULL
;
3060 // generate the drag end event
3061 wxTreeEvent
event(wxEVT_COMMAND_TREE_END_DRAG
, GetId());
3063 event
.m_item
= item
;
3064 event
.m_pointDrag
= pt
;
3065 event
.SetEventObject(this);
3067 (void)GetEventHandler()->ProcessEvent(event
);
3069 m_isDragging
= FALSE
;
3070 m_dropTarget
= (wxGenericTreeItem
*)NULL
;
3074 SetCursor(m_oldCursor
);
3076 #if defined( __WXMSW__ ) || defined(__WXMAC__)
3084 // here we process only the messages which happen on tree items
3088 if (item
== NULL
) return; /* we hit the blank area */
3090 if ( event
.RightDown() )
3092 wxTreeEvent
nevent(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK
, GetId());
3093 nevent
.m_item
= item
;
3094 nevent
.m_pointDrag
= CalcScrolledPosition(pt
);
3095 nevent
.SetEventObject(this);
3096 GetEventHandler()->ProcessEvent(nevent
);
3098 else if ( event
.LeftUp() )
3100 // this facilitates multiple-item drag-and-drop
3102 if (item
&& HasFlag(wxTR_MULTIPLE
))
3104 wxArrayTreeItemIds selections
;
3105 size_t count
= GetSelections(selections
);
3108 !event
.ControlDown() &&
3111 DoSelectItem(item
, true, false);
3117 if ( (item
== m_current
) &&
3118 (flags
& wxTREE_HITTEST_ONITEMLABEL
) &&
3119 HasFlag(wxTR_EDIT_LABELS
) )
3121 if ( m_renameTimer
)
3123 if ( m_renameTimer
->IsRunning() )
3124 m_renameTimer
->Stop();
3128 m_renameTimer
= new wxTreeRenameTimer( this );
3131 m_renameTimer
->Start( wxTreeRenameTimer::DELAY
, TRUE
);
3134 m_lastOnSame
= FALSE
;
3137 else // !RightDown() && !LeftUp() ==> LeftDown() || LeftDClick()
3139 if ( event
.LeftDown() )
3141 m_lastOnSame
= item
== m_current
;
3144 if ( flags
& wxTREE_HITTEST_ONITEMBUTTON
)
3146 // only toggle the item for a single click, double click on
3147 // the button doesn't do anything (it toggles the item twice)
3148 if ( event
.LeftDown() )
3153 // don't select the item if the button was clicked
3158 // clear the previously selected items, if the
3159 // user clicked outside of the present selection.
3160 // otherwise, perform the deselection on mouse-up.
3161 // this allows multiple drag and drop to work.
3163 if (!IsSelected(item
))
3165 // how should the selection work for this event?
3166 bool is_multiple
, extended_select
, unselect_others
;
3167 EventFlagsToSelType(GetWindowStyleFlag(),
3169 event
.ControlDown(),
3170 is_multiple
, extended_select
, unselect_others
);
3172 DoSelectItem(item
, unselect_others
, extended_select
);
3176 // For some reason, Windows isn't recognizing a left double-click,
3177 // so we need to simulate it here. Allow 200 milliseconds for now.
3178 if ( event
.LeftDClick() )
3180 // double clicking should not start editing the item label
3181 if ( m_renameTimer
)
3182 m_renameTimer
->Stop();
3184 m_lastOnSame
= FALSE
;
3186 // send activate event first
3187 wxTreeEvent
nevent( wxEVT_COMMAND_TREE_ITEM_ACTIVATED
, GetId() );
3188 nevent
.m_item
= item
;
3189 nevent
.m_pointDrag
= CalcScrolledPosition(pt
);
3190 nevent
.SetEventObject( this );
3191 if ( !GetEventHandler()->ProcessEvent( nevent
) )
3193 // if the user code didn't process the activate event,
3194 // handle it ourselves by toggling the item when it is
3196 if ( item
->HasPlus() )
3206 void wxGenericTreeCtrl::OnInternalIdle()
3208 wxWindow::OnInternalIdle();
3210 // Check if we need to select the root item
3211 // because nothing else has been selected.
3212 // Delaying it means that we can invoke event handlers
3213 // as required, when a first item is selected.
3214 if (!HasFlag(wxTR_MULTIPLE
) && !GetSelection().IsOk())
3217 SelectItem(m_select_me
);
3218 else if (GetRootItem().IsOk())
3219 SelectItem(GetRootItem());
3222 /* after all changes have been done to the tree control,
3223 * we actually redraw the tree when everything is over */
3225 if (!m_dirty
) return;
3226 if (m_freezeCount
) return;
3230 CalculatePositions();
3232 AdjustMyScrollbars();
3235 void wxGenericTreeCtrl::CalculateSize( wxGenericTreeItem
*item
, wxDC
&dc
)
3240 wxTreeItemAttr
*attr
= item
->GetAttributes();
3241 if ( attr
&& attr
->HasFont() )
3242 dc
.SetFont(attr
->GetFont());
3243 else if ( item
->IsBold() )
3244 dc
.SetFont(m_boldFont
);
3246 dc
.SetFont(m_normalFont
);
3248 dc
.GetTextExtent( item
->GetText(), &text_w
, &text_h
);
3251 // restore normal font
3252 dc
.SetFont( m_normalFont
);
3256 int image
= item
->GetCurrentImage();
3257 if ( image
!= NO_IMAGE
)
3259 if ( m_imageListNormal
)
3261 m_imageListNormal
->GetSize( image
, image_w
, image_h
);
3266 int total_h
= (image_h
> text_h
) ? image_h
: text_h
;
3269 total_h
+= 2; // at least 2 pixels
3271 total_h
+= total_h
/10; // otherwise 10% extra spacing
3273 item
->SetHeight(total_h
);
3274 if (total_h
>m_lineHeight
)
3275 m_lineHeight
=total_h
;
3277 item
->SetWidth(image_w
+text_w
+2);
3280 // -----------------------------------------------------------------------------
3281 // for developper : y is now the top of the level
3282 // not the middle of it !
3283 void wxGenericTreeCtrl::CalculateLevel( wxGenericTreeItem
*item
, wxDC
&dc
, int level
, int &y
)
3285 int x
= level
*m_indent
;
3286 if (!HasFlag(wxTR_HIDE_ROOT
))
3290 else if (level
== 0)
3292 // a hidden root is not evaluated, but its
3293 // children are always calculated
3297 CalculateSize( item
, dc
);
3300 item
->SetX( x
+m_spacing
);
3302 y
+= GetLineHeight(item
);
3304 if ( !item
->IsExpanded() )
3306 // we don't need to calculate collapsed branches
3311 wxArrayGenericTreeItems
& children
= item
->GetChildren();
3312 size_t n
, count
= children
.Count();
3314 for (n
= 0; n
< count
; ++n
)
3315 CalculateLevel( children
[n
], dc
, level
, y
); // recurse
3318 void wxGenericTreeCtrl::CalculatePositions()
3320 if ( !m_anchor
) return;
3322 wxClientDC
dc(this);
3325 dc
.SetFont( m_normalFont
);
3327 dc
.SetPen( m_dottedPen
);
3328 //if(GetImageList() == NULL)
3329 // m_lineHeight = (int)(dc.GetCharHeight() + 4);
3332 CalculateLevel( m_anchor
, dc
, 0, y
); // start recursion
3335 void wxGenericTreeCtrl::RefreshSubtree(wxGenericTreeItem
*item
)
3337 if (m_dirty
) return;
3338 if (m_freezeCount
) return;
3340 wxSize client
= GetClientSize();
3343 CalcScrolledPosition(0, item
->GetY(), NULL
, &rect
.y
);
3344 rect
.width
= client
.x
;
3345 rect
.height
= client
.y
;
3347 Refresh(TRUE
, &rect
);
3349 AdjustMyScrollbars();
3352 void wxGenericTreeCtrl::RefreshLine( wxGenericTreeItem
*item
)
3354 if (m_dirty
) return;
3355 if (m_freezeCount
) return;
3358 CalcScrolledPosition(0, item
->GetY(), NULL
, &rect
.y
);
3359 rect
.width
= GetClientSize().x
;
3360 rect
.height
= GetLineHeight(item
); //dc.GetCharHeight() + 6;
3362 Refresh(TRUE
, &rect
);
3365 void wxGenericTreeCtrl::RefreshSelected()
3367 if (m_freezeCount
) return;
3369 // TODO: this is awfully inefficient, we should keep the list of all
3370 // selected items internally, should be much faster
3372 RefreshSelectedUnder(m_anchor
);
3375 void wxGenericTreeCtrl::RefreshSelectedUnder(wxGenericTreeItem
*item
)
3377 if (m_freezeCount
) return;
3379 if ( item
->IsSelected() )
3382 const wxArrayGenericTreeItems
& children
= item
->GetChildren();
3383 size_t count
= children
.GetCount();
3384 for ( size_t n
= 0; n
< count
; n
++ )
3386 RefreshSelectedUnder(children
[n
]);
3390 void wxGenericTreeCtrl::Freeze()
3395 void wxGenericTreeCtrl::Thaw()
3397 wxCHECK_RET( m_freezeCount
> 0, _T("thawing unfrozen tree control?") );
3399 if ( !--m_freezeCount
)
3405 // ----------------------------------------------------------------------------
3406 // changing colours: we need to refresh the tree control
3407 // ----------------------------------------------------------------------------
3409 bool wxGenericTreeCtrl::SetBackgroundColour(const wxColour
& colour
)
3411 if ( !wxWindow::SetBackgroundColour(colour
) )
3414 if (m_freezeCount
) return TRUE
;
3421 bool wxGenericTreeCtrl::SetForegroundColour(const wxColour
& colour
)
3423 if ( !wxWindow::SetForegroundColour(colour
) )
3426 if (m_freezeCount
) return TRUE
;
3433 // Process the tooltip event, to speed up event processing.
3434 // Doesn't actually get a tooltip.
3435 void wxGenericTreeCtrl::OnGetToolTip( wxTreeEvent
&event
)
3440 #endif // wxUSE_TREECTRL