1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/generic/treectlg.cpp
3 // Purpose: generic tree control implementation
4 // Author: Robert Roebling
6 // Modified: 22/10/98 - almost total rewrite, simpler interface (VZ)
8 // Copyright: (c) 1998 Robert Roebling and Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // =============================================================================
14 // =============================================================================
16 // -----------------------------------------------------------------------------
18 // -----------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
29 #include "wx/treectrl.h"
32 #include "wx/dcclient.h"
34 #include "wx/settings.h"
35 #include "wx/listbox.h"
36 #include "wx/textctrl.h"
39 #include "wx/generic/treectlg.h"
40 #include "wx/imaglist.h"
42 #include "wx/renderer.h"
45 #include "wx/osx/private.h"
48 // -----------------------------------------------------------------------------
50 // -----------------------------------------------------------------------------
52 class WXDLLIMPEXP_FWD_CORE wxGenericTreeItem
;
54 WX_DEFINE_ARRAY_PTR(wxGenericTreeItem
*, wxArrayGenericTreeItems
);
56 // ----------------------------------------------------------------------------
58 // ----------------------------------------------------------------------------
60 static const int NO_IMAGE
= -1;
62 static const int PIXELS_PER_UNIT
= 10;
64 // the margin between the item state image and the item normal image
65 static const int MARGIN_BETWEEN_STATE_AND_IMAGE
= 2;
67 // the margin between the item image and the item text
68 static const int MARGIN_BETWEEN_IMAGE_AND_TEXT
= 4;
70 // -----------------------------------------------------------------------------
72 // -----------------------------------------------------------------------------
74 // timer used for enabling in-place edit
75 class WXDLLEXPORT wxTreeRenameTimer
: public wxTimer
78 // start editing the current item after half a second (if the mouse hasn't
79 // been clicked/moved)
82 wxTreeRenameTimer( wxGenericTreeCtrl
*owner
);
84 virtual void Notify();
87 wxGenericTreeCtrl
*m_owner
;
89 DECLARE_NO_COPY_CLASS(wxTreeRenameTimer
)
92 // control used for in-place edit
93 class WXDLLEXPORT wxTreeTextCtrl
: public wxTextCtrl
96 wxTreeTextCtrl(wxGenericTreeCtrl
*owner
, wxGenericTreeItem
*item
);
98 void EndEdit( bool discardChanges
);
100 const wxGenericTreeItem
* item() const { return m_itemEdited
; }
103 void OnChar( wxKeyEvent
&event
);
104 void OnKeyUp( wxKeyEvent
&event
);
105 void OnKillFocus( wxFocusEvent
&event
);
107 bool AcceptChanges();
108 void Finish( bool setfocus
);
111 wxGenericTreeCtrl
*m_owner
;
112 wxGenericTreeItem
*m_itemEdited
;
113 wxString m_startValue
;
114 bool m_aboutToFinish
;
116 DECLARE_EVENT_TABLE()
117 DECLARE_NO_COPY_CLASS(wxTreeTextCtrl
)
120 // timer used to clear wxGenericTreeCtrl::m_findPrefix if no key was pressed
121 // for a sufficiently long time
122 class WXDLLEXPORT wxTreeFindTimer
: public wxTimer
125 // reset the current prefix after half a second of inactivity
126 enum { DELAY
= 500 };
128 wxTreeFindTimer( wxGenericTreeCtrl
*owner
) { m_owner
= owner
; }
130 virtual void Notify() { m_owner
->m_findPrefix
.clear(); }
133 wxGenericTreeCtrl
*m_owner
;
135 DECLARE_NO_COPY_CLASS(wxTreeFindTimer
)
139 class WXDLLEXPORT wxGenericTreeItem
150 wxGenericTreeItem( wxGenericTreeItem
*parent
,
151 const wxString
& text
,
154 wxTreeItemData
*data
);
156 ~wxGenericTreeItem();
159 wxArrayGenericTreeItems
& GetChildren() { return m_children
; }
161 const wxString
& GetText() const { return m_text
; }
162 int GetImage(wxTreeItemIcon which
= wxTreeItemIcon_Normal
) const
163 { return m_images
[which
]; }
164 wxTreeItemData
*GetData() const { return m_data
; }
165 int GetState() const { return m_state
; }
167 // returns the current image for the item (depending on its
168 // selected/expanded/whatever state)
169 int GetCurrentImage() const;
171 void SetText(const wxString
& text
)
178 void SetImage(int image
, wxTreeItemIcon which
)
180 m_images
[which
] = image
;
184 void SetData(wxTreeItemData
*data
) { m_data
= data
; }
185 void SetState(int state
) { m_state
= state
; m_width
= 0; }
187 void SetHasPlus(bool has
= true) { m_hasPlus
= has
; }
189 void SetBold(bool bold
)
196 int GetX() const { return m_x
; }
197 int GetY() const { return m_y
; }
199 void SetX(int x
) { m_x
= x
; }
200 void SetY(int y
) { m_y
= y
; }
202 int GetHeight() const { return m_height
; }
203 int GetWidth() const { return m_width
; }
205 int GetTextHeight() const
207 wxASSERT_MSG( m_heightText
!= -1, "must call CalculateSize() first" );
212 int GetTextWidth() const
214 wxASSERT_MSG( m_widthText
!= -1, "must call CalculateSize() first" );
219 wxGenericTreeItem
*GetParent() const { return m_parent
; }
221 // sets the items font for the specified DC if it uses any special font or
222 // simply returns false otherwise
223 bool SetFont(wxGenericTreeCtrl
*control
, wxDC
& dc
) const
227 wxTreeItemAttr
* const attr
= GetAttributes();
228 if ( attr
&& attr
->HasFont() )
229 font
= attr
->GetFont();
231 font
= control
->m_boldFont
;
241 // deletes all children notifying the treectrl about it
242 void DeleteChildren(wxGenericTreeCtrl
*tree
);
244 // get count of all children (and grand children if 'recursively')
245 size_t GetChildrenCount(bool recursively
= true) const;
247 void Insert(wxGenericTreeItem
*child
, size_t index
)
248 { m_children
.Insert(child
, index
); }
250 // calculate and cache the item size using either the provided DC (which is
251 // supposed to have wxGenericTreeCtrl::m_normalFont selected into it!) or a
252 // wxClientDC on the control window
253 void CalculateSize(wxGenericTreeCtrl
*control
, wxDC
& dc
)
254 { DoCalculateSize(control
, dc
, true /* dc uses normal font */); }
255 void CalculateSize(wxGenericTreeCtrl
*control
);
257 void GetSize( int &x
, int &y
, const wxGenericTreeCtrl
* );
259 void ResetSize() { m_width
= 0; }
260 void ResetTextSize() { m_width
= 0; m_widthText
= -1; }
261 void RecursiveResetSize();
262 void RecursiveResetTextSize();
264 // return the item at given position (or NULL if no item), onButton is
265 // true if the point belongs to the item's button, otherwise it lies
266 // on the item's label
267 wxGenericTreeItem
*HitTest( const wxPoint
& point
,
268 const wxGenericTreeCtrl
*,
272 void Expand() { m_isCollapsed
= false; }
273 void Collapse() { m_isCollapsed
= true; }
275 void SetHilight( bool set
= true ) { m_hasHilight
= set
; }
278 bool HasChildren() const { return !m_children
.IsEmpty(); }
279 bool IsSelected() const { return m_hasHilight
!= 0; }
280 bool IsExpanded() const { return !m_isCollapsed
; }
281 bool HasPlus() const { return m_hasPlus
|| HasChildren(); }
282 bool IsBold() const { return m_isBold
!= 0; }
285 // get them - may be NULL
286 wxTreeItemAttr
*GetAttributes() const { return m_attr
; }
287 // get them ensuring that the pointer is not NULL
288 wxTreeItemAttr
& Attr()
292 m_attr
= new wxTreeItemAttr
;
298 void SetAttributes(wxTreeItemAttr
*attr
)
300 if ( m_ownsAttr
) delete m_attr
;
306 // set them and delete when done
307 void AssignAttributes(wxTreeItemAttr
*attr
)
316 // calculate the size of this item, i.e. set m_width, m_height and
317 // m_widthText and m_heightText properly
319 // if dcUsesNormalFont is true, the current dc font must be the normal tree
321 void DoCalculateSize(wxGenericTreeCtrl
*control
,
323 bool dcUsesNormalFont
);
325 // since there can be very many of these, we save size by chosing
326 // the smallest representation for the elements and by ordering
327 // the members to avoid padding.
328 wxString m_text
; // label to be rendered for item
332 wxTreeItemData
*m_data
; // user-provided data
334 int m_state
; // item state
336 wxArrayGenericTreeItems m_children
; // list of children
337 wxGenericTreeItem
*m_parent
; // parent of this item
339 wxTreeItemAttr
*m_attr
; // attributes???
341 // tree ctrl images for the normal, selected, expanded and
342 // expanded+selected states
343 int m_images
[wxTreeItemIcon_Max
];
345 wxCoord m_x
; // (virtual) offset from top
346 wxCoord m_y
; // (virtual) offset from left
347 int m_width
; // width of this item
348 int m_height
; // height of this item
350 // use bitfields to save size
351 unsigned int m_isCollapsed
:1;
352 unsigned int m_hasHilight
:1; // same as focused
353 unsigned int m_hasPlus
:1; // used for item which doesn't have
354 // children but has a [+] button
355 unsigned int m_isBold
:1; // render the label in bold font
356 unsigned int m_ownsAttr
:1; // delete attribute when done
358 DECLARE_NO_COPY_CLASS(wxGenericTreeItem
)
361 // =============================================================================
363 // =============================================================================
365 // ----------------------------------------------------------------------------
367 // ----------------------------------------------------------------------------
369 // translate the key or mouse event flags to the type of selection we're
371 static void EventFlagsToSelType(long style
,
375 bool &extended_select
,
376 bool &unselect_others
)
378 is_multiple
= (style
& wxTR_MULTIPLE
) != 0;
379 extended_select
= shiftDown
&& is_multiple
;
380 unselect_others
= !(extended_select
|| (ctrlDown
&& is_multiple
));
383 // check if the given item is under another one
385 IsDescendantOf(const wxGenericTreeItem
*parent
, const wxGenericTreeItem
*item
)
389 if ( item
== parent
)
391 // item is a descendant of parent
395 item
= item
->GetParent();
401 // -----------------------------------------------------------------------------
402 // wxTreeRenameTimer (internal)
403 // -----------------------------------------------------------------------------
405 wxTreeRenameTimer::wxTreeRenameTimer( wxGenericTreeCtrl
*owner
)
410 void wxTreeRenameTimer::Notify()
412 m_owner
->OnRenameTimer();
415 //-----------------------------------------------------------------------------
416 // wxTreeTextCtrl (internal)
417 //-----------------------------------------------------------------------------
419 BEGIN_EVENT_TABLE(wxTreeTextCtrl
,wxTextCtrl
)
420 EVT_CHAR (wxTreeTextCtrl::OnChar
)
421 EVT_KEY_UP (wxTreeTextCtrl::OnKeyUp
)
422 EVT_KILL_FOCUS (wxTreeTextCtrl::OnKillFocus
)
425 wxTreeTextCtrl::wxTreeTextCtrl(wxGenericTreeCtrl
*owner
,
426 wxGenericTreeItem
*item
)
427 : m_itemEdited(item
), m_startValue(item
->GetText())
430 m_aboutToFinish
= false;
432 int w
= m_itemEdited
->GetWidth(),
433 h
= m_itemEdited
->GetHeight();
436 m_owner
->CalcScrolledPosition(item
->GetX(), item
->GetY(), &x
, &y
);
441 int image
= item
->GetCurrentImage();
442 if ( image
!= NO_IMAGE
)
444 if ( m_owner
->m_imageListNormal
)
446 m_owner
->m_imageListNormal
->GetSize( image
, image_w
, image_h
);
447 image_w
+= MARGIN_BETWEEN_IMAGE_AND_TEXT
;
451 wxFAIL_MSG(_T("you must create an image list to use images!"));
455 // FIXME: what are all these hardcoded 4, 8 and 11s really?
459 wxSize bs
= DoGetBestSize() ;
460 // edit control height
463 int diff
= h
- ( bs
.y
- 8 ) ;
469 (void)Create(m_owner
, wxID_ANY
, m_startValue
,
470 wxPoint(x
- 4, y
- 4), wxSize(w
+ 11, h
+ 8));
473 void wxTreeTextCtrl::EndEdit(bool discardChanges
)
475 m_aboutToFinish
= true;
477 if ( discardChanges
)
479 m_owner
->OnRenameCancelled(m_itemEdited
);
485 // Notify the owner about the changes
488 // Even if vetoed, close the control (consistent with MSW)
493 bool wxTreeTextCtrl::AcceptChanges()
495 const wxString value
= GetValue();
497 if ( value
== m_startValue
)
499 // nothing changed, always accept
500 // when an item remains unchanged, the owner
501 // needs to be notified that the user decided
502 // not to change the tree item label, and that
503 // the edit has been cancelled
505 m_owner
->OnRenameCancelled(m_itemEdited
);
509 if ( !m_owner
->OnRenameAccept(m_itemEdited
, value
) )
511 // vetoed by the user
515 // accepted, do rename the item
516 m_owner
->SetItemText(m_itemEdited
, value
);
521 void wxTreeTextCtrl::Finish( bool setfocus
)
523 m_owner
->ResetTextControl();
525 wxPendingDelete
.Append(this);
531 void wxTreeTextCtrl::OnChar( wxKeyEvent
&event
)
533 switch ( event
.m_keyCode
)
548 void wxTreeTextCtrl::OnKeyUp( wxKeyEvent
&event
)
550 if ( !m_aboutToFinish
)
552 // auto-grow the textctrl:
553 wxSize parentSize
= m_owner
->GetSize();
554 wxPoint myPos
= GetPosition();
555 wxSize mySize
= GetSize();
557 GetTextExtent(GetValue() + _T("M"), &sx
, &sy
);
558 if (myPos
.x
+ sx
> parentSize
.x
)
559 sx
= parentSize
.x
- myPos
.x
;
562 SetSize(sx
, wxDefaultCoord
);
568 void wxTreeTextCtrl::OnKillFocus( wxFocusEvent
&event
)
570 if ( !m_aboutToFinish
)
572 if ( !AcceptChanges() )
573 m_owner
->OnRenameCancelled( m_itemEdited
);
578 // We should let the native text control handle focus, too.
582 // -----------------------------------------------------------------------------
584 // -----------------------------------------------------------------------------
586 wxGenericTreeItem::wxGenericTreeItem(wxGenericTreeItem
*parent
,
587 const wxString
& text
,
588 int image
, int selImage
,
589 wxTreeItemData
*data
)
592 m_images
[wxTreeItemIcon_Normal
] = image
;
593 m_images
[wxTreeItemIcon_Selected
] = selImage
;
594 m_images
[wxTreeItemIcon_Expanded
] = NO_IMAGE
;
595 m_images
[wxTreeItemIcon_SelectedExpanded
] = NO_IMAGE
;
598 m_state
= wxTREE_ITEMSTATE_NONE
;
601 m_isCollapsed
= true;
602 m_hasHilight
= false;
611 // We don't know the height here yet.
619 wxGenericTreeItem::~wxGenericTreeItem()
623 if (m_ownsAttr
) delete m_attr
;
625 wxASSERT_MSG( m_children
.IsEmpty(),
626 "must call DeleteChildren() before deleting the item" );
629 void wxGenericTreeItem::DeleteChildren(wxGenericTreeCtrl
*tree
)
631 size_t count
= m_children
.GetCount();
632 for ( size_t n
= 0; n
< count
; n
++ )
634 wxGenericTreeItem
*child
= m_children
[n
];
635 tree
->SendDeleteEvent(child
);
637 child
->DeleteChildren(tree
);
638 if ( child
== tree
->m_select_me
)
639 tree
->m_select_me
= NULL
;
646 size_t wxGenericTreeItem::GetChildrenCount(bool recursively
) const
648 size_t count
= m_children
.GetCount();
652 size_t total
= count
;
653 for (size_t n
= 0; n
< count
; ++n
)
655 total
+= m_children
[n
]->GetChildrenCount();
661 void wxGenericTreeItem::GetSize( int &x
, int &y
,
662 const wxGenericTreeCtrl
*theButton
)
664 int bottomY
=m_y
+theButton
->GetLineHeight(this);
665 if ( y
< bottomY
) y
= bottomY
;
666 int width
= m_x
+ m_width
;
667 if ( x
< width
) x
= width
;
671 size_t count
= m_children
.GetCount();
672 for ( size_t n
= 0; n
< count
; ++n
)
674 m_children
[n
]->GetSize( x
, y
, theButton
);
679 wxGenericTreeItem
*wxGenericTreeItem::HitTest(const wxPoint
& point
,
680 const wxGenericTreeCtrl
*theCtrl
,
684 // for a hidden root node, don't evaluate it, but do evaluate children
685 if ( !(level
== 0 && theCtrl
->HasFlag(wxTR_HIDE_ROOT
)) )
688 int h
= theCtrl
->GetLineHeight(this);
689 if ((point
.y
> m_y
) && (point
.y
< m_y
+ h
))
691 int y_mid
= m_y
+ h
/2;
692 if (point
.y
< y_mid
)
693 flags
|= wxTREE_HITTEST_ONITEMUPPERPART
;
695 flags
|= wxTREE_HITTEST_ONITEMLOWERPART
;
697 int xCross
= m_x
- theCtrl
->GetSpacing();
699 // according to the drawing code the triangels are drawn
700 // at -4 , -4 from the position up to +10/+10 max
701 if ((point
.x
> xCross
-4) && (point
.x
< xCross
+10) &&
702 (point
.y
> y_mid
-4) && (point
.y
< y_mid
+10) &&
703 HasPlus() && theCtrl
->HasButtons() )
705 // 5 is the size of the plus sign
706 if ((point
.x
> xCross
-6) && (point
.x
< xCross
+6) &&
707 (point
.y
> y_mid
-6) && (point
.y
< y_mid
+6) &&
708 HasPlus() && theCtrl
->HasButtons() )
711 flags
|= wxTREE_HITTEST_ONITEMBUTTON
;
715 if ((point
.x
>= m_x
) && (point
.x
<= m_x
+m_width
))
720 // assuming every image (normal and selected) has the same size!
721 if ( (GetImage() != NO_IMAGE
) && theCtrl
->m_imageListNormal
)
723 theCtrl
->m_imageListNormal
->GetSize(GetImage(),
730 if ( (GetState() != wxTREE_ITEMSTATE_NONE
) &&
731 theCtrl
->m_imageListState
)
733 theCtrl
->m_imageListState
->GetSize(GetState(),
737 if ((state_w
!= -1) && (point
.x
<= m_x
+ state_w
+ 1))
738 flags
|= wxTREE_HITTEST_ONITEMSTATEICON
;
739 else if ((image_w
!= -1) &&
741 (state_w
!= -1 ? state_w
+
742 MARGIN_BETWEEN_STATE_AND_IMAGE
745 flags
|= wxTREE_HITTEST_ONITEMICON
;
747 flags
|= wxTREE_HITTEST_ONITEMLABEL
;
753 flags
|= wxTREE_HITTEST_ONITEMINDENT
;
754 if (point
.x
> m_x
+m_width
)
755 flags
|= wxTREE_HITTEST_ONITEMRIGHT
;
760 // if children are expanded, fall through to evaluate them
761 if (m_isCollapsed
) return NULL
;
765 size_t count
= m_children
.GetCount();
766 for ( size_t n
= 0; n
< count
; n
++ )
768 wxGenericTreeItem
*res
= m_children
[n
]->HitTest( point
,
779 int wxGenericTreeItem::GetCurrentImage() const
781 int image
= NO_IMAGE
;
786 image
= GetImage(wxTreeItemIcon_SelectedExpanded
);
789 if ( image
== NO_IMAGE
)
791 // we usually fall back to the normal item, but try just the
792 // expanded one (and not selected) first in this case
793 image
= GetImage(wxTreeItemIcon_Expanded
);
799 image
= GetImage(wxTreeItemIcon_Selected
);
802 // maybe it doesn't have the specific image we want,
803 // try the default one instead
804 if ( image
== NO_IMAGE
) image
= GetImage();
809 void wxGenericTreeItem::CalculateSize(wxGenericTreeCtrl
* control
)
811 // check if we need to do anything before creating the DC
815 wxClientDC
dc(control
);
816 DoCalculateSize(control
, dc
, false /* normal font not used */);
820 wxGenericTreeItem::DoCalculateSize(wxGenericTreeCtrl
* control
,
822 bool dcUsesNormalFont
)
824 if ( m_width
!= 0 ) // Size known, nothing to do
827 if ( m_widthText
== -1 )
830 if ( SetFont(control
, dc
) )
834 else // we have no special font
836 if ( !dcUsesNormalFont
)
838 // but we do need to ensure that the normal font is used: notice
839 // that this doesn't count as changing the font as we don't need
841 dc
.SetFont(control
->m_normalFont
);
847 dc
.GetTextExtent( GetText(), &m_widthText
, &m_heightText
);
849 // restore normal font if the DC used it previously and we changed it
851 dc
.SetFont(control
->m_normalFont
);
854 int text_h
= m_heightText
+ 2;
856 int image_h
= 0, image_w
= 0;
857 int image
= GetCurrentImage();
858 if ( image
!= NO_IMAGE
&& control
->m_imageListNormal
)
860 control
->m_imageListNormal
->GetSize(image
, image_w
, image_h
);
861 image_w
+= MARGIN_BETWEEN_IMAGE_AND_TEXT
;
864 int state_h
= 0, state_w
= 0;
865 int state
= GetState();
866 if ( state
!= wxTREE_ITEMSTATE_NONE
&& control
->m_imageListState
)
868 control
->m_imageListState
->GetSize(state
, state_w
, state_h
);
870 state_w
+= MARGIN_BETWEEN_STATE_AND_IMAGE
;
872 state_w
+= MARGIN_BETWEEN_IMAGE_AND_TEXT
;
875 int img_h
= wxMax(state_h
, image_h
);
876 m_height
= wxMax(img_h
, text_h
);
879 m_height
+= 2; // at least 2 pixels
881 m_height
+= m_height
/ 10; // otherwise 10% extra spacing
883 if (m_height
> control
->m_lineHeight
)
884 control
->m_lineHeight
= m_height
;
886 m_width
= state_w
+ image_w
+ m_widthText
+ 2;
889 void wxGenericTreeItem::RecursiveResetSize()
893 const size_t count
= m_children
.Count();
894 for (size_t i
= 0; i
< count
; i
++ )
895 m_children
[i
]->RecursiveResetSize();
898 void wxGenericTreeItem::RecursiveResetTextSize()
903 const size_t count
= m_children
.Count();
904 for (size_t i
= 0; i
< count
; i
++ )
905 m_children
[i
]->RecursiveResetTextSize();
908 // -----------------------------------------------------------------------------
909 // wxGenericTreeCtrl implementation
910 // -----------------------------------------------------------------------------
912 IMPLEMENT_DYNAMIC_CLASS(wxGenericTreeCtrl
, wxControl
)
914 BEGIN_EVENT_TABLE(wxGenericTreeCtrl
, wxTreeCtrlBase
)
915 EVT_PAINT (wxGenericTreeCtrl::OnPaint
)
916 EVT_SIZE (wxGenericTreeCtrl::OnSize
)
917 EVT_MOUSE_EVENTS (wxGenericTreeCtrl::OnMouse
)
918 EVT_CHAR (wxGenericTreeCtrl::OnChar
)
919 EVT_SET_FOCUS (wxGenericTreeCtrl::OnSetFocus
)
920 EVT_KILL_FOCUS (wxGenericTreeCtrl::OnKillFocus
)
921 EVT_TREE_ITEM_GETTOOLTIP(wxID_ANY
, wxGenericTreeCtrl::OnGetToolTip
)
924 #if !defined(__WXMSW__) || defined(__WXUNIVERSAL__)
926 * wxTreeCtrl has to be a real class or we have problems with
927 * the run-time information.
930 IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl
, wxGenericTreeCtrl
)
933 // -----------------------------------------------------------------------------
934 // construction/destruction
935 // -----------------------------------------------------------------------------
937 void wxGenericTreeCtrl::Init()
950 m_hilightBrush
= new wxBrush
952 wxSystemSettings::GetColour
954 wxSYS_COLOUR_HIGHLIGHT
959 m_hilightUnfocusedBrush
= new wxBrush
961 wxSystemSettings::GetColour
963 wxSYS_COLOUR_BTNSHADOW
968 m_imageListButtons
= NULL
;
969 m_ownsImageListButtons
= false;
972 m_isDragging
= false;
973 m_dropTarget
= m_oldSelection
= NULL
;
977 m_renameTimer
= NULL
;
981 m_dropEffectAboveItem
= false;
983 m_dndEffect
= NoEffect
;
984 m_dndEffectItem
= NULL
;
986 m_lastOnSame
= false;
988 #if defined( __WXMAC__ )
989 #if wxOSX_USE_ATSU_TEXT
990 m_normalFont
.MacCreateFromThemeFont( kThemeViewsFont
) ;
992 m_normalFont
.MacCreateFromUIFont( kCTFontViewsFontType
) ;
995 m_normalFont
= wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT
);
997 m_boldFont
= wxFont(m_normalFont
.GetPointSize(),
998 m_normalFont
.GetFamily(),
999 m_normalFont
.GetStyle(),
1001 m_normalFont
.GetUnderlined(),
1002 m_normalFont
.GetFaceName(),
1003 m_normalFont
.GetEncoding());
1006 bool wxGenericTreeCtrl::Create(wxWindow
*parent
,
1011 const wxValidator
& validator
,
1012 const wxString
& name
)
1016 wxGetOsVersion(&major
, &minor
);
1019 style
|= wxTR_ROW_LINES
;
1022 if ( !wxControl::Create( parent
, id
, pos
, size
,
1023 style
|wxHSCROLL
|wxVSCROLL
,
1028 // If the tree display has no buttons, but does have
1029 // connecting lines, we can use a narrower layout.
1030 // It may not be a good idea to force this...
1031 if (!HasButtons() && !HasFlag(wxTR_NO_LINES
))
1037 wxVisualAttributes attr
= GetDefaultAttributes();
1038 SetOwnForegroundColour( attr
.colFg
);
1039 SetOwnBackgroundColour( attr
.colBg
);
1041 SetOwnFont(attr
.font
);
1043 // this is a misnomer: it's called "dotted pen" but uses (default) wxSOLID
1044 // style because we apparently get performance problems when using dotted
1045 // pen for drawing in some ports -- but under MSW it seems to work fine
1047 m_dottedPen
= wxPen(*wxLIGHT_GREY
, 0, wxPENSTYLE_DOT
);
1049 m_dottedPen
= *wxGREY_PEN
;
1052 SetInitialSize(size
);
1057 wxGenericTreeCtrl::~wxGenericTreeCtrl()
1059 delete m_hilightBrush
;
1060 delete m_hilightUnfocusedBrush
;
1064 delete m_renameTimer
;
1067 if (m_ownsImageListButtons
)
1068 delete m_imageListButtons
;
1071 // -----------------------------------------------------------------------------
1073 // -----------------------------------------------------------------------------
1075 unsigned int wxGenericTreeCtrl::GetCount() const
1079 // the tree is empty
1083 unsigned int count
= m_anchor
->GetChildrenCount();
1084 if ( !HasFlag(wxTR_HIDE_ROOT
) )
1086 // take the root itself into account
1093 void wxGenericTreeCtrl::SetIndent(unsigned int indent
)
1095 m_indent
= (unsigned short) indent
;
1100 wxGenericTreeCtrl::GetChildrenCount(const wxTreeItemId
& item
,
1101 bool recursively
) const
1103 wxCHECK_MSG( item
.IsOk(), 0u, wxT("invalid tree item") );
1105 return ((wxGenericTreeItem
*) item
.m_pItem
)->GetChildrenCount(recursively
);
1108 void wxGenericTreeCtrl::SetWindowStyle(const long styles
)
1110 // Do not try to expand the root node if it hasn't been created yet
1111 if (m_anchor
&& !HasFlag(wxTR_HIDE_ROOT
) && (styles
& wxTR_HIDE_ROOT
))
1113 // if we will hide the root, make sure children are visible
1114 m_anchor
->SetHasPlus();
1116 CalculatePositions();
1119 // right now, just sets the styles. Eventually, we may
1120 // want to update the inherited styles, but right now
1121 // none of the parents has updatable styles
1122 m_windowStyle
= styles
;
1126 // -----------------------------------------------------------------------------
1127 // functions to work with tree items
1128 // -----------------------------------------------------------------------------
1130 wxString
wxGenericTreeCtrl::GetItemText(const wxTreeItemId
& item
) const
1132 wxCHECK_MSG( item
.IsOk(), wxEmptyString
, wxT("invalid tree item") );
1134 return ((wxGenericTreeItem
*) item
.m_pItem
)->GetText();
1137 int wxGenericTreeCtrl::GetItemImage(const wxTreeItemId
& item
,
1138 wxTreeItemIcon which
) const
1140 wxCHECK_MSG( item
.IsOk(), -1, wxT("invalid tree item") );
1142 return ((wxGenericTreeItem
*) item
.m_pItem
)->GetImage(which
);
1145 wxTreeItemData
*wxGenericTreeCtrl::GetItemData(const wxTreeItemId
& item
) const
1147 wxCHECK_MSG( item
.IsOk(), NULL
, wxT("invalid tree item") );
1149 return ((wxGenericTreeItem
*) item
.m_pItem
)->GetData();
1152 int wxGenericTreeCtrl::DoGetItemState(const wxTreeItemId
& item
) const
1154 wxCHECK_MSG( item
.IsOk(), wxTREE_ITEMSTATE_NONE
, wxT("invalid tree item") );
1156 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1157 return pItem
->GetState();
1160 wxColour
wxGenericTreeCtrl::GetItemTextColour(const wxTreeItemId
& item
) const
1162 wxCHECK_MSG( item
.IsOk(), wxNullColour
, wxT("invalid tree item") );
1164 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1165 return pItem
->Attr().GetTextColour();
1169 wxGenericTreeCtrl::GetItemBackgroundColour(const wxTreeItemId
& item
) const
1171 wxCHECK_MSG( item
.IsOk(), wxNullColour
, wxT("invalid tree item") );
1173 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1174 return pItem
->Attr().GetBackgroundColour();
1177 wxFont
wxGenericTreeCtrl::GetItemFont(const wxTreeItemId
& item
) const
1179 wxCHECK_MSG( item
.IsOk(), wxNullFont
, wxT("invalid tree item") );
1181 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1182 return pItem
->Attr().GetFont();
1186 wxGenericTreeCtrl::SetItemText(const wxTreeItemId
& item
, const wxString
& text
)
1188 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1190 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1191 pItem
->SetText(text
);
1192 pItem
->CalculateSize(this);
1196 void wxGenericTreeCtrl::SetItemImage(const wxTreeItemId
& item
,
1198 wxTreeItemIcon which
)
1200 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1202 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1203 pItem
->SetImage(image
, which
);
1204 pItem
->CalculateSize(this);
1209 wxGenericTreeCtrl::SetItemData(const wxTreeItemId
& item
, wxTreeItemData
*data
)
1211 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1214 data
->SetId( item
);
1216 ((wxGenericTreeItem
*) item
.m_pItem
)->SetData(data
);
1219 void wxGenericTreeCtrl::DoSetItemState(const wxTreeItemId
& item
, int state
)
1221 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1223 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1224 pItem
->SetState(state
);
1225 pItem
->CalculateSize(this);
1229 void wxGenericTreeCtrl::SetItemHasChildren(const wxTreeItemId
& item
, bool has
)
1231 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1233 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1234 pItem
->SetHasPlus(has
);
1238 void wxGenericTreeCtrl::SetItemBold(const wxTreeItemId
& item
, bool bold
)
1240 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1242 // avoid redrawing the tree if no real change
1243 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1244 if ( pItem
->IsBold() != bold
)
1246 pItem
->SetBold(bold
);
1248 // recalculate the item size as bold and non bold fonts have different
1250 pItem
->CalculateSize(this);
1255 void wxGenericTreeCtrl::SetItemDropHighlight(const wxTreeItemId
& item
,
1258 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1264 bg
= wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHT
);
1265 fg
= wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHTTEXT
);
1268 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1269 pItem
->Attr().SetTextColour(fg
);
1270 pItem
->Attr().SetBackgroundColour(bg
);
1274 void wxGenericTreeCtrl::SetItemTextColour(const wxTreeItemId
& item
,
1275 const wxColour
& col
)
1277 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1279 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1280 pItem
->Attr().SetTextColour(col
);
1284 void wxGenericTreeCtrl::SetItemBackgroundColour(const wxTreeItemId
& item
,
1285 const wxColour
& col
)
1287 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1289 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1290 pItem
->Attr().SetBackgroundColour(col
);
1295 wxGenericTreeCtrl::SetItemFont(const wxTreeItemId
& item
, const wxFont
& font
)
1297 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
1299 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1300 pItem
->Attr().SetFont(font
);
1301 pItem
->ResetTextSize();
1302 pItem
->CalculateSize(this);
1306 bool wxGenericTreeCtrl::SetFont( const wxFont
&font
)
1308 wxTreeCtrlBase::SetFont(font
);
1310 m_normalFont
= font
;
1311 m_boldFont
= wxFont(m_normalFont
.GetPointSize(),
1312 m_normalFont
.GetFamily(),
1313 m_normalFont
.GetStyle(),
1315 m_normalFont
.GetUnderlined(),
1316 m_normalFont
.GetFaceName(),
1317 m_normalFont
.GetEncoding());
1320 m_anchor
->RecursiveResetTextSize();
1326 // -----------------------------------------------------------------------------
1327 // item status inquiries
1328 // -----------------------------------------------------------------------------
1330 bool wxGenericTreeCtrl::IsVisible(const wxTreeItemId
& item
) const
1332 wxCHECK_MSG( item
.IsOk(), false, wxT("invalid tree item") );
1334 // An item is only visible if it's not a descendant of a collapsed item
1335 wxGenericTreeItem
*pItem
= (wxGenericTreeItem
*) item
.m_pItem
;
1336 wxGenericTreeItem
* parent
= pItem
->GetParent();
1339 if (!parent
->IsExpanded())
1341 parent
= parent
->GetParent();
1345 GetViewStart(& startX
, & startY
);
1347 wxSize clientSize
= GetClientSize();
1350 if (!GetBoundingRect(item
, rect
))
1352 if (rect
.GetWidth() == 0 || rect
.GetHeight() == 0)
1354 if (rect
.GetBottom() < 0 || rect
.GetTop() > clientSize
.y
)
1356 if (rect
.GetRight() < 0 || rect
.GetLeft() > clientSize
.x
)
1362 bool wxGenericTreeCtrl::ItemHasChildren(const wxTreeItemId
& item
) const
1364 wxCHECK_MSG( item
.IsOk(), false, wxT("invalid tree item") );
1366 // consider that the item does have children if it has the "+" button: it
1367 // might not have them (if it had never been expanded yet) but then it
1368 // could have them as well and it's better to err on this side rather than
1369 // disabling some operations which are restricted to the items with
1370 // children for an item which does have them
1371 return ((wxGenericTreeItem
*) item
.m_pItem
)->HasPlus();
1374 bool wxGenericTreeCtrl::IsExpanded(const wxTreeItemId
& item
) const
1376 wxCHECK_MSG( item
.IsOk(), false, wxT("invalid tree item") );
1378 return ((wxGenericTreeItem
*) item
.m_pItem
)->IsExpanded();
1381 bool wxGenericTreeCtrl::IsSelected(const wxTreeItemId
& item
) const
1383 wxCHECK_MSG( item
.IsOk(), false, wxT("invalid tree item") );
1385 return ((wxGenericTreeItem
*) item
.m_pItem
)->IsSelected();
1388 bool wxGenericTreeCtrl::IsBold(const wxTreeItemId
& item
) const
1390 wxCHECK_MSG( item
.IsOk(), false, wxT("invalid tree item") );
1392 return ((wxGenericTreeItem
*) item
.m_pItem
)->IsBold();
1395 // -----------------------------------------------------------------------------
1397 // -----------------------------------------------------------------------------
1399 wxTreeItemId
wxGenericTreeCtrl::GetItemParent(const wxTreeItemId
& item
) const
1401 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1403 return ((wxGenericTreeItem
*) item
.m_pItem
)->GetParent();
1406 wxTreeItemId
wxGenericTreeCtrl::GetFirstChild(const wxTreeItemId
& item
,
1407 wxTreeItemIdValue
& cookie
) const
1409 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1412 return GetNextChild(item
, cookie
);
1415 wxTreeItemId
wxGenericTreeCtrl::GetNextChild(const wxTreeItemId
& item
,
1416 wxTreeItemIdValue
& cookie
) const
1418 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1420 wxArrayGenericTreeItems
&
1421 children
= ((wxGenericTreeItem
*) item
.m_pItem
)->GetChildren();
1423 // it's ok to cast cookie to size_t, we never have indices big enough to
1424 // overflow "void *"
1425 size_t *pIndex
= (size_t *)&cookie
;
1426 if ( *pIndex
< children
.GetCount() )
1428 return children
.Item((*pIndex
)++);
1432 // there are no more of them
1433 return wxTreeItemId();
1437 wxTreeItemId
wxGenericTreeCtrl::GetLastChild(const wxTreeItemId
& item
) const
1439 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1441 wxArrayGenericTreeItems
&
1442 children
= ((wxGenericTreeItem
*) item
.m_pItem
)->GetChildren();
1443 return children
.IsEmpty() ? wxTreeItemId() : wxTreeItemId(children
.Last());
1446 wxTreeItemId
wxGenericTreeCtrl::GetNextSibling(const wxTreeItemId
& item
) const
1448 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1450 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
1451 wxGenericTreeItem
*parent
= i
->GetParent();
1452 if ( parent
== NULL
)
1454 // root item doesn't have any siblings
1455 return wxTreeItemId();
1458 wxArrayGenericTreeItems
& siblings
= parent
->GetChildren();
1459 int index
= siblings
.Index(i
);
1460 wxASSERT( index
!= wxNOT_FOUND
); // I'm not a child of my parent?
1462 size_t n
= (size_t)(index
+ 1);
1463 return n
== siblings
.GetCount() ? wxTreeItemId()
1464 : wxTreeItemId(siblings
[n
]);
1467 wxTreeItemId
wxGenericTreeCtrl::GetPrevSibling(const wxTreeItemId
& item
) const
1469 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1471 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
1472 wxGenericTreeItem
*parent
= i
->GetParent();
1473 if ( parent
== NULL
)
1475 // root item doesn't have any siblings
1476 return wxTreeItemId();
1479 wxArrayGenericTreeItems
& siblings
= parent
->GetChildren();
1480 int index
= siblings
.Index(i
);
1481 wxASSERT( index
!= wxNOT_FOUND
); // I'm not a child of my parent?
1483 return index
== 0 ? wxTreeItemId()
1484 : wxTreeItemId(siblings
[(size_t)(index
- 1)]);
1487 // Only for internal use right now, but should probably be public
1488 wxTreeItemId
wxGenericTreeCtrl::GetNext(const wxTreeItemId
& item
) const
1490 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1492 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
1494 // First see if there are any children.
1495 wxArrayGenericTreeItems
& children
= i
->GetChildren();
1496 if (children
.GetCount() > 0)
1498 return children
.Item(0);
1502 // Try a sibling of this or ancestor instead
1503 wxTreeItemId p
= item
;
1504 wxTreeItemId toFind
;
1507 toFind
= GetNextSibling(p
);
1508 p
= GetItemParent(p
);
1509 } while (p
.IsOk() && !toFind
.IsOk());
1514 wxTreeItemId
wxGenericTreeCtrl::GetFirstVisibleItem() const
1516 wxTreeItemId id
= GetRootItem();
1525 } while (id
.IsOk());
1527 return wxTreeItemId();
1530 wxTreeItemId
wxGenericTreeCtrl::GetNextVisible(const wxTreeItemId
& item
) const
1532 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1533 wxASSERT_MSG( IsVisible(item
), wxT("this item itself should be visible") );
1535 wxTreeItemId id
= item
;
1538 while (id
= GetNext(id
), id
.IsOk())
1544 return wxTreeItemId();
1547 wxTreeItemId
wxGenericTreeCtrl::GetPrevVisible(const wxTreeItemId
& item
) const
1549 wxCHECK_MSG( item
.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1550 wxASSERT_MSG( IsVisible(item
), wxT("this item itself should be visible") );
1552 // find out the starting point
1553 wxTreeItemId prevItem
= GetPrevSibling(item
);
1554 if ( !prevItem
.IsOk() )
1556 prevItem
= GetItemParent(item
);
1559 // find the first visible item after it
1560 while ( prevItem
.IsOk() && !IsVisible(prevItem
) )
1562 prevItem
= GetNext(prevItem
);
1563 if ( !prevItem
.IsOk() || prevItem
== item
)
1565 // there are no visible items before item
1566 return wxTreeItemId();
1570 // from there we must be able to navigate until this item
1571 while ( prevItem
.IsOk() )
1573 const wxTreeItemId nextItem
= GetNextVisible(prevItem
);
1574 if ( !nextItem
.IsOk() || nextItem
== item
)
1577 prevItem
= nextItem
;
1583 // called by wxTextTreeCtrl when it marks itself for deletion
1584 void wxGenericTreeCtrl::ResetTextControl()
1589 // find the first item starting with the given prefix after the given item
1590 wxTreeItemId
wxGenericTreeCtrl::FindItem(const wxTreeItemId
& idParent
,
1591 const wxString
& prefixOrig
) const
1593 // match is case insensitive as this is more convenient to the user: having
1594 // to press Shift-letter to go to the item starting with a capital letter
1595 // would be too bothersome
1596 wxString prefix
= prefixOrig
.Lower();
1598 // determine the starting point: we shouldn't take the current item (this
1599 // allows to switch between two items starting with the same letter just by
1600 // pressing it) but we shouldn't jump to the next one if the user is
1601 // continuing to type as otherwise he might easily skip the item he wanted
1602 wxTreeItemId id
= idParent
;
1603 if ( prefix
.length() == 1 )
1608 // look for the item starting with the given prefix after it
1609 while ( id
.IsOk() && !GetItemText(id
).Lower().StartsWith(prefix
) )
1614 // if we haven't found anything...
1617 // ... wrap to the beginning
1619 if ( HasFlag(wxTR_HIDE_ROOT
) )
1621 // can't select virtual root
1625 // and try all the items (stop when we get to the one we started from)
1626 while ( id
.IsOk() && id
!= idParent
&&
1627 !GetItemText(id
).Lower().StartsWith(prefix
) )
1631 // If we haven't found the item, id.IsOk() will be false, as per
1638 // -----------------------------------------------------------------------------
1640 // -----------------------------------------------------------------------------
1642 wxTreeItemId
wxGenericTreeCtrl::DoInsertItem(const wxTreeItemId
& parentId
,
1644 const wxString
& text
,
1647 wxTreeItemData
*data
)
1649 wxGenericTreeItem
*parent
= (wxGenericTreeItem
*) parentId
.m_pItem
;
1652 // should we give a warning here?
1653 return AddRoot(text
, image
, selImage
, data
);
1656 m_dirty
= true; // do this first so stuff below doesn't cause flicker
1658 wxGenericTreeItem
*item
=
1659 new wxGenericTreeItem( parent
, text
, image
, selImage
, data
);
1663 data
->m_pItem
= item
;
1666 parent
->Insert( item
, previous
== (size_t)-1 ? parent
->GetChildren().size()
1669 InvalidateBestSize();
1673 wxTreeItemId
wxGenericTreeCtrl::AddRoot(const wxString
& text
,
1676 wxTreeItemData
*data
)
1678 wxCHECK_MSG( !m_anchor
, wxTreeItemId(), "tree can have only one root" );
1680 m_dirty
= true; // do this first so stuff below doesn't cause flicker
1682 m_anchor
= new wxGenericTreeItem(NULL
, text
,
1683 image
, selImage
, data
);
1686 data
->m_pItem
= m_anchor
;
1689 if (HasFlag(wxTR_HIDE_ROOT
))
1691 // if root is hidden, make sure we can navigate
1693 m_anchor
->SetHasPlus();
1695 CalculatePositions();
1698 if (!HasFlag(wxTR_MULTIPLE
))
1700 m_current
= m_key_current
= m_anchor
;
1701 m_current
->SetHilight( true );
1704 InvalidateBestSize();
1708 wxTreeItemId
wxGenericTreeCtrl::DoInsertAfter(const wxTreeItemId
& parentId
,
1709 const wxTreeItemId
& idPrevious
,
1710 const wxString
& text
,
1711 int image
, int selImage
,
1712 wxTreeItemData
*data
)
1714 wxGenericTreeItem
*parent
= (wxGenericTreeItem
*) parentId
.m_pItem
;
1717 // should we give a warning here?
1718 return AddRoot(text
, image
, selImage
, data
);
1722 if (idPrevious
.IsOk())
1724 index
= parent
->GetChildren().Index(
1725 (wxGenericTreeItem
*) idPrevious
.m_pItem
);
1726 wxASSERT_MSG( index
!= wxNOT_FOUND
,
1727 "previous item in wxGenericTreeCtrl::InsertItem() "
1728 "is not a sibling" );
1731 return DoInsertItem(parentId
, (size_t)++index
, text
, image
, selImage
, data
);
1735 void wxGenericTreeCtrl::SendDeleteEvent(wxGenericTreeItem
*item
)
1737 wxTreeEvent
event(wxEVT_COMMAND_TREE_DELETE_ITEM
, this, item
);
1738 GetEventHandler()->ProcessEvent( event
);
1741 // Don't leave edit or selection on a child which is about to disappear
1742 void wxGenericTreeCtrl::ChildrenClosing(wxGenericTreeItem
* item
)
1744 if ( m_textCtrl
&& item
!= m_textCtrl
->item() &&
1745 IsDescendantOf(item
, m_textCtrl
->item()) )
1747 m_textCtrl
->EndEdit( true );
1750 if ( item
!= m_key_current
&& IsDescendantOf(item
, m_key_current
) )
1752 m_key_current
= NULL
;
1755 if ( IsDescendantOf(item
, m_select_me
) )
1760 if ( item
!= m_current
&& IsDescendantOf(item
, m_current
) )
1762 m_current
->SetHilight( false );
1768 void wxGenericTreeCtrl::DeleteChildren(const wxTreeItemId
& itemId
)
1770 m_dirty
= true; // do this first so stuff below doesn't cause flicker
1772 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1773 ChildrenClosing(item
);
1774 item
->DeleteChildren(this);
1775 InvalidateBestSize();
1778 void wxGenericTreeCtrl::Delete(const wxTreeItemId
& itemId
)
1780 m_dirty
= true; // do this first so stuff below doesn't cause flicker
1782 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1784 if (m_textCtrl
!= NULL
&& IsDescendantOf(item
, m_textCtrl
->item()))
1786 // can't delete the item being edited, cancel editing it first
1787 m_textCtrl
->EndEdit( true );
1790 wxGenericTreeItem
*parent
= item
->GetParent();
1792 // don't keep stale pointers around!
1793 if ( IsDescendantOf(item
, m_key_current
) )
1795 // Don't silently change the selection:
1796 // do it properly in idle time, so event
1797 // handlers get called.
1799 // m_key_current = parent;
1800 m_key_current
= NULL
;
1803 // m_select_me records whether we need to select
1804 // a different item, in idle time.
1805 if ( m_select_me
&& IsDescendantOf(item
, m_select_me
) )
1807 m_select_me
= parent
;
1810 if ( IsDescendantOf(item
, m_current
) )
1812 // Don't silently change the selection:
1813 // do it properly in idle time, so event
1814 // handlers get called.
1816 // m_current = parent;
1818 m_select_me
= parent
;
1821 // remove the item from the tree
1824 parent
->GetChildren().Remove( item
); // remove by value
1826 else // deleting the root
1828 // nothing will be left in the tree
1832 // and delete all of its children and the item itself now
1833 item
->DeleteChildren(this);
1834 SendDeleteEvent(item
);
1836 if (item
== m_select_me
)
1841 InvalidateBestSize();
1844 void wxGenericTreeCtrl::DeleteAllItems()
1852 void wxGenericTreeCtrl::Expand(const wxTreeItemId
& itemId
)
1854 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1856 wxCHECK_RET( item
, _T("invalid item in wxGenericTreeCtrl::Expand") );
1857 wxCHECK_RET( !HasFlag(wxTR_HIDE_ROOT
) || itemId
!= GetRootItem(),
1858 _T("can't expand hidden root") );
1860 if ( !item
->HasPlus() )
1863 if ( item
->IsExpanded() )
1866 wxTreeEvent
event(wxEVT_COMMAND_TREE_ITEM_EXPANDING
, this, item
);
1868 if ( GetEventHandler()->ProcessEvent( event
) && !event
.IsAllowed() )
1870 // cancelled by program
1877 CalculatePositions();
1879 RefreshSubtree(item
);
1886 event
.SetEventType(wxEVT_COMMAND_TREE_ITEM_EXPANDED
);
1887 GetEventHandler()->ProcessEvent( event
);
1890 void wxGenericTreeCtrl::Collapse(const wxTreeItemId
& itemId
)
1892 wxCHECK_RET( !HasFlag(wxTR_HIDE_ROOT
) || itemId
!= GetRootItem(),
1893 _T("can't collapse hidden root") );
1895 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1897 if ( !item
->IsExpanded() )
1900 wxTreeEvent
event(wxEVT_COMMAND_TREE_ITEM_COLLAPSING
, this, item
);
1901 if ( GetEventHandler()->ProcessEvent( event
) && !event
.IsAllowed() )
1903 // cancelled by program
1907 ChildrenClosing(item
);
1910 #if 0 // TODO why should items be collapsed recursively?
1911 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1912 size_t count
= children
.GetCount();
1913 for ( size_t n
= 0; n
< count
; n
++ )
1915 Collapse(children
[n
]);
1919 CalculatePositions();
1921 RefreshSubtree(item
);
1923 event
.SetEventType(wxEVT_COMMAND_TREE_ITEM_COLLAPSED
);
1924 GetEventHandler()->ProcessEvent( event
);
1927 void wxGenericTreeCtrl::CollapseAndReset(const wxTreeItemId
& item
)
1930 DeleteChildren(item
);
1933 void wxGenericTreeCtrl::Toggle(const wxTreeItemId
& itemId
)
1935 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
1937 if (item
->IsExpanded())
1943 void wxGenericTreeCtrl::Unselect()
1947 m_current
->SetHilight( false );
1948 RefreshLine( m_current
);
1955 void wxGenericTreeCtrl::UnselectAllChildren(wxGenericTreeItem
*item
)
1957 if (item
->IsSelected())
1959 item
->SetHilight(false);
1963 if (item
->HasChildren())
1965 wxArrayGenericTreeItems
& children
= item
->GetChildren();
1966 size_t count
= children
.GetCount();
1967 for ( size_t n
= 0; n
< count
; ++n
)
1969 UnselectAllChildren(children
[n
]);
1974 void wxGenericTreeCtrl::UnselectAll()
1976 wxTreeItemId rootItem
= GetRootItem();
1978 // the tree might not have the root item at all
1981 UnselectAllChildren((wxGenericTreeItem
*) rootItem
.m_pItem
);
1985 // Recursive function !
1986 // To stop we must have crt_item<last_item
1988 // Tag all next children, when no more children,
1989 // Move to parent (not to tag)
1990 // Keep going... if we found last_item, we stop.
1992 wxGenericTreeCtrl::TagNextChildren(wxGenericTreeItem
*crt_item
,
1993 wxGenericTreeItem
*last_item
,
1996 wxGenericTreeItem
*parent
= crt_item
->GetParent();
1998 if (parent
== NULL
) // This is root item
1999 return TagAllChildrenUntilLast(crt_item
, last_item
, select
);
2001 wxArrayGenericTreeItems
& children
= parent
->GetChildren();
2002 int index
= children
.Index(crt_item
);
2003 wxASSERT( index
!= wxNOT_FOUND
); // I'm not a child of my parent?
2005 size_t count
= children
.GetCount();
2006 for (size_t n
=(size_t)(index
+1); n
<count
; ++n
)
2008 if ( TagAllChildrenUntilLast(children
[n
], last_item
, select
) )
2012 return TagNextChildren(parent
, last_item
, select
);
2016 wxGenericTreeCtrl::TagAllChildrenUntilLast(wxGenericTreeItem
*crt_item
,
2017 wxGenericTreeItem
*last_item
,
2020 crt_item
->SetHilight(select
);
2021 RefreshLine(crt_item
);
2023 if (crt_item
==last_item
)
2026 if (crt_item
->HasChildren())
2028 wxArrayGenericTreeItems
& children
= crt_item
->GetChildren();
2029 size_t count
= children
.GetCount();
2030 for ( size_t n
= 0; n
< count
; ++n
)
2032 if (TagAllChildrenUntilLast(children
[n
], last_item
, select
))
2041 wxGenericTreeCtrl::SelectItemRange(wxGenericTreeItem
*item1
,
2042 wxGenericTreeItem
*item2
)
2046 // item2 is not necessary after item1
2047 // choice first' and 'last' between item1 and item2
2048 wxGenericTreeItem
*first
= (item1
->GetY()<item2
->GetY()) ? item1
: item2
;
2049 wxGenericTreeItem
*last
= (item1
->GetY()<item2
->GetY()) ? item2
: item1
;
2051 bool select
= m_current
->IsSelected();
2053 if ( TagAllChildrenUntilLast(first
,last
,select
) )
2056 TagNextChildren(first
,last
,select
);
2059 void wxGenericTreeCtrl::DoSelectItem(const wxTreeItemId
& itemId
,
2060 bool unselect_others
,
2061 bool extended_select
)
2063 wxCHECK_RET( itemId
.IsOk(), wxT("invalid tree item") );
2067 bool is_single
=!(GetWindowStyleFlag() & wxTR_MULTIPLE
);
2068 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
2070 //wxCHECK_RET( ( (!unselect_others) && is_single),
2071 // wxT("this is a single selection tree") );
2073 // to keep going anyhow !!!
2076 if (item
->IsSelected())
2077 return; // nothing to do
2078 unselect_others
= true;
2079 extended_select
= false;
2081 else if ( unselect_others
&& item
->IsSelected() )
2083 // selection change if there is more than one item currently selected
2084 wxArrayTreeItemIds selected_items
;
2085 if ( GetSelections(selected_items
) == 1 )
2089 wxTreeEvent
event(wxEVT_COMMAND_TREE_SEL_CHANGING
, this, item
);
2090 event
.m_itemOld
= m_current
;
2091 // TODO : Here we don't send any selection mode yet !
2093 if ( GetEventHandler()->ProcessEvent( event
) && !event
.IsAllowed() )
2096 wxTreeItemId parent
= GetItemParent( itemId
);
2097 while (parent
.IsOk())
2099 if (!IsExpanded(parent
))
2102 parent
= GetItemParent( parent
);
2106 if (unselect_others
)
2108 if (is_single
) Unselect(); // to speed up thing
2113 if (extended_select
)
2118 m_key_current
= (wxGenericTreeItem
*) GetRootItem().m_pItem
;
2121 // don't change the mark (m_current)
2122 SelectItemRange(m_current
, item
);
2126 bool select
= true; // the default
2128 // Check if we need to toggle hilight (ctrl mode)
2129 if (!unselect_others
)
2130 select
=!item
->IsSelected();
2132 m_current
= m_key_current
= item
;
2133 m_current
->SetHilight(select
);
2134 RefreshLine( m_current
);
2137 // This can cause idle processing to select the root
2138 // if no item is selected, so it must be after the
2140 EnsureVisible( itemId
);
2142 event
.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED
);
2143 GetEventHandler()->ProcessEvent( event
);
2146 void wxGenericTreeCtrl::SelectItem(const wxTreeItemId
& itemId
, bool select
)
2150 DoSelectItem(itemId
, !HasFlag(wxTR_MULTIPLE
));
2154 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
2155 wxCHECK_RET( item
, wxT("SelectItem(): invalid tree item") );
2157 wxTreeEvent
event(wxEVT_COMMAND_TREE_SEL_CHANGING
, this, item
);
2158 if ( GetEventHandler()->ProcessEvent( event
) && !event
.IsAllowed() )
2161 item
->SetHilight(false);
2164 event
.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED
);
2165 GetEventHandler()->ProcessEvent( event
);
2169 void wxGenericTreeCtrl::FillArray(wxGenericTreeItem
*item
,
2170 wxArrayTreeItemIds
&array
) const
2172 if ( item
->IsSelected() )
2173 array
.Add(wxTreeItemId(item
));
2175 if ( item
->HasChildren() )
2177 wxArrayGenericTreeItems
& children
= item
->GetChildren();
2178 size_t count
= children
.GetCount();
2179 for ( size_t n
= 0; n
< count
; ++n
)
2180 FillArray(children
[n
], array
);
2184 size_t wxGenericTreeCtrl::GetSelections(wxArrayTreeItemIds
&array
) const
2187 wxTreeItemId idRoot
= GetRootItem();
2188 if ( idRoot
.IsOk() )
2190 FillArray((wxGenericTreeItem
*) idRoot
.m_pItem
, array
);
2192 //else: the tree is empty, so no selections
2194 return array
.GetCount();
2197 void wxGenericTreeCtrl::EnsureVisible(const wxTreeItemId
& item
)
2199 wxCHECK_RET( item
.IsOk(), wxT("invalid tree item") );
2201 if (!item
.IsOk()) return;
2203 wxGenericTreeItem
*gitem
= (wxGenericTreeItem
*) item
.m_pItem
;
2205 // first expand all parent branches
2206 wxGenericTreeItem
*parent
= gitem
->GetParent();
2208 if ( HasFlag(wxTR_HIDE_ROOT
) )
2210 while ( parent
&& parent
!= m_anchor
)
2213 parent
= parent
->GetParent();
2221 parent
= parent
->GetParent();
2225 //if (parent) CalculatePositions();
2230 void wxGenericTreeCtrl::ScrollTo(const wxTreeItemId
&item
)
2232 if (!item
.IsOk()) return;
2234 // We have to call this here because the label in
2235 // question might just have been added and no screen
2236 // update taken place.
2238 #if defined( __WXMSW__ ) || defined(__WXMAC__)
2241 DoDirtyProcessing();
2243 wxGenericTreeItem
*gitem
= (wxGenericTreeItem
*) item
.m_pItem
;
2245 // now scroll to the item
2246 int item_y
= gitem
->GetY();
2250 GetViewStart( &start_x
, &start_y
);
2251 start_y
*= PIXELS_PER_UNIT
;
2255 GetClientSize( &client_w
, &client_h
);
2257 if (item_y
< start_y
+3)
2262 m_anchor
->GetSize( x
, y
, this );
2263 y
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
2264 x
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
2265 int x_pos
= GetScrollPos( wxHORIZONTAL
);
2266 // Item should appear at top
2267 SetScrollbars( PIXELS_PER_UNIT
, PIXELS_PER_UNIT
,
2268 x
/PIXELS_PER_UNIT
, y
/PIXELS_PER_UNIT
,
2269 x_pos
, item_y
/PIXELS_PER_UNIT
);
2271 else if (item_y
+GetLineHeight(gitem
) > start_y
+client_h
)
2276 m_anchor
->GetSize( x
, y
, this );
2277 y
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
2278 x
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
2279 item_y
+= PIXELS_PER_UNIT
+2;
2280 int x_pos
= GetScrollPos( wxHORIZONTAL
);
2281 // Item should appear at bottom
2282 SetScrollbars( PIXELS_PER_UNIT
, PIXELS_PER_UNIT
,
2283 x
/PIXELS_PER_UNIT
, y
/PIXELS_PER_UNIT
,
2285 (item_y
+GetLineHeight(gitem
)-client_h
)/PIXELS_PER_UNIT
);
2289 // FIXME: tree sorting functions are not reentrant and not MT-safe!
2290 static wxGenericTreeCtrl
*s_treeBeingSorted
= NULL
;
2292 static int LINKAGEMODE
tree_ctrl_compare_func(wxGenericTreeItem
**item1
,
2293 wxGenericTreeItem
**item2
)
2295 wxCHECK_MSG( s_treeBeingSorted
, 0,
2296 "bug in wxGenericTreeCtrl::SortChildren()" );
2298 return s_treeBeingSorted
->OnCompareItems(*item1
, *item2
);
2301 void wxGenericTreeCtrl::SortChildren(const wxTreeItemId
& itemId
)
2303 wxCHECK_RET( itemId
.IsOk(), wxT("invalid tree item") );
2305 wxGenericTreeItem
*item
= (wxGenericTreeItem
*) itemId
.m_pItem
;
2307 wxCHECK_RET( !s_treeBeingSorted
,
2308 wxT("wxGenericTreeCtrl::SortChildren is not reentrant") );
2310 wxArrayGenericTreeItems
& children
= item
->GetChildren();
2311 if ( children
.GetCount() > 1 )
2315 s_treeBeingSorted
= this;
2316 children
.Sort(tree_ctrl_compare_func
);
2317 s_treeBeingSorted
= NULL
;
2319 //else: don't make the tree dirty as nothing changed
2322 void wxGenericTreeCtrl::CalculateLineHeight()
2324 wxClientDC
dc(this);
2325 m_lineHeight
= (int)(dc
.GetCharHeight() + 4);
2327 if ( m_imageListNormal
)
2329 // Calculate a m_lineHeight value from the normal Image sizes.
2330 // May be toggle off. Then wxGenericTreeCtrl will spread when
2331 // necessary (which might look ugly).
2332 int n
= m_imageListNormal
->GetImageCount();
2333 for (int i
= 0; i
< n
; i
++)
2335 int width
= 0, height
= 0;
2336 m_imageListNormal
->GetSize(i
, width
, height
);
2337 if (height
> m_lineHeight
) m_lineHeight
= height
;
2341 if ( m_imageListState
)
2343 // Calculate a m_lineHeight value from the state Image sizes.
2344 // May be toggle off. Then wxGenericTreeCtrl will spread when
2345 // necessary (which might look ugly).
2346 int n
= m_imageListState
->GetImageCount();
2347 for (int i
= 0; i
< n
; i
++)
2349 int width
= 0, height
= 0;
2350 m_imageListState
->GetSize(i
, width
, height
);
2351 if (height
> m_lineHeight
) m_lineHeight
= height
;
2355 if (m_imageListButtons
)
2357 // Calculate a m_lineHeight value from the Button image sizes.
2358 // May be toggle off. Then wxGenericTreeCtrl will spread when
2359 // necessary (which might look ugly).
2360 int n
= m_imageListButtons
->GetImageCount();
2361 for (int i
= 0; i
< n
; i
++)
2363 int width
= 0, height
= 0;
2364 m_imageListButtons
->GetSize(i
, width
, height
);
2365 if (height
> m_lineHeight
) m_lineHeight
= height
;
2369 if (m_lineHeight
< 30)
2370 m_lineHeight
+= 2; // at least 2 pixels
2372 m_lineHeight
+= m_lineHeight
/10; // otherwise 10% extra spacing
2375 void wxGenericTreeCtrl::SetImageList(wxImageList
*imageList
)
2377 if (m_ownsImageListNormal
) delete m_imageListNormal
;
2378 m_imageListNormal
= imageList
;
2379 m_ownsImageListNormal
= false;
2383 m_anchor
->RecursiveResetSize();
2385 // Don't do any drawing if we're setting the list to NULL,
2386 // since we may be in the process of deleting the tree control.
2388 CalculateLineHeight();
2391 void wxGenericTreeCtrl::SetStateImageList(wxImageList
*imageList
)
2393 if (m_ownsImageListState
) delete m_imageListState
;
2394 m_imageListState
= imageList
;
2395 m_ownsImageListState
= false;
2399 m_anchor
->RecursiveResetSize();
2401 // Don't do any drawing if we're setting the list to NULL,
2402 // since we may be in the process of deleting the tree control.
2404 CalculateLineHeight();
2407 void wxGenericTreeCtrl::SetButtonsImageList(wxImageList
*imageList
)
2409 if (m_ownsImageListButtons
) delete m_imageListButtons
;
2410 m_imageListButtons
= imageList
;
2411 m_ownsImageListButtons
= false;
2415 m_anchor
->RecursiveResetSize();
2417 CalculateLineHeight();
2420 void wxGenericTreeCtrl::AssignButtonsImageList(wxImageList
*imageList
)
2422 SetButtonsImageList(imageList
);
2423 m_ownsImageListButtons
= true;
2426 // -----------------------------------------------------------------------------
2428 // -----------------------------------------------------------------------------
2430 void wxGenericTreeCtrl::AdjustMyScrollbars()
2435 m_anchor
->GetSize( x
, y
, this );
2436 y
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
2437 x
+= PIXELS_PER_UNIT
+2; // one more scrollbar unit + 2 pixels
2438 int x_pos
= GetScrollPos( wxHORIZONTAL
);
2439 int y_pos
= GetScrollPos( wxVERTICAL
);
2440 SetScrollbars( PIXELS_PER_UNIT
, PIXELS_PER_UNIT
,
2441 x
/PIXELS_PER_UNIT
, y
/PIXELS_PER_UNIT
,
2446 SetScrollbars( 0, 0, 0, 0 );
2450 int wxGenericTreeCtrl::GetLineHeight(wxGenericTreeItem
*item
) const
2452 if (GetWindowStyleFlag() & wxTR_HAS_VARIABLE_ROW_HEIGHT
)
2453 return item
->GetHeight();
2455 return m_lineHeight
;
2458 void wxGenericTreeCtrl::PaintItem(wxGenericTreeItem
*item
, wxDC
& dc
)
2460 item
->SetFont(this, dc
);
2461 item
->CalculateSize(this, dc
);
2463 wxCoord text_h
= item
->GetTextHeight();
2465 int image_h
= 0, image_w
= 0;
2466 int image
= item
->GetCurrentImage();
2467 if ( image
!= NO_IMAGE
)
2469 if ( m_imageListNormal
)
2471 m_imageListNormal
->GetSize(image
, image_w
, image_h
);
2472 image_w
+= MARGIN_BETWEEN_IMAGE_AND_TEXT
;
2480 int state_h
= 0, state_w
= 0;
2481 int state
= item
->GetState();
2482 if ( state
!= wxTREE_ITEMSTATE_NONE
)
2484 if ( m_imageListState
)
2486 m_imageListState
->GetSize(state
, state_w
, state_h
);
2488 state_w
+= MARGIN_BETWEEN_STATE_AND_IMAGE
;
2490 state_w
+= MARGIN_BETWEEN_IMAGE_AND_TEXT
;
2494 state
= wxTREE_ITEMSTATE_NONE
;
2498 int total_h
= GetLineHeight(item
);
2499 bool drawItemBackground
= false,
2500 hasBgColour
= false;
2502 if ( item
->IsSelected() )
2504 dc
.SetBrush(*(m_hasFocus
? m_hilightBrush
: m_hilightUnfocusedBrush
));
2505 drawItemBackground
= true;
2510 wxTreeItemAttr
* const attr
= item
->GetAttributes();
2511 if ( attr
&& attr
->HasBackgroundColour() )
2513 drawItemBackground
=
2515 colBg
= attr
->GetBackgroundColour();
2519 colBg
= GetBackgroundColour();
2521 dc
.SetBrush(wxBrush(colBg
, wxBRUSHSTYLE_SOLID
));
2524 int offset
= HasFlag(wxTR_ROW_LINES
) ? 1 : 0;
2526 if ( HasFlag(wxTR_FULL_ROW_HIGHLIGHT
) )
2530 GetVirtualSize(&w
, &h
);
2531 wxRect
rect( x
, item
->GetY()+offset
, w
, total_h
-offset
);
2532 if (!item
->IsSelected())
2534 dc
.DrawRectangle(rect
);
2538 int flags
= wxCONTROL_SELECTED
;
2540 #if defined( __WXMAC__ ) && !defined(__WXUNIVERSAL__) && wxOSX_USE_CARBON // TODO CS
2541 && IsControlActive( (ControlRef
)GetHandle() )
2544 flags
|= wxCONTROL_FOCUSED
;
2545 if ((item
== m_current
) && (m_hasFocus
))
2546 flags
|= wxCONTROL_CURRENT
;
2548 wxRendererNative::Get().
2549 DrawItemSelectionRect(this, dc
, rect
, flags
);
2552 else // no full row highlight
2554 if ( item
->IsSelected() &&
2555 (state
!= wxTREE_ITEMSTATE_NONE
|| image
!= NO_IMAGE
) )
2557 // If it's selected, and there's an state image or normal image,
2558 // then we should take care to leave the area under the image
2559 // painted in the background colour.
2560 wxRect
rect( item
->GetX() + state_w
+ image_w
- 2,
2561 item
->GetY() + offset
,
2562 item
->GetWidth() - state_w
- image_w
+ 2,
2564 #if !defined(__WXGTK20__) && !defined(__WXMAC__)
2565 dc
.DrawRectangle( rect
);
2570 int flags
= wxCONTROL_SELECTED
;
2572 flags
|= wxCONTROL_FOCUSED
;
2573 if ((item
== m_current
) && (m_hasFocus
))
2574 flags
|= wxCONTROL_CURRENT
;
2575 wxRendererNative::Get().
2576 DrawItemSelectionRect(this, dc
, rect
, flags
);
2579 // On GTK+ 2, drawing a 'normal' background is wrong for themes that
2580 // don't allow backgrounds to be customized. Not drawing the background,
2581 // except for custom item backgrounds, works for both kinds of theme.
2582 else if (drawItemBackground
)
2584 wxRect
rect( item
->GetX() + state_w
+ image_w
- 2,
2585 item
->GetY() + offset
,
2586 item
->GetWidth() - state_w
- image_w
+ 2,
2590 dc
.DrawRectangle( rect
);
2592 else // no specific background colour
2597 int flags
= wxCONTROL_SELECTED
;
2599 flags
|= wxCONTROL_FOCUSED
;
2600 if ((item
== m_current
) && (m_hasFocus
))
2601 flags
|= wxCONTROL_CURRENT
;
2602 wxRendererNative::Get().
2603 DrawItemSelectionRect(this, dc
, rect
, flags
);
2608 if ( state
!= wxTREE_ITEMSTATE_NONE
)
2610 dc
.SetClippingRegion( item
->GetX(), item
->GetY(), state_w
, total_h
);
2611 m_imageListState
->Draw( state
, dc
,
2614 (total_h
> state_h
? (total_h
-state_h
)/2
2616 wxIMAGELIST_DRAW_TRANSPARENT
);
2617 dc
.DestroyClippingRegion();
2620 if ( image
!= NO_IMAGE
)
2622 dc
.SetClippingRegion(item
->GetX() + state_w
, item
->GetY(),
2624 m_imageListNormal
->Draw( image
, dc
,
2625 item
->GetX() + state_w
,
2627 (total_h
> image_h
? (total_h
-image_h
)/2
2629 wxIMAGELIST_DRAW_TRANSPARENT
);
2630 dc
.DestroyClippingRegion();
2633 dc
.SetBackgroundMode(wxBRUSHSTYLE_TRANSPARENT
);
2634 int extraH
= (total_h
> text_h
) ? (total_h
- text_h
)/2 : 0;
2635 dc
.DrawText( item
->GetText(),
2636 (wxCoord
)(state_w
+ image_w
+ item
->GetX()),
2637 (wxCoord
)(item
->GetY() + extraH
));
2639 // restore normal font
2640 dc
.SetFont( m_normalFont
);
2642 if (item
== m_dndEffectItem
)
2644 dc
.SetPen( *wxBLACK_PEN
);
2645 // DnD visual effects
2646 switch (m_dndEffect
)
2650 dc
.SetBrush(*wxTRANSPARENT_BRUSH
);
2651 int w
= item
->GetWidth() + 2;
2652 int h
= total_h
+ 2;
2653 dc
.DrawRectangle( item
->GetX() - 1, item
->GetY() - 1, w
, h
);
2658 int x
= item
->GetX(),
2660 dc
.DrawLine( x
, y
, x
+ item
->GetWidth(), y
);
2665 int x
= item
->GetX(),
2668 dc
.DrawLine( x
, y
, x
+ item
->GetWidth(), y
);
2678 wxGenericTreeCtrl::PaintLevel(wxGenericTreeItem
*item
,
2683 int x
= level
*m_indent
;
2684 if (!HasFlag(wxTR_HIDE_ROOT
))
2688 else if (level
== 0)
2690 // always expand hidden root
2692 wxArrayGenericTreeItems
& children
= item
->GetChildren();
2693 int count
= children
.GetCount();
2699 PaintLevel(children
[n
], dc
, 1, y
);
2700 } while (++n
< count
);
2702 if ( !HasFlag(wxTR_NO_LINES
) && HasFlag(wxTR_LINES_AT_ROOT
)
2705 // draw line down to last child
2706 origY
+= GetLineHeight(children
[0])>>1;
2707 oldY
+= GetLineHeight(children
[n
-1])>>1;
2708 dc
.DrawLine(3, origY
, 3, oldY
);
2714 item
->SetX(x
+m_spacing
);
2717 int h
= GetLineHeight(item
);
2719 int y_mid
= y_top
+ (h
>>1);
2722 int exposed_x
= dc
.LogicalToDeviceX(0);
2723 int exposed_y
= dc
.LogicalToDeviceY(y_top
);
2725 if (IsExposed(exposed_x
, exposed_y
, 10000, h
)) // 10000 = very much
2729 // don't draw rect outline if we already have the
2730 // background color under Mac
2731 (item
->IsSelected() && m_hasFocus
) ? wxBLACK_PEN
:
2732 #endif // !__WXMAC__
2736 if ( item
->IsSelected()
2737 #if defined( __WXMAC__ ) && !defined(__WXUNIVERSAL__) && wxOSX_USE_CARBON // TODO CS
2738 // On wxMac, if the tree doesn't have the focus we draw an empty
2739 // rectangle, so we want to make sure that the text is visible
2740 // against the normal background, not the highlightbackground, so
2741 // don't use the highlight text colour unless we have the focus.
2742 && m_hasFocus
&& IsControlActive( (ControlRef
)GetHandle() )
2749 colText
= wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHTTEXT
);
2754 wxTreeItemAttr
*attr
= item
->GetAttributes();
2755 if (attr
&& attr
->HasTextColour())
2756 colText
= attr
->GetTextColour();
2758 colText
= GetForegroundColour();
2762 dc
.SetTextForeground(colText
);
2766 PaintItem(item
, dc
);
2768 if (HasFlag(wxTR_ROW_LINES
))
2770 // if the background colour is white, choose a
2771 // contrasting color for the lines
2772 dc
.SetPen(*((GetBackgroundColour() == *wxWHITE
)
2773 ? wxMEDIUM_GREY_PEN
: wxWHITE_PEN
));
2774 dc
.DrawLine(0, y_top
, 10000, y_top
);
2775 dc
.DrawLine(0, y
, 10000, y
);
2778 // restore DC objects
2779 dc
.SetBrush(*wxWHITE_BRUSH
);
2780 dc
.SetPen(m_dottedPen
);
2781 dc
.SetTextForeground(*wxBLACK
);
2783 if ( !HasFlag(wxTR_NO_LINES
) )
2785 // draw the horizontal line here
2787 if (x
> (signed)m_indent
)
2788 x_start
-= m_indent
;
2789 else if (HasFlag(wxTR_LINES_AT_ROOT
))
2791 dc
.DrawLine(x_start
, y_mid
, x
+ m_spacing
, y_mid
);
2794 // should the item show a button?
2795 if ( item
->HasPlus() && HasButtons() )
2797 if ( m_imageListButtons
)
2799 // draw the image button here
2802 int image
= item
->IsExpanded() ? wxTreeItemIcon_Expanded
2803 : wxTreeItemIcon_Normal
;
2804 if ( item
->IsSelected() )
2805 image
+= wxTreeItemIcon_Selected
- wxTreeItemIcon_Normal
;
2807 m_imageListButtons
->GetSize(image
, image_w
, image_h
);
2808 int xx
= x
- image_w
/2;
2809 int yy
= y_mid
- image_h
/2;
2811 wxDCClipper
clip(dc
, xx
, yy
, image_w
, image_h
);
2812 m_imageListButtons
->Draw(image
, dc
, xx
, yy
,
2813 wxIMAGELIST_DRAW_TRANSPARENT
);
2815 else // no custom buttons
2817 static const int wImage
= 9;
2818 static const int hImage
= 9;
2821 if (item
->IsExpanded())
2822 flag
|= wxCONTROL_EXPANDED
;
2823 if (item
== m_underMouse
)
2824 flag
|= wxCONTROL_CURRENT
;
2826 wxRendererNative::Get().DrawTreeItemButton
2830 wxRect(x
- wImage
/2,
2839 if (item
->IsExpanded())
2841 wxArrayGenericTreeItems
& children
= item
->GetChildren();
2842 int count
= children
.GetCount();
2849 PaintLevel(children
[n
], dc
, level
, y
);
2850 } while (++n
< count
);
2852 if (!HasFlag(wxTR_NO_LINES
) && count
> 0)
2854 // draw line down to last child
2855 oldY
+= GetLineHeight(children
[n
-1])>>1;
2856 if (HasButtons()) y_mid
+= 5;
2858 // Only draw the portion of the line that is visible, in case
2860 wxCoord xOrigin
=0, yOrigin
=0, width
, height
;
2861 dc
.GetDeviceOrigin(&xOrigin
, &yOrigin
);
2862 yOrigin
= abs(yOrigin
);
2863 GetClientSize(&width
, &height
);
2865 // Move end points to the begining/end of the view?
2866 if (y_mid
< yOrigin
)
2868 if (oldY
> yOrigin
+ height
)
2869 oldY
= yOrigin
+ height
;
2871 // after the adjustments if y_mid is larger than oldY then the
2872 // line isn't visible at all so don't draw anything
2874 dc
.DrawLine(x
, y_mid
, x
, oldY
);
2880 void wxGenericTreeCtrl::DrawDropEffect(wxGenericTreeItem
*item
)
2884 if ( item
->HasPlus() )
2886 // it's a folder, indicate it by a border
2891 // draw a line under the drop target because the item will be
2893 DrawLine(item
, !m_dropEffectAboveItem
);
2896 SetCursor(*wxSTANDARD_CURSOR
);
2901 SetCursor(wxCURSOR_NO_ENTRY
);
2905 void wxGenericTreeCtrl::DrawBorder(const wxTreeItemId
&item
)
2907 wxCHECK_RET( item
.IsOk(), "invalid item in wxGenericTreeCtrl::DrawLine" );
2909 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
2911 if (m_dndEffect
== NoEffect
)
2913 m_dndEffect
= BorderEffect
;
2914 m_dndEffectItem
= i
;
2918 m_dndEffect
= NoEffect
;
2919 m_dndEffectItem
= NULL
;
2922 wxRect
rect( i
->GetX()-1, i
->GetY()-1, i
->GetWidth()+2, GetLineHeight(i
)+2 );
2923 CalcScrolledPosition( rect
.x
, rect
.y
, &rect
.x
, &rect
.y
);
2924 RefreshRect( rect
);
2927 void wxGenericTreeCtrl::DrawLine(const wxTreeItemId
&item
, bool below
)
2929 wxCHECK_RET( item
.IsOk(), "invalid item in wxGenericTreeCtrl::DrawLine" );
2931 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
2933 if (m_dndEffect
== NoEffect
)
2936 m_dndEffect
= BelowEffect
;
2938 m_dndEffect
= AboveEffect
;
2939 m_dndEffectItem
= i
;
2943 m_dndEffect
= NoEffect
;
2944 m_dndEffectItem
= NULL
;
2947 wxRect
rect( i
->GetX()-1, i
->GetY()-1, i
->GetWidth()+2, GetLineHeight(i
)+2 );
2948 CalcScrolledPosition( rect
.x
, rect
.y
, &rect
.x
, &rect
.y
);
2949 RefreshRect( rect
);
2952 // -----------------------------------------------------------------------------
2953 // wxWidgets callbacks
2954 // -----------------------------------------------------------------------------
2956 void wxGenericTreeCtrl::OnSize( wxSizeEvent
&event
)
2959 if (HasFlag( wxTR_FULL_ROW_HIGHLIGHT
) && m_current
)
2960 RefreshLine( m_current
);
2966 void wxGenericTreeCtrl::OnPaint( wxPaintEvent
&WXUNUSED(event
) )
2974 dc
.SetFont( m_normalFont
);
2975 dc
.SetPen( m_dottedPen
);
2977 // this is now done dynamically
2978 //if(GetImageList() == NULL)
2979 // m_lineHeight = (int)(dc.GetCharHeight() + 4);
2982 PaintLevel( m_anchor
, dc
, 0, y
);
2985 void wxGenericTreeCtrl::OnSetFocus( wxFocusEvent
&event
)
2994 void wxGenericTreeCtrl::OnKillFocus( wxFocusEvent
&event
)
3003 void wxGenericTreeCtrl::OnChar( wxKeyEvent
&event
)
3005 wxTreeEvent
te( wxEVT_COMMAND_TREE_KEY_DOWN
, this);
3006 te
.m_evtKey
= event
;
3007 if ( GetEventHandler()->ProcessEvent( te
) )
3009 // intercepted by the user code
3013 if ( (m_current
== 0) || (m_key_current
== 0) )
3019 // how should the selection work for this event?
3020 bool is_multiple
, extended_select
, unselect_others
;
3021 EventFlagsToSelType(GetWindowStyleFlag(),
3024 is_multiple
, extended_select
, unselect_others
);
3026 if (GetLayoutDirection() == wxLayout_RightToLeft
)
3028 if (event
.GetKeyCode() == WXK_RIGHT
)
3029 event
.m_keyCode
= WXK_LEFT
;
3030 else if (event
.GetKeyCode() == WXK_LEFT
)
3031 event
.m_keyCode
= WXK_RIGHT
;
3036 // * : Expand all/Collapse all
3037 // ' ' | return : activate
3038 // up : go up (not last children!)
3040 // left : go to parent
3041 // right : open if parent and go next
3042 // home : go to root
3043 // end : go to last item without opening parents
3044 // alnum : start or continue searching for the item with this prefix
3045 int keyCode
= event
.GetKeyCode();
3050 if (m_current
->HasPlus() && !IsExpanded(m_current
))
3058 if ( !IsExpanded(m_current
) )
3061 ExpandAllChildren(m_current
);
3064 //else: fall through to Collapse() it
3068 if (IsExpanded(m_current
))
3070 Collapse(m_current
);
3076 // Use the item's bounding rectangle to determine position for
3079 GetBoundingRect(m_current
, ItemRect
, true);
3082 eventMenu(wxEVT_COMMAND_TREE_ITEM_MENU
, this, m_current
);
3083 // Use the left edge, vertical middle
3084 eventMenu
.m_pointDrag
= wxPoint(ItemRect
.GetX(),
3086 ItemRect
.GetHeight() / 2);
3087 GetEventHandler()->ProcessEvent( eventMenu
);
3093 if ( !event
.HasModifiers() )
3096 eventAct(wxEVT_COMMAND_TREE_ITEM_ACTIVATED
, this, m_current
);
3097 GetEventHandler()->ProcessEvent( eventAct
);
3100 // in any case, also generate the normal key event for this key,
3101 // even if we generated the ACTIVATED event above: this is what
3102 // wxMSW does and it makes sense because you might not want to
3103 // process ACTIVATED event at all and handle Space and Return
3104 // directly (and differently) which would be impossible otherwise
3108 // up goes to the previous sibling or to the last
3109 // of its children if it's expanded
3112 wxTreeItemId prev
= GetPrevSibling( m_key_current
);
3115 prev
= GetItemParent( m_key_current
);
3116 if ((prev
== GetRootItem()) && HasFlag(wxTR_HIDE_ROOT
))
3118 break; // don't go to root if it is hidden
3122 wxTreeItemIdValue cookie
;
3123 wxTreeItemId current
= m_key_current
;
3124 // TODO: Huh? If we get here, we'd better be the first
3125 // child of our parent. How else could it be?
3126 if (current
== GetFirstChild( prev
, cookie
))
3128 // otherwise we return to where we came from
3132 m_key_current
= (wxGenericTreeItem
*) prev
.m_pItem
;
3139 while ( IsExpanded(prev
) && HasChildren(prev
) )
3141 wxTreeItemId child
= GetLastChild(prev
);
3148 DoSelectItem( prev
, unselect_others
, extended_select
);
3149 m_key_current
=(wxGenericTreeItem
*) prev
.m_pItem
;
3154 // left arrow goes to the parent
3157 wxTreeItemId prev
= GetItemParent( m_current
);
3158 if ((prev
== GetRootItem()) && HasFlag(wxTR_HIDE_ROOT
))
3160 // don't go to root if it is hidden
3161 prev
= GetPrevSibling( m_current
);
3165 DoSelectItem( prev
, unselect_others
, extended_select
);
3171 // this works the same as the down arrow except that we
3172 // also expand the item if it wasn't expanded yet
3173 if (m_current
!= GetRootItem().m_pItem
|| !HasFlag(wxTR_HIDE_ROOT
))
3175 //else: don't try to expand hidden root item (which can be the
3176 // current one when the tree is empty)
3182 if (IsExpanded(m_key_current
) && HasChildren(m_key_current
))
3184 wxTreeItemIdValue cookie
;
3185 wxTreeItemId child
= GetFirstChild( m_key_current
, cookie
);
3189 DoSelectItem( child
, unselect_others
, extended_select
);
3190 m_key_current
=(wxGenericTreeItem
*) child
.m_pItem
;
3194 wxTreeItemId next
= GetNextSibling( m_key_current
);
3197 wxTreeItemId current
= m_key_current
;
3198 while (current
.IsOk() && !next
)
3200 current
= GetItemParent( current
);
3201 if (current
) next
= GetNextSibling( current
);
3206 DoSelectItem( next
, unselect_others
, extended_select
);
3207 m_key_current
=(wxGenericTreeItem
*) next
.m_pItem
;
3213 // <End> selects the last visible tree item
3216 wxTreeItemId last
= GetRootItem();
3218 while ( last
.IsOk() && IsExpanded(last
) )
3220 wxTreeItemId lastChild
= GetLastChild(last
);
3222 // it may happen if the item was expanded but then all of
3223 // its children have been deleted - so IsExpanded() returned
3224 // true, but GetLastChild() returned invalid item
3233 DoSelectItem( last
, unselect_others
, extended_select
);
3238 // <Home> selects the root item
3241 wxTreeItemId prev
= GetRootItem();
3245 if ( HasFlag(wxTR_HIDE_ROOT
) )
3247 wxTreeItemIdValue cookie
;
3248 prev
= GetFirstChild(prev
, cookie
);
3253 DoSelectItem( prev
, unselect_others
, extended_select
);
3258 // do not use wxIsalnum() here
3259 if ( !event
.HasModifiers() &&
3260 ((keyCode
>= '0' && keyCode
<= '9') ||
3261 (keyCode
>= 'a' && keyCode
<= 'z') ||
3262 (keyCode
>= 'A' && keyCode
<= 'Z' )))
3264 // find the next item starting with the given prefix
3265 wxChar ch
= (wxChar
)keyCode
;
3267 wxTreeItemId id
= FindItem(m_current
, m_findPrefix
+ ch
);
3278 // also start the timer to reset the current prefix if the user
3279 // doesn't press any more alnum keys soon -- we wouldn't want
3280 // to use this prefix for a new item search
3283 m_findTimer
= new wxTreeFindTimer(this);
3286 m_findTimer
->Start(wxTreeFindTimer::DELAY
, wxTIMER_ONE_SHOT
);
3296 wxGenericTreeCtrl::DoTreeHitTest(const wxPoint
& point
, int& flags
) const
3301 if (point
.x
<0) flags
|= wxTREE_HITTEST_TOLEFT
;
3302 if (point
.x
>w
) flags
|= wxTREE_HITTEST_TORIGHT
;
3303 if (point
.y
<0) flags
|= wxTREE_HITTEST_ABOVE
;
3304 if (point
.y
>h
) flags
|= wxTREE_HITTEST_BELOW
;
3305 if (flags
) return wxTreeItemId();
3307 if (m_anchor
== NULL
)
3309 flags
= wxTREE_HITTEST_NOWHERE
;
3310 return wxTreeItemId();
3313 wxGenericTreeItem
*hit
= m_anchor
->HitTest(CalcUnscrolledPosition(point
),
3317 flags
= wxTREE_HITTEST_NOWHERE
;
3318 return wxTreeItemId();
3323 // get the bounding rectangle of the item (or of its label only)
3324 bool wxGenericTreeCtrl::GetBoundingRect(const wxTreeItemId
& item
,
3326 bool textOnly
) const
3328 wxCHECK_MSG( item
.IsOk(), false,
3329 "invalid item in wxGenericTreeCtrl::GetBoundingRect" );
3331 wxGenericTreeItem
*i
= (wxGenericTreeItem
*) item
.m_pItem
;
3335 int image_h
= 0, image_w
= 0;
3336 int image
= ((wxGenericTreeItem
*) item
.m_pItem
)->GetCurrentImage();
3337 if ( image
!= NO_IMAGE
&& m_imageListNormal
)
3339 m_imageListNormal
->GetSize( image
, image_w
, image_h
);
3340 image_w
+= MARGIN_BETWEEN_IMAGE_AND_TEXT
;
3343 int state_h
= 0, state_w
= 0;
3344 int state
= ((wxGenericTreeItem
*) item
.m_pItem
)->GetState();
3345 if ( state
!= wxTREE_ITEMSTATE_NONE
&& m_imageListState
)
3347 m_imageListState
->GetSize( state
, state_w
, state_h
);
3349 state_w
+= MARGIN_BETWEEN_STATE_AND_IMAGE
;
3351 state_w
+= MARGIN_BETWEEN_IMAGE_AND_TEXT
;
3354 rect
.x
= i
->GetX() + state_w
+ image_w
;
3355 rect
.width
= i
->GetWidth() - state_w
- image_w
;
3358 else // the entire line
3361 rect
.width
= GetClientSize().x
;
3365 rect
.height
= GetLineHeight(i
);
3367 // we have to return the logical coordinates, not physical ones
3368 rect
.SetTopLeft(CalcScrolledPosition(rect
.GetTopLeft()));
3373 wxTextCtrl
*wxGenericTreeCtrl::EditLabel(const wxTreeItemId
& item
,
3374 wxClassInfo
* WXUNUSED(textCtrlClass
))
3376 wxCHECK_MSG( item
.IsOk(), NULL
, _T("can't edit an invalid item") );
3378 wxGenericTreeItem
*itemEdit
= (wxGenericTreeItem
*)item
.m_pItem
;
3380 wxTreeEvent
te(wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT
, this, itemEdit
);
3381 if ( GetEventHandler()->ProcessEvent( te
) && !te
.IsAllowed() )
3387 // We have to call this here because the label in
3388 // question might just have been added and no screen
3389 // update taken place.
3391 #if defined( __WXMSW__ ) || defined(__WXMAC__)
3394 DoDirtyProcessing();
3397 // TODO: use textCtrlClass here to create the control of correct class
3398 m_textCtrl
= new wxTreeTextCtrl(this, itemEdit
);
3400 m_textCtrl
->SetFocus();
3405 // returns a pointer to the text edit control if the item is being
3406 // edited, NULL otherwise (it's assumed that no more than one item may
3407 // be edited simultaneously)
3408 wxTextCtrl
* wxGenericTreeCtrl::GetEditControl() const
3413 void wxGenericTreeCtrl::EndEditLabel(const wxTreeItemId
& WXUNUSED(item
),
3414 bool discardChanges
)
3416 wxCHECK_RET( m_textCtrl
, _T("not editing label") );
3418 m_textCtrl
->EndEdit(discardChanges
);
3421 bool wxGenericTreeCtrl::OnRenameAccept(wxGenericTreeItem
*item
,
3422 const wxString
& value
)
3424 wxTreeEvent
le(wxEVT_COMMAND_TREE_END_LABEL_EDIT
, this, item
);
3426 le
.m_editCancelled
= false;
3428 return !GetEventHandler()->ProcessEvent( le
) || le
.IsAllowed();
3431 void wxGenericTreeCtrl::OnRenameCancelled(wxGenericTreeItem
*item
)
3433 // let owner know that the edit was cancelled
3434 wxTreeEvent
le(wxEVT_COMMAND_TREE_END_LABEL_EDIT
, this, item
);
3435 le
.m_label
= wxEmptyString
;
3436 le
.m_editCancelled
= true;
3438 GetEventHandler()->ProcessEvent( le
);
3441 void wxGenericTreeCtrl::OnRenameTimer()
3443 EditLabel( m_current
);
3446 void wxGenericTreeCtrl::OnMouse( wxMouseEvent
&event
)
3448 if ( !m_anchor
)return;
3450 wxPoint pt
= CalcUnscrolledPosition(event
.GetPosition());
3452 // Is the mouse over a tree item button?
3454 wxGenericTreeItem
*thisItem
= m_anchor
->HitTest(pt
, this, flags
, 0);
3455 wxGenericTreeItem
*underMouse
= thisItem
;
3457 bool underMouseChanged
= (underMouse
!= m_underMouse
) ;
3458 #endif // wxUSE_TOOLTIPS
3461 (flags
& wxTREE_HITTEST_ONITEMBUTTON
) &&
3462 (!event
.LeftIsDown()) &&
3464 (!m_renameTimer
|| !m_renameTimer
->IsRunning()))
3472 if (underMouse
!= m_underMouse
)
3476 // unhighlight old item
3477 wxGenericTreeItem
*tmp
= m_underMouse
;
3478 m_underMouse
= NULL
;
3482 m_underMouse
= underMouse
;
3484 RefreshLine( m_underMouse
);
3488 // Determines what item we are hovering over and need a tooltip for
3489 wxTreeItemId hoverItem
= thisItem
;
3491 // We do not want a tooltip if we are dragging, or if the rename timer is
3493 if ( underMouseChanged
&&
3496 (!m_renameTimer
|| !m_renameTimer
->IsRunning()) )
3498 // Ask the tree control what tooltip (if any) should be shown
3500 hevent(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP
, this, hoverItem
);
3502 if ( GetEventHandler()->ProcessEvent(hevent
) && hevent
.IsAllowed() )
3504 SetToolTip(hevent
.m_label
);
3509 // we process left mouse up event (enables in-place edit), middle/right down
3510 // (pass to the user code), left dbl click (activate item) and
3511 // dragging/moving events for items drag-and-drop
3512 if ( !(event
.LeftDown() ||
3514 event
.MiddleDown() ||
3515 event
.RightDown() ||
3516 event
.LeftDClick() ||
3518 ((event
.Moving() || event
.RightUp()) && m_isDragging
)) )
3527 wxGenericTreeItem
*item
= m_anchor
->HitTest(pt
, this, flags
, 0);
3529 if ( event
.Dragging() && !m_isDragging
)
3531 if (m_dragCount
== 0)
3536 if (m_dragCount
!= 3)
3538 // wait until user drags a bit further...
3542 wxEventType command
= event
.RightIsDown()
3543 ? wxEVT_COMMAND_TREE_BEGIN_RDRAG
3544 : wxEVT_COMMAND_TREE_BEGIN_DRAG
;
3546 wxTreeEvent
nevent(command
, this, m_current
);
3547 nevent
.SetPoint(CalcScrolledPosition(pt
));
3549 // by default the dragging is not supported, the user code must
3550 // explicitly allow the event for it to take place
3553 if ( GetEventHandler()->ProcessEvent(nevent
) && nevent
.IsAllowed() )
3555 // we're going to drag this item
3556 m_isDragging
= true;
3558 // remember the old cursor because we will change it while
3560 m_oldCursor
= m_cursor
;
3562 // in a single selection control, hide the selection temporarily
3563 if ( !(GetWindowStyleFlag() & wxTR_MULTIPLE
) )
3565 m_oldSelection
= (wxGenericTreeItem
*) GetSelection().m_pItem
;
3567 if ( m_oldSelection
)
3569 m_oldSelection
->SetHilight(false);
3570 RefreshLine(m_oldSelection
);
3577 else if ( event
.Dragging() )
3579 if ( item
!= m_dropTarget
)
3581 // unhighlight the previous drop target
3582 DrawDropEffect(m_dropTarget
);
3584 m_dropTarget
= item
;
3586 // highlight the current drop target if any
3587 DrawDropEffect(m_dropTarget
);
3589 #if defined(__WXMSW__) || defined(__WXMAC__) || defined(__WXGTK20__)
3596 else if ( (event
.LeftUp() || event
.RightUp()) && m_isDragging
)
3600 // erase the highlighting
3601 DrawDropEffect(m_dropTarget
);
3603 if ( m_oldSelection
)
3605 m_oldSelection
->SetHilight(true);
3606 RefreshLine(m_oldSelection
);
3607 m_oldSelection
= NULL
;
3610 // generate the drag end event
3611 wxTreeEvent
eventEndDrag(wxEVT_COMMAND_TREE_END_DRAG
, this, item
);
3613 eventEndDrag
.m_pointDrag
= CalcScrolledPosition(pt
);
3615 (void)GetEventHandler()->ProcessEvent(eventEndDrag
);
3617 m_isDragging
= false;
3618 m_dropTarget
= NULL
;
3620 SetCursor(m_oldCursor
);
3622 #if defined( __WXMSW__ ) || defined(__WXMAC__)
3630 // If we got to this point, we are not dragging or moving the mouse.
3631 // Because the code in carbon/toplevel.cpp will only set focus to the
3632 // tree if we skip for EVT_LEFT_DOWN, we MUST skip this event here for
3634 // We skip even if we didn't hit an item because we still should
3635 // restore focus to the tree control even if we didn't exactly hit an
3637 if ( event
.LeftDown() )
3642 // here we process only the messages which happen on tree items
3646 if (item
== NULL
) return; /* we hit the blank area */
3648 if ( event
.RightDown() )
3650 // If the item is already selected, do not update the selection.
3651 // Multi-selections should not be cleared if a selected item is
3653 if (!IsSelected(item
))
3655 DoSelectItem(item
, true, false);
3659 nevent(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK
, this, item
);
3660 nevent
.m_pointDrag
= CalcScrolledPosition(pt
);
3661 event
.Skip(!GetEventHandler()->ProcessEvent(nevent
));
3663 // Consistent with MSW (for now), send the ITEM_MENU *after*
3664 // the RIGHT_CLICK event. TODO: This behavior may change.
3665 wxTreeEvent
nevent2(wxEVT_COMMAND_TREE_ITEM_MENU
, this, item
);
3666 nevent2
.m_pointDrag
= CalcScrolledPosition(pt
);
3667 GetEventHandler()->ProcessEvent(nevent2
);
3669 else if ( event
.MiddleDown() )
3672 nevent(wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK
, this, item
);
3673 nevent
.m_pointDrag
= CalcScrolledPosition(pt
);
3674 event
.Skip(!GetEventHandler()->ProcessEvent(nevent
));
3676 else if ( event
.LeftUp() )
3678 if (flags
& wxTREE_HITTEST_ONITEMSTATEICON
)
3681 nevent(wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK
, this, item
);
3682 GetEventHandler()->ProcessEvent(nevent
);
3685 // this facilitates multiple-item drag-and-drop
3687 if ( /* item && */ HasFlag(wxTR_MULTIPLE
))
3689 wxArrayTreeItemIds selections
;
3690 size_t count
= GetSelections(selections
);
3696 DoSelectItem(item
, true, false);
3702 if ( (item
== m_current
) &&
3703 (flags
& wxTREE_HITTEST_ONITEMLABEL
) &&
3704 HasFlag(wxTR_EDIT_LABELS
) )
3706 if ( m_renameTimer
)
3708 if ( m_renameTimer
->IsRunning() )
3709 m_renameTimer
->Stop();
3713 m_renameTimer
= new wxTreeRenameTimer( this );
3716 m_renameTimer
->Start( wxTreeRenameTimer::DELAY
, true );
3719 m_lastOnSame
= false;
3722 else // !RightDown() && !MiddleDown() && !LeftUp()
3724 // ==> LeftDown() || LeftDClick()
3725 if ( event
.LeftDown() )
3727 m_lastOnSame
= item
== m_current
;
3730 if ( flags
& wxTREE_HITTEST_ONITEMBUTTON
)
3732 // only toggle the item for a single click, double click on
3733 // the button doesn't do anything (it toggles the item twice)
3734 if ( event
.LeftDown() )
3739 // don't select the item if the button was clicked
3744 // clear the previously selected items, if the
3745 // user clicked outside of the present selection.
3746 // otherwise, perform the deselection on mouse-up.
3747 // this allows multiple drag and drop to work.
3748 // but if Cmd is down, toggle selection of the clicked item
3749 if (!IsSelected(item
) || event
.CmdDown())
3751 // how should the selection work for this event?
3752 bool is_multiple
, extended_select
, unselect_others
;
3753 EventFlagsToSelType(GetWindowStyleFlag(),
3760 DoSelectItem(item
, unselect_others
, extended_select
);
3764 // For some reason, Windows isn't recognizing a left double-click,
3765 // so we need to simulate it here. Allow 200 milliseconds for now.
3766 if ( event
.LeftDClick() )
3768 // double clicking should not start editing the item label
3769 if ( m_renameTimer
)
3770 m_renameTimer
->Stop();
3772 m_lastOnSame
= false;
3774 // send activate event first
3776 nevent(wxEVT_COMMAND_TREE_ITEM_ACTIVATED
, this, item
);
3777 nevent
.m_pointDrag
= CalcScrolledPosition(pt
);
3778 if ( !GetEventHandler()->ProcessEvent( nevent
) )
3780 // if the user code didn't process the activate event,
3781 // handle it ourselves by toggling the item when it is
3783 if ( item
->HasPlus() )
3793 void wxGenericTreeCtrl::OnInternalIdle()
3795 wxWindow::OnInternalIdle();
3797 // Check if we need to select the root item
3798 // because nothing else has been selected.
3799 // Delaying it means that we can invoke event handlers
3800 // as required, when a first item is selected.
3801 if (!HasFlag(wxTR_MULTIPLE
) && !GetSelection().IsOk())
3804 SelectItem(m_select_me
);
3805 else if (GetRootItem().IsOk())
3806 SelectItem(GetRootItem());
3809 // after all changes have been done to the tree control,
3810 // actually redraw the tree when everything is over
3812 DoDirtyProcessing();
3816 wxGenericTreeCtrl::CalculateLevel(wxGenericTreeItem
*item
,
3821 int x
= level
*m_indent
;
3822 if (!HasFlag(wxTR_HIDE_ROOT
))
3826 else if (level
== 0)
3828 // a hidden root is not evaluated, but its
3829 // children are always calculated
3833 item
->CalculateSize(this, dc
);
3836 item
->SetX( x
+m_spacing
);
3838 y
+= GetLineHeight(item
);
3840 if ( !item
->IsExpanded() )
3842 // we don't need to calculate collapsed branches
3847 wxArrayGenericTreeItems
& children
= item
->GetChildren();
3848 size_t n
, count
= children
.GetCount();
3850 for (n
= 0; n
< count
; ++n
)
3851 CalculateLevel( children
[n
], dc
, level
, y
); // recurse
3854 void wxGenericTreeCtrl::CalculatePositions()
3856 if ( !m_anchor
) return;
3858 wxClientDC
dc(this);
3861 dc
.SetFont( m_normalFont
);
3863 dc
.SetPen( m_dottedPen
);
3864 //if(GetImageList() == NULL)
3865 // m_lineHeight = (int)(dc.GetCharHeight() + 4);
3868 CalculateLevel( m_anchor
, dc
, 0, y
); // start recursion
3871 void wxGenericTreeCtrl::Refresh(bool eraseBackground
, const wxRect
*rect
)
3874 wxTreeCtrlBase::Refresh(eraseBackground
, rect
);
3877 void wxGenericTreeCtrl::RefreshSubtree(wxGenericTreeItem
*item
)
3879 if (m_dirty
|| IsFrozen() )
3882 wxSize client
= GetClientSize();
3885 CalcScrolledPosition(0, item
->GetY(), NULL
, &rect
.y
);
3886 rect
.width
= client
.x
;
3887 rect
.height
= client
.y
;
3889 Refresh(true, &rect
);
3891 AdjustMyScrollbars();
3894 void wxGenericTreeCtrl::RefreshLine( wxGenericTreeItem
*item
)
3896 if (m_dirty
|| IsFrozen() )
3900 CalcScrolledPosition(0, item
->GetY(), NULL
, &rect
.y
);
3901 rect
.width
= GetClientSize().x
;
3902 rect
.height
= GetLineHeight(item
); //dc.GetCharHeight() + 6;
3904 Refresh(true, &rect
);
3907 void wxGenericTreeCtrl::RefreshSelected()
3912 // TODO: this is awfully inefficient, we should keep the list of all
3913 // selected items internally, should be much faster
3915 RefreshSelectedUnder(m_anchor
);
3918 void wxGenericTreeCtrl::RefreshSelectedUnder(wxGenericTreeItem
*item
)
3923 if ( item
->IsSelected() )
3926 const wxArrayGenericTreeItems
& children
= item
->GetChildren();
3927 size_t count
= children
.GetCount();
3928 for ( size_t n
= 0; n
< count
; n
++ )
3930 RefreshSelectedUnder(children
[n
]);
3934 void wxGenericTreeCtrl::DoThaw()
3936 wxTreeCtrlBase::DoThaw();
3939 DoDirtyProcessing();
3944 // ----------------------------------------------------------------------------
3945 // changing colours: we need to refresh the tree control
3946 // ----------------------------------------------------------------------------
3948 bool wxGenericTreeCtrl::SetBackgroundColour(const wxColour
& colour
)
3950 if ( !wxWindow::SetBackgroundColour(colour
) )
3958 bool wxGenericTreeCtrl::SetForegroundColour(const wxColour
& colour
)
3960 if ( !wxWindow::SetForegroundColour(colour
) )
3968 // Process the tooltip event, to speed up event processing.
3969 // Doesn't actually get a tooltip.
3970 void wxGenericTreeCtrl::OnGetToolTip( wxTreeEvent
&event
)
3976 // NOTE: If using the wxListBox visual attributes works everywhere then this can
3977 // be removed, as well as the #else case below.
3978 #define _USE_VISATTR 0
3983 wxGenericTreeCtrl::GetClassDefaultAttributes(wxWindowVariant variant
)
3985 wxGenericTreeCtrl::GetClassDefaultAttributes(wxWindowVariant
WXUNUSED(variant
))
3989 // Use the same color scheme as wxListBox
3990 return wxListBox::GetClassDefaultAttributes(variant
);
3992 wxVisualAttributes attr
;
3993 attr
.colFg
= wxSystemSettings::GetColour(wxSYS_COLOUR_LISTBOXTEXT
);
3994 attr
.colBg
= wxSystemSettings::GetColour(wxSYS_COLOUR_LISTBOX
);
3995 attr
.font
= wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
);
4000 void wxGenericTreeCtrl::DoDirtyProcessing()
4007 CalculatePositions();
4009 AdjustMyScrollbars();
4012 wxSize
wxGenericTreeCtrl::DoGetBestSize() const
4014 // make sure all positions are calculated as normally this only done during
4015 // idle time but we need them for base class DoGetBestSize() to return the
4017 wxConstCast(this, wxGenericTreeCtrl
)->CalculatePositions();
4019 wxSize size
= wxTreeCtrlBase::DoGetBestSize();
4021 // there seems to be an implicit extra border around the items, although
4022 // I'm not really sure where does it come from -- but without this, the
4023 // scrollbars appear in a tree with default/best size
4026 // and the border has to be rounded up to a multiple of PIXELS_PER_UNIT or
4027 // scrollbars still appear
4028 const wxSize
& borderSize
= GetWindowBorderSize();
4030 int dx
= (size
.x
- borderSize
.x
) % PIXELS_PER_UNIT
;
4032 size
.x
+= PIXELS_PER_UNIT
- dx
;
4033 int dy
= (size
.y
- borderSize
.y
) % PIXELS_PER_UNIT
;
4035 size
.y
+= PIXELS_PER_UNIT
- dy
;
4037 // we need to update the cache too as the base class cached its own value
4038 CacheBestSize(size
);
4043 #endif // wxUSE_TREECTRL