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 // -----------------------------------------------------------------------------
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"
42 #include "wx/mac/private.h"
45 // -----------------------------------------------------------------------------
47 // -----------------------------------------------------------------------------
49 class WXDLLEXPORT wxGenericTreeItem
;
51 WX_DEFINE_EXPORTED_ARRAY(wxGenericTreeItem
*, wxArrayGenericTreeItems
);
53 // ----------------------------------------------------------------------------
55 // ----------------------------------------------------------------------------
57 static const int NO_IMAGE
= -1;
59 static const int PIXELS_PER_UNIT
= 10;
61 // ----------------------------------------------------------------------------
63 // ----------------------------------------------------------------------------
66 static const char *aqua_arrow_right
[] = {
67 /* columns rows colors chars-per-pixel */
88 static const char *aqua_arrow_down
[] = {
89 /* columns rows colors chars-per-pixel */
109 // -----------------------------------------------------------------------------
111 // -----------------------------------------------------------------------------
113 // timer used for enabling in-place edit
114 class WXDLLEXPORT wxTreeRenameTimer
: public wxTimer
117 // start editing the current item after half a second (if the mouse hasn't
118 // been clicked/moved)
119 enum { DELAY
= 500 };
121 wxTreeRenameTimer( wxGenericTreeCtrl
*owner
);
123 virtual void Notify();
126 wxGenericTreeCtrl
*m_owner
;
128 DECLARE_NO_COPY_CLASS(wxTreeRenameTimer
)
131 // control used for in-place edit
132 class WXDLLEXPORT wxTreeTextCtrl
: public wxTextCtrl
135 wxTreeTextCtrl(wxGenericTreeCtrl
*owner
, wxGenericTreeItem
*item
);
138 void OnChar( wxKeyEvent
&event
);
139 void OnKeyUp( wxKeyEvent
&event
);
140 void OnKillFocus( wxFocusEvent
&event
);
142 bool AcceptChanges();
146 wxGenericTreeCtrl
*m_owner
;
147 wxGenericTreeItem
*m_itemEdited
;
148 wxString m_startValue
;
151 DECLARE_EVENT_TABLE()
152 DECLARE_NO_COPY_CLASS(wxTreeTextCtrl
)
155 // timer used to clear wxGenericTreeCtrl::m_findPrefix if no key was pressed
156 // for a sufficiently long time
157 class WXDLLEXPORT wxTreeFindTimer
: public wxTimer
160 // reset the current prefix after half a second of inactivity
161 enum { DELAY
= 500 };
163 wxTreeFindTimer( wxGenericTreeCtrl
*owner
) { m_owner
= owner
; }
165 virtual void Notify() { m_owner
->m_findPrefix
.clear(); }
168 wxGenericTreeCtrl
*m_owner
;
170 DECLARE_NO_COPY_CLASS(wxTreeFindTimer
)
174 class WXDLLEXPORT wxGenericTreeItem
178 wxGenericTreeItem() { m_data
= NULL
; }
179 wxGenericTreeItem( wxGenericTreeItem
*parent
,
180 const wxString
& text
,
183 wxTreeItemData
*data
);
185 ~wxGenericTreeItem();
188 wxArrayGenericTreeItems
& GetChildren() { return m_children
; }
190 const wxString
& GetText() const { return m_text
; }
191 int GetImage(wxTreeItemIcon which
= wxTreeItemIcon_Normal
) const
192 { return m_images
[which
]; }
193 wxTreeItemData
*GetData() const { return m_data
; }
195 // returns the current image for the item (depending on its
196 // selected/expanded/whatever state)
197 int GetCurrentImage() const;
199 void SetText( const wxString
&text
);
200 void SetImage(int image
, wxTreeItemIcon which
) { m_images
[which
] = image
; }
201 void SetData(wxTreeItemData
*data
) { m_data
= data
; }
203 void SetHasPlus(bool has
= TRUE
) { m_hasPlus
= has
; }
205 void SetBold(bool bold
) { m_isBold
= bold
; }
207 int GetX() const { return m_x
; }
208 int GetY() const { return m_y
; }
210 void SetX(int x
) { m_x
= x
; }
211 void SetY(int y
) { m_y
= y
; }
213 int GetHeight() const { return m_height
; }
214 int GetWidth() const { return m_width
; }
216 void SetHeight(int h
) { m_height
= h
; }
217 void SetWidth(int w
) { m_width
= w
; }
219 wxGenericTreeItem
*GetParent() const { return m_parent
; }
222 // deletes all children notifying the treectrl about it if !NULL
224 void DeleteChildren(wxGenericTreeCtrl
*tree
= NULL
);
226 // get count of all children (and grand children if 'recursively')
227 size_t GetChildrenCount(bool recursively
= TRUE
) const;
229 void Insert(wxGenericTreeItem
*child
, size_t index
)
230 { m_children
.Insert(child
, index
); }
232 void GetSize( int &x
, int &y
, const wxGenericTreeCtrl
* );
234 // return the item at given position (or NULL if no item), onButton is
235 // TRUE if the point belongs to the item's button, otherwise it lies
236 // on the button's label
237 wxGenericTreeItem
*HitTest( const wxPoint
& point
,
238 const wxGenericTreeCtrl
*,
242 void Expand() { m_isCollapsed
= FALSE
; }
243 void Collapse() { m_isCollapsed
= TRUE
; }
245 void SetHilight( bool set
= TRUE
) { m_hasHilight
= set
; }
248 bool HasChildren() const { return !m_children
.IsEmpty(); }
249 bool IsSelected() const { return m_hasHilight
!= 0; }
250 bool IsExpanded() const { return !m_isCollapsed
; }
251 bool HasPlus() const { return m_hasPlus
|| HasChildren(); }
252 bool IsBold() const { return m_isBold
!= 0; }
255 // get them - may be NULL
256 wxTreeItemAttr
*GetAttributes() const { return m_attr
; }
257 // get them ensuring that the pointer is not NULL
258 wxTreeItemAttr
& Attr()
262 m_attr
= new wxTreeItemAttr
;
268 void SetAttributes(wxTreeItemAttr
*attr
)
270 if ( m_ownsAttr
) delete m_attr
;
274 // set them and delete when done
275 void AssignAttributes(wxTreeItemAttr
*attr
)
282 // since there can be very many of these, we save size by chosing
283 // the smallest representation for the elements and by ordering
284 // the members to avoid padding.
285 wxString m_text
; // label to be rendered for item
287 wxTreeItemData
*m_data
; // user-provided data
289 wxArrayGenericTreeItems m_children
; // list of children
290 wxGenericTreeItem
*m_parent
; // parent of this item
292 wxTreeItemAttr
*m_attr
; // attributes???
294 // tree ctrl images for the normal, selected, expanded and
295 // expanded+selected states
296 short m_images
[wxTreeItemIcon_Max
];
298 wxCoord m_x
; // (virtual) offset from top
299 wxCoord m_y
; // (virtual) offset from left
300 short m_width
; // width of this item
301 unsigned char m_height
; // height of this item
303 // use bitfields to save size
304 int m_isCollapsed
:1;
305 int m_hasHilight
:1; // same as focused
306 int m_hasPlus
:1; // used for item which doesn't have
307 // children but has a [+] button
308 int m_isBold
:1; // render the label in bold font
309 int m_ownsAttr
:1; // delete attribute when done
311 DECLARE_NO_COPY_CLASS(wxGenericTreeItem
)
314 // =============================================================================
316 // =============================================================================
318 // ----------------------------------------------------------------------------
320 // ----------------------------------------------------------------------------
322 // translate the key or mouse event flags to the type of selection we're
324 static void EventFlagsToSelType(long style
,
328 bool &extended_select
,
329 bool &unselect_others
)
331 is_multiple
= (style
& wxTR_MULTIPLE
) != 0;
332 extended_select
= shiftDown
&& is_multiple
;
333 unselect_others
= !(extended_select
|| (ctrlDown
&& is_multiple
));
336 // check if the given item is under another one
337 static bool IsDescendantOf(wxGenericTreeItem
*parent
, wxGenericTreeItem
*item
)
341 if ( item
== parent
)
343 // item is a descendant of parent
347 item
= item
->GetParent();
353 // -----------------------------------------------------------------------------
354 // wxTreeRenameTimer (internal)
355 // -----------------------------------------------------------------------------
357 wxTreeRenameTimer::wxTreeRenameTimer( wxGenericTreeCtrl
*owner
)
362 void wxTreeRenameTimer::Notify()
364 m_owner
->OnRenameTimer();
367 //-----------------------------------------------------------------------------
368 // wxTreeTextCtrl (internal)
369 //-----------------------------------------------------------------------------
371 BEGIN_EVENT_TABLE(wxTreeTextCtrl
,wxTextCtrl
)
372 EVT_CHAR (wxTreeTextCtrl::OnChar
)
373 EVT_KEY_UP (wxTreeTextCtrl::OnKeyUp
)
374 EVT_KILL_FOCUS (wxTreeTextCtrl::OnKillFocus
)
377 wxTreeTextCtrl::wxTreeTextCtrl(wxGenericTreeCtrl
*owner
,
378 wxGenericTreeItem
*item
)
379 : m_itemEdited(item
), m_startValue(item
->GetText())
384 int w
= m_itemEdited
->GetWidth(),
385 h
= m_itemEdited
->GetHeight();
388 m_owner
->CalcScrolledPosition(item
->GetX(), item
->GetY(), &x
, &y
);
393 int image
= item
->GetCurrentImage();
394 if ( image
!= NO_IMAGE
)
396 if ( m_owner
->m_imageListNormal
)
398 m_owner
->m_imageListNormal
->GetSize( image
, image_w
, image_h
);
403 wxFAIL_MSG(_T("you must create an image list to use images!"));
407 // FIXME: what are all these hardcoded 4, 8 and 11s really?
411 (void)Create(m_owner
, wxID_ANY
, m_startValue
,
412 wxPoint(x
- 4, y
- 4), wxSize(w
+ 11, h
+ 8));
415 bool wxTreeTextCtrl::AcceptChanges()
417 const wxString value
= GetValue();
419 if ( value
== m_startValue
)
421 // nothing changed, always accept
425 if ( !m_owner
->OnRenameAccept(m_itemEdited
, value
) )
427 // vetoed by the user
431 // accepted, do rename the item
432 m_owner
->SetItemText(m_itemEdited
, value
);
437 void wxTreeTextCtrl::Finish()
441 m_owner
->ResetTextControl();
443 wxPendingDelete
.Append(this);
447 m_owner
->SetFocus(); // This doesn't work. TODO.
451 void wxTreeTextCtrl::OnChar( wxKeyEvent
&event
)
453 switch ( event
.m_keyCode
)
456 if ( !AcceptChanges() )
458 // vetoed by the user, don't disappear
465 m_owner
->OnRenameCancelled(m_itemEdited
);
473 void wxTreeTextCtrl::OnKeyUp( wxKeyEvent
&event
)
477 // auto-grow the textctrl:
478 wxSize parentSize
= m_owner
->GetSize();
479 wxPoint myPos
= GetPosition();
480 wxSize mySize
= GetSize();
482 GetTextExtent(GetValue() + _T("M"), &sx
, &sy
);
483 if (myPos
.x
+ sx
> parentSize
.x
)
484 sx
= parentSize
.x
- myPos
.x
;
493 void wxTreeTextCtrl::OnKillFocus( wxFocusEvent
&event
)
501 if ( AcceptChanges() )
507 // -----------------------------------------------------------------------------
509 // -----------------------------------------------------------------------------
511 wxGenericTreeItem::wxGenericTreeItem(wxGenericTreeItem
*parent
,
512 const wxString
& text
,
513 int image
, int selImage
,
514 wxTreeItemData
*data
)
517 m_images
[wxTreeItemIcon_Normal
] = image
;
518 m_images
[wxTreeItemIcon_Selected
] = selImage
;
519 m_images
[wxTreeItemIcon_Expanded
] = NO_IMAGE
;
520 m_images
[wxTreeItemIcon_SelectedExpanded
] = NO_IMAGE
;
525 m_isCollapsed
= TRUE
;
526 m_hasHilight
= FALSE
;
532 m_attr
= (wxTreeItemAttr
*)NULL
;
535 // We don't know the height here yet.
540 wxGenericTreeItem::~wxGenericTreeItem()
544 if (m_ownsAttr
) delete m_attr
;
546 wxASSERT_MSG( m_children
.IsEmpty(),
547 wxT("please call DeleteChildren() before deleting the item") );
550 void wxGenericTreeItem::DeleteChildren(wxGenericTreeCtrl
*tree
)
552 size_t count
= m_children
.Count();
553 for ( size_t n
= 0; n
< count
; n
++ )
555 wxGenericTreeItem
*child
= m_children
[n
];
557 tree
->SendDeleteEvent(child
);
559 child
->DeleteChildren(tree
);
566 void wxGenericTreeItem::SetText( const wxString
&text
)
571 size_t wxGenericTreeItem::GetChildrenCount(bool recursively
) const
573 size_t count
= m_children
.Count();
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
.Count();
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 // 5 is the size of the plus sign
623 int xCross
= m_x
- theCtrl
->GetSpacing();
624 if ((point
.x
> xCross
-5) && (point
.x
< xCross
+5) &&
625 (point
.y
> y_mid
-5) && (point
.y
< y_mid
+5) &&
626 HasPlus() && theCtrl
->HasButtons() )
628 flags
|= wxTREE_HITTEST_ONITEMBUTTON
;
632 if ((point
.x
>= m_x
) && (point
.x
<= m_x
+m_width
))
637 // assuming every image (normal and selected) has the same size!
638 if ( (GetImage() != NO_IMAGE
) && theCtrl
->m_imageListNormal
)
639 theCtrl
->m_imageListNormal
->GetSize(GetImage(),
642 if ((image_w
!= -1) && (point
.x
<= m_x
+ image_w
+ 1))
643 flags
|= wxTREE_HITTEST_ONITEMICON
;
645 flags
|= wxTREE_HITTEST_ONITEMLABEL
;
651 flags
|= wxTREE_HITTEST_ONITEMINDENT
;
652 if (point
.x
> m_x
+m_width
)
653 flags
|= wxTREE_HITTEST_ONITEMRIGHT
;
658 // if children are expanded, fall through to evaluate them
659 if (m_isCollapsed
) return (wxGenericTreeItem
*) NULL
;
663 size_t count
= m_children
.Count();
664 for ( size_t n
= 0; n
< count
; n
++ )
666 wxGenericTreeItem
*res
= m_children
[n
]->HitTest( point
,
674 return (wxGenericTreeItem
*) NULL
;
677 int wxGenericTreeItem::GetCurrentImage() const
679 int image
= NO_IMAGE
;
684 image
= GetImage(wxTreeItemIcon_SelectedExpanded
);
687 if ( image
== NO_IMAGE
)
689 // we usually fall back to the normal item, but try just the
690 // expanded one (and not selected) first in this case
691 image
= GetImage(wxTreeItemIcon_Expanded
);
697 image
= GetImage(wxTreeItemIcon_Selected
);
700 // maybe it doesn't have the specific image we want,
701 // try the default one instead
702 if ( image
== NO_IMAGE
) image
= GetImage();
707 // -----------------------------------------------------------------------------
708 // wxGenericTreeCtrl implementation
709 // -----------------------------------------------------------------------------
711 IMPLEMENT_DYNAMIC_CLASS(wxGenericTreeCtrl
, wxScrolledWindow
)
713 BEGIN_EVENT_TABLE(wxGenericTreeCtrl
,wxScrolledWindow
)
714 EVT_PAINT (wxGenericTreeCtrl::OnPaint
)
715 EVT_MOUSE_EVENTS (wxGenericTreeCtrl::OnMouse
)
716 EVT_CHAR (wxGenericTreeCtrl::OnChar
)
717 EVT_SET_FOCUS (wxGenericTreeCtrl::OnSetFocus
)
718 EVT_KILL_FOCUS (wxGenericTreeCtrl::OnKillFocus
)
719 EVT_IDLE (wxGenericTreeCtrl::OnIdle
)
722 #if !defined(__WXMSW__) || defined(__WIN16__) || defined(__WXUNIVERSAL__)
724 * wxTreeCtrl has to be a real class or we have problems with
725 * the run-time information.
728 IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl
, wxGenericTreeCtrl
)
731 // -----------------------------------------------------------------------------
732 // construction/destruction
733 // -----------------------------------------------------------------------------
735 void wxGenericTreeCtrl::Init()
737 m_current
= m_key_current
= m_anchor
= (wxGenericTreeItem
*) NULL
;
745 m_hilightBrush
= new wxBrush
747 wxSystemSettings::GetColour
749 wxSYS_COLOUR_HIGHLIGHT
754 m_hilightUnfocusedBrush
= new wxBrush
756 wxSystemSettings::GetColour
758 wxSYS_COLOUR_BTNSHADOW
763 m_imageListNormal
= m_imageListButtons
=
764 m_imageListState
= (wxImageList
*) NULL
;
765 m_ownsImageListNormal
= m_ownsImageListButtons
=
766 m_ownsImageListState
= FALSE
;
769 m_isDragging
= FALSE
;
770 m_dropTarget
= m_oldSelection
= (wxGenericTreeItem
*)NULL
;
773 m_renameTimer
= NULL
;
776 m_lastOnSame
= FALSE
;
778 m_normalFont
= wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT
);
779 m_boldFont
= wxFont(m_normalFont
.GetPointSize(),
780 m_normalFont
.GetFamily(),
781 m_normalFont
.GetStyle(),
783 m_normalFont
.GetUnderlined(),
784 m_normalFont
.GetFaceName(),
785 m_normalFont
.GetEncoding());
788 bool wxGenericTreeCtrl::Create(wxWindow
*parent
,
793 const wxValidator
&validator
,
794 const wxString
& name
)
798 wxGetOsVersion( &major
, &minor
);
800 if (style
& wxTR_HAS_BUTTONS
) style
|= wxTR_MAC_BUTTONS
;
801 if (style
& wxTR_HAS_BUTTONS
) style
&= ~wxTR_HAS_BUTTONS
;
802 style
&= ~wxTR_LINES_AT_ROOT
;
803 style
|= wxTR_NO_LINES
;
805 style
|= wxTR_ROW_LINES
;
807 style
|= wxTR_AQUA_BUTTONS
;
810 if (style
& wxTR_AQUA_BUTTONS
)
812 m_arrowRight
= new wxBitmap( aqua_arrow_right
);
813 m_arrowDown
= new wxBitmap( aqua_arrow_down
);
821 wxScrolledWindow::Create( parent
, id
, pos
, size
,
822 style
|wxHSCROLL
|wxVSCROLL
, name
);
824 // If the tree display has no buttons, but does have
825 // connecting lines, we can use a narrower layout.
826 // It may not be a good idea to force this...
827 if (!HasButtons() && !HasFlag(wxTR_NO_LINES
))
834 SetValidator( validator
);
837 SetForegroundColour( wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT
) );
838 SetBackgroundColour( wxSystemSettings::GetColour(wxSYS_COLOUR_LISTBOX
) );
840 // m_dottedPen = wxPen( "grey", 0, wxDOT ); too slow under XFree86
841 m_dottedPen
= wxPen( wxT("grey"), 0, 0 );
846 wxGenericTreeCtrl::~wxGenericTreeCtrl()
848 delete m_hilightBrush
;
849 delete m_hilightUnfocusedBrush
;
856 delete m_renameTimer
;
859 if (m_ownsImageListNormal
)
860 delete m_imageListNormal
;
861 if (m_ownsImageListState
)
862 delete m_imageListState
;
863 if (m_ownsImageListButtons
)
864 delete m_imageListButtons
;
867 // -----------------------------------------------------------------------------
869 // -----------------------------------------------------------------------------
871 size_t wxGenericTreeCtrl::GetCount() const
873 return m_anchor
== NULL
? 0u : m_anchor
->GetChildrenCount();
876 void wxGenericTreeCtrl::SetIndent(unsigned int indent
)
878 m_indent
= (unsigned short) indent
;
882 void wxGenericTreeCtrl::SetSpacing(unsigned int spacing
)
884 m_spacing
= (unsigned short) spacing
;
888 size_t wxGenericTreeCtrl::GetChildrenCount(const wxTreeItemId
& item
, bool recursively
)
890 wxCHECK_MSG( item
.IsOk(), 0u, wxT("invalid tree item") );
892 return ((wxGenericTreeItem
*) item
.m_pItem
)->GetChildrenCount(recursively
);
895 void wxGenericTreeCtrl::SetWindowStyle(const long styles
)
897 if (!HasFlag(wxTR_HIDE_ROOT
) && (styles
& wxTR_HIDE_ROOT
))
899 // if we will hide the root, make sure children are visible
900 m_anchor
->SetHasPlus();
902 CalculatePositions();
905 // right now, just sets the styles. Eventually, we may
906 // want to update the inherited styles, but right now
907 // none of the parents has updatable styles
908 m_windowStyle
= styles
;
912 // -----------------------------------------------------------------------------
913 // functions to work with tree items
914 // -----------------------------------------------------------------------------
916 wxString
wxGenericTreeCtrl::GetItemText(const wxTreeItemId
& item
) const
918 wxCHECK_MSG( item
.IsOk(), wxT(""), wxT("invalid tree item") );
920 return ((wxGenericTreeItem
*) item
.m_pItem
)->GetText();
923 int wxGenericTreeCtrl::GetItemImage(const wxTreeItemId
& item
,
924 wxTreeItemIcon which
) const
926 wxCHECK_MSG( item
.IsOk(), -1, wxT("invalid tree item") );
928 return ((wxGenericTreeItem
*) item
.m_pItem
)->GetImage(which
);
931 wxTreeItemData
*wxGenericTreeCtrl::GetItemData(const wxTreeItemId
& item
) const
933 wxCHECK_MSG( item
.IsOk(), NULL
, wxT("invalid tree item") );
935 return ((wxGenericTreeItem
*) item
.m_pItem
)->GetData();
938 wxColour
wxGenericTreeCtrl::GetItemTextColour(const wxTreeItemId
& item
) const
940 wxCHECK_MSG( item
.IsOk(), wxNullColour
, wxT("invalid tree item") );
942 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
943 return pItem
->Attr().GetTextColour();
946 wxColour
wxGenericTreeCtrl::GetItemBackgroundColour(const wxTreeItemId
& item
) const
948 wxCHECK_MSG( item
.IsOk(), wxNullColour
, wxT("invalid tree item") );
950 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
951 return pItem
->Attr().GetBackgroundColour();
954 wxFont
wxGenericTreeCtrl::GetItemFont(const wxTreeItemId
& item
) const
956 wxCHECK_MSG( item
.IsOk(), wxNullFont
, wxT("invalid tree item") );
958 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
959 return pItem
->Attr().GetFont();
962 void wxGenericTreeCtrl::SetItemText(const wxTreeItemId
& item
, const wxString
& text
)
964 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
967 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
968 pItem
->SetText(text
);
969 CalculateSize(pItem
, dc
);
973 void wxGenericTreeCtrl::SetItemImage(const wxTreeItemId
& item
,
975 wxTreeItemIcon which
)
977 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
979 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
980 pItem
->SetImage(image
, which
);
983 CalculateSize(pItem
, dc
);
987 void wxGenericTreeCtrl::SetItemData(const wxTreeItemId
& item
, wxTreeItemData
*data
)
989 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
991 ((wxGenericTreeItem
*) item
.m_pItem
)->SetData(data
);
994 void wxGenericTreeCtrl::SetItemHasChildren(const wxTreeItemId
& item
, bool has
)
996 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
998 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
999 pItem
->SetHasPlus(has
);
1003 void wxGenericTreeCtrl::SetItemBold(const wxTreeItemId
& item
, bool bold
)
1005 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1007 // avoid redrawing the tree if no real change
1008 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1009 if ( pItem
->IsBold() != bold
)
1011 pItem
->SetBold(bold
);
1016 void wxGenericTreeCtrl::SetItemTextColour(const wxTreeItemId
& item
,
1017 const wxColour
& col
)
1019 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1021 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1022 pItem
->Attr().SetTextColour(col
);
1026 void wxGenericTreeCtrl::SetItemBackgroundColour(const wxTreeItemId
& item
,
1027 const wxColour
& col
)
1029 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1031 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1032 pItem
->Attr().SetBackgroundColour(col
);
1036 void wxGenericTreeCtrl::SetItemFont(const wxTreeItemId
& item
, const wxFont
& font
)
1038 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1040 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1041 pItem
->Attr().SetFont(font
);
1045 bool wxGenericTreeCtrl::SetFont( const wxFont
&font
)
1047 wxScrolledWindow::SetFont(font
);
1049 m_normalFont
= font
;
1050 m_boldFont
= wxFont(m_normalFont
.GetPointSize(),
1051 m_normalFont
.GetFamily(),
1052 m_normalFont
.GetStyle(),
1054 m_normalFont
.GetUnderlined(),
1055 m_normalFont
.GetFaceName(),
1056 m_normalFont
.GetEncoding());
1062 // -----------------------------------------------------------------------------
1063 // item status inquiries
1064 // -----------------------------------------------------------------------------
1066 bool wxGenericTreeCtrl::IsVisible(const wxTreeItemId
& item
) const
1068 wxCHECK_MSG( item
.IsOk(), FALSE
, wxT("invalid tree item") );
1070 // An item is only visible if it's not a descendant of a collapsed item
1071 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1072 wxGenericTreeItem
* parent
= pItem
->GetParent();
1075 if (!parent
->IsExpanded())
1077 parent
= parent
->GetParent();
1081 GetViewStart(& startX
, & startY
);
1083 wxSize clientSize
= GetClientSize();
1086 if (!GetBoundingRect(item
, rect
))
1088 if (rect
.GetWidth() == 0 || rect
.GetHeight() == 0)
1090 if (rect
.GetBottom() < 0 || rect
.GetTop() > clientSize
.y
)
1092 if (rect
.GetRight() < 0 || rect
.GetLeft() > clientSize
.x
)
1098 bool wxGenericTreeCtrl::ItemHasChildren(const wxTreeItemId
& item
) const
1100 wxCHECK_MSG( item
.IsOk(), FALSE
, wxT("invalid tree item") );
1102 // consider that the item does have children if it has the "+" button: it
1103 // might not have them (if it had never been expanded yet) but then it
1104 // could have them as well and it's better to err on this side rather than
1105 // disabling some operations which are restricted to the items with
1106 // children for an item which does have them
1107 return ((wxGenericTreeItem
*) item
.m_pItem
)->HasPlus();
1110 bool wxGenericTreeCtrl::IsExpanded(const wxTreeItemId
& item
) const
1112 wxCHECK_MSG( item
.IsOk(), FALSE
, wxT("invalid tree item") );
1114 return ((wxGenericTreeItem
*) item
.m_pItem
)->IsExpanded();
1117 bool wxGenericTreeCtrl::IsSelected(const wxTreeItemId
& item
) const
1119 wxCHECK_MSG( item
.IsOk(), FALSE
, wxT("invalid tree item") );
1121 return ((wxGenericTreeItem
*) item
.m_pItem
)->IsSelected();
1124 bool wxGenericTreeCtrl::IsBold(const wxTreeItemId
& item
) const
1126 wxCHECK_MSG( item
.IsOk(), FALSE
, wxT("invalid tree item") );
1128 return ((wxGenericTreeItem
*) item
.m_pItem
)->IsBold();
1131 // -----------------------------------------------------------------------------
1133 // -----------------------------------------------------------------------------
1135 wxTreeItemId
wxGenericTreeCtrl::GetItemParent(const wxTreeItemId
& item
) const
1137 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1139 return ((wxGenericTreeItem
*) item
.m_pItem
)->GetParent();
1142 wxTreeItemId
wxGenericTreeCtrl::GetFirstChild(const wxTreeItemId
& item
, long& cookie
) const
1144 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1147 return GetNextChild(item
, cookie
);
1150 wxTreeItemId
wxGenericTreeCtrl::GetNextChild(const wxTreeItemId
& item
, long& cookie
) const
1152 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1154 wxArrayGenericTreeItems
& children
= ((wxGenericTreeItem
*) item
.m_pItem
)->GetChildren();
1155 if ( (size_t)cookie
< children
.Count() )
1157 return children
.Item((size_t)cookie
++);
1161 // there are no more of them
1162 return wxTreeItemId();
1166 wxTreeItemId
wxGenericTreeCtrl::GetLastChild(const wxTreeItemId
& item
) const
1168 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1170 wxArrayGenericTreeItems
& children
= ((wxGenericTreeItem
*) item
.m_pItem
)->GetChildren();
1171 return (children
.IsEmpty() ? wxTreeItemId() : wxTreeItemId(children
.Last()));
1174 wxTreeItemId
wxGenericTreeCtrl::GetNextSibling(const wxTreeItemId
& item
) const
1176 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1178 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
1179 wxGenericTreeItem
*parent
= i
->GetParent();
1180 if ( parent
== NULL
)
1182 // root item doesn't have any siblings
1183 return wxTreeItemId();
1186 wxArrayGenericTreeItems
& siblings
= parent
->GetChildren();
1187 int index
= siblings
.Index(i
);
1188 wxASSERT( index
!= wxNOT_FOUND
); // I'm not a child of my parent?
1190 size_t n
= (size_t)(index
+ 1);
1191 return n
== siblings
.Count() ? wxTreeItemId() : wxTreeItemId(siblings
[n
]);
1194 wxTreeItemId
wxGenericTreeCtrl::GetPrevSibling(const wxTreeItemId
& item
) const
1196 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1198 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
1199 wxGenericTreeItem
*parent
= i
->GetParent();
1200 if ( parent
== NULL
)
1202 // root item doesn't have any siblings
1203 return wxTreeItemId();
1206 wxArrayGenericTreeItems
& siblings
= parent
->GetChildren();
1207 int index
= siblings
.Index(i
);
1208 wxASSERT( index
!= wxNOT_FOUND
); // I'm not a child of my parent?
1210 return index
== 0 ? wxTreeItemId()
1211 : wxTreeItemId(siblings
[(size_t)(index
- 1)]);
1214 // Only for internal use right now, but should probably be public
1215 wxTreeItemId
wxGenericTreeCtrl::GetNext(const wxTreeItemId
& item
) const
1217 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1219 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
1221 // First see if there are any children.
1222 wxArrayGenericTreeItems
& children
= i
->GetChildren();
1223 if (children
.GetCount() > 0)
1225 return children
.Item(0);
1229 // Try a sibling of this or ancestor instead
1230 wxTreeItemId p
= item
;
1231 wxTreeItemId toFind
;
1234 toFind
= GetNextSibling(p
);
1235 p
= GetItemParent(p
);
1236 } while (p
.IsOk() && !toFind
.IsOk());
1241 wxTreeItemId
wxGenericTreeCtrl::GetFirstVisibleItem() const
1243 wxTreeItemId id
= GetRootItem();
1252 } while (id
.IsOk());
1254 return wxTreeItemId();
1257 wxTreeItemId
wxGenericTreeCtrl::GetNextVisible(const wxTreeItemId
& item
) const
1259 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1261 wxTreeItemId id
= item
;
1264 while (id
= GetNext(id
), id
.IsOk())
1270 return wxTreeItemId();
1273 wxTreeItemId
wxGenericTreeCtrl::GetPrevVisible(const wxTreeItemId
& item
) const
1275 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1277 wxFAIL_MSG(wxT("not implemented"));
1279 return wxTreeItemId();
1282 // called by wxTextTreeCtrl when it marks itself for deletion
1283 void wxGenericTreeCtrl::ResetTextControl()
1288 // find the first item starting with the given prefix after the given item
1289 wxTreeItemId
wxGenericTreeCtrl::FindItem(const wxTreeItemId
& idParent
,
1290 const wxString
& prefixOrig
) const
1292 // match is case insensitive as this is more convenient to the user: having
1293 // to press Shift-letter to go to the item starting with a capital letter
1294 // would be too bothersome
1295 wxString prefix
= prefixOrig
.Lower();
1297 // determine the starting point: we shouldn't take the current item (this
1298 // allows to switch between two items starting with the same letter just by
1299 // pressing it) but we shouldn't jump to the next one if the user is
1300 // continuing to type as otherwise he might easily skip the item he wanted
1301 wxTreeItemId id
= idParent
;
1302 if ( prefix
.length() == 1 )
1307 // look for the item starting with the given prefix after it
1308 while ( id
.IsOk() && !GetItemText(id
).Lower().StartsWith(prefix
) )
1313 // if we haven't found anything...
1316 // ... wrap to the beginning
1318 if ( HasFlag(wxTR_HIDE_ROOT
) )
1320 // can't select virtual root
1324 // and try all the items (stop when we get to the one we started from)
1325 while ( id
!= idParent
&& !GetItemText(id
).Lower().StartsWith(prefix
) )
1334 // -----------------------------------------------------------------------------
1336 // -----------------------------------------------------------------------------
1338 wxTreeItemId
wxGenericTreeCtrl::DoInsertItem(const wxTreeItemId
& parentId
,
1340 const wxString
& text
,
1341 int image
, int selImage
,
1342 wxTreeItemData
*data
)
1344 wxGenericTreeItem
*parent
= (wxGenericTreeItem
*) parentId
.m_pItem
;
1347 // should we give a warning here?
1348 return AddRoot(text
, image
, selImage
, data
);
1351 m_dirty
= TRUE
; // do this first so stuff below doesn't cause flicker
1353 wxGenericTreeItem
*item
=
1354 new wxGenericTreeItem( parent
, text
, image
, selImage
, data
);
1358 data
->m_pItem
= (long) item
;
1361 parent
->Insert( item
, previous
);
1366 wxTreeItemId
wxGenericTreeCtrl::AddRoot(const wxString
& text
,
1367 int image
, int selImage
,
1368 wxTreeItemData
*data
)
1370 wxCHECK_MSG( !m_anchor
, wxTreeItemId(), wxT("tree can have only one root") );
1372 m_dirty
= TRUE
; // do this first so stuff below doesn't cause flicker
1374 m_anchor
= new wxGenericTreeItem((wxGenericTreeItem
*)NULL
, text
,
1375 image
, selImage
, data
);
1378 data
->m_pItem
= (long) m_anchor
;
1381 if (HasFlag(wxTR_HIDE_ROOT
))
1383 // if root is hidden, make sure we can navigate
1385 m_anchor
->SetHasPlus();
1387 CalculatePositions();
1390 if (!HasFlag(wxTR_MULTIPLE
))
1392 m_current
= m_key_current
= m_anchor
;
1393 m_current
->SetHilight( TRUE
);
1399 wxTreeItemId
wxGenericTreeCtrl::PrependItem(const wxTreeItemId
& parent
,
1400 const wxString
& text
,
1401 int image
, int selImage
,
1402 wxTreeItemData
*data
)
1404 return DoInsertItem(parent
, 0u, text
, image
, selImage
, data
);
1407 wxTreeItemId
wxGenericTreeCtrl::InsertItem(const wxTreeItemId
& parentId
,
1408 const wxTreeItemId
& idPrevious
,
1409 const wxString
& text
,
1410 int image
, int selImage
,
1411 wxTreeItemData
*data
)
1413 wxGenericTreeItem
*parent
= (wxGenericTreeItem
*) parentId
.m_pItem
;
1416 // should we give a warning here?
1417 return AddRoot(text
, image
, selImage
, data
);
1421 if (idPrevious
.IsOk())
1423 index
= parent
->GetChildren().Index((wxGenericTreeItem
*) idPrevious
.m_pItem
);
1424 wxASSERT_MSG( index
!= wxNOT_FOUND
,
1425 wxT("previous item in wxGenericTreeCtrl::InsertItem() is not a sibling") );
1428 return DoInsertItem(parentId
, (size_t)++index
, text
, image
, selImage
, data
);
1431 wxTreeItemId
wxGenericTreeCtrl::InsertItem(const wxTreeItemId
& parentId
,
1433 const wxString
& text
,
1434 int image
, int selImage
,
1435 wxTreeItemData
*data
)
1437 wxGenericTreeItem
*parent
= (wxGenericTreeItem
*) parentId
.m_pItem
;
1440 // should we give a warning here?
1441 return AddRoot(text
, image
, selImage
, data
);
1444 return DoInsertItem(parentId
, before
, text
, image
, selImage
, data
);
1447 wxTreeItemId
wxGenericTreeCtrl::AppendItem(const wxTreeItemId
& parentId
,
1448 const wxString
& text
,
1449 int image
, int selImage
,
1450 wxTreeItemData
*data
)
1452 wxGenericTreeItem
*parent
= (wxGenericTreeItem
*) parentId
.m_pItem
;
1455 // should we give a warning here?
1456 return AddRoot(text
, image
, selImage
, data
);
1459 return DoInsertItem( parent
, parent
->GetChildren().Count(), text
,
1460 image
, selImage
, data
);
1463 void wxGenericTreeCtrl::SendDeleteEvent(wxGenericTreeItem
*item
)
1465 wxTreeEvent
event( wxEVT_COMMAND_TREE_DELETE_ITEM
, GetId() );
1466 event
.m_item
= (long) item
;
1467 event
.SetEventObject( this );
1468 ProcessEvent( event
);
1471 void wxGenericTreeCtrl::DeleteChildren(const wxTreeItemId
& itemId
)
1473 m_dirty
= TRUE
; // do this first so stuff below doesn't cause flicker
1475 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1476 item
->DeleteChildren(this);
1479 void wxGenericTreeCtrl::Delete(const wxTreeItemId
& itemId
)
1481 m_dirty
= TRUE
; // do this first so stuff below doesn't cause flicker
1483 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1485 wxGenericTreeItem
*parent
= item
->GetParent();
1487 // don't keep stale pointers around!
1488 if ( IsDescendantOf(item
, m_key_current
) )
1490 m_key_current
= parent
;
1493 if ( IsDescendantOf(item
, m_current
) )
1498 // remove the item from the tree
1501 parent
->GetChildren().Remove( item
); // remove by value
1503 else // deleting the root
1505 // nothing will be left in the tree
1509 // and delete all of its children and the item itself now
1510 item
->DeleteChildren(this);
1511 SendDeleteEvent(item
);
1515 void wxGenericTreeCtrl::DeleteAllItems()
1523 void wxGenericTreeCtrl::Expand(const wxTreeItemId
& itemId
)
1525 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1527 wxCHECK_RET( item
, _T("invalid item in wxGenericTreeCtrl::Expand") );
1528 wxCHECK_RET( !HasFlag(wxTR_HIDE_ROOT
) || itemId
!= GetRootItem(),
1529 _T("can't expand hidden root") );
1531 if ( !item
->HasPlus() )
1534 if ( item
->IsExpanded() )
1537 wxTreeEvent
event( wxEVT_COMMAND_TREE_ITEM_EXPANDING
, GetId() );
1538 event
.m_item
= (long) item
;
1539 event
.SetEventObject( this );
1541 if ( ProcessEvent( event
) && !event
.IsAllowed() )
1543 // cancelled by program
1548 CalculatePositions();
1550 RefreshSubtree(item
);
1552 event
.SetEventType(wxEVT_COMMAND_TREE_ITEM_EXPANDED
);
1553 ProcessEvent( event
);
1556 void wxGenericTreeCtrl::ExpandAll(const wxTreeItemId
& item
)
1558 if ( !HasFlag(wxTR_HIDE_ROOT
) || item
!= GetRootItem())
1561 if ( !IsExpanded(item
) )
1566 wxTreeItemId child
= GetFirstChild(item
, cookie
);
1567 while ( child
.IsOk() )
1571 child
= GetNextChild(item
, cookie
);
1575 void wxGenericTreeCtrl::Collapse(const wxTreeItemId
& itemId
)
1577 wxCHECK_RET( !HasFlag(wxTR_HIDE_ROOT
) || itemId
!= GetRootItem(),
1578 _T("can't collapse hidden root") );
1580 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1582 if ( !item
->IsExpanded() )
1585 wxTreeEvent
event( wxEVT_COMMAND_TREE_ITEM_COLLAPSING
, GetId() );
1586 event
.m_item
= (long) item
;
1587 event
.SetEventObject( this );
1588 if ( ProcessEvent( event
) && !event
.IsAllowed() )
1590 // cancelled by program
1596 #if 0 // TODO why should items be collapsed recursively?
1597 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1598 size_t count
= children
.Count();
1599 for ( size_t n
= 0; n
< count
; n
++ )
1601 Collapse(children
[n
]);
1605 CalculatePositions();
1607 RefreshSubtree(item
);
1609 event
.SetEventType(wxEVT_COMMAND_TREE_ITEM_COLLAPSED
);
1610 ProcessEvent( event
);
1613 void wxGenericTreeCtrl::CollapseAndReset(const wxTreeItemId
& item
)
1616 DeleteChildren(item
);
1619 void wxGenericTreeCtrl::Toggle(const wxTreeItemId
& itemId
)
1621 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1623 if (item
->IsExpanded())
1629 void wxGenericTreeCtrl::Unselect()
1633 m_current
->SetHilight( FALSE
);
1634 RefreshLine( m_current
);
1640 void wxGenericTreeCtrl::UnselectAllChildren(wxGenericTreeItem
*item
)
1642 if (item
->IsSelected())
1644 item
->SetHilight(FALSE
);
1648 if (item
->HasChildren())
1650 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1651 size_t count
= children
.Count();
1652 for ( size_t n
= 0; n
< count
; ++n
)
1654 UnselectAllChildren(children
[n
]);
1659 void wxGenericTreeCtrl::UnselectAll()
1661 wxTreeItemId rootItem
= GetRootItem();
1663 // the tree might not have the root item at all
1666 UnselectAllChildren((wxGenericTreeItem
*) rootItem
.m_pItem
);
1670 // Recursive function !
1671 // To stop we must have crt_item<last_item
1673 // Tag all next children, when no more children,
1674 // Move to parent (not to tag)
1675 // Keep going... if we found last_item, we stop.
1676 bool wxGenericTreeCtrl::TagNextChildren(wxGenericTreeItem
*crt_item
, wxGenericTreeItem
*last_item
, bool select
)
1678 wxGenericTreeItem
*parent
= crt_item
->GetParent();
1680 if (parent
== NULL
) // This is root item
1681 return TagAllChildrenUntilLast(crt_item
, last_item
, select
);
1683 wxArrayGenericTreeItems
& children
= parent
->GetChildren();
1684 int index
= children
.Index(crt_item
);
1685 wxASSERT( index
!= wxNOT_FOUND
); // I'm not a child of my parent?
1687 size_t count
= children
.Count();
1688 for (size_t n
=(size_t)(index
+1); n
<count
; ++n
)
1690 if (TagAllChildrenUntilLast(children
[n
], last_item
, select
)) return TRUE
;
1693 return TagNextChildren(parent
, last_item
, select
);
1696 bool wxGenericTreeCtrl::TagAllChildrenUntilLast(wxGenericTreeItem
*crt_item
, wxGenericTreeItem
*last_item
, bool select
)
1698 crt_item
->SetHilight(select
);
1699 RefreshLine(crt_item
);
1701 if (crt_item
==last_item
)
1704 if (crt_item
->HasChildren())
1706 wxArrayGenericTreeItems
& children
= crt_item
->GetChildren();
1707 size_t count
= children
.Count();
1708 for ( size_t n
= 0; n
< count
; ++n
)
1710 if (TagAllChildrenUntilLast(children
[n
], last_item
, select
))
1718 void wxGenericTreeCtrl::SelectItemRange(wxGenericTreeItem
*item1
, wxGenericTreeItem
*item2
)
1720 // item2 is not necessary after item1
1721 wxGenericTreeItem
*first
=NULL
, *last
=NULL
;
1723 // choice first' and 'last' between item1 and item2
1724 if (item1
->GetY()<item2
->GetY())
1735 bool select
= m_current
->IsSelected();
1737 if ( TagAllChildrenUntilLast(first
,last
,select
) )
1740 TagNextChildren(first
,last
,select
);
1743 void wxGenericTreeCtrl::SelectItem(const wxTreeItemId
& itemId
,
1744 bool unselect_others
,
1745 bool extended_select
)
1747 wxCHECK_RET( itemId
.IsOk(), wxT("invalid tree item") );
1749 bool is_single
=!(GetWindowStyleFlag() & wxTR_MULTIPLE
);
1750 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1752 //wxCHECK_RET( ( (!unselect_others) && is_single),
1753 // wxT("this is a single selection tree") );
1755 // to keep going anyhow !!!
1758 if (item
->IsSelected())
1759 return; // nothing to do
1760 unselect_others
= TRUE
;
1761 extended_select
= FALSE
;
1763 else if ( unselect_others
&& item
->IsSelected() )
1765 // selection change if there is more than one item currently selected
1766 wxArrayTreeItemIds selected_items
;
1767 if ( GetSelections(selected_items
) == 1 )
1771 wxTreeEvent
event( wxEVT_COMMAND_TREE_SEL_CHANGING
, GetId() );
1772 event
.m_item
= (long) item
;
1773 event
.m_itemOld
= (long) m_current
;
1774 event
.SetEventObject( this );
1775 // TODO : Here we don't send any selection mode yet !
1777 if ( GetEventHandler()->ProcessEvent( event
) && !event
.IsAllowed() )
1780 wxTreeItemId parent
= GetItemParent( itemId
);
1781 while (parent
.IsOk())
1783 if (!IsExpanded(parent
))
1786 parent
= GetItemParent( parent
);
1789 EnsureVisible( itemId
);
1792 if (unselect_others
)
1794 if (is_single
) Unselect(); // to speed up thing
1799 if (extended_select
)
1803 m_current
= m_key_current
= (wxGenericTreeItem
*) GetRootItem().m_pItem
;
1806 // don't change the mark (m_current)
1807 SelectItemRange(m_current
, item
);
1811 bool select
=TRUE
; // the default
1813 // Check if we need to toggle hilight (ctrl mode)
1814 if (!unselect_others
)
1815 select
=!item
->IsSelected();
1817 m_current
= m_key_current
= item
;
1818 m_current
->SetHilight(select
);
1819 RefreshLine( m_current
);
1822 event
.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED
);
1823 GetEventHandler()->ProcessEvent( event
);
1826 void wxGenericTreeCtrl::FillArray(wxGenericTreeItem
*item
,
1827 wxArrayTreeItemIds
&array
) const
1829 if ( item
->IsSelected() )
1830 array
.Add(wxTreeItemId(item
));
1832 if ( item
->HasChildren() )
1834 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1835 size_t count
= children
.GetCount();
1836 for ( size_t n
= 0; n
< count
; ++n
)
1837 FillArray(children
[n
], array
);
1841 size_t wxGenericTreeCtrl::GetSelections(wxArrayTreeItemIds
&array
) const
1844 wxTreeItemId idRoot
= GetRootItem();
1845 if ( idRoot
.IsOk() )
1847 FillArray((wxGenericTreeItem
*) idRoot
.m_pItem
, array
);
1849 //else: the tree is empty, so no selections
1851 return array
.Count();
1854 void wxGenericTreeCtrl::EnsureVisible(const wxTreeItemId
& item
)
1856 if (!item
.IsOk()) return;
1858 wxGenericTreeItem
*gitem
= (wxGenericTreeItem
*) item
.m_pItem
;
1860 // first expand all parent branches
1861 wxGenericTreeItem
*parent
= gitem
->GetParent();
1863 if ( HasFlag(wxTR_HIDE_ROOT
) )
1865 while ( parent
!= m_anchor
)
1868 parent
= parent
->GetParent();
1876 parent
= parent
->GetParent();
1880 //if (parent) CalculatePositions();
1885 void wxGenericTreeCtrl::ScrollTo(const wxTreeItemId
&item
)
1887 if (!item
.IsOk()) return;
1889 // We have to call this here because the label in
1890 // question might just have been added and no screen
1891 // update taken place.
1892 if (m_dirty
) wxYieldIfNeeded();
1894 wxGenericTreeItem
*gitem
= (wxGenericTreeItem
*) item
.m_pItem
;
1896 // now scroll to the item
1897 int item_y
= gitem
->GetY();
1901 GetViewStart( &start_x
, &start_y
);
1902 start_y
*= PIXELS_PER_UNIT
;
1906 GetClientSize( &client_w
, &client_h
);
1908 if (item_y
< start_y
+3)
1913 m_anchor
->GetSize( x
, y
, this );
1914 y
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
1915 x
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
1916 int x_pos
= GetScrollPos( wxHORIZONTAL
);
1917 // Item should appear at top
1918 SetScrollbars( PIXELS_PER_UNIT
, PIXELS_PER_UNIT
, x
/PIXELS_PER_UNIT
, y
/PIXELS_PER_UNIT
, x_pos
, item_y
/PIXELS_PER_UNIT
);
1920 else if (item_y
+GetLineHeight(gitem
) > start_y
+client_h
)
1925 m_anchor
->GetSize( x
, y
, this );
1926 y
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
1927 x
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
1928 item_y
+= PIXELS_PER_UNIT
+2;
1929 int x_pos
= GetScrollPos( wxHORIZONTAL
);
1930 // Item should appear at bottom
1931 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
);
1935 // FIXME: tree sorting functions are not reentrant and not MT-safe!
1936 static wxGenericTreeCtrl
*s_treeBeingSorted
= NULL
;
1938 static int LINKAGEMODE
tree_ctrl_compare_func(wxGenericTreeItem
**item1
,
1939 wxGenericTreeItem
**item2
)
1941 wxCHECK_MSG( s_treeBeingSorted
, 0, wxT("bug in wxGenericTreeCtrl::SortChildren()") );
1943 return s_treeBeingSorted
->OnCompareItems(*item1
, *item2
);
1946 int wxGenericTreeCtrl::OnCompareItems(const wxTreeItemId
& item1
,
1947 const wxTreeItemId
& item2
)
1949 return wxStrcmp(GetItemText(item1
), GetItemText(item2
));
1952 void wxGenericTreeCtrl::SortChildren(const wxTreeItemId
& itemId
)
1954 wxCHECK_RET( itemId
.IsOk(), wxT("invalid tree item") );
1956 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1958 wxCHECK_RET( !s_treeBeingSorted
,
1959 wxT("wxGenericTreeCtrl::SortChildren is not reentrant") );
1961 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1962 if ( children
.Count() > 1 )
1966 s_treeBeingSorted
= this;
1967 children
.Sort(tree_ctrl_compare_func
);
1968 s_treeBeingSorted
= NULL
;
1970 //else: don't make the tree dirty as nothing changed
1973 wxImageList
*wxGenericTreeCtrl::GetImageList() const
1975 return m_imageListNormal
;
1978 wxImageList
*wxGenericTreeCtrl::GetButtonsImageList() const
1980 return m_imageListButtons
;
1983 wxImageList
*wxGenericTreeCtrl::GetStateImageList() const
1985 return m_imageListState
;
1988 void wxGenericTreeCtrl::CalculateLineHeight()
1990 wxClientDC
dc(this);
1991 m_lineHeight
= (int)(dc
.GetCharHeight() + 4);
1993 if ( m_imageListNormal
)
1995 // Calculate a m_lineHeight value from the normal Image sizes.
1996 // May be toggle off. Then wxGenericTreeCtrl will spread when
1997 // necessary (which might look ugly).
1998 int n
= m_imageListNormal
->GetImageCount();
1999 for (int i
= 0; i
< n
; i
++)
2001 int width
= 0, height
= 0;
2002 m_imageListNormal
->GetSize(i
, width
, height
);
2003 if (height
> m_lineHeight
) m_lineHeight
= height
;
2007 if (m_imageListButtons
)
2009 // Calculate a m_lineHeight value from the Button image sizes.
2010 // May be toggle off. Then wxGenericTreeCtrl will spread when
2011 // necessary (which might look ugly).
2012 int n
= m_imageListButtons
->GetImageCount();
2013 for (int i
= 0; i
< n
; i
++)
2015 int width
= 0, height
= 0;
2016 m_imageListButtons
->GetSize(i
, width
, height
);
2017 if (height
> m_lineHeight
) m_lineHeight
= height
;
2021 if (m_lineHeight
< 30)
2022 m_lineHeight
+= 2; // at least 2 pixels
2024 m_lineHeight
+= m_lineHeight
/10; // otherwise 10% extra spacing
2027 void wxGenericTreeCtrl::SetImageList(wxImageList
*imageList
)
2029 if (m_ownsImageListNormal
) delete m_imageListNormal
;
2030 m_imageListNormal
= imageList
;
2031 m_ownsImageListNormal
= FALSE
;
2033 // Don't do any drawing if we're setting the list to NULL,
2034 // since we may be in the process of deleting the tree control.
2036 CalculateLineHeight();
2039 void wxGenericTreeCtrl::SetStateImageList(wxImageList
*imageList
)
2041 if (m_ownsImageListState
) delete m_imageListState
;
2042 m_imageListState
= imageList
;
2043 m_ownsImageListState
= FALSE
;
2046 void wxGenericTreeCtrl::SetButtonsImageList(wxImageList
*imageList
)
2048 if (m_ownsImageListButtons
) delete m_imageListButtons
;
2049 m_imageListButtons
= imageList
;
2050 m_ownsImageListButtons
= FALSE
;
2052 CalculateLineHeight();
2055 void wxGenericTreeCtrl::AssignImageList(wxImageList
*imageList
)
2057 SetImageList(imageList
);
2058 m_ownsImageListNormal
= TRUE
;
2061 void wxGenericTreeCtrl::AssignStateImageList(wxImageList
*imageList
)
2063 SetStateImageList(imageList
);
2064 m_ownsImageListState
= TRUE
;
2067 void wxGenericTreeCtrl::AssignButtonsImageList(wxImageList
*imageList
)
2069 SetButtonsImageList(imageList
);
2070 m_ownsImageListButtons
= TRUE
;
2073 // -----------------------------------------------------------------------------
2075 // -----------------------------------------------------------------------------
2077 void wxGenericTreeCtrl::AdjustMyScrollbars()
2082 m_anchor
->GetSize( x
, y
, this );
2083 y
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
2084 x
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
2085 int x_pos
= GetScrollPos( wxHORIZONTAL
);
2086 int y_pos
= GetScrollPos( wxVERTICAL
);
2087 SetScrollbars( PIXELS_PER_UNIT
, PIXELS_PER_UNIT
, x
/PIXELS_PER_UNIT
, y
/PIXELS_PER_UNIT
, x_pos
, y_pos
);
2091 SetScrollbars( 0, 0, 0, 0 );
2095 int wxGenericTreeCtrl::GetLineHeight(wxGenericTreeItem
*item
) const
2097 if (GetWindowStyleFlag() & wxTR_HAS_VARIABLE_ROW_HEIGHT
)
2098 return item
->GetHeight();
2100 return m_lineHeight
;
2103 void wxGenericTreeCtrl::PaintItem(wxGenericTreeItem
*item
, wxDC
& dc
)
2105 // TODO implement "state" icon on items
2107 wxTreeItemAttr
*attr
= item
->GetAttributes();
2108 if ( attr
&& attr
->HasFont() )
2109 dc
.SetFont(attr
->GetFont());
2110 else if (item
->IsBold())
2111 dc
.SetFont(m_boldFont
);
2113 long text_w
= 0, text_h
= 0;
2114 dc
.GetTextExtent( item
->GetText(), &text_w
, &text_h
);
2116 int image_h
= 0, image_w
= 0;
2117 int image
= item
->GetCurrentImage();
2118 if ( image
!= NO_IMAGE
)
2120 if ( m_imageListNormal
)
2122 m_imageListNormal
->GetSize( image
, image_w
, image_h
);
2131 int total_h
= GetLineHeight(item
);
2133 if ( item
->IsSelected() )
2135 // under mac selections are only a rectangle in case they don't have the focus
2139 dc
.SetBrush( *wxTRANSPARENT_BRUSH
) ;
2140 dc
.SetPen( wxPen( wxSystemSettings::GetColour( wxSYS_COLOUR_HIGHLIGHT
) , 1 , wxSOLID
) ) ;
2144 dc
.SetBrush( *m_hilightBrush
) ;
2147 dc
.SetBrush(*(m_hasFocus
? m_hilightBrush
: m_hilightUnfocusedBrush
));
2153 if ( attr
&& attr
->HasBackgroundColour() )
2154 colBg
= attr
->GetBackgroundColour();
2156 colBg
= m_backgroundColour
;
2157 dc
.SetBrush(wxBrush(colBg
, wxSOLID
));
2160 int offset
= HasFlag(wxTR_ROW_LINES
) ? 1 : 0;
2162 if ( HasFlag(wxTR_FULL_ROW_HIGHLIGHT
) )
2166 DoGetPosition(&x
, &y
);
2168 dc
.DrawRectangle(x
, item
->GetY()+offset
, w
, total_h
-offset
);
2172 if ( item
->IsSelected() && image
!= NO_IMAGE
)
2174 // If it's selected, and there's an image, then we should
2175 // take care to leave the area under the image painted in the
2176 // background colour.
2177 dc
.DrawRectangle( item
->GetX() + image_w
- 2, item
->GetY()+offset
,
2178 item
->GetWidth() - image_w
+ 2, total_h
-offset
);
2182 dc
.DrawRectangle( item
->GetX()-2, item
->GetY()+offset
,
2183 item
->GetWidth()+2, total_h
-offset
);
2187 if ( image
!= NO_IMAGE
)
2189 dc
.SetClippingRegion( item
->GetX(), item
->GetY(), image_w
-2, total_h
);
2190 m_imageListNormal
->Draw( image
, dc
,
2192 item
->GetY() +((total_h
> image_h
)?((total_h
-image_h
)/2):0),
2193 wxIMAGELIST_DRAW_TRANSPARENT
);
2194 dc
.DestroyClippingRegion();
2197 dc
.SetBackgroundMode(wxTRANSPARENT
);
2198 int extraH
= (total_h
> text_h
) ? (total_h
- text_h
)/2 : 0;
2199 dc
.DrawText( item
->GetText(),
2200 (wxCoord
)(image_w
+ item
->GetX()),
2201 (wxCoord
)(item
->GetY() + extraH
));
2203 // restore normal font
2204 dc
.SetFont( m_normalFont
);
2207 // Now y stands for the top of the item, whereas it used to stand for middle !
2208 void wxGenericTreeCtrl::PaintLevel( wxGenericTreeItem
*item
, wxDC
&dc
, int level
, int &y
)
2210 int x
= level
*m_indent
;
2211 if (!HasFlag(wxTR_HIDE_ROOT
))
2215 else if (level
== 0)
2217 // always expand hidden root
2219 wxArrayGenericTreeItems
& children
= item
->GetChildren();
2220 int count
= children
.Count();
2226 PaintLevel(children
[n
], dc
, 1, y
);
2227 } while (++n
< count
);
2229 if (!HasFlag(wxTR_NO_LINES
) && HasFlag(wxTR_LINES_AT_ROOT
) && count
> 0)
2231 // draw line down to last child
2232 origY
+= GetLineHeight(children
[0])>>1;
2233 oldY
+= GetLineHeight(children
[n
-1])>>1;
2234 dc
.DrawLine(3, origY
, 3, oldY
);
2240 item
->SetX(x
+m_spacing
);
2243 int h
= GetLineHeight(item
);
2245 int y_mid
= y_top
+ (h
>>1);
2248 int exposed_x
= dc
.LogicalToDeviceX(0);
2249 int exposed_y
= dc
.LogicalToDeviceY(y_top
);
2251 if (IsExposed(exposed_x
, exposed_y
, 10000, h
)) // 10000 = very much
2255 // don't draw rect outline if we already have the
2256 // background color under Mac
2257 (item
->IsSelected() && m_hasFocus
) ? wxBLACK_PEN
:
2258 #endif // !__WXMAC__
2262 if ( item
->IsSelected() )
2264 colText
= wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHTTEXT
);
2268 wxTreeItemAttr
*attr
= item
->GetAttributes();
2269 if (attr
&& attr
->HasTextColour())
2270 colText
= attr
->GetTextColour();
2272 colText
= GetForegroundColour();
2276 dc
.SetTextForeground(colText
);
2280 PaintItem(item
, dc
);
2282 if (HasFlag(wxTR_ROW_LINES
))
2284 // if the background colour is white, choose a
2285 // contrasting color for the lines
2286 dc
.SetPen(*((GetBackgroundColour() == *wxWHITE
)
2287 ? wxMEDIUM_GREY_PEN
: wxWHITE_PEN
));
2288 dc
.DrawLine(0, y_top
, 10000, y_top
);
2289 dc
.DrawLine(0, y
, 10000, y
);
2292 // restore DC objects
2293 dc
.SetBrush(*wxWHITE_BRUSH
);
2294 dc
.SetPen(m_dottedPen
);
2295 dc
.SetTextForeground(*wxBLACK
);
2297 if (item
->HasPlus() && HasButtons()) // should the item show a button?
2299 if (!HasFlag(wxTR_NO_LINES
))
2301 if (x
> (signed)m_indent
)
2302 dc
.DrawLine(x
- m_indent
, y_mid
, x
- 5, y_mid
);
2303 else if (HasFlag(wxTR_LINES_AT_ROOT
))
2304 dc
.DrawLine(3, y_mid
, x
- 5, y_mid
);
2305 dc
.DrawLine(x
+ 5, y_mid
, x
+ m_spacing
, y_mid
);
2308 if (m_imageListButtons
!= NULL
)
2310 // draw the image button here
2311 int image_h
= 0, image_w
= 0, image
= wxTreeItemIcon_Normal
;
2312 if (item
->IsExpanded()) image
= wxTreeItemIcon_Expanded
;
2313 if (item
->IsSelected())
2314 image
+= wxTreeItemIcon_Selected
- wxTreeItemIcon_Normal
;
2315 m_imageListButtons
->GetSize(image
, image_w
, image_h
);
2316 int xx
= x
- (image_w
>>1);
2317 int yy
= y_mid
- (image_h
>>1);
2318 dc
.SetClippingRegion(xx
, yy
, image_w
, image_h
);
2319 m_imageListButtons
->Draw(image
, dc
, xx
, yy
,
2320 wxIMAGELIST_DRAW_TRANSPARENT
);
2321 dc
.DestroyClippingRegion();
2323 else if (HasFlag(wxTR_TWIST_BUTTONS
))
2325 // draw the twisty button here
2327 if (HasFlag(wxTR_AQUA_BUTTONS
))
2330 wxMacPortSetter
helper(&dc
) ;
2331 wxMacWindowClipper
clipper(this) ;
2332 wxDC::MacSetupBackgroundForCurrentPort( MacGetBackgroundBrush() ) ;
2335 int loc_y
= y_mid
- 6 ;
2336 MacWindowToRootWindow( & loc_x
, & loc_y
) ;
2337 Rect bounds
= { loc_y
, loc_x
, loc_y
+ 18 , loc_x
+ 12 } ;
2338 ThemeButtonDrawInfo info
= { kThemeStateActive
, item
->IsExpanded() ? kThemeDisclosureDown
: kThemeDisclosureRight
,
2339 kThemeAdornmentNone
};
2340 DrawThemeButton( &bounds
, kThemeDisclosureButton
,
2341 &info
, NULL
, NULL
, NULL
, NULL
) ;
2343 if (item
->IsExpanded())
2344 dc
.DrawBitmap( *m_arrowDown
, x
-5, y_mid
-6, TRUE
);
2346 dc
.DrawBitmap( *m_arrowRight
, x
-5, y_mid
-6, TRUE
);
2351 dc
.SetBrush(*m_hilightBrush
);
2352 dc
.SetPen(*wxBLACK_PEN
);
2355 if (item
->IsExpanded())
2358 button
[0].y
= y_mid
-2;
2360 button
[1].y
= y_mid
-2;
2362 button
[2].y
= y_mid
+3;
2366 button
[0].y
= y_mid
-5;
2368 button
[1].y
= y_mid
+5;
2370 button
[2].y
= y_mid
;
2373 dc
.DrawPolygon(3, button
);
2374 dc
.SetPen(m_dottedPen
);
2377 else // if (HasFlag(wxTR_HAS_BUTTONS))
2379 // draw the plus sign here
2380 dc
.SetPen(*wxGREY_PEN
);
2381 dc
.SetBrush(*wxWHITE_BRUSH
);
2382 dc
.DrawRectangle(x
-5, y_mid
-4, 11, 9);
2383 dc
.SetPen(*wxBLACK_PEN
);
2384 dc
.DrawLine(x
-2, y_mid
, x
+3, y_mid
);
2385 if (!item
->IsExpanded())
2386 dc
.DrawLine(x
, y_mid
-2, x
, y_mid
+3);
2387 dc
.SetPen(m_dottedPen
);
2390 else if (!HasFlag(wxTR_NO_LINES
)) // no button; maybe a line?
2392 // draw the horizontal line here
2394 if (x
> (signed)m_indent
)
2395 x_start
-= m_indent
;
2396 else if (HasFlag(wxTR_LINES_AT_ROOT
))
2398 dc
.DrawLine(x_start
, y_mid
, x
+ m_spacing
, y_mid
);
2402 if (item
->IsExpanded())
2404 wxArrayGenericTreeItems
& children
= item
->GetChildren();
2405 int count
= children
.Count();
2412 PaintLevel(children
[n
], dc
, level
, y
);
2413 } while (++n
< count
);
2415 if (!HasFlag(wxTR_NO_LINES
) && count
> 0)
2417 // draw line down to last child
2418 oldY
+= GetLineHeight(children
[n
-1])>>1;
2419 if (HasButtons()) y_mid
+= 5;
2421 // Only draw the portion of the line that is visible, in case it is huge
2422 wxCoord xOrigin
=0, yOrigin
=0, width
, height
;
2423 dc
.GetDeviceOrigin(&xOrigin
, &yOrigin
);
2424 yOrigin
= abs(yOrigin
);
2425 GetClientSize(&width
, &height
);
2427 // Move end points to the begining/end of the view?
2428 if (y_mid
< yOrigin
)
2430 if (oldY
> yOrigin
+ height
)
2431 oldY
= yOrigin
+ height
;
2433 // after the adjustments if y_mid is larger than oldY then the line
2434 // isn't visible at all so don't draw anything
2436 dc
.DrawLine(x
, y_mid
, x
, oldY
);
2442 void wxGenericTreeCtrl::DrawDropEffect(wxGenericTreeItem
*item
)
2446 if ( item
->HasPlus() )
2448 // it's a folder, indicate it by a border
2453 // draw a line under the drop target because the item will be
2455 DrawLine(item
, TRUE
/* below */);
2458 SetCursor(wxCURSOR_BULLSEYE
);
2463 SetCursor(wxCURSOR_NO_ENTRY
);
2467 void wxGenericTreeCtrl::DrawBorder(const wxTreeItemId
&item
)
2469 wxCHECK_RET( item
.IsOk(), _T("invalid item in wxGenericTreeCtrl::DrawLine") );
2471 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
2473 wxClientDC
dc(this);
2475 dc
.SetLogicalFunction(wxINVERT
);
2476 dc
.SetBrush(*wxTRANSPARENT_BRUSH
);
2478 int w
= i
->GetWidth() + 2;
2479 int h
= GetLineHeight(i
) + 2;
2481 dc
.DrawRectangle( i
->GetX() - 1, i
->GetY() - 1, w
, h
);
2484 void wxGenericTreeCtrl::DrawLine(const wxTreeItemId
&item
, bool below
)
2486 wxCHECK_RET( item
.IsOk(), _T("invalid item in wxGenericTreeCtrl::DrawLine") );
2488 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
2490 wxClientDC
dc(this);
2492 dc
.SetLogicalFunction(wxINVERT
);
2498 y
+= GetLineHeight(i
) - 1;
2501 dc
.DrawLine( x
, y
, x
+ i
->GetWidth(), y
);
2504 // -----------------------------------------------------------------------------
2505 // wxWindows callbacks
2506 // -----------------------------------------------------------------------------
2508 void wxGenericTreeCtrl::OnPaint( wxPaintEvent
&WXUNUSED(event
) )
2516 dc
.SetFont( m_normalFont
);
2517 dc
.SetPen( m_dottedPen
);
2519 // this is now done dynamically
2520 //if(GetImageList() == NULL)
2521 // m_lineHeight = (int)(dc.GetCharHeight() + 4);
2524 PaintLevel( m_anchor
, dc
, 0, y
);
2527 void wxGenericTreeCtrl::OnSetFocus( wxFocusEvent
&event
)
2536 void wxGenericTreeCtrl::OnKillFocus( wxFocusEvent
&event
)
2545 void wxGenericTreeCtrl::OnChar( wxKeyEvent
&event
)
2547 wxTreeEvent
te( wxEVT_COMMAND_TREE_KEY_DOWN
, GetId() );
2548 te
.m_evtKey
= event
;
2549 te
.SetEventObject( this );
2550 if ( GetEventHandler()->ProcessEvent( te
) )
2552 // intercepted by the user code
2556 if ( (m_current
== 0) || (m_key_current
== 0) )
2562 // how should the selection work for this event?
2563 bool is_multiple
, extended_select
, unselect_others
;
2564 EventFlagsToSelType(GetWindowStyleFlag(),
2566 event
.ControlDown(),
2567 is_multiple
, extended_select
, unselect_others
);
2571 // * : Expand all/Collapse all
2572 // ' ' | return : activate
2573 // up : go up (not last children!)
2575 // left : go to parent
2576 // right : open if parent and go next
2577 // home : go to root
2578 // end : go to last item without opening parents
2579 // alnum : start or continue searching for the item with this prefix
2580 int keyCode
= event
.GetKeyCode();
2585 if (m_current
->HasPlus() && !IsExpanded(m_current
))
2593 if ( !IsExpanded(m_current
) )
2596 ExpandAll(m_current
);
2599 //else: fall through to Collapse() it
2603 if (IsExpanded(m_current
))
2605 Collapse(m_current
);
2611 if ( !event
.HasModifiers() )
2613 wxTreeEvent
event( wxEVT_COMMAND_TREE_ITEM_ACTIVATED
, GetId() );
2614 event
.m_item
= (long) m_current
;
2615 event
.SetEventObject( this );
2616 GetEventHandler()->ProcessEvent( event
);
2619 // in any case, also generate the normal key event for this key,
2620 // even if we generated the ACTIVATED event above: this is what
2621 // wxMSW does and it makes sense because you might not want to
2622 // process ACTIVATED event at all and handle Space and Return
2623 // directly (and differently) which would be impossible otherwise
2627 // up goes to the previous sibling or to the last
2628 // of its children if it's expanded
2631 wxTreeItemId prev
= GetPrevSibling( m_key_current
);
2634 prev
= GetItemParent( m_key_current
);
2635 if ((prev
== GetRootItem()) && HasFlag(wxTR_HIDE_ROOT
))
2637 break; // don't go to root if it is hidden
2642 wxTreeItemId current
= m_key_current
;
2643 // TODO: Huh? If we get here, we'd better be the first child of our parent. How else could it be?
2644 if (current
== GetFirstChild( prev
, cookie
))
2646 // otherwise we return to where we came from
2647 SelectItem( prev
, unselect_others
, extended_select
);
2648 m_key_current
= (wxGenericTreeItem
*) prev
.m_pItem
;
2655 while ( IsExpanded(prev
) && HasChildren(prev
) )
2657 wxTreeItemId child
= GetLastChild(prev
);
2664 SelectItem( prev
, unselect_others
, extended_select
);
2665 m_key_current
=(wxGenericTreeItem
*) prev
.m_pItem
;
2670 // left arrow goes to the parent
2673 wxTreeItemId prev
= GetItemParent( m_current
);
2674 if ((prev
== GetRootItem()) && HasFlag(wxTR_HIDE_ROOT
))
2676 // don't go to root if it is hidden
2677 prev
= GetPrevSibling( m_current
);
2681 SelectItem( prev
, unselect_others
, extended_select
);
2687 // this works the same as the down arrow except that we
2688 // also expand the item if it wasn't expanded yet
2694 if (IsExpanded(m_key_current
) && HasChildren(m_key_current
))
2697 wxTreeItemId child
= GetFirstChild( m_key_current
, cookie
);
2698 SelectItem( child
, unselect_others
, extended_select
);
2699 m_key_current
=(wxGenericTreeItem
*) child
.m_pItem
;
2703 wxTreeItemId next
= GetNextSibling( m_key_current
);
2706 wxTreeItemId current
= m_key_current
;
2707 while (current
&& !next
)
2709 current
= GetItemParent( current
);
2710 if (current
) next
= GetNextSibling( current
);
2715 SelectItem( next
, unselect_others
, extended_select
);
2716 m_key_current
=(wxGenericTreeItem
*) next
.m_pItem
;
2722 // <End> selects the last visible tree item
2725 wxTreeItemId last
= GetRootItem();
2727 while ( last
.IsOk() && IsExpanded(last
) )
2729 wxTreeItemId lastChild
= GetLastChild(last
);
2731 // it may happen if the item was expanded but then all of
2732 // its children have been deleted - so IsExpanded() returned
2733 // TRUE, but GetLastChild() returned invalid item
2742 SelectItem( last
, unselect_others
, extended_select
);
2747 // <Home> selects the root item
2750 wxTreeItemId prev
= GetRootItem();
2754 if ( HasFlag(wxTR_HIDE_ROOT
) )
2757 prev
= GetFirstChild(prev
, dummy
);
2762 SelectItem( prev
, unselect_others
, extended_select
);
2767 // do not use wxIsalnum() here
2768 if ( !event
.HasModifiers() &&
2769 ((keyCode
>= '0' && keyCode
<= '9') ||
2770 (keyCode
>= 'a' && keyCode
<= 'z') ||
2771 (keyCode
>= 'A' && keyCode
<= 'Z' )))
2773 // find the next item starting with the given prefix
2774 char ch
= (char)keyCode
;
2776 wxTreeItemId id
= FindItem(m_current
, m_findPrefix
+ (wxChar
)ch
);
2787 // also start the timer to reset the current prefix if the user
2788 // doesn't press any more alnum keys soon -- we wouldn't want
2789 // to use this prefix for a new item search
2792 m_findTimer
= new wxTreeFindTimer(this);
2795 m_findTimer
->Start(wxTreeFindTimer::DELAY
, wxTIMER_ONE_SHOT
);
2804 wxTreeItemId
wxGenericTreeCtrl::HitTest(const wxPoint
& point
, int& flags
)
2806 // JACS: removed wxYieldIfNeeded() because it can cause the window
2807 // to be deleted from under us if a close window event is pending
2812 if (point
.x
<0) flags
|= wxTREE_HITTEST_TOLEFT
;
2813 if (point
.x
>w
) flags
|= wxTREE_HITTEST_TORIGHT
;
2814 if (point
.y
<0) flags
|= wxTREE_HITTEST_ABOVE
;
2815 if (point
.y
>h
) flags
|= wxTREE_HITTEST_BELOW
;
2816 if (flags
) return wxTreeItemId();
2818 if (m_anchor
== NULL
)
2820 flags
= wxTREE_HITTEST_NOWHERE
;
2821 return wxTreeItemId();
2824 wxGenericTreeItem
*hit
= m_anchor
->HitTest(CalcUnscrolledPosition(point
),
2828 flags
= wxTREE_HITTEST_NOWHERE
;
2829 return wxTreeItemId();
2834 // get the bounding rectangle of the item (or of its label only)
2835 bool wxGenericTreeCtrl::GetBoundingRect(const wxTreeItemId
& item
,
2837 bool WXUNUSED(textOnly
)) const
2839 wxCHECK_MSG( item
.IsOk(), FALSE
, _T("invalid item in wxGenericTreeCtrl::GetBoundingRect") );
2841 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
2844 GetViewStart(& startX
, & startY
);
2846 rect
.x
= i
->GetX() - startX
*PIXELS_PER_UNIT
;
2847 rect
.y
= i
->GetY() - startY
*PIXELS_PER_UNIT
;
2848 rect
.width
= i
->GetWidth();
2849 //rect.height = i->GetHeight();
2850 rect
.height
= GetLineHeight(i
);
2855 void wxGenericTreeCtrl::Edit( const wxTreeItemId
& item
)
2857 wxCHECK_RET( item
.IsOk(), _T("can't edit an invalid item") );
2859 wxGenericTreeItem
*itemEdit
= (wxGenericTreeItem
*)item
.m_pItem
;
2861 wxTreeEvent
te( wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT
, GetId() );
2862 te
.m_item
= (long) itemEdit
;
2863 te
.SetEventObject( this );
2864 if ( GetEventHandler()->ProcessEvent( te
) && !te
.IsAllowed() )
2870 // We have to call this here because the label in
2871 // question might just have been added and no screen
2872 // update taken place.
2876 m_textCtrl
= new wxTreeTextCtrl(this, itemEdit
);
2878 m_textCtrl
->SetFocus();
2881 // returns a pointer to the text edit control if the item is being
2882 // edited, NULL otherwise (it's assumed that no more than one item may
2883 // be edited simultaneously)
2884 wxTextCtrl
* wxGenericTreeCtrl::GetEditControl() const
2889 bool wxGenericTreeCtrl::OnRenameAccept(wxGenericTreeItem
*item
,
2890 const wxString
& value
)
2892 wxTreeEvent
le( wxEVT_COMMAND_TREE_END_LABEL_EDIT
, GetId() );
2893 le
.m_item
= (long) item
;
2894 le
.SetEventObject( this );
2896 le
.m_editCancelled
= FALSE
;
2898 return !GetEventHandler()->ProcessEvent( le
) || le
.IsAllowed();
2901 void wxGenericTreeCtrl::OnRenameCancelled(wxGenericTreeItem
*item
)
2903 // let owner know that the edit was cancelled
2904 wxTreeEvent
le( wxEVT_COMMAND_TREE_END_LABEL_EDIT
, GetId() );
2905 le
.m_item
= (long) item
;
2906 le
.SetEventObject( this );
2907 le
.m_label
= wxEmptyString
;
2908 le
.m_editCancelled
= FALSE
;
2910 GetEventHandler()->ProcessEvent( le
);
2916 void wxGenericTreeCtrl::OnRenameTimer()
2921 void wxGenericTreeCtrl::OnMouse( wxMouseEvent
&event
)
2923 if ( !m_anchor
) return;
2925 // we process left mouse up event (enables in-place edit), right down
2926 // (pass to the user code), left dbl click (activate item) and
2927 // dragging/moving events for items drag-and-drop
2928 if ( !(event
.LeftDown() ||
2930 event
.RightDown() ||
2931 event
.LeftDClick() ||
2933 ((event
.Moving() || event
.RightUp()) && m_isDragging
)) )
2940 wxPoint pt
= CalcUnscrolledPosition(event
.GetPosition());
2943 wxGenericTreeItem
*item
= m_anchor
->HitTest(pt
, this, flags
, 0);
2945 if ( event
.Dragging() && !m_isDragging
)
2947 if (m_dragCount
== 0)
2952 if (m_dragCount
!= 3)
2954 // wait until user drags a bit further...
2958 wxEventType command
= event
.RightIsDown()
2959 ? wxEVT_COMMAND_TREE_BEGIN_RDRAG
2960 : wxEVT_COMMAND_TREE_BEGIN_DRAG
;
2962 wxTreeEvent
nevent( command
, GetId() );
2963 nevent
.m_item
= (long) m_current
;
2964 nevent
.SetEventObject(this);
2966 // by default the dragging is not supported, the user code must
2967 // explicitly allow the event for it to take place
2970 if ( GetEventHandler()->ProcessEvent(nevent
) && nevent
.IsAllowed() )
2972 // we're going to drag this item
2973 m_isDragging
= TRUE
;
2975 // remember the old cursor because we will change it while
2977 m_oldCursor
= m_cursor
;
2979 // in a single selection control, hide the selection temporarily
2980 if ( !(GetWindowStyleFlag() & wxTR_MULTIPLE
) )
2982 m_oldSelection
= (wxGenericTreeItem
*) GetSelection().m_pItem
;
2984 if ( m_oldSelection
)
2986 m_oldSelection
->SetHilight(FALSE
);
2987 RefreshLine(m_oldSelection
);
2994 else if ( event
.Moving() )
2996 if ( item
!= m_dropTarget
)
2998 // unhighlight the previous drop target
2999 DrawDropEffect(m_dropTarget
);
3001 m_dropTarget
= item
;
3003 // highlight the current drop target if any
3004 DrawDropEffect(m_dropTarget
);
3009 else if ( (event
.LeftUp() || event
.RightUp()) && m_isDragging
)
3011 // erase the highlighting
3012 DrawDropEffect(m_dropTarget
);
3014 if ( m_oldSelection
)
3016 m_oldSelection
->SetHilight(TRUE
);
3017 RefreshLine(m_oldSelection
);
3018 m_oldSelection
= (wxGenericTreeItem
*)NULL
;
3021 // generate the drag end event
3022 wxTreeEvent
event(wxEVT_COMMAND_TREE_END_DRAG
, GetId());
3024 event
.m_item
= (long) item
;
3025 event
.m_pointDrag
= pt
;
3026 event
.SetEventObject(this);
3028 (void)GetEventHandler()->ProcessEvent(event
);
3030 m_isDragging
= FALSE
;
3031 m_dropTarget
= (wxGenericTreeItem
*)NULL
;
3035 SetCursor(m_oldCursor
);
3041 // here we process only the messages which happen on tree items
3045 if (item
== NULL
) return; /* we hit the blank area */
3047 if ( event
.RightDown() )
3049 wxTreeEvent
nevent(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK
, GetId());
3050 nevent
.m_item
= (long) item
;
3051 nevent
.m_pointDrag
= CalcScrolledPosition(pt
);
3052 nevent
.SetEventObject(this);
3053 GetEventHandler()->ProcessEvent(nevent
);
3055 else if ( event
.LeftUp() )
3059 if ( (item
== m_current
) &&
3060 (flags
& wxTREE_HITTEST_ONITEMLABEL
) &&
3061 HasFlag(wxTR_EDIT_LABELS
) )
3063 if ( m_renameTimer
)
3065 if ( m_renameTimer
->IsRunning() )
3066 m_renameTimer
->Stop();
3070 m_renameTimer
= new wxTreeRenameTimer( this );
3073 m_renameTimer
->Start( wxTreeRenameTimer::DELAY
, TRUE
);
3076 m_lastOnSame
= FALSE
;
3079 else // !RightDown() && !LeftUp() ==> LeftDown() || LeftDClick()
3081 if ( event
.LeftDown() )
3083 m_lastOnSame
= item
== m_current
;
3086 if ( flags
& wxTREE_HITTEST_ONITEMBUTTON
)
3088 // only toggle the item for a single click, double click on
3089 // the button doesn't do anything (it toggles the item twice)
3090 if ( event
.LeftDown() )
3095 // don't select the item if the button was clicked
3099 // how should the selection work for this event?
3100 bool is_multiple
, extended_select
, unselect_others
;
3101 EventFlagsToSelType(GetWindowStyleFlag(),
3103 event
.ControlDown(),
3104 is_multiple
, extended_select
, unselect_others
);
3106 SelectItem(item
, unselect_others
, extended_select
);
3108 // For some reason, Windows isn't recognizing a left double-click,
3109 // so we need to simulate it here. Allow 200 milliseconds for now.
3110 if ( event
.LeftDClick() )
3112 // double clicking should not start editing the item label
3113 if ( m_renameTimer
)
3114 m_renameTimer
->Stop();
3116 m_lastOnSame
= FALSE
;
3118 // send activate event first
3119 wxTreeEvent
nevent( wxEVT_COMMAND_TREE_ITEM_ACTIVATED
, GetId() );
3120 nevent
.m_item
= (long) item
;
3121 nevent
.m_pointDrag
= CalcScrolledPosition(pt
);
3122 nevent
.SetEventObject( this );
3123 if ( !GetEventHandler()->ProcessEvent( nevent
) )
3125 // if the user code didn't process the activate event,
3126 // handle it ourselves by toggling the item when it is
3128 if ( item
->HasPlus() )
3138 void wxGenericTreeCtrl::OnIdle( wxIdleEvent
&WXUNUSED(event
) )
3140 /* after all changes have been done to the tree control,
3141 * we actually redraw the tree when everything is over */
3143 if (!m_dirty
) return;
3147 CalculatePositions();
3149 AdjustMyScrollbars();
3152 void wxGenericTreeCtrl::CalculateSize( wxGenericTreeItem
*item
, wxDC
&dc
)
3157 wxTreeItemAttr
*attr
= item
->GetAttributes();
3158 if ( attr
&& attr
->HasFont() )
3159 dc
.SetFont(attr
->GetFont());
3160 else if ( item
->IsBold() )
3161 dc
.SetFont(m_boldFont
);
3163 dc
.GetTextExtent( item
->GetText(), &text_w
, &text_h
);
3166 // restore normal font
3167 dc
.SetFont( m_normalFont
);
3171 int image
= item
->GetCurrentImage();
3172 if ( image
!= NO_IMAGE
)
3174 if ( m_imageListNormal
)
3176 m_imageListNormal
->GetSize( image
, image_w
, image_h
);
3181 int total_h
= (image_h
> text_h
) ? image_h
: text_h
;
3184 total_h
+= 2; // at least 2 pixels
3186 total_h
+= total_h
/10; // otherwise 10% extra spacing
3188 item
->SetHeight(total_h
);
3189 if (total_h
>m_lineHeight
)
3190 m_lineHeight
=total_h
;
3192 item
->SetWidth(image_w
+text_w
+2);
3195 // -----------------------------------------------------------------------------
3196 // for developper : y is now the top of the level
3197 // not the middle of it !
3198 void wxGenericTreeCtrl::CalculateLevel( wxGenericTreeItem
*item
, wxDC
&dc
, int level
, int &y
)
3200 int x
= level
*m_indent
;
3201 if (!HasFlag(wxTR_HIDE_ROOT
))
3205 else if (level
== 0)
3207 // a hidden root is not evaluated, but its
3208 // children are always calculated
3212 CalculateSize( item
, dc
);
3215 item
->SetX( x
+m_spacing
);
3217 y
+= GetLineHeight(item
);
3219 if ( !item
->IsExpanded() )
3221 // we don't need to calculate collapsed branches
3226 wxArrayGenericTreeItems
& children
= item
->GetChildren();
3227 size_t n
, count
= children
.Count();
3229 for (n
= 0; n
< count
; ++n
)
3230 CalculateLevel( children
[n
], dc
, level
, y
); // recurse
3233 void wxGenericTreeCtrl::CalculatePositions()
3235 if ( !m_anchor
) return;
3237 wxClientDC
dc(this);
3240 dc
.SetFont( m_normalFont
);
3242 dc
.SetPen( m_dottedPen
);
3243 //if(GetImageList() == NULL)
3244 // m_lineHeight = (int)(dc.GetCharHeight() + 4);
3247 CalculateLevel( m_anchor
, dc
, 0, y
); // start recursion
3250 void wxGenericTreeCtrl::RefreshSubtree(wxGenericTreeItem
*item
)
3252 if (m_dirty
) return;
3254 wxSize client
= GetClientSize();
3257 CalcScrolledPosition(0, item
->GetY(), NULL
, &rect
.y
);
3258 rect
.width
= client
.x
;
3259 rect
.height
= client
.y
;
3261 Refresh(TRUE
, &rect
);
3263 AdjustMyScrollbars();
3266 void wxGenericTreeCtrl::RefreshLine( wxGenericTreeItem
*item
)
3268 if (m_dirty
) return;
3271 CalcScrolledPosition(0, item
->GetY(), NULL
, &rect
.y
);
3272 rect
.width
= GetClientSize().x
;
3273 rect
.height
= GetLineHeight(item
); //dc.GetCharHeight() + 6;
3275 Refresh(TRUE
, &rect
);
3278 void wxGenericTreeCtrl::RefreshSelected()
3280 // TODO: this is awfully inefficient, we should keep the list of all
3281 // selected items internally, should be much faster
3283 RefreshSelectedUnder(m_anchor
);
3286 void wxGenericTreeCtrl::RefreshSelectedUnder(wxGenericTreeItem
*item
)
3288 if ( item
->IsSelected() )
3291 const wxArrayGenericTreeItems
& children
= item
->GetChildren();
3292 size_t count
= children
.GetCount();
3293 for ( size_t n
= 0; n
< count
; n
++ )
3295 RefreshSelectedUnder(children
[n
]);
3299 // ----------------------------------------------------------------------------
3300 // changing colours: we need to refresh the tree control
3301 // ----------------------------------------------------------------------------
3303 bool wxGenericTreeCtrl::SetBackgroundColour(const wxColour
& colour
)
3305 if ( !wxWindow::SetBackgroundColour(colour
) )
3313 bool wxGenericTreeCtrl::SetForegroundColour(const wxColour
& colour
)
3315 if ( !wxWindow::SetForegroundColour(colour
) )
3323 #endif // wxUSE_TREECTRL