1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/treectrl.cpp
4 // Author: Julian Smart
5 // Modified by: Vadim Zeitlin to be less MSW-specific on 10.10.98
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
21 #pragma implementation "treectrl.h"
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
33 #include "wx/msw/private.h"
35 // Set this to 1 to be _absolutely_ sure that repainting will work for all
36 // comctl32.dll versions
37 #define wxUSE_COMCTL32_SAFELY 0
39 // Mingw32 is a bit mental even though this is done in winundef
48 #if defined(__WIN95__)
52 #include "wx/dynarray.h"
53 #include "wx/imaglist.h"
54 #include "wx/settings.h"
55 #include "wx/msw/treectrl.h"
56 #include "wx/msw/dragimag.h"
58 #ifdef __GNUWIN32_OLD__
59 #include "wx/msw/gnuwin32/extra.h"
62 #if defined(__WIN95__) && !((defined(__GNUWIN32_OLD__) || defined(__TWIN32__)) && !defined(__CYGWIN10__))
66 // Bug in headers, sometimes
68 #define TVIS_FOCUSED 0x0001
72 #define TV_FIRST 0x1100
75 #ifndef TVS_CHECKBOXES
76 #define TVS_CHECKBOXES 0x0100
79 #ifndef TVS_FULLROWSELECT
80 #define TVS_FULLROWSELECT 0x1000
83 // old headers might miss these messages (comctl32.dll 4.71+ only)
84 #ifndef TVM_SETBKCOLOR
85 #define TVM_SETBKCOLOR (TV_FIRST + 29)
86 #define TVM_SETTEXTCOLOR (TV_FIRST + 30)
89 // a macro to hide the ugliness of nested casts
90 #define HITEM(item) (HTREEITEM)(WXHTREEITEM)(item)
92 // the native control doesn't support multiple selections under MSW and we
93 // have 2 ways to emulate them: either using TVS_CHECKBOXES style and let
94 // checkboxes be the selection status (checked == selected) or by really
95 // emulating everything, i.e. intercepting mouse and key events &c. The first
96 // approach is much easier but doesn't work with comctl32.dll < 4.71 and also
98 #define wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE 0
101 // ----------------------------------------------------------------------------
103 // ----------------------------------------------------------------------------
105 // wrapper for TreeView_HitTest
106 static HTREEITEM
GetItemFromPoint(HWND hwndTV
, int x
, int y
)
112 return (HTREEITEM
)TreeView_HitTest(hwndTV
, &tvht
);
115 #if !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
117 // wrappers for TreeView_GetItem/TreeView_SetItem
118 static bool IsItemSelected(HWND hwndTV
, HTREEITEM hItem
)
121 tvi
.mask
= TVIF_STATE
| TVIF_HANDLE
;
122 tvi
.stateMask
= TVIS_SELECTED
;
125 if ( !TreeView_GetItem(hwndTV
, &tvi
) )
127 wxLogLastError(wxT("TreeView_GetItem"));
130 return (tvi
.state
& TVIS_SELECTED
) != 0;
133 static void SelectItem(HWND hwndTV
, HTREEITEM hItem
, bool select
= TRUE
)
136 tvi
.mask
= TVIF_STATE
| TVIF_HANDLE
;
137 tvi
.stateMask
= TVIS_SELECTED
;
138 tvi
.state
= select
? TVIS_SELECTED
: 0;
141 if ( TreeView_SetItem(hwndTV
, &tvi
) == -1 )
143 wxLogLastError(wxT("TreeView_SetItem"));
147 static inline void UnselectItem(HWND hwndTV
, HTREEITEM htItem
)
149 SelectItem(hwndTV
, htItem
, FALSE
);
152 static inline void ToggleItemSelection(HWND hwndTV
, HTREEITEM htItem
)
154 SelectItem(hwndTV
, htItem
, !IsItemSelected(hwndTV
, htItem
));
157 // helper function which selects all items in a range and, optionally,
158 // unselects all others
159 static void SelectRange(HWND hwndTV
,
162 bool unselectOthers
= TRUE
)
164 // find the first (or last) item and select it
166 HTREEITEM htItem
= (HTREEITEM
)TreeView_GetRoot(hwndTV
);
167 while ( htItem
&& cont
)
169 if ( (htItem
== htFirst
) || (htItem
== htLast
) )
171 if ( !IsItemSelected(hwndTV
, htItem
) )
173 SelectItem(hwndTV
, htItem
);
180 if ( unselectOthers
&& IsItemSelected(hwndTV
, htItem
) )
182 UnselectItem(hwndTV
, htItem
);
186 htItem
= (HTREEITEM
)TreeView_GetNextVisible(hwndTV
, htItem
);
189 // select the items in range
190 cont
= htFirst
!= htLast
;
191 while ( htItem
&& cont
)
193 if ( !IsItemSelected(hwndTV
, htItem
) )
195 SelectItem(hwndTV
, htItem
);
198 cont
= (htItem
!= htFirst
) && (htItem
!= htLast
);
200 htItem
= (HTREEITEM
)TreeView_GetNextVisible(hwndTV
, htItem
);
204 if ( unselectOthers
)
208 if ( IsItemSelected(hwndTV
, htItem
) )
210 UnselectItem(hwndTV
, htItem
);
213 htItem
= (HTREEITEM
)TreeView_GetNextVisible(hwndTV
, htItem
);
217 // seems to be necessary - otherwise the just selected items don't always
218 // appear as selected
219 UpdateWindow(hwndTV
);
222 // helper function which tricks the standard control into changing the focused
223 // item without changing anything else (if someone knows why Microsoft doesn't
224 // allow to do it by just setting TVIS_FOCUSED flag, please tell me!)
225 static void SetFocus(HWND hwndTV
, HTREEITEM htItem
)
228 HTREEITEM htFocus
= (HTREEITEM
)TreeView_GetSelection(hwndTV
);
233 if ( htItem
!= htFocus
)
235 // remember the selection state of the item
236 bool wasSelected
= IsItemSelected(hwndTV
, htItem
);
238 if ( htFocus
&& IsItemSelected(hwndTV
, htFocus
) )
240 // prevent the tree from unselecting the old focus which it
241 // would do by default (TreeView_SelectItem unselects the
243 TreeView_SelectItem(hwndTV
, 0);
244 SelectItem(hwndTV
, htFocus
);
247 TreeView_SelectItem(hwndTV
, htItem
);
251 // need to clear the selection which TreeView_SelectItem() gave
253 UnselectItem(hwndTV
, htItem
);
255 //else: was selected, still selected - ok
257 //else: nothing to do, focus already there
263 bool wasFocusSelected
= IsItemSelected(hwndTV
, htFocus
);
265 // just clear the focus
266 TreeView_SelectItem(hwndTV
, 0);
268 if ( wasFocusSelected
)
270 // restore the selection state
271 SelectItem(hwndTV
, htFocus
);
274 //else: nothing to do, no focus already
278 #endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
280 // ----------------------------------------------------------------------------
282 // ----------------------------------------------------------------------------
284 // a convenient wrapper around TV_ITEM struct which adds a ctor
286 #pragma warning( disable : 4097 ) // inheriting from typedef
289 struct wxTreeViewItem
: public TV_ITEM
291 wxTreeViewItem(const wxTreeItemId
& item
, // the item handle
292 UINT mask_
, // fields which are valid
293 UINT stateMask_
= 0) // for TVIF_STATE only
295 // hItem member is always valid
296 mask
= mask_
| TVIF_HANDLE
;
297 stateMask
= stateMask_
;
303 #pragma warning( default : 4097 )
306 // a class which encapsulates the tree traversal logic: it vists all (unless
307 // OnVisit() returns FALSE) items under the given one
308 class wxTreeTraversal
311 wxTreeTraversal(const wxTreeCtrl
*tree
)
316 // do traverse the tree: visit all items (recursively by default) under the
317 // given one; return TRUE if all items were traversed or FALSE if the
318 // traversal was aborted because OnVisit returned FALSE
319 bool DoTraverse(const wxTreeItemId
& root
, bool recursively
= TRUE
);
321 // override this function to do whatever is needed for each item, return
322 // FALSE to stop traversing
323 virtual bool OnVisit(const wxTreeItemId
& item
) = 0;
326 const wxTreeCtrl
*GetTree() const { return m_tree
; }
329 bool Traverse(const wxTreeItemId
& root
, bool recursively
);
331 const wxTreeCtrl
*m_tree
;
334 // internal class for getting the selected items
335 class TraverseSelections
: public wxTreeTraversal
338 TraverseSelections(const wxTreeCtrl
*tree
,
339 wxArrayTreeItemIds
& selections
)
340 : wxTreeTraversal(tree
), m_selections(selections
)
342 m_selections
.Empty();
344 DoTraverse(tree
->GetRootItem());
347 virtual bool OnVisit(const wxTreeItemId
& item
)
349 #if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
350 if ( GetTree()->IsItemChecked(item
) )
352 if ( ::IsItemSelected(GetHwndOf(GetTree()), HITEM(item
)) )
355 m_selections
.Add(item
);
361 size_t GetCount() const { return m_selections
.GetCount(); }
364 wxArrayTreeItemIds
& m_selections
;
367 // internal class for counting tree items
368 class TraverseCounter
: public wxTreeTraversal
371 TraverseCounter(const wxTreeCtrl
*tree
,
372 const wxTreeItemId
& root
,
374 : wxTreeTraversal(tree
)
378 DoTraverse(root
, recursively
);
381 virtual bool OnVisit(const wxTreeItemId
& WXUNUSED(item
))
388 size_t GetCount() const { return m_count
; }
394 // ----------------------------------------------------------------------------
395 // This class is needed for support of different images: the Win32 common
396 // control natively supports only 2 images (the normal one and another for the
397 // selected state). We wish to provide support for 2 more of them for folder
398 // items (i.e. those which have children): for expanded state and for expanded
399 // selected state. For this we use this structure to store the additional items
402 // There is only one problem with this: when we retrieve the item's data, we
403 // don't know whether we get a pointer to wxTreeItemData or
404 // wxTreeItemIndirectData. So we always set the item id to an invalid value
405 // in this class and the code using the client data checks for it and retrieves
406 // the real client data in this case.
407 // ----------------------------------------------------------------------------
409 class wxTreeItemIndirectData
: public wxTreeItemData
412 // ctor associates this data with the item and the real item data becomes
413 // available through our GetData() method
414 wxTreeItemIndirectData(wxTreeCtrl
*tree
, const wxTreeItemId
& item
)
416 for ( size_t n
= 0; n
< WXSIZEOF(m_images
); n
++ )
422 m_data
= tree
->GetItemData(item
);
424 // and set ourselves as the new one
425 tree
->SetIndirectItemData(item
, this);
427 // we must have the invalid value for the item
431 // dtor deletes the associated data as well
432 virtual ~wxTreeItemIndirectData() { delete m_data
; }
435 // get the real data associated with the item
436 wxTreeItemData
*GetData() const { return m_data
; }
438 void SetData(wxTreeItemData
*data
) { m_data
= data
; }
440 // do we have such image?
441 bool HasImage(wxTreeItemIcon which
) const { return m_images
[which
] != -1; }
443 int GetImage(wxTreeItemIcon which
) const { return m_images
[which
]; }
445 void SetImage(int image
, wxTreeItemIcon which
) { m_images
[which
] = image
; }
448 // all the images associated with the item
449 int m_images
[wxTreeItemIcon_Max
];
451 // the real client data
452 wxTreeItemData
*m_data
;
455 // ----------------------------------------------------------------------------
457 // ----------------------------------------------------------------------------
459 IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl
, wxControl
)
461 // ----------------------------------------------------------------------------
463 // ----------------------------------------------------------------------------
465 // handy table for sending events
466 static wxEventType g_events
[2][2] =
468 { wxEVT_COMMAND_TREE_ITEM_COLLAPSED
, wxEVT_COMMAND_TREE_ITEM_COLLAPSING
},
469 { wxEVT_COMMAND_TREE_ITEM_EXPANDED
, wxEVT_COMMAND_TREE_ITEM_EXPANDING
}
472 // ============================================================================
474 // ============================================================================
476 // ----------------------------------------------------------------------------
478 // ----------------------------------------------------------------------------
480 bool wxTreeTraversal::DoTraverse(const wxTreeItemId
& root
, bool recursively
)
482 if ( !OnVisit(root
) )
485 return Traverse(root
, recursively
);
488 bool wxTreeTraversal::Traverse(const wxTreeItemId
& root
, bool recursively
)
491 wxTreeItemId child
= m_tree
->GetFirstChild(root
, cookie
);
492 while ( child
.IsOk() )
494 // depth first traversal
495 if ( recursively
&& !Traverse(child
, TRUE
) )
498 if ( !OnVisit(child
) )
501 child
= m_tree
->GetNextChild(root
, cookie
);
507 // ----------------------------------------------------------------------------
508 // construction and destruction
509 // ----------------------------------------------------------------------------
511 void wxTreeCtrl::Init()
513 m_imageListNormal
= NULL
;
514 m_imageListState
= NULL
;
515 m_ownsImageListNormal
= m_ownsImageListState
= FALSE
;
517 m_hasAnyAttr
= FALSE
;
521 // Initialize static array of events, because with the new event system,
522 // they may not be initialized yet.
524 g_events
[0][0] = wxEVT_COMMAND_TREE_ITEM_COLLAPSED
;
525 g_events
[0][1] = wxEVT_COMMAND_TREE_ITEM_COLLAPSING
;
526 g_events
[1][0] = wxEVT_COMMAND_TREE_ITEM_EXPANDED
;
527 g_events
[1][1] = wxEVT_COMMAND_TREE_ITEM_EXPANDING
;
530 bool wxTreeCtrl::Create(wxWindow
*parent
,
535 const wxValidator
& validator
,
536 const wxString
& name
)
540 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
543 DWORD wstyle
= WS_VISIBLE
| WS_CHILD
| WS_TABSTOP
|
546 if ( m_windowStyle
& wxCLIP_SIBLINGS
)
547 wstyle
|= WS_CLIPSIBLINGS
;
549 if ((m_windowStyle
& wxTR_NO_LINES
) == 0)
550 wstyle
|= TVS_HASLINES
;
551 if ( m_windowStyle
& wxTR_HAS_BUTTONS
)
552 wstyle
|= TVS_HASBUTTONS
;
554 if ( m_windowStyle
& wxTR_EDIT_LABELS
)
555 wstyle
|= TVS_EDITLABELS
;
557 if ( m_windowStyle
& wxTR_LINES_AT_ROOT
)
558 wstyle
|= TVS_LINESATROOT
;
560 if ( m_windowStyle
& wxTR_FULL_ROW_HIGHLIGHT
)
562 if ( wxTheApp
->GetComCtl32Version() >= 471 )
563 wstyle
|= TVS_FULLROWSELECT
;
567 // using TVS_CHECKBOXES for emulation of a multiselection tree control
568 // doesn't work without the new enough headers
569 #if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE && \
570 !defined( __GNUWIN32_OLD__ ) && \
571 !defined( __BORLANDC__ ) && \
572 !defined( __WATCOMC__ ) && \
573 (!defined(__VISUALC__) || (__VISUALC__ > 1010))
575 // we emulate the multiple selection tree controls by using checkboxes: set
576 // up the image list we need for this if we do have multiple selections
577 if ( m_windowStyle
& wxTR_MULTIPLE
)
578 wstyle
|= TVS_CHECKBOXES
;
579 #endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
581 // Create the tree control.
582 if ( !MSWCreateControl(WC_TREEVIEW
, wstyle
) )
585 #if wxUSE_COMCTL32_SAFELY
586 wxWindow::SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_WINDOW
));
587 wxWindow::SetForegroundColour(wxWindow::GetParent()->GetForegroundColour());
589 SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_WINDOW
));
590 SetForegroundColour(wxWindow::GetParent()->GetForegroundColour());
592 // This works around a bug in the Windows tree control whereby for some versions
593 // of comctrl32, setting any colour actually draws the background in black.
594 // This will initialise the background to the system colour.
595 // THIS FIX NOW REVERTED since it caused problems on _other_ systems.
596 // Assume the user has an updated comctl32.dll.
597 ::SendMessage(GetHwnd(), TVM_SETBKCOLOR
, 0,-1);
598 wxWindow::SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_WINDOW
));
599 SetForegroundColour(wxWindow::GetParent()->GetForegroundColour());
603 // VZ: this is some experimental code which may be used to get the
604 // TVS_CHECKBOXES style functionality for comctl32.dll < 4.71.
605 // AFAIK, the standard DLL does about the same thing anyhow.
607 if ( m_windowStyle
& wxTR_MULTIPLE
)
611 // create the DC compatible with the current screen
612 HDC hdcMem
= CreateCompatibleDC(NULL
);
614 // create a mono bitmap of the standard size
615 int x
= GetSystemMetrics(SM_CXMENUCHECK
);
616 int y
= GetSystemMetrics(SM_CYMENUCHECK
);
617 wxImageList
imagelistCheckboxes(x
, y
, FALSE
, 2);
618 HBITMAP hbmpCheck
= CreateBitmap(x
, y
, // bitmap size
619 1, // # of color planes
620 1, // # bits needed for one pixel
621 0); // array containing colour data
622 SelectObject(hdcMem
, hbmpCheck
);
624 // then draw a check mark into it
625 RECT rect
= { 0, 0, x
, y
};
626 if ( !::DrawFrameControl(hdcMem
, &rect
,
628 DFCS_BUTTONCHECK
| DFCS_CHECKED
) )
630 wxLogLastError(wxT("DrawFrameControl(check)"));
633 bmp
.SetHBITMAP((WXHBITMAP
)hbmpCheck
);
634 imagelistCheckboxes
.Add(bmp
);
636 if ( !::DrawFrameControl(hdcMem
, &rect
,
640 wxLogLastError(wxT("DrawFrameControl(uncheck)"));
643 bmp
.SetHBITMAP((WXHBITMAP
)hbmpCheck
);
644 imagelistCheckboxes
.Add(bmp
);
650 SetStateImageList(&imagelistCheckboxes
);
654 SetSize(pos
.x
, pos
.y
, size
.x
, size
.y
);
659 wxTreeCtrl::~wxTreeCtrl()
661 // delete any attributes
664 for ( wxNode
*node
= m_attrs
.Next(); node
; node
= m_attrs
.Next() )
666 delete (wxTreeItemAttr
*)node
->Data();
669 // prevent TVN_DELETEITEM handler from deleting the attributes again!
670 m_hasAnyAttr
= FALSE
;
675 // delete user data to prevent memory leaks
678 if (m_ownsImageListNormal
) delete m_imageListNormal
;
679 if (m_ownsImageListState
) delete m_imageListState
;
682 // ----------------------------------------------------------------------------
684 // ----------------------------------------------------------------------------
686 // simple wrappers which add error checking in debug mode
688 bool wxTreeCtrl::DoGetItem(wxTreeViewItem
* tvItem
) const
690 if ( !TreeView_GetItem(GetHwnd(), tvItem
) )
692 wxLogLastError(wxT("TreeView_GetItem"));
700 void wxTreeCtrl::DoSetItem(wxTreeViewItem
* tvItem
)
702 if ( TreeView_SetItem(GetHwnd(), tvItem
) == -1 )
704 wxLogLastError(wxT("TreeView_SetItem"));
708 size_t wxTreeCtrl::GetCount() const
710 return (size_t)TreeView_GetCount(GetHwnd());
713 unsigned int wxTreeCtrl::GetIndent() const
715 return TreeView_GetIndent(GetHwnd());
718 void wxTreeCtrl::SetIndent(unsigned int indent
)
720 TreeView_SetIndent(GetHwnd(), indent
);
723 wxImageList
*wxTreeCtrl::GetImageList() const
725 return m_imageListNormal
;
728 wxImageList
*wxTreeCtrl::GetStateImageList() const
730 return m_imageListNormal
;
733 void wxTreeCtrl::SetAnyImageList(wxImageList
*imageList
, int which
)
736 TreeView_SetImageList(GetHwnd(),
737 imageList
? imageList
->GetHIMAGELIST() : 0,
741 void wxTreeCtrl::SetImageList(wxImageList
*imageList
)
743 if (m_ownsImageListNormal
) delete m_imageListNormal
;
744 SetAnyImageList(m_imageListNormal
= imageList
, TVSIL_NORMAL
);
745 m_ownsImageListNormal
= FALSE
;
748 void wxTreeCtrl::SetStateImageList(wxImageList
*imageList
)
750 if (m_ownsImageListState
) delete m_imageListState
;
751 SetAnyImageList(m_imageListState
= imageList
, TVSIL_STATE
);
752 m_ownsImageListState
= FALSE
;
755 void wxTreeCtrl::AssignImageList(wxImageList
*imageList
)
757 SetImageList(imageList
);
758 m_ownsImageListNormal
= TRUE
;
761 void wxTreeCtrl::AssignStateImageList(wxImageList
*imageList
)
763 SetStateImageList(imageList
);
764 m_ownsImageListState
= TRUE
;
767 size_t wxTreeCtrl::GetChildrenCount(const wxTreeItemId
& item
,
768 bool recursively
) const
770 TraverseCounter
counter(this, item
, recursively
);
772 return counter
.GetCount() - 1;
775 // ----------------------------------------------------------------------------
777 // ----------------------------------------------------------------------------
779 bool wxTreeCtrl::SetBackgroundColour(const wxColour
&colour
)
781 #if !wxUSE_COMCTL32_SAFELY
782 if ( !wxWindowBase::SetBackgroundColour(colour
) )
785 SendMessage(GetHwnd(), TVM_SETBKCOLOR
, 0, colour
.GetPixel());
791 bool wxTreeCtrl::SetForegroundColour(const wxColour
&colour
)
793 #if !wxUSE_COMCTL32_SAFELY
794 if ( !wxWindowBase::SetForegroundColour(colour
) )
797 SendMessage(GetHwnd(), TVM_SETTEXTCOLOR
, 0, colour
.GetPixel());
803 // ----------------------------------------------------------------------------
805 // ----------------------------------------------------------------------------
807 wxString
wxTreeCtrl::GetItemText(const wxTreeItemId
& item
) const
809 wxChar buf
[512]; // the size is arbitrary...
811 wxTreeViewItem
tvItem(item
, TVIF_TEXT
);
812 tvItem
.pszText
= buf
;
813 tvItem
.cchTextMax
= WXSIZEOF(buf
);
814 if ( !DoGetItem(&tvItem
) )
816 // don't return some garbage which was on stack, but an empty string
820 return wxString(buf
);
823 void wxTreeCtrl::SetItemText(const wxTreeItemId
& item
, const wxString
& text
)
825 wxTreeViewItem
tvItem(item
, TVIF_TEXT
);
826 tvItem
.pszText
= (wxChar
*)text
.c_str(); // conversion is ok
830 int wxTreeCtrl::DoGetItemImageFromData(const wxTreeItemId
& item
,
831 wxTreeItemIcon which
) const
833 wxTreeViewItem
tvItem(item
, TVIF_PARAM
);
834 if ( !DoGetItem(&tvItem
) )
839 return ((wxTreeItemIndirectData
*)tvItem
.lParam
)->GetImage(which
);
842 void wxTreeCtrl::DoSetItemImageFromData(const wxTreeItemId
& item
,
844 wxTreeItemIcon which
) const
846 wxTreeViewItem
tvItem(item
, TVIF_PARAM
);
847 if ( !DoGetItem(&tvItem
) )
852 wxTreeItemIndirectData
*data
= ((wxTreeItemIndirectData
*)tvItem
.lParam
);
854 data
->SetImage(image
, which
);
856 // make sure that we have selected images as well
857 if ( which
== wxTreeItemIcon_Normal
&&
858 !data
->HasImage(wxTreeItemIcon_Selected
) )
860 data
->SetImage(image
, wxTreeItemIcon_Selected
);
863 if ( which
== wxTreeItemIcon_Expanded
&&
864 !data
->HasImage(wxTreeItemIcon_SelectedExpanded
) )
866 data
->SetImage(image
, wxTreeItemIcon_SelectedExpanded
);
870 void wxTreeCtrl::DoSetItemImages(const wxTreeItemId
& item
,
874 wxTreeViewItem
tvItem(item
, TVIF_IMAGE
| TVIF_SELECTEDIMAGE
);
875 tvItem
.iSelectedImage
= imageSel
;
876 tvItem
.iImage
= image
;
880 int wxTreeCtrl::GetItemImage(const wxTreeItemId
& item
,
881 wxTreeItemIcon which
) const
883 if ( HasIndirectData(item
) )
885 return DoGetItemImageFromData(item
, which
);
892 wxFAIL_MSG( wxT("unknown tree item image type") );
894 case wxTreeItemIcon_Normal
:
898 case wxTreeItemIcon_Selected
:
899 mask
= TVIF_SELECTEDIMAGE
;
902 case wxTreeItemIcon_Expanded
:
903 case wxTreeItemIcon_SelectedExpanded
:
907 wxTreeViewItem
tvItem(item
, mask
);
910 return mask
== TVIF_IMAGE
? tvItem
.iImage
: tvItem
.iSelectedImage
;
913 void wxTreeCtrl::SetItemImage(const wxTreeItemId
& item
, int image
,
914 wxTreeItemIcon which
)
916 int imageNormal
, imageSel
;
920 wxFAIL_MSG( wxT("unknown tree item image type") );
922 case wxTreeItemIcon_Normal
:
924 imageSel
= GetItemSelectedImage(item
);
927 case wxTreeItemIcon_Selected
:
928 imageNormal
= GetItemImage(item
);
932 case wxTreeItemIcon_Expanded
:
933 case wxTreeItemIcon_SelectedExpanded
:
934 if ( !HasIndirectData(item
) )
936 // we need to get the old images first, because after we create
937 // the wxTreeItemIndirectData GetItemXXXImage() will use it to
939 imageNormal
= GetItemImage(item
);
940 imageSel
= GetItemSelectedImage(item
);
942 // if it doesn't have it yet, add it
943 wxTreeItemIndirectData
*data
= new
944 wxTreeItemIndirectData(this, item
);
946 // copy the data to the new location
947 data
->SetImage(imageNormal
, wxTreeItemIcon_Normal
);
948 data
->SetImage(imageSel
, wxTreeItemIcon_Selected
);
951 DoSetItemImageFromData(item
, image
, which
);
953 // reset the normal/selected images because we won't use them any
954 // more - now they're stored inside the indirect data
956 imageSel
= I_IMAGECALLBACK
;
960 // NB: at least in version 5.00.0518.9 of comctl32.dll we need to always
961 // change both normal and selected image - otherwise the change simply
962 // doesn't take place!
963 DoSetItemImages(item
, imageNormal
, imageSel
);
966 wxTreeItemData
*wxTreeCtrl::GetItemData(const wxTreeItemId
& item
) const
968 wxTreeViewItem
tvItem(item
, TVIF_PARAM
);
969 if ( !DoGetItem(&tvItem
) )
974 wxTreeItemData
*data
= (wxTreeItemData
*)tvItem
.lParam
;
975 if ( IsDataIndirect(data
) )
977 data
= ((wxTreeItemIndirectData
*)data
)->GetData();
983 void wxTreeCtrl::SetItemData(const wxTreeItemId
& item
, wxTreeItemData
*data
)
985 // first, associate this piece of data with this item
991 wxTreeViewItem
tvItem(item
, TVIF_PARAM
);
993 if ( HasIndirectData(item
) )
995 if ( DoGetItem(&tvItem
) )
997 ((wxTreeItemIndirectData
*)tvItem
.lParam
)->SetData(data
);
1001 wxFAIL_MSG( wxT("failed to change tree items data") );
1006 tvItem
.lParam
= (LPARAM
)data
;
1011 void wxTreeCtrl::SetIndirectItemData(const wxTreeItemId
& item
,
1012 wxTreeItemIndirectData
*data
)
1014 // this should never happen because it's unnecessary and will probably lead
1015 // to crash too because the code elsewhere supposes that the pointer the
1016 // wxTreeItemIndirectData has is a real wxItemData and not
1017 // wxTreeItemIndirectData as well
1018 wxASSERT_MSG( !HasIndirectData(item
), wxT("setting indirect data twice?") );
1020 SetItemData(item
, data
);
1023 bool wxTreeCtrl::HasIndirectData(const wxTreeItemId
& item
) const
1025 // query the item itself
1026 wxTreeViewItem
tvItem(item
, TVIF_PARAM
);
1027 if ( !DoGetItem(&tvItem
) )
1032 wxTreeItemData
*data
= (wxTreeItemData
*)tvItem
.lParam
;
1034 return data
&& IsDataIndirect(data
);
1037 void wxTreeCtrl::SetItemHasChildren(const wxTreeItemId
& item
, bool has
)
1039 wxTreeViewItem
tvItem(item
, TVIF_CHILDREN
);
1040 tvItem
.cChildren
= (int)has
;
1044 void wxTreeCtrl::SetItemBold(const wxTreeItemId
& item
, bool bold
)
1046 wxTreeViewItem
tvItem(item
, TVIF_STATE
, TVIS_BOLD
);
1047 tvItem
.state
= bold
? TVIS_BOLD
: 0;
1051 void wxTreeCtrl::SetItemDropHighlight(const wxTreeItemId
& item
, bool highlight
)
1053 wxTreeViewItem
tvItem(item
, TVIF_STATE
, TVIS_DROPHILITED
);
1054 tvItem
.state
= highlight
? TVIS_DROPHILITED
: 0;
1058 void wxTreeCtrl::RefreshItem(const wxTreeItemId
& item
)
1061 if ( GetBoundingRect(item
, rect
) )
1067 void wxTreeCtrl::SetItemTextColour(const wxTreeItemId
& item
,
1068 const wxColour
& col
)
1070 m_hasAnyAttr
= TRUE
;
1072 long id
= (long)(WXHTREEITEM
)item
;
1073 wxTreeItemAttr
*attr
= (wxTreeItemAttr
*)m_attrs
.Get(id
);
1076 attr
= new wxTreeItemAttr
;
1077 m_attrs
.Put(id
, (wxObject
*)attr
);
1080 attr
->SetTextColour(col
);
1085 void wxTreeCtrl::SetItemBackgroundColour(const wxTreeItemId
& item
,
1086 const wxColour
& col
)
1088 m_hasAnyAttr
= TRUE
;
1090 long id
= (long)(WXHTREEITEM
)item
;
1091 wxTreeItemAttr
*attr
= (wxTreeItemAttr
*)m_attrs
.Get(id
);
1094 attr
= new wxTreeItemAttr
;
1095 m_attrs
.Put(id
, (wxObject
*)attr
);
1098 attr
->SetBackgroundColour(col
);
1103 void wxTreeCtrl::SetItemFont(const wxTreeItemId
& item
, const wxFont
& font
)
1105 m_hasAnyAttr
= TRUE
;
1107 long id
= (long)(WXHTREEITEM
)item
;
1108 wxTreeItemAttr
*attr
= (wxTreeItemAttr
*)m_attrs
.Get(id
);
1111 attr
= new wxTreeItemAttr
;
1112 m_attrs
.Put(id
, (wxObject
*)attr
);
1115 attr
->SetFont(font
);
1120 // ----------------------------------------------------------------------------
1122 // ----------------------------------------------------------------------------
1124 bool wxTreeCtrl::IsVisible(const wxTreeItemId
& item
) const
1126 // Bug in Gnu-Win32 headers, so don't use the macro TreeView_GetItemRect
1129 // this ugliness comes directly from MSDN - it *is* the correct way to pass
1130 // the HTREEITEM with TVM_GETITEMRECT
1131 *(WXHTREEITEM
*)&rect
= (WXHTREEITEM
)item
;
1133 // FALSE means get item rect for the whole item, not only text
1134 return SendMessage(GetHwnd(), TVM_GETITEMRECT
, FALSE
, (LPARAM
)&rect
) != 0;
1137 bool wxTreeCtrl::ItemHasChildren(const wxTreeItemId
& item
) const
1139 wxTreeViewItem
tvItem(item
, TVIF_CHILDREN
);
1142 return tvItem
.cChildren
!= 0;
1145 bool wxTreeCtrl::IsExpanded(const wxTreeItemId
& item
) const
1147 // probably not a good idea to put it here
1148 //wxASSERT( ItemHasChildren(item) );
1150 wxTreeViewItem
tvItem(item
, TVIF_STATE
, TVIS_EXPANDED
);
1153 return (tvItem
.state
& TVIS_EXPANDED
) != 0;
1156 bool wxTreeCtrl::IsSelected(const wxTreeItemId
& item
) const
1158 wxTreeViewItem
tvItem(item
, TVIF_STATE
, TVIS_SELECTED
);
1161 return (tvItem
.state
& TVIS_SELECTED
) != 0;
1164 bool wxTreeCtrl::IsBold(const wxTreeItemId
& item
) const
1166 wxTreeViewItem
tvItem(item
, TVIF_STATE
, TVIS_BOLD
);
1169 return (tvItem
.state
& TVIS_BOLD
) != 0;
1172 // ----------------------------------------------------------------------------
1174 // ----------------------------------------------------------------------------
1176 wxTreeItemId
wxTreeCtrl::GetRootItem() const
1178 return wxTreeItemId((WXHTREEITEM
) TreeView_GetRoot(GetHwnd()));
1181 wxTreeItemId
wxTreeCtrl::GetSelection() const
1183 wxCHECK_MSG( !(m_windowStyle
& wxTR_MULTIPLE
), (long)(WXHTREEITEM
)0,
1184 wxT("this only works with single selection controls") );
1186 return wxTreeItemId((WXHTREEITEM
) TreeView_GetSelection(GetHwnd()));
1189 wxTreeItemId
wxTreeCtrl::GetParent(const wxTreeItemId
& item
) const
1191 return wxTreeItemId((WXHTREEITEM
) TreeView_GetParent(GetHwnd(), HITEM(item
)));
1194 wxTreeItemId
wxTreeCtrl::GetFirstChild(const wxTreeItemId
& item
,
1195 long& _cookie
) const
1197 // remember the last child returned in 'cookie'
1198 _cookie
= (long)TreeView_GetChild(GetHwnd(), HITEM(item
));
1200 return wxTreeItemId((WXHTREEITEM
)_cookie
);
1203 wxTreeItemId
wxTreeCtrl::GetNextChild(const wxTreeItemId
& WXUNUSED(item
),
1204 long& _cookie
) const
1206 wxTreeItemId l
= wxTreeItemId((WXHTREEITEM
)TreeView_GetNextSibling(GetHwnd(),
1213 wxTreeItemId
wxTreeCtrl::GetLastChild(const wxTreeItemId
& item
) const
1215 // can this be done more efficiently?
1218 wxTreeItemId childLast
,
1219 child
= GetFirstChild(item
, cookie
);
1220 while ( child
.IsOk() )
1223 child
= GetNextChild(item
, cookie
);
1229 wxTreeItemId
wxTreeCtrl::GetNextSibling(const wxTreeItemId
& item
) const
1231 return wxTreeItemId((WXHTREEITEM
) TreeView_GetNextSibling(GetHwnd(), HITEM(item
)));
1234 wxTreeItemId
wxTreeCtrl::GetPrevSibling(const wxTreeItemId
& item
) const
1236 return wxTreeItemId((WXHTREEITEM
) TreeView_GetPrevSibling(GetHwnd(), HITEM(item
)));
1239 wxTreeItemId
wxTreeCtrl::GetFirstVisibleItem() const
1241 return wxTreeItemId((WXHTREEITEM
) TreeView_GetFirstVisible(GetHwnd()));
1244 wxTreeItemId
wxTreeCtrl::GetNextVisible(const wxTreeItemId
& item
) const
1246 wxASSERT_MSG( IsVisible(item
), wxT("The item you call GetNextVisible() for must be visible itself!"));
1248 return wxTreeItemId((WXHTREEITEM
) TreeView_GetNextVisible(GetHwnd(), HITEM(item
)));
1251 wxTreeItemId
wxTreeCtrl::GetPrevVisible(const wxTreeItemId
& item
) const
1253 wxASSERT_MSG( IsVisible(item
), wxT("The item you call GetPrevVisible() for must be visible itself!"));
1255 return wxTreeItemId((WXHTREEITEM
) TreeView_GetPrevVisible(GetHwnd(), HITEM(item
)));
1258 // ----------------------------------------------------------------------------
1259 // multiple selections emulation
1260 // ----------------------------------------------------------------------------
1262 bool wxTreeCtrl::IsItemChecked(const wxTreeItemId
& item
) const
1264 // receive the desired information.
1265 wxTreeViewItem
tvItem(item
, TVIF_STATE
, TVIS_STATEIMAGEMASK
);
1268 // state image indices are 1 based
1269 return ((tvItem
.state
>> 12) - 1) == 1;
1272 void wxTreeCtrl::SetItemCheck(const wxTreeItemId
& item
, bool check
)
1274 // receive the desired information.
1275 wxTreeViewItem
tvItem(item
, TVIF_STATE
, TVIS_STATEIMAGEMASK
);
1277 // state images are one-based
1278 tvItem
.state
= (check
? 2 : 1) << 12;
1283 size_t wxTreeCtrl::GetSelections(wxArrayTreeItemIds
& selections
) const
1285 TraverseSelections
selector(this, selections
);
1287 return selector
.GetCount();
1290 // ----------------------------------------------------------------------------
1292 // ----------------------------------------------------------------------------
1294 wxTreeItemId
wxTreeCtrl::DoInsertItem(const wxTreeItemId
& parent
,
1295 wxTreeItemId hInsertAfter
,
1296 const wxString
& text
,
1297 int image
, int selectedImage
,
1298 wxTreeItemData
*data
)
1300 wxCHECK_MSG( parent
.IsOk() || !TreeView_GetRoot(GetHwnd()),
1302 _T("can't have more than one root in the tree") );
1304 TV_INSERTSTRUCT tvIns
;
1305 tvIns
.hParent
= HITEM(parent
);
1306 tvIns
.hInsertAfter
= HITEM(hInsertAfter
);
1308 // this is how we insert the item as the first child: supply a NULL
1310 if ( !tvIns
.hInsertAfter
)
1312 tvIns
.hInsertAfter
= TVI_FIRST
;
1316 if ( !text
.IsEmpty() )
1319 tvIns
.item
.pszText
= (wxChar
*)text
.c_str(); // cast is ok
1323 tvIns
.item
.pszText
= NULL
;
1324 tvIns
.item
.cchTextMax
= 0;
1330 tvIns
.item
.iImage
= image
;
1332 if ( selectedImage
== -1 )
1334 // take the same image for selected icon if not specified
1335 selectedImage
= image
;
1339 if ( selectedImage
!= -1 )
1341 mask
|= TVIF_SELECTEDIMAGE
;
1342 tvIns
.item
.iSelectedImage
= selectedImage
;
1348 tvIns
.item
.lParam
= (LPARAM
)data
;
1351 tvIns
.item
.mask
= mask
;
1353 HTREEITEM id
= (HTREEITEM
) TreeView_InsertItem(GetHwnd(), &tvIns
);
1356 wxLogLastError(wxT("TreeView_InsertItem"));
1361 // associate the application tree item with Win32 tree item handle
1362 data
->SetId((WXHTREEITEM
)id
);
1365 return wxTreeItemId((WXHTREEITEM
)id
);
1368 // for compatibility only
1369 wxTreeItemId
wxTreeCtrl::InsertItem(const wxTreeItemId
& parent
,
1370 const wxString
& text
,
1371 int image
, int selImage
,
1374 return DoInsertItem(parent
, (WXHTREEITEM
)insertAfter
, text
,
1375 image
, selImage
, NULL
);
1378 wxTreeItemId
wxTreeCtrl::AddRoot(const wxString
& text
,
1379 int image
, int selectedImage
,
1380 wxTreeItemData
*data
)
1382 return DoInsertItem(wxTreeItemId((long) (WXHTREEITEM
) 0), (long)(WXHTREEITEM
) 0,
1383 text
, image
, selectedImage
, data
);
1386 wxTreeItemId
wxTreeCtrl::PrependItem(const wxTreeItemId
& parent
,
1387 const wxString
& text
,
1388 int image
, int selectedImage
,
1389 wxTreeItemData
*data
)
1391 return DoInsertItem(parent
, (WXHTREEITEM
) TVI_FIRST
,
1392 text
, image
, selectedImage
, data
);
1395 wxTreeItemId
wxTreeCtrl::InsertItem(const wxTreeItemId
& parent
,
1396 const wxTreeItemId
& idPrevious
,
1397 const wxString
& text
,
1398 int image
, int selectedImage
,
1399 wxTreeItemData
*data
)
1401 return DoInsertItem(parent
, idPrevious
, text
, image
, selectedImage
, data
);
1404 wxTreeItemId
wxTreeCtrl::InsertItem(const wxTreeItemId
& parent
,
1406 const wxString
& text
,
1407 int image
, int selectedImage
,
1408 wxTreeItemData
*data
)
1410 // find the item from index
1412 wxTreeItemId idPrev
, idCur
= GetFirstChild(parent
, cookie
);
1413 while ( index
!= 0 && idCur
.IsOk() )
1418 idCur
= GetNextChild(parent
, cookie
);
1421 // assert, not check: if the index is invalid, we will append the item
1423 wxASSERT_MSG( index
== 0, _T("bad index in wxTreeCtrl::InsertItem") );
1425 return DoInsertItem(parent
, idPrev
, text
, image
, selectedImage
, data
);
1428 wxTreeItemId
wxTreeCtrl::AppendItem(const wxTreeItemId
& parent
,
1429 const wxString
& text
,
1430 int image
, int selectedImage
,
1431 wxTreeItemData
*data
)
1433 return DoInsertItem(parent
, (WXHTREEITEM
) TVI_LAST
,
1434 text
, image
, selectedImage
, data
);
1437 void wxTreeCtrl::Delete(const wxTreeItemId
& item
)
1439 if ( !TreeView_DeleteItem(GetHwnd(), HITEM(item
)) )
1441 wxLogLastError(wxT("TreeView_DeleteItem"));
1445 // delete all children (but don't delete the item itself)
1446 void wxTreeCtrl::DeleteChildren(const wxTreeItemId
& item
)
1450 wxArrayLong children
;
1451 wxTreeItemId child
= GetFirstChild(item
, cookie
);
1452 while ( child
.IsOk() )
1454 children
.Add((long)(WXHTREEITEM
)child
);
1456 child
= GetNextChild(item
, cookie
);
1459 size_t nCount
= children
.Count();
1460 for ( size_t n
= 0; n
< nCount
; n
++ )
1462 if ( !TreeView_DeleteItem(GetHwnd(), (HTREEITEM
)children
[n
]) )
1464 wxLogLastError(wxT("TreeView_DeleteItem"));
1469 void wxTreeCtrl::DeleteAllItems()
1471 if ( !TreeView_DeleteAllItems(GetHwnd()) )
1473 wxLogLastError(wxT("TreeView_DeleteAllItems"));
1477 void wxTreeCtrl::DoExpand(const wxTreeItemId
& item
, int flag
)
1479 wxASSERT_MSG( flag
== TVE_COLLAPSE
||
1480 flag
== (TVE_COLLAPSE
| TVE_COLLAPSERESET
) ||
1481 flag
== TVE_EXPAND
||
1483 wxT("Unknown flag in wxTreeCtrl::DoExpand") );
1485 // TreeView_Expand doesn't send TVN_ITEMEXPAND(ING) messages, so we must
1486 // emulate them. This behaviour has changed slightly with comctl32.dll
1487 // v 4.70 - now it does send them but only the first time. To maintain
1488 // compatible behaviour and also in order to not have surprises with the
1489 // future versions, don't rely on this and still do everything ourselves.
1490 // To avoid that the messages be sent twice when the item is expanded for
1491 // the first time we must clear TVIS_EXPANDEDONCE style manually.
1493 wxTreeViewItem
tvItem(item
, TVIF_STATE
, TVIS_EXPANDEDONCE
);
1497 if ( TreeView_Expand(GetHwnd(), HITEM(item
), flag
) != 0 )
1499 wxTreeEvent
event(wxEVT_NULL
, m_windowId
);
1500 event
.m_item
= item
;
1502 bool isExpanded
= IsExpanded(item
);
1504 event
.SetEventObject(this);
1506 // FIXME return value of {EXPAND|COLLAPS}ING event handler is discarded
1507 event
.SetEventType(g_events
[isExpanded
][TRUE
]);
1508 GetEventHandler()->ProcessEvent(event
);
1510 event
.SetEventType(g_events
[isExpanded
][FALSE
]);
1511 GetEventHandler()->ProcessEvent(event
);
1513 //else: change didn't took place, so do nothing at all
1516 void wxTreeCtrl::Expand(const wxTreeItemId
& item
)
1518 DoExpand(item
, TVE_EXPAND
);
1521 void wxTreeCtrl::Collapse(const wxTreeItemId
& item
)
1523 DoExpand(item
, TVE_COLLAPSE
);
1526 void wxTreeCtrl::CollapseAndReset(const wxTreeItemId
& item
)
1528 DoExpand(item
, TVE_COLLAPSE
| TVE_COLLAPSERESET
);
1531 void wxTreeCtrl::Toggle(const wxTreeItemId
& item
)
1533 DoExpand(item
, TVE_TOGGLE
);
1536 void wxTreeCtrl::ExpandItem(const wxTreeItemId
& item
, int action
)
1538 DoExpand(item
, action
);
1541 void wxTreeCtrl::Unselect()
1543 wxASSERT_MSG( !(m_windowStyle
& wxTR_MULTIPLE
),
1544 wxT("doesn't make sense, may be you want UnselectAll()?") );
1546 // just remove the selection
1547 SelectItem(wxTreeItemId((long) (WXHTREEITEM
) 0));
1550 void wxTreeCtrl::UnselectAll()
1552 if ( m_windowStyle
& wxTR_MULTIPLE
)
1554 wxArrayTreeItemIds selections
;
1555 size_t count
= GetSelections(selections
);
1556 for ( size_t n
= 0; n
< count
; n
++ )
1558 #if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
1559 SetItemCheck(selections
[n
], FALSE
);
1560 #else // !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
1561 ::UnselectItem(GetHwnd(), HITEM(selections
[n
]));
1562 #endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE/!wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
1567 // just remove the selection
1572 void wxTreeCtrl::SelectItem(const wxTreeItemId
& item
)
1574 if ( m_windowStyle
& wxTR_MULTIPLE
)
1576 #if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
1577 // selecting the item means checking it
1579 #else // !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
1580 ::SelectItem(GetHwnd(), HITEM(item
));
1581 #endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE/!wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
1585 // inspite of the docs (MSDN Jan 99 edition), we don't seem to receive
1586 // the notification from the control (i.e. TVN_SELCHANG{ED|ING}), so
1587 // send them ourselves
1589 wxTreeEvent
event(wxEVT_NULL
, m_windowId
);
1590 event
.m_item
= item
;
1591 event
.SetEventObject(this);
1593 event
.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGING
);
1594 if ( !GetEventHandler()->ProcessEvent(event
) || event
.IsAllowed() )
1596 if ( !TreeView_SelectItem(GetHwnd(), HITEM(item
)) )
1598 wxLogLastError(wxT("TreeView_SelectItem"));
1602 event
.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED
);
1603 (void)GetEventHandler()->ProcessEvent(event
);
1606 //else: program vetoed the change
1610 void wxTreeCtrl::EnsureVisible(const wxTreeItemId
& item
)
1613 TreeView_EnsureVisible(GetHwnd(), HITEM(item
));
1616 void wxTreeCtrl::ScrollTo(const wxTreeItemId
& item
)
1618 if ( !TreeView_SelectSetFirstVisible(GetHwnd(), HITEM(item
)) )
1620 wxLogLastError(wxT("TreeView_SelectSetFirstVisible"));
1624 wxTextCtrl
* wxTreeCtrl::GetEditControl() const
1626 // normally, we could try to do something like this to return something
1627 // even when the editing was started by the user and not by calling
1628 // EditLabel() - but as nobody has asked for this so far and there might be
1629 // problems in the code below, I leave it disabled for now (VZ)
1633 HWND hwndText
= TreeView_GetEditControl(GetHwnd());
1636 m_textCtrl
= new wxTextCtrl(this, -1);
1638 m_textCtrl
->SetHWND((WXHWND
)hwndText
);
1640 //else: not editing label right now
1647 void wxTreeCtrl::DeleteTextCtrl()
1651 // the HWND corresponding to this control is deleted by the tree
1652 // control itself and we don't know when exactly this happens, so check
1653 // if the window still exists before calling UnsubclassWin()
1654 if ( !::IsWindow(GetHwndOf(m_textCtrl
)) )
1656 m_textCtrl
->SetHWND(0);
1659 m_textCtrl
->UnsubclassWin();
1660 m_textCtrl
->SetHWND(0);
1666 wxTextCtrl
* wxTreeCtrl::EditLabel(const wxTreeItemId
& item
,
1667 wxClassInfo
* textControlClass
)
1669 wxASSERT( textControlClass
->IsKindOf(CLASSINFO(wxTextCtrl
)) );
1673 HWND hWnd
= (HWND
) TreeView_EditLabel(GetHwnd(), HITEM(item
));
1675 // this is not an error - the TVN_BEGINLABELEDIT handler might have
1682 m_textCtrl
= (wxTextCtrl
*)textControlClass
->CreateObject();
1683 m_textCtrl
->SetParent(this);
1684 m_textCtrl
->SetHWND((WXHWND
)hWnd
);
1685 m_textCtrl
->SubclassWin((WXHWND
)hWnd
);
1690 // End label editing, optionally cancelling the edit
1691 void wxTreeCtrl::EndEditLabel(const wxTreeItemId
& WXUNUSED(item
), bool discardChanges
)
1693 TreeView_EndEditLabelNow(GetHwnd(), discardChanges
);
1698 wxTreeItemId
wxTreeCtrl::HitTest(const wxPoint
& point
, int& flags
)
1700 TV_HITTESTINFO hitTestInfo
;
1701 hitTestInfo
.pt
.x
= (int)point
.x
;
1702 hitTestInfo
.pt
.y
= (int)point
.y
;
1704 TreeView_HitTest(GetHwnd(), &hitTestInfo
);
1709 #define TRANSLATE_FLAG(flag) if ( hitTestInfo.flags & TVHT_##flag ) \
1710 flags |= wxTREE_HITTEST_##flag
1712 TRANSLATE_FLAG(ABOVE
);
1713 TRANSLATE_FLAG(BELOW
);
1714 TRANSLATE_FLAG(NOWHERE
);
1715 TRANSLATE_FLAG(ONITEMBUTTON
);
1716 TRANSLATE_FLAG(ONITEMICON
);
1717 TRANSLATE_FLAG(ONITEMINDENT
);
1718 TRANSLATE_FLAG(ONITEMLABEL
);
1719 TRANSLATE_FLAG(ONITEMRIGHT
);
1720 TRANSLATE_FLAG(ONITEMSTATEICON
);
1721 TRANSLATE_FLAG(TOLEFT
);
1722 TRANSLATE_FLAG(TORIGHT
);
1724 #undef TRANSLATE_FLAG
1726 return wxTreeItemId((WXHTREEITEM
) hitTestInfo
.hItem
);
1729 bool wxTreeCtrl::GetBoundingRect(const wxTreeItemId
& item
,
1731 bool textOnly
) const
1734 if ( TreeView_GetItemRect(GetHwnd(), HITEM(item
),
1737 rect
= wxRect(wxPoint(rc
.left
, rc
.top
), wxPoint(rc
.right
, rc
.bottom
));
1743 // couldn't retrieve rect: for example, item isn't visible
1748 // ----------------------------------------------------------------------------
1750 // ----------------------------------------------------------------------------
1752 // this is just a tiny namespace which is friend to wxTreeCtrl and so can use
1753 // functions such as IsDataIndirect()
1754 class wxTreeSortHelper
1757 static int CALLBACK
Compare(LPARAM data1
, LPARAM data2
, LPARAM tree
);
1760 static wxTreeItemId
GetIdFromData(wxTreeCtrl
*tree
, LPARAM item
)
1762 wxTreeItemData
*data
= (wxTreeItemData
*)item
;
1763 if ( tree
->IsDataIndirect(data
) )
1765 data
= ((wxTreeItemIndirectData
*)data
)->GetData();
1768 return data
->GetId();
1772 int CALLBACK
wxTreeSortHelper::Compare(LPARAM pItem1
,
1776 wxCHECK_MSG( pItem1
&& pItem2
, 0,
1777 wxT("sorting tree without data doesn't make sense") );
1779 wxTreeCtrl
*tree
= (wxTreeCtrl
*)htree
;
1781 return tree
->OnCompareItems(GetIdFromData(tree
, pItem1
),
1782 GetIdFromData(tree
, pItem2
));
1785 int wxTreeCtrl::OnCompareItems(const wxTreeItemId
& item1
,
1786 const wxTreeItemId
& item2
)
1788 return wxStrcmp(GetItemText(item1
), GetItemText(item2
));
1791 void wxTreeCtrl::SortChildren(const wxTreeItemId
& item
)
1793 // rely on the fact that TreeView_SortChildren does the same thing as our
1794 // default behaviour, i.e. sorts items alphabetically and so call it
1795 // directly if we're not in derived class (much more efficient!)
1796 if ( GetClassInfo() == CLASSINFO(wxTreeCtrl
) )
1798 TreeView_SortChildren(GetHwnd(), HITEM(item
), 0);
1803 tvSort
.hParent
= HITEM(item
);
1804 tvSort
.lpfnCompare
= wxTreeSortHelper::Compare
;
1805 tvSort
.lParam
= (LPARAM
)this;
1806 TreeView_SortChildrenCB(GetHwnd(), &tvSort
, 0 /* reserved */);
1810 // ----------------------------------------------------------------------------
1812 // ----------------------------------------------------------------------------
1814 bool wxTreeCtrl::MSWCommand(WXUINT cmd
, WXWORD id
)
1816 if ( cmd
== EN_UPDATE
)
1818 wxCommandEvent
event(wxEVT_COMMAND_TEXT_UPDATED
, id
);
1819 event
.SetEventObject( this );
1820 ProcessCommand(event
);
1822 else if ( cmd
== EN_KILLFOCUS
)
1824 wxCommandEvent
event(wxEVT_KILL_FOCUS
, id
);
1825 event
.SetEventObject( this );
1826 ProcessCommand(event
);
1834 // command processed
1838 // we hook into WndProc to process WM_MOUSEMOVE/WM_BUTTONUP messages - as we
1839 // only do it during dragging, minimize wxWin overhead (this is important for
1840 // WM_MOUSEMOVE as they're a lot of them) by catching Windows messages directly
1841 // instead of passing by wxWin events
1842 long wxTreeCtrl::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
1844 bool processed
= FALSE
;
1846 bool isMultiple
= (GetWindowStyle() & wxTR_MULTIPLE
) != 0;
1848 if ( (nMsg
>= WM_MOUSEFIRST
) && (nMsg
<= WM_MOUSELAST
) )
1850 // we only process mouse messages here and these parameters have the same
1851 // meaning for all of them
1852 int x
= GET_X_LPARAM(lParam
),
1853 y
= GET_Y_LPARAM(lParam
);
1854 HTREEITEM htItem
= GetItemFromPoint(GetHwnd(), x
, y
);
1858 #if !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
1859 case WM_LBUTTONDOWN
:
1860 if ( htItem
&& isMultiple
)
1862 if ( wParam
& MK_CONTROL
)
1866 // toggle selected state
1867 ToggleItemSelection(GetHwnd(), htItem
);
1869 ::SetFocus(GetHwnd(), htItem
);
1871 // reset on any click without Shift
1876 else if ( wParam
& MK_SHIFT
)
1878 // this selects all items between the starting one and
1881 if ( !m_htSelStart
)
1883 // take the focused item
1884 m_htSelStart
= (WXHTREEITEM
)
1885 TreeView_GetSelection(GetHwnd());
1888 SelectRange(GetHwnd(), HITEM(m_htSelStart
), htItem
,
1889 !(wParam
& MK_CONTROL
));
1891 ::SetFocus(GetHwnd(), htItem
);
1895 else // normal click
1897 // clear the selection and then let the default handler
1901 // prevent the click from starting in-place editing
1902 // when there was no selection in the control
1903 TreeView_SelectItem(GetHwnd(), 0);
1905 // reset on any click without Shift
1910 #endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
1915 m_dragImage
->Move(wxPoint(x
, y
));
1918 // highlight the item as target (hiding drag image is
1919 // necessary - otherwise the display will be corrupted)
1920 m_dragImage
->Hide();
1921 TreeView_SelectDropTarget(GetHwnd(), htItem
);
1922 m_dragImage
->Show();
1931 m_dragImage
->EndDrag();
1935 // generate the drag end event
1936 wxTreeEvent
event(wxEVT_COMMAND_TREE_END_DRAG
, m_windowId
);
1938 event
.m_item
= (WXHTREEITEM
)htItem
;
1939 event
.m_pointDrag
= wxPoint(x
, y
);
1940 event
.SetEventObject(this);
1942 (void)GetEventHandler()->ProcessEvent(event
);
1944 // if we don't do it, the tree seems to think that 2 items
1945 // are selected simultaneously which is quite weird
1946 TreeView_SelectDropTarget(GetHwnd(), 0);
1951 #if !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
1952 else if ( (nMsg
== WM_SETFOCUS
|| nMsg
== WM_KILLFOCUS
) && isMultiple
)
1954 // the tree control greys out the selected item when it loses focus and
1955 // paints it as selected again when it regains it, but it won't do it
1956 // for the other items itself - help it
1957 wxArrayTreeItemIds selections
;
1958 size_t count
= GetSelections(selections
);
1960 for ( size_t n
= 0; n
< count
; n
++ )
1962 // TreeView_GetItemRect() will return FALSE if item is not visible,
1963 // which may happen perfectly well
1964 if ( TreeView_GetItemRect(GetHwnd(), HITEM(selections
[n
]),
1967 ::InvalidateRect(GetHwnd(), &rect
, FALSE
);
1971 else if ( nMsg
== WM_KEYDOWN
&& isMultiple
)
1973 bool bCtrl
= wxIsCtrlDown(),
1974 bShift
= wxIsShiftDown();
1976 // we handle.arrows and space, but not page up/down and home/end: the
1977 // latter should be easy, but not the former
1979 HTREEITEM htSel
= (HTREEITEM
)TreeView_GetSelection(GetHwnd());
1980 if ( !m_htSelStart
)
1982 m_htSelStart
= (WXHTREEITEM
)htSel
;
1985 if ( wParam
== VK_SPACE
)
1989 ToggleItemSelection(GetHwnd(), htSel
);
1995 ::SelectItem(GetHwnd(), htSel
);
2000 else if ( wParam
== VK_UP
|| wParam
== VK_DOWN
)
2002 if ( !bCtrl
&& !bShift
)
2004 // no modifiers, just clear selection and then let the default
2005 // processing to take place
2010 (void)wxControl::MSWWindowProc(nMsg
, wParam
, lParam
);
2012 HTREEITEM htNext
= (HTREEITEM
)(wParam
== VK_UP
2013 ? TreeView_GetPrevVisible(GetHwnd(), htSel
)
2014 : TreeView_GetNextVisible(GetHwnd(), htSel
));
2018 // at the top/bottom
2024 SelectRange(GetHwnd(), HITEM(m_htSelStart
), htNext
);
2028 // without changing selection
2029 ::SetFocus(GetHwnd(), htNext
);
2036 #endif // !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
2038 rc
= wxControl::MSWWindowProc(nMsg
, wParam
, lParam
);
2043 // process WM_NOTIFY Windows message
2044 bool wxTreeCtrl::MSWOnNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
*result
)
2046 wxTreeEvent
event(wxEVT_NULL
, m_windowId
);
2047 wxEventType eventType
= wxEVT_NULL
;
2048 NMHDR
*hdr
= (NMHDR
*)lParam
;
2050 switch ( hdr
->code
)
2053 eventType
= wxEVT_COMMAND_TREE_BEGIN_DRAG
;
2056 case TVN_BEGINRDRAG
:
2058 if ( eventType
== wxEVT_NULL
)
2059 eventType
= wxEVT_COMMAND_TREE_BEGIN_RDRAG
;
2060 //else: left drag, already set above
2062 NM_TREEVIEW
*tv
= (NM_TREEVIEW
*)lParam
;
2064 event
.m_item
= (WXHTREEITEM
) tv
->itemNew
.hItem
;
2065 event
.m_pointDrag
= wxPoint(tv
->ptDrag
.x
, tv
->ptDrag
.y
);
2067 // don't allow dragging by default: the user code must
2068 // explicitly say that it wants to allow it to avoid breaking
2074 case TVN_BEGINLABELEDIT
:
2076 eventType
= wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT
;
2077 TV_DISPINFO
*info
= (TV_DISPINFO
*)lParam
;
2079 event
.m_item
= (WXHTREEITEM
) info
->item
.hItem
;
2080 event
.m_label
= info
->item
.pszText
;
2084 case TVN_DELETEITEM
:
2086 eventType
= wxEVT_COMMAND_TREE_DELETE_ITEM
;
2087 NM_TREEVIEW
*tv
= (NM_TREEVIEW
*)lParam
;
2089 event
.m_item
= (WXHTREEITEM
)tv
->itemOld
.hItem
;
2093 delete (wxTreeItemAttr
*)m_attrs
.
2094 Delete((long)tv
->itemOld
.hItem
);
2099 case TVN_ENDLABELEDIT
:
2101 eventType
= wxEVT_COMMAND_TREE_END_LABEL_EDIT
;
2102 TV_DISPINFO
*info
= (TV_DISPINFO
*)lParam
;
2104 event
.m_item
= (WXHTREEITEM
)info
->item
.hItem
;
2105 event
.m_label
= info
->item
.pszText
;
2106 if (info
->item
.pszText
== NULL
)
2111 case TVN_GETDISPINFO
:
2112 eventType
= wxEVT_COMMAND_TREE_GET_INFO
;
2115 case TVN_SETDISPINFO
:
2117 if ( eventType
== wxEVT_NULL
)
2118 eventType
= wxEVT_COMMAND_TREE_SET_INFO
;
2119 //else: get, already set above
2121 TV_DISPINFO
*info
= (TV_DISPINFO
*)lParam
;
2123 event
.m_item
= (WXHTREEITEM
) info
->item
.hItem
;
2127 case TVN_ITEMEXPANDING
:
2128 case TVN_ITEMEXPANDED
:
2130 NM_TREEVIEW
* tv
= (NM_TREEVIEW
*)lParam
;
2132 bool expand
= FALSE
;
2133 switch ( tv
->action
)
2144 wxLogDebug(wxT("unexpected code %d in TVN_ITEMEXPAND message"), tv
->action
);
2147 bool ing
= ((int)hdr
->code
== TVN_ITEMEXPANDING
);
2148 eventType
= g_events
[expand
][ing
];
2150 event
.m_item
= (WXHTREEITEM
) tv
->itemNew
.hItem
;
2156 eventType
= wxEVT_COMMAND_TREE_KEY_DOWN
;
2157 TV_KEYDOWN
*info
= (TV_KEYDOWN
*)lParam
;
2159 // we pass 0 as last CreateKeyEvent() parameter because we
2160 // don't have access to the real key press flags here - but as
2161 // it is only used to determin wxKeyEvent::m_altDown flag it's
2163 event
.m_evtKey
= CreateKeyEvent(wxEVT_KEY_DOWN
,
2164 wxCharCodeMSWToWX(info
->wVKey
),
2167 // a separate event for Space/Return
2168 if ( !wxIsCtrlDown() && !wxIsShiftDown() &&
2169 ((info
->wVKey
== VK_SPACE
) || (info
->wVKey
== VK_RETURN
)) )
2171 wxTreeEvent
event2(wxEVT_COMMAND_TREE_ITEM_ACTIVATED
,
2173 event2
.SetEventObject(this);
2174 if ( !(GetWindowStyle() & wxTR_MULTIPLE
) )
2176 event2
.m_item
= GetSelection();
2178 //else: don't know how to get it
2180 (void)GetEventHandler()->ProcessEvent(event2
);
2185 case TVN_SELCHANGED
:
2186 eventType
= wxEVT_COMMAND_TREE_SEL_CHANGED
;
2189 case TVN_SELCHANGING
:
2191 if ( eventType
== wxEVT_NULL
)
2192 eventType
= wxEVT_COMMAND_TREE_SEL_CHANGING
;
2193 //else: already set above
2195 NM_TREEVIEW
* tv
= (NM_TREEVIEW
*)lParam
;
2197 event
.m_item
= (WXHTREEITEM
) tv
->itemNew
.hItem
;
2198 event
.m_itemOld
= (WXHTREEITEM
) tv
->itemOld
.hItem
;
2202 #if defined(_WIN32_IE) && _WIN32_IE >= 0x300 && !wxUSE_COMCTL32_SAFELY && !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 0 ) )
2205 LPNMTVCUSTOMDRAW lptvcd
= (LPNMTVCUSTOMDRAW
)lParam
;
2206 NMCUSTOMDRAW
& nmcd
= lptvcd
->nmcd
;
2207 switch ( nmcd
.dwDrawStage
)
2210 // if we've got any items with non standard attributes,
2211 // notify us before painting each item
2212 *result
= m_hasAnyAttr
? CDRF_NOTIFYITEMDRAW
2216 case CDDS_ITEMPREPAINT
:
2218 wxTreeItemAttr
*attr
=
2219 (wxTreeItemAttr
*)m_attrs
.Get(nmcd
.dwItemSpec
);
2223 // nothing to do for this item
2224 *result
= CDRF_DODEFAULT
;
2229 wxColour colText
, colBack
;
2230 if ( attr
->HasFont() )
2232 wxFont font
= attr
->GetFont();
2233 hFont
= (HFONT
)font
.GetResourceHandle();
2240 if ( attr
->HasTextColour() )
2242 colText
= attr
->GetTextColour();
2246 colText
= GetForegroundColour();
2249 // selection colours should override ours
2250 if ( nmcd
.uItemState
& CDIS_SELECTED
)
2252 DWORD clrBk
= ::GetSysColor(COLOR_HIGHLIGHT
);
2253 lptvcd
->clrTextBk
= clrBk
;
2255 // try to make the text visible
2256 lptvcd
->clrText
= wxColourToRGB(colText
);
2257 lptvcd
->clrText
|= ~clrBk
;
2258 lptvcd
->clrText
&= 0x00ffffff;
2262 if ( attr
->HasBackgroundColour() )
2264 colBack
= attr
->GetBackgroundColour();
2268 colBack
= GetBackgroundColour();
2271 lptvcd
->clrText
= wxColourToRGB(colText
);
2272 lptvcd
->clrTextBk
= wxColourToRGB(colBack
);
2275 // note that if we wanted to set colours for
2276 // individual columns (subitems), we would have
2277 // returned CDRF_NOTIFYSUBITEMREDRAW from here
2280 ::SelectObject(nmcd
.hdc
, hFont
);
2282 *result
= CDRF_NEWFONT
;
2286 *result
= CDRF_DODEFAULT
;
2292 *result
= CDRF_DODEFAULT
;
2296 // we always process it
2298 #endif // _WIN32_IE >= 0x300
2303 TV_HITTESTINFO tvhti
;
2304 ::GetCursorPos(&tvhti
.pt
);
2305 ::ScreenToClient(GetHwnd(), &tvhti
.pt
);
2306 if ( TreeView_HitTest(GetHwnd(), &tvhti
) )
2308 if ( tvhti
.flags
& TVHT_ONITEM
)
2310 event
.m_item
= (WXHTREEITEM
) tvhti
.hItem
;
2311 eventType
= (int)hdr
->code
== NM_DBLCLK
2312 ? wxEVT_COMMAND_TREE_ITEM_ACTIVATED
2313 : wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK
;
2315 event
.m_pointDrag
.x
= tvhti
.pt
.x
;
2316 event
.m_pointDrag
.y
= tvhti
.pt
.y
;
2325 return wxControl::MSWOnNotify(idCtrl
, lParam
, result
);
2328 event
.SetEventObject(this);
2329 event
.SetEventType(eventType
);
2331 bool processed
= GetEventHandler()->ProcessEvent(event
);
2334 switch ( hdr
->code
)
2337 // we translate NM_DBLCLK into ACTIVATED event, so don't interpret
2338 // the return code of this event handler as the return value for
2339 // NM_DBLCLK - otherwise, double clicking the item to toggle its
2340 // expanded status would never work
2345 case TVN_BEGINRDRAG
:
2346 if ( event
.IsAllowed() )
2348 // normally this is impossible because the m_dragImage is
2349 // deleted once the drag operation is over
2350 wxASSERT_MSG( !m_dragImage
, _T("starting to drag once again?") );
2352 m_dragImage
= new wxDragImage(*this, event
.m_item
);
2353 m_dragImage
->BeginDrag(wxPoint(0, 0), this);
2354 m_dragImage
->Show();
2358 case TVN_DELETEITEM
:
2360 // NB: we might process this message using wxWindows event
2361 // tables, but due to overhead of wxWin event system we
2362 // prefer to do it here ourself (otherwise deleting a tree
2363 // with many items is just too slow)
2364 NM_TREEVIEW
* tv
= (NM_TREEVIEW
*)lParam
;
2366 wxTreeItemId item
= event
.m_item
;
2367 if ( HasIndirectData(item
) )
2369 wxTreeItemIndirectData
*data
= (wxTreeItemIndirectData
*)
2371 delete data
; // can't be NULL here
2375 wxTreeItemData
*data
= (wxTreeItemData
*)tv
->itemOld
.lParam
;
2376 delete data
; // may be NULL, ok
2379 processed
= TRUE
; // Make sure we don't get called twice
2383 case TVN_BEGINLABELEDIT
:
2384 // return TRUE to cancel label editing
2385 *result
= !event
.IsAllowed();
2388 case TVN_ENDLABELEDIT
:
2389 // return TRUE to set the label to the new string: note that we
2390 // also must pretend that we did process the message or it is going
2391 // to be passed to DefWindowProc() which will happily return FALSE
2392 // cancelling the label change
2393 *result
= event
.IsAllowed();
2396 // ensure that we don't have the text ctrl which is going to be
2401 case TVN_SELCHANGING
:
2402 case TVN_ITEMEXPANDING
:
2403 // return TRUE to prevent the action from happening
2404 *result
= !event
.IsAllowed();
2407 case TVN_GETDISPINFO
:
2408 // NB: so far the user can't set the image himself anyhow, so do it
2409 // anyway - but this may change later
2410 // if ( /* !processed && */ 1 )
2412 wxTreeItemId item
= event
.m_item
;
2413 TV_DISPINFO
*info
= (TV_DISPINFO
*)lParam
;
2414 if ( info
->item
.mask
& TVIF_IMAGE
)
2417 DoGetItemImageFromData
2420 IsExpanded(item
) ? wxTreeItemIcon_Expanded
2421 : wxTreeItemIcon_Normal
2424 if ( info
->item
.mask
& TVIF_SELECTEDIMAGE
)
2426 info
->item
.iSelectedImage
=
2427 DoGetItemImageFromData
2430 IsExpanded(item
) ? wxTreeItemIcon_SelectedExpanded
2431 : wxTreeItemIcon_Selected
2438 // for the other messages the return value is ignored and there is
2439 // nothing special to do
2446 #endif // wxUSE_TREECTRL