X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cc11ded1ae65fb38d6ff7a5483c6c27ea3471bfa..4081eb6fe2de5eed5716459d09c8f4bed8eda92d:/src/msw/treectrl.cpp?ds=sidebyside diff --git a/src/msw/treectrl.cpp b/src/msw/treectrl.cpp index 40f9f53105..3093583d52 100644 --- a/src/msw/treectrl.cpp +++ b/src/msw/treectrl.cpp @@ -26,23 +26,24 @@ #if wxUSE_TREECTRL -#include "wx/msw/private.h" +#include "wx/treectrl.h" -// include "properly" -#include "wx/msw/wrapcctl.h" +#ifndef WX_PRECOMP + #include "wx/msw/wrapcctl.h" // include "properly" + #include "wx/msw/missing.h" + #include "wx/dynarray.h" + #include "wx/log.h" + #include "wx/app.h" + #include "wx/settings.h" +#endif -#include "wx/msw/missing.h" +#include "wx/msw/private.h" // Set this to 1 to be _absolutely_ sure that repainting will work for all // comctl32.dll versions #define wxUSE_COMCTL32_SAFELY 0 -#include "wx/app.h" -#include "wx/log.h" -#include "wx/dynarray.h" #include "wx/imaglist.h" -#include "wx/settings.h" -#include "wx/treectrl.h" #include "wx/msw/dragimag.h" // macros to hide the cast ugliness @@ -51,29 +52,62 @@ // get HTREEITEM from wxTreeItemId #define HITEM(item) ((HTREEITEM)(((item).m_pItem))) -// the native control doesn't support multiple selections under MSW and we -// have 2 ways to emulate them: either using TVS_CHECKBOXES style and let -// checkboxes be the selection status (checked == selected) or by really -// emulating everything, i.e. intercepting mouse and key events &c. The first -// approach is much easier but doesn't work with comctl32.dll < 4.71 and also -// looks quite ugly. -#define wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE 0 -// ---------------------------------------------------------------------------- -// private functions -// ---------------------------------------------------------------------------- +// older SDKs are missing these +#ifndef TVN_ITEMCHANGINGA -// wrapper for TreeView_HitTest -static HTREEITEM GetItemFromPoint(HWND hwndTV, int x, int y) +#define TVN_ITEMCHANGINGA (TVN_FIRST-16) +#define TVN_ITEMCHANGINGW (TVN_FIRST-17) + +typedef struct tagNMTVITEMCHANGE { - TV_HITTESTINFO tvht; - tvht.pt.x = x; - tvht.pt.y = y; + NMHDR hdr; + UINT uChanged; + HTREEITEM hItem; + UINT uStateNew; + UINT uStateOld; + LPARAM lParam; +} NMTVITEMCHANGE; - return (HTREEITEM)TreeView_HitTest(hwndTV, &tvht); -} +#endif + + +// this helper class is used on vista systems for preventing unwanted +// item state changes in the vista tree control. It is only effective in +// multi-select mode on vista systems. + +// The vista tree control includes some new code that originally broke the +// multi-selection tree, causing seemingly spurious item selection state changes +// during Shift or Ctrl-click item selection. (To witness the original broken +// behavior, simply make IsLocked() below always return false). This problem was +// solved by using the following class to 'unlock' an item's selection state. -#if !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE +class TreeItemUnlocker +{ +public: + // unlock a single item + TreeItemUnlocker(HTREEITEM item) { ms_unlockedItem = item; } + + // unlock all items, don't use unless absolutely necessary + TreeItemUnlocker() { ms_unlockedItem = (HTREEITEM)-1; } + + // lock everything back + ~TreeItemUnlocker() { ms_unlockedItem = NULL; } + + + // check if the item state is currently locked + static bool IsLocked(HTREEITEM item) + { return ms_unlockedItem != (HTREEITEM)-1 && item != ms_unlockedItem; } + +private: + static HTREEITEM ms_unlockedItem; +}; + +HTREEITEM TreeItemUnlocker::ms_unlockedItem = NULL; + +// ---------------------------------------------------------------------------- +// private functions +// ---------------------------------------------------------------------------- // wrappers for TreeView_GetItem/TreeView_SetItem static bool IsItemSelected(HWND hwndTV, HTREEITEM hItem) @@ -84,6 +118,8 @@ static bool IsItemSelected(HWND hwndTV, HTREEITEM hItem) tvi.stateMask = TVIS_SELECTED; tvi.hItem = hItem; + TreeItemUnlocker unlocker(hItem); + if ( !TreeView_GetItem(hwndTV, &tvi) ) { wxLogLastError(wxT("TreeView_GetItem")); @@ -100,6 +136,8 @@ static bool SelectItem(HWND hwndTV, HTREEITEM hItem, bool select = true) tvi.state = select ? TVIS_SELECTED : 0; tvi.hItem = hItem; + TreeItemUnlocker unlocker(hItem); + if ( TreeView_SetItem(hwndTV, &tvi) == -1 ) { wxLogLastError(wxT("TreeView_SetItem")); @@ -114,11 +152,6 @@ static inline void UnselectItem(HWND hwndTV, HTREEITEM htItem) SelectItem(hwndTV, htItem, false); } -static inline void ToggleItemSelection(HWND hwndTV, HTREEITEM htItem) -{ - SelectItem(hwndTV, htItem, !IsItemSelected(hwndTV, htItem)); -} - // helper function which selects all items in a range and, optionally, // unselects all others static void SelectRange(HWND hwndTV, @@ -187,60 +220,57 @@ static void SelectRange(HWND hwndTV, // helper function which tricks the standard control into changing the focused // item without changing anything else (if someone knows why Microsoft doesn't // allow to do it by just setting TVIS_FOCUSED flag, please tell me!) -static void SetFocus(HWND hwndTV, HTREEITEM htItem) +// +// returns true if the focus was changed, false if the given item was already +// the focused one +static bool SetFocus(HWND hwndTV, HTREEITEM htItem) { // the current focus HTREEITEM htFocus = (HTREEITEM)TreeView_GetSelection(hwndTV); + if ( htItem == htFocus ) + return false; + if ( htItem ) { - // set the focus - if ( htItem != htFocus ) - { - // remember the selection state of the item - bool wasSelected = IsItemSelected(hwndTV, htItem); + // remember the selection state of the item + bool wasSelected = IsItemSelected(hwndTV, htItem); - if ( htFocus && IsItemSelected(hwndTV, htFocus) ) - { - // prevent the tree from unselecting the old focus which it - // would do by default (TreeView_SelectItem unselects the - // focused item) - TreeView_SelectItem(hwndTV, 0); - SelectItem(hwndTV, htFocus); - } + if ( htFocus && IsItemSelected(hwndTV, htFocus) ) + { + // prevent the tree from unselecting the old focus which it + // would do by default (TreeView_SelectItem unselects the + // focused item) + TreeView_SelectItem(hwndTV, 0); + SelectItem(hwndTV, htFocus); + } - TreeView_SelectItem(hwndTV, htItem); + TreeView_SelectItem(hwndTV, htItem); - if ( !wasSelected ) - { - // need to clear the selection which TreeView_SelectItem() gave - // us - UnselectItem(hwndTV, htItem); - } - //else: was selected, still selected - ok + if ( !wasSelected ) + { + // need to clear the selection which TreeView_SelectItem() gave + // us + UnselectItem(hwndTV, htItem); } - //else: nothing to do, focus already there + //else: was selected, still selected - ok } - else + else // reset focus { - if ( htFocus ) - { - bool wasFocusSelected = IsItemSelected(hwndTV, htFocus); + bool wasFocusSelected = IsItemSelected(hwndTV, htFocus); - // just clear the focus - TreeView_SelectItem(hwndTV, 0); + // just clear the focus + TreeView_SelectItem(hwndTV, 0); - if ( wasFocusSelected ) - { - // restore the selection state - SelectItem(hwndTV, htFocus); - } + if ( wasFocusSelected ) + { + // restore the selection state + SelectItem(hwndTV, htFocus); } - //else: nothing to do, no focus already } -} -#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE + return true; +} // ---------------------------------------------------------------------------- // private classes @@ -266,27 +296,122 @@ struct wxTreeViewItem : public TV_ITEM } }; +// ---------------------------------------------------------------------------- +// This class is our userdata/lParam for the TV_ITEMs stored in the treeview. +// +// We need this for a couple of reasons: +// +// 1) This class is needed for support of different images: the Win32 common +// control natively supports only 2 images (the normal one and another for the +// selected state). We wish to provide support for 2 more of them for folder +// items (i.e. those which have children): for expanded state and for expanded +// selected state. For this we use this structure to store the additional items +// images. +// +// 2) This class is also needed to hold the HITEM so that we can sort +// it correctly in the MSW sort callback. +// +// In addition it makes other workarounds such as this easier and helps +// simplify the code. +// ---------------------------------------------------------------------------- + +class wxTreeItemParam +{ +public: + wxTreeItemParam() + { + m_data = NULL; + + for ( size_t n = 0; n < WXSIZEOF(m_images); n++ ) + { + m_images[n] = -1; + } + } + + // dtor deletes the associated data as well + virtual ~wxTreeItemParam() { delete m_data; } + + // accessors + // get the real data associated with the item + wxTreeItemData *GetData() const { return m_data; } + // change it + void SetData(wxTreeItemData *data) { m_data = data; } + + // do we have such image? + bool HasImage(wxTreeItemIcon which) const { return m_images[which] != -1; } + // get image, falling back to the other images if this one is not + // specified + int GetImage(wxTreeItemIcon which) const + { + int image = m_images[which]; + if ( image == -1 ) + { + switch ( which ) + { + case wxTreeItemIcon_SelectedExpanded: + image = GetImage(wxTreeItemIcon_Expanded); + if ( image != -1 ) + break; + //else: fall through + + case wxTreeItemIcon_Selected: + case wxTreeItemIcon_Expanded: + image = GetImage(wxTreeItemIcon_Normal); + break; + + case wxTreeItemIcon_Normal: + // no fallback + break; + + default: + wxFAIL_MSG( _T("unsupported wxTreeItemIcon value") ); + } + } + + return image; + } + // change the given image + void SetImage(int image, wxTreeItemIcon which) { m_images[which] = image; } + + // get item + const wxTreeItemId& GetItem() const { return m_item; } + // set item + void SetItem(const wxTreeItemId& item) { m_item = item; } + +protected: + // all the images associated with the item + int m_images[wxTreeItemIcon_Max]; + + // item for sort callbacks + wxTreeItemId m_item; + + // the real client data + wxTreeItemData *m_data; + + DECLARE_NO_COPY_CLASS(wxTreeItemParam) +}; + // wxVirutalNode is used in place of a single root when 'hidden' root is // specified. class wxVirtualNode : public wxTreeViewItem { public: - wxVirtualNode(wxTreeItemData *data) + wxVirtualNode(wxTreeItemParam *param) : wxTreeViewItem(TVI_ROOT, 0) { - m_data = data; + m_param = param; } ~wxVirtualNode() { - delete m_data; + delete m_param; } - wxTreeItemData *GetData() const { return m_data; } - void SetData(wxTreeItemData *data) { delete m_data; m_data = data; } + wxTreeItemParam *GetParam() const { return m_param; } + void SetParam(wxTreeItemParam *param) { delete m_param; m_param = param; } private: - wxTreeItemData *m_data; + wxTreeItemParam *m_param; DECLARE_NO_COPY_CLASS(wxVirtualNode) }; @@ -352,17 +477,15 @@ public: virtual bool OnVisit(const wxTreeItemId& item) { + const wxTreeCtrl * const tree = GetTree(); + // can't visit a virtual node. - if ( (GetTree()->GetRootItem() == item) && (GetTree()->GetWindowStyle() & wxTR_HIDE_ROOT)) + if ( (tree->GetRootItem() == item) && tree->HasFlag(wxTR_HIDE_ROOT) ) { return true; } -#if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE - if ( GetTree()->IsItemChecked(item) ) -#else - if ( ::IsItemSelected(GetHwndOf(GetTree()), HITEM(item)) ) -#endif + if ( ::IsItemSelected(GetHwndOf(tree), HITEM(item)) ) { m_selections.Add(item); } @@ -407,69 +530,6 @@ private: DECLARE_NO_COPY_CLASS(TraverseCounter) }; -// ---------------------------------------------------------------------------- -// This class is needed for support of different images: the Win32 common -// control natively supports only 2 images (the normal one and another for the -// selected state). We wish to provide support for 2 more of them for folder -// items (i.e. those which have children): for expanded state and for expanded -// selected state. For this we use this structure to store the additional items -// images. -// -// There is only one problem with this: when we retrieve the item's data, we -// don't know whether we get a pointer to wxTreeItemData or -// wxTreeItemIndirectData. So we always set the item id to an invalid value -// in this class and the code using the client data checks for it and retrieves -// the real client data in this case. -// ---------------------------------------------------------------------------- - -class wxTreeItemIndirectData : public wxTreeItemData -{ -public: - // ctor associates this data with the item and the real item data becomes - // available through our GetData() method - wxTreeItemIndirectData(wxTreeCtrl *tree, const wxTreeItemId& item) - { - for ( size_t n = 0; n < WXSIZEOF(m_images); n++ ) - { - m_images[n] = -1; - } - - // save the old data - m_data = tree->GetItemData(item); - - // and set ourselves as the new one - tree->SetIndirectItemData(item, this); - - // we must have the invalid value for the item - m_pItem = 0l; - } - - // dtor deletes the associated data as well - virtual ~wxTreeItemIndirectData() { delete m_data; } - - // accessors - // get the real data associated with the item - wxTreeItemData *GetData() const { return m_data; } - // change it - void SetData(wxTreeItemData *data) { m_data = data; } - - // do we have such image? - bool HasImage(wxTreeItemIcon which) const { return m_images[which] != -1; } - // get image - int GetImage(wxTreeItemIcon which) const { return m_images[which]; } - // change it - void SetImage(int image, wxTreeItemIcon which) { m_images[which] = image; } - -private: - // all the images associated with the item - int m_images[wxTreeItemIcon_Max]; - - // the real client data - wxTreeItemData *m_data; - - DECLARE_NO_COPY_CLASS(wxTreeItemIndirectData) -}; - // ---------------------------------------------------------------------------- // wxWin macros // ---------------------------------------------------------------------------- @@ -517,7 +577,9 @@ wxBEGIN_FLAGS( wxTreeCtrlStyle ) wxFLAGS_MEMBER(wxTR_HAS_VARIABLE_ROW_HEIGHT) wxFLAGS_MEMBER(wxTR_SINGLE) wxFLAGS_MEMBER(wxTR_MULTIPLE) +#if WXWIN_COMPATIBILITY_2_8 wxFLAGS_MEMBER(wxTR_EXTENDED) +#endif wxFLAGS_MEMBER(wxTR_DEFAULT_STYLE) wxEND_FLAGS( wxTreeCtrlStyle ) @@ -613,7 +675,9 @@ void wxTreeCtrl::Init() { m_textCtrl = NULL; m_hasAnyAttr = false; +#if wxUSE_DRAGIMAGE m_dragImage = NULL; +#endif m_pVirtualRoot = NULL; // initialize the global array of events now as it can't be done statically @@ -640,7 +704,7 @@ bool wxTreeCtrl::Create(wxWindow *parent, if ( !CreateControl(parent, id, pos, size, style, validator, name) ) return false; - DWORD exStyle = 0; + WXDWORD exStyle = 0; DWORD wstyle = MSWGetStyle(m_windowStyle, & exStyle); wstyle |= WS_TABSTOP | TVS_SHOWSELALWAYS; @@ -661,20 +725,6 @@ bool wxTreeCtrl::Create(wxWindow *parent, wstyle |= TVS_FULLROWSELECT; } - // using TVS_CHECKBOXES for emulation of a multiselection tree control - // doesn't work without the new enough headers -#if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE && \ - !defined( __GNUWIN32_OLD__ ) && \ - !defined( __BORLANDC__ ) && \ - !defined( __WATCOMC__ ) && \ - (!defined(__VISUALC__) || (__VISUALC__ > 1010)) - - // we emulate the multiple selection tree controls by using checkboxes: set - // up the image list we need for this if we do have multiple selections - if ( m_windowStyle & wxTR_MULTIPLE ) - wstyle |= TVS_CHECKBOXES; -#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE - #if !defined(__WXWINCE__) && defined(TVS_INFOTIP) // Need so that TVN_GETINFOTIP messages will be sent wstyle |= TVS_INFOTIP; @@ -794,7 +844,7 @@ wxTreeCtrl::GetClassDefaultAttributes(wxWindowVariant variant) // simple wrappers which add error checking in debug mode -bool wxTreeCtrl::DoGetItem(wxTreeViewItem* tvItem) const +bool wxTreeCtrl::DoGetItem(wxTreeViewItem *tvItem) const { wxCHECK_MSG( tvItem->hItem != TVI_ROOT, false, _T("can't retrieve virtual root item") ); @@ -809,17 +859,19 @@ bool wxTreeCtrl::DoGetItem(wxTreeViewItem* tvItem) const return true; } -void wxTreeCtrl::DoSetItem(wxTreeViewItem* tvItem) +void wxTreeCtrl::DoSetItem(wxTreeViewItem *tvItem) { + TreeItemUnlocker unlocker(tvItem->hItem); + if ( TreeView_SetItem(GetHwnd(), tvItem) == -1 ) { wxLogLastError(wxT("TreeView_SetItem")); } } -size_t wxTreeCtrl::GetCount() const +unsigned int wxTreeCtrl::GetCount() const { - return (size_t)TreeView_GetCount(GetHwnd()); + return (unsigned int)TreeView_GetCount(GetHwnd()); } unsigned int wxTreeCtrl::GetIndent() const @@ -835,9 +887,9 @@ void wxTreeCtrl::SetIndent(unsigned int indent) void wxTreeCtrl::SetAnyImageList(wxImageList *imageList, int which) { // no error return - TreeView_SetImageList(GetHwnd(), - imageList ? imageList->GetHIMAGELIST() : 0, - which); + (void) TreeView_SetImageList(GetHwnd(), + imageList ? imageList->GetHIMAGELIST() : 0, + which); } void wxTreeCtrl::SetImageList(wxImageList *imageList) @@ -897,6 +949,11 @@ bool wxTreeCtrl::SetForegroundColour(const wxColour &colour) // Item access // ---------------------------------------------------------------------------- +bool wxTreeCtrl::IsHiddenRoot(const wxTreeItemId& item) const +{ + return HITEM(item) == TVI_ROOT && HasFlag(wxTR_HIDE_ROOT); +} + wxString wxTreeCtrl::GetItemText(const wxTreeItemId& item) const { wxCHECK_MSG( item.IsOk(), wxEmptyString, wxT("invalid tree item") ); @@ -923,7 +980,7 @@ void wxTreeCtrl::SetItemText(const wxTreeItemId& item, const wxString& text) return; wxTreeViewItem tvItem(item, TVIF_TEXT); - tvItem.pszText = (wxChar *)text.c_str(); // conversion is ok + tvItem.pszText = (wxChar *)text.wx_str(); // conversion is ok DoSetItem(&tvItem); // when setting the text of the item being edited, the text control should @@ -936,263 +993,92 @@ void wxTreeCtrl::SetItemText(const wxTreeItemId& item, const wxString& text) { if ( item == m_idEdited ) { - ::SetWindowText(hwndEdit, text); + ::SetWindowText(hwndEdit, text.wx_str()); } } } -int wxTreeCtrl::DoGetItemImageFromData(const wxTreeItemId& item, - wxTreeItemIcon which) const -{ - wxTreeViewItem tvItem(item, TVIF_PARAM); - if ( !DoGetItem(&tvItem) ) - { - return -1; - } - - return ((wxTreeItemIndirectData *)tvItem.lParam)->GetImage(which); -} - -void wxTreeCtrl::DoSetItemImageFromData(const wxTreeItemId& item, - int image, - wxTreeItemIcon which) const -{ - wxTreeViewItem tvItem(item, TVIF_PARAM); - if ( !DoGetItem(&tvItem) ) - { - return; - } - - wxTreeItemIndirectData *data = ((wxTreeItemIndirectData *)tvItem.lParam); - - data->SetImage(image, which); - - // make sure that we have selected images as well - if ( which == wxTreeItemIcon_Normal && - !data->HasImage(wxTreeItemIcon_Selected) ) - { - data->SetImage(image, wxTreeItemIcon_Selected); - } - - if ( which == wxTreeItemIcon_Expanded && - !data->HasImage(wxTreeItemIcon_SelectedExpanded) ) - { - data->SetImage(image, wxTreeItemIcon_SelectedExpanded); - } -} - -void wxTreeCtrl::DoSetItemImages(const wxTreeItemId& item, - int image, - int imageSel) -{ - wxTreeViewItem tvItem(item, TVIF_IMAGE | TVIF_SELECTEDIMAGE); - tvItem.iSelectedImage = imageSel; - tvItem.iImage = image; - DoSetItem(&tvItem); -} - int wxTreeCtrl::GetItemImage(const wxTreeItemId& item, wxTreeItemIcon which) const { wxCHECK_MSG( item.IsOk(), -1, wxT("invalid tree item") ); - if ( (HITEM(item) == TVI_ROOT) && (m_windowStyle & wxTR_HIDE_ROOT) ) + if ( IsHiddenRoot(item) ) { - // TODO: Maybe a hidden root can still provide images? + // no images for hidden root item return -1; } - if ( HasIndirectData(item) ) - { - return DoGetItemImageFromData(item, which); - } - - UINT mask; - switch ( which ) - { - default: - wxFAIL_MSG( wxT("unknown tree item image type") ); - - case wxTreeItemIcon_Normal: - mask = TVIF_IMAGE; - break; + wxTreeItemParam *param = GetItemParam(item); - case wxTreeItemIcon_Selected: - mask = TVIF_SELECTEDIMAGE; - break; - - case wxTreeItemIcon_Expanded: - case wxTreeItemIcon_SelectedExpanded: - return -1; - } - - wxTreeViewItem tvItem(item, mask); - DoGetItem(&tvItem); - - return mask == TVIF_IMAGE ? tvItem.iImage : tvItem.iSelectedImage; + return param && param->HasImage(which) ? param->GetImage(which) : -1; } void wxTreeCtrl::SetItemImage(const wxTreeItemId& item, int image, wxTreeItemIcon which) { wxCHECK_RET( item.IsOk(), wxT("invalid tree item") ); + wxCHECK_RET( which >= 0 && + which < wxTreeItemIcon_Max, + wxT("invalid image index")); - if ( IS_VIRTUAL_ROOT(item) ) + + if ( IsHiddenRoot(item) ) { - // TODO: Maybe a hidden root can still store images? + // no images for hidden root item return; } - int imageNormal, - imageSel; - - switch ( which ) - { - default: - wxFAIL_MSG( wxT("unknown tree item image type") ); - // fall through - - case wxTreeItemIcon_Normal: - { - const int imageNormalOld = GetItemImage(item); - const int imageSelOld = - GetItemImage(item, wxTreeItemIcon_Selected); - - // always set the normal image - imageNormal = image; - - // if the selected and normal images were the same, they should - // be the same after the update, otherwise leave the selected - // image as it was - imageSel = imageNormalOld == imageSelOld ? image : imageSelOld; - } - break; - - case wxTreeItemIcon_Selected: - imageNormal = GetItemImage(item); - imageSel = image; - break; - - case wxTreeItemIcon_Expanded: - case wxTreeItemIcon_SelectedExpanded: - if ( !HasIndirectData(item) ) - { - // we need to get the old images first, because after we create - // the wxTreeItemIndirectData GetItemXXXImage() will use it to - // get the images - imageNormal = GetItemImage(item); - imageSel = GetItemImage(item, wxTreeItemIcon_Selected); - - // if it doesn't have it yet, add it - wxTreeItemIndirectData *data = new - wxTreeItemIndirectData(this, item); - - // copy the data to the new location - data->SetImage(imageNormal, wxTreeItemIcon_Normal); - data->SetImage(imageSel, wxTreeItemIcon_Selected); - } - - DoSetItemImageFromData(item, image, which); + wxTreeItemParam *data = GetItemParam(item); + if ( !data ) + return; - // reset the normal/selected images because we won't use them any - // more - now they're stored inside the indirect data - imageNormal = - imageSel = I_IMAGECALLBACK; - break; - } + data->SetImage(image, which); - // NB: at least in version 5.00.0518.9 of comctl32.dll we need to always - // change both normal and selected image - otherwise the change simply - // doesn't take place! - DoSetItemImages(item, imageNormal, imageSel); + RefreshItem(item); } -wxTreeItemData *wxTreeCtrl::GetItemData(const wxTreeItemId& item) const +wxTreeItemParam *wxTreeCtrl::GetItemParam(const wxTreeItemId& item) const { wxCHECK_MSG( item.IsOk(), NULL, wxT("invalid tree item") ); wxTreeViewItem tvItem(item, TVIF_PARAM); - // Hidden root may have data. + // hidden root may still have data. if ( IS_VIRTUAL_ROOT(item) ) { - return GET_VIRTUAL_ROOT()->GetData(); + return GET_VIRTUAL_ROOT()->GetParam(); } - // Visible node. + // visible node. if ( !DoGetItem(&tvItem) ) { return NULL; } - wxTreeItemData *data = (wxTreeItemData *)tvItem.lParam; - if ( IsDataIndirect(data) ) - { - data = ((wxTreeItemIndirectData *)data)->GetData(); - } - - return data; + return (wxTreeItemParam *)tvItem.lParam; } -void wxTreeCtrl::SetItemData(const wxTreeItemId& item, wxTreeItemData *data) +wxTreeItemData *wxTreeCtrl::GetItemData(const wxTreeItemId& item) const { - wxCHECK_RET( item.IsOk(), wxT("invalid tree item") ); + wxTreeItemParam *data = GetItemParam(item); - if ( IS_VIRTUAL_ROOT(item) ) - { - GET_VIRTUAL_ROOT()->SetData(data); - } + return data ? data->GetData() : NULL; +} +void wxTreeCtrl::SetItemData(const wxTreeItemId& item, wxTreeItemData *data) +{ // first, associate this piece of data with this item if ( data ) { data->SetId(item); } - wxTreeViewItem tvItem(item, TVIF_PARAM); - - if ( HasIndirectData(item) ) - { - if ( DoGetItem(&tvItem) ) - { - ((wxTreeItemIndirectData *)tvItem.lParam)->SetData(data); - } - else - { - wxFAIL_MSG( wxT("failed to change tree items data") ); - } - } - else - { - tvItem.lParam = (LPARAM)data; - DoSetItem(&tvItem); - } -} - -void wxTreeCtrl::SetIndirectItemData(const wxTreeItemId& item, - wxTreeItemIndirectData *data) -{ - // this should never happen because it's unnecessary and will probably lead - // to crash too because the code elsewhere supposes that the pointer the - // wxTreeItemIndirectData has is a real wxItemData and not - // wxTreeItemIndirectData as well - wxASSERT_MSG( !HasIndirectData(item), wxT("setting indirect data twice?") ); - - SetItemData(item, data); -} - -bool wxTreeCtrl::HasIndirectData(const wxTreeItemId& item) const -{ - // query the item itself - wxTreeViewItem tvItem(item, TVIF_PARAM); - if ( !DoGetItem(&tvItem) ) - { - return false; - } + wxTreeItemParam *param = GetItemParam(item); - wxTreeItemData *data = (wxTreeItemData *)tvItem.lParam; + wxCHECK_RET( param, wxT("failed to change tree items data") ); - return data && IsDataIndirect(data); + param->SetData(data); } void wxTreeCtrl::SetItemHasChildren(const wxTreeItemId& item, bool has) @@ -1333,6 +1219,10 @@ void wxTreeCtrl::SetItemFont(const wxTreeItemId& item, const wxFont& font) attr->SetFont(font); + // Reset the item's text to ensure that the bounding rect will be adjusted + // for the new font. + SetItemText(item, GetItemText(item)); + RefreshItem(item); } @@ -1483,36 +1373,6 @@ wxTreeItemId wxTreeCtrl::GetNextChild(const wxTreeItemId& WXUNUSED(item), return item; } -#if WXWIN_COMPATIBILITY_2_4 - -wxTreeItemId wxTreeCtrl::GetFirstChild(const wxTreeItemId& item, - long& cookie) const -{ - wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") ); - - cookie = (long)TreeView_GetChild(GetHwnd(), HITEM(item)); - - return wxTreeItemId((void *)cookie); -} - -wxTreeItemId wxTreeCtrl::GetNextChild(const wxTreeItemId& WXUNUSED(item), - long& cookie) const -{ - wxTreeItemId fromCookie((void *)cookie); - - HTREEITEM hitem = HITEM(fromCookie); - - hitem = TreeView_GetNextSibling(GetHwnd(), hitem); - - wxTreeItemId item(hitem); - - cookie = (long)item.m_pItem; - - return item; -} - -#endif // WXWIN_COMPATIBILITY_2_4 - wxTreeItemId wxTreeCtrl::GetLastChild(const wxTreeItemId& item) const { wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") ); @@ -1553,7 +1413,15 @@ wxTreeItemId wxTreeCtrl::GetNextVisible(const wxTreeItemId& item) const wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") ); wxASSERT_MSG( IsVisible(item), wxT("The item you call GetNextVisible() for must be visible itself!")); - return wxTreeItemId(TreeView_GetNextVisible(GetHwnd(), HITEM(item))); + wxTreeItemId next(TreeView_GetNextVisible(GetHwnd(), HITEM(item))); + if ( next.IsOk() && !IsVisible(next) ) + { + // Win32 considers that any non-collapsed item is visible while we want + // to return only really visible items + next.Unset(); + } + + return next; } wxTreeItemId wxTreeCtrl::GetPrevVisible(const wxTreeItemId& item) const @@ -1561,7 +1429,15 @@ wxTreeItemId wxTreeCtrl::GetPrevVisible(const wxTreeItemId& item) const wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") ); wxASSERT_MSG( IsVisible(item), wxT("The item you call GetPrevVisible() for must be visible itself!")); - return wxTreeItemId(TreeView_GetPrevVisible(GetHwnd(), HITEM(item))); + wxTreeItemId prev(TreeView_GetPrevVisible(GetHwnd(), HITEM(item))); + if ( prev.IsOk() && !IsVisible(prev) ) + { + // just as above, Win32 function will happily return the previous item + // in the tree for the first visible item too + prev.Unset(); + } + + return prev; } // ---------------------------------------------------------------------------- @@ -1631,7 +1507,7 @@ wxTreeItemId wxTreeCtrl::DoInsertAfter(const wxTreeItemId& parent, if ( !text.empty() ) { mask |= TVIF_TEXT; - tvIns.item.pszText = (wxChar *)text.c_str(); // cast is ok + tvIns.item.pszText = (wxChar *)text.wx_str(); // cast is ok } else { @@ -1639,76 +1515,69 @@ wxTreeItemId wxTreeCtrl::DoInsertAfter(const wxTreeItemId& parent, tvIns.item.cchTextMax = 0; } - if ( image != -1 ) - { - mask |= TVIF_IMAGE; - tvIns.item.iImage = image; + // create the param which will store the other item parameters + wxTreeItemParam *param = new wxTreeItemParam; - if ( selectedImage == -1 ) - { - // take the same image for selected icon if not specified - selectedImage = image; - } - } + // we return the images on demand as they depend on whether the item is + // expanded or collapsed too in our case + mask |= TVIF_IMAGE | TVIF_SELECTEDIMAGE; + tvIns.item.iImage = I_IMAGECALLBACK; + tvIns.item.iSelectedImage = I_IMAGECALLBACK; - if ( selectedImage != -1 ) - { - mask |= TVIF_SELECTEDIMAGE; - tvIns.item.iSelectedImage = selectedImage; - } - - if ( data != NULL ) - { - mask |= TVIF_PARAM; - tvIns.item.lParam = (LPARAM)data; - } + param->SetImage(image, wxTreeItemIcon_Normal); + param->SetImage(selectedImage, wxTreeItemIcon_Selected); + mask |= TVIF_PARAM; + tvIns.item.lParam = (LPARAM)param; tvIns.item.mask = mask; - HTREEITEM id = (HTREEITEM) TreeView_InsertItem(GetHwnd(), &tvIns); + // don't use the hack below for the children of hidden root: this results + // in a crash inside comctl32.dll when we call TreeView_GetItemRect() + const bool firstChild = !IsHiddenRoot(parent) && + !TreeView_GetChild(GetHwnd(), HITEM(parent)); + + HTREEITEM id = TreeView_InsertItem(GetHwnd(), &tvIns); if ( id == 0 ) { wxLogLastError(wxT("TreeView_InsertItem")); } + // apparently some Windows versions (2000 and XP are reported to do this) + // sometimes don't refresh the tree after adding the first child and so we + // need this to make the "[+]" appear + if ( firstChild ) + { + RECT rect; + TreeView_GetItemRect(GetHwnd(), HITEM(parent), &rect, FALSE); + ::InvalidateRect(GetHwnd(), &rect, FALSE); + } + + // associate the application tree item with Win32 tree item handle + param->SetItem(id); + + // setup wxTreeItemData if ( data != NULL ) { - // associate the application tree item with Win32 tree item handle + param->SetData(data); data->SetId(id); } return wxTreeItemId(id); } -// for compatibility only -#if WXWIN_COMPATIBILITY_2_4 - -void wxTreeCtrl::SetImageList(wxImageList *imageList, int) -{ - SetImageList(imageList); -} - -int wxTreeCtrl::GetItemSelectedImage(const wxTreeItemId& item) const -{ - return GetItemImage(item, wxTreeItemIcon_Selected); -} - -void wxTreeCtrl::SetItemSelectedImage(const wxTreeItemId& item, int image) -{ - SetItemImage(item, image, wxTreeItemIcon_Selected); -} - -#endif // WXWIN_COMPATIBILITY_2_4 - wxTreeItemId wxTreeCtrl::AddRoot(const wxString& text, int image, int selectedImage, wxTreeItemData *data) { - - if ( m_windowStyle & wxTR_HIDE_ROOT ) + if ( HasFlag(wxTR_HIDE_ROOT) ) { + wxASSERT_MSG( !m_pVirtualRoot, _T("tree can have only a single root") ); + // create a virtual root item, the parent for all the others - m_pVirtualRoot = new wxVirtualNode(data); + wxTreeItemParam *param = new wxTreeItemParam; + param->SetData(data); + + m_pVirtualRoot = new wxVirtualNode(param); return TVI_ROOT; } @@ -1751,6 +1620,10 @@ wxTreeItemId wxTreeCtrl::DoInsertItem(const wxTreeItemId& parent, void wxTreeCtrl::Delete(const wxTreeItemId& item) { + // unlock tree selections on vista, without this the + // tree ctrl will eventually crash after item deletion + TreeItemUnlocker unlock_all; + if ( !TreeView_DeleteItem(GetHwnd(), HITEM(item)) ) { wxLogLastError(wxT("TreeView_DeleteItem")); @@ -1760,6 +1633,9 @@ void wxTreeCtrl::Delete(const wxTreeItemId& item) // delete all children (but don't delete the item itself) void wxTreeCtrl::DeleteChildren(const wxTreeItemId& item) { + // unlock tree selections on vista for the duration of this call + TreeItemUnlocker unlock_all; + wxTreeItemIdValue cookie; wxArrayTreeItemIds children; @@ -1783,6 +1659,9 @@ void wxTreeCtrl::DeleteChildren(const wxTreeItemId& item) void wxTreeCtrl::DeleteAllItems() { + // unlock tree selections on vista for the duration of this call + TreeItemUnlocker unlock_all; + // delete the "virtual" root item. if ( GET_VIRTUAL_ROOT() ) { @@ -1807,8 +1686,8 @@ void wxTreeCtrl::DoExpand(const wxTreeItemId& item, int flag) wxT("Unknown flag in wxTreeCtrl::DoExpand") ); // A hidden root can be neither expanded nor collapsed. - wxCHECK_RET( !(m_windowStyle & wxTR_HIDE_ROOT) || (HITEM(item) != TVI_ROOT), - wxT("Can't expand/collapse hidden root node!") ) + wxCHECK_RET( !IsHiddenRoot(item), + wxT("Can't expand/collapse hidden root node!") ); // TreeView_Expand doesn't send TVN_ITEMEXPAND(ING) messages, so we must // emulate them. This behaviour has changed slightly with comctl32.dll @@ -1824,17 +1703,13 @@ void wxTreeCtrl::DoExpand(const wxTreeItemId& item, int flag) if ( TreeView_Expand(GetHwnd(), HITEM(item), flag) != 0 ) { - wxTreeEvent event(wxEVT_NULL, m_windowId); - event.m_item = item; - event.SetEventObject(this); - // note that the {EXPAND|COLLAPS}ING event is sent by TreeView_Expand() // itself - event.SetEventType(gs_expandEvents[IsExpanded(item) ? IDX_EXPAND - : IDX_COLLAPSE] - [IDX_DONE]); - - (void)GetEventHandler()->ProcessEvent(event); + wxTreeEvent event(gs_expandEvents[IsExpanded(item) ? IDX_EXPAND + : IDX_COLLAPSE] + [IDX_DONE], + this, item); + (void)HandleWindowEvent(event); } //else: change didn't took place, so do nothing at all } @@ -1859,15 +1734,6 @@ void wxTreeCtrl::Toggle(const wxTreeItemId& item) DoExpand(item, TVE_TOGGLE); } -#if WXWIN_COMPATIBILITY_2_4 - -void wxTreeCtrl::ExpandItem(const wxTreeItemId& item, int action) -{ - DoExpand(item, action); -} - -#endif - void wxTreeCtrl::Unselect() { wxASSERT_MSG( !(m_windowStyle & wxTR_MULTIPLE), @@ -1885,11 +1751,7 @@ void wxTreeCtrl::UnselectAll() size_t count = GetSelections(selections); for ( size_t n = 0; n < count; n++ ) { -#if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE - SetItemCheck(HITEM(selections[n]), false); -#else // !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE ::UnselectItem(GetHwnd(), HITEM(selections[n])); -#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE/!wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE } m_htSelStart.Unset(); @@ -1903,47 +1765,42 @@ void wxTreeCtrl::UnselectAll() void wxTreeCtrl::SelectItem(const wxTreeItemId& item, bool select) { - if ( m_windowStyle & wxTR_MULTIPLE ) - { -#if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE - // selecting the item means checking it - SetItemCheck(item, select); -#else // !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE - ::SelectItem(GetHwnd(), HITEM(item), select); -#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE/!wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE - } - else - { - wxASSERT_MSG( select, - _T("SelectItem(false) works only for multiselect") ); + wxCHECK_RET( !IsHiddenRoot(item), _T("can't select hidden root item") ); - // inspite of the docs (MSDN Jan 99 edition), we don't seem to receive - // the notification from the control (i.e. TVN_SELCHANG{ED|ING}), so - // send them ourselves + wxASSERT_MSG( select || HasFlag(wxTR_MULTIPLE), + _T("SelectItem(false) works only for multiselect") ); - wxTreeEvent event(wxEVT_NULL, m_windowId); - event.m_item = item; - event.SetEventObject(this); - - event.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGING); - if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() ) + wxTreeEvent event(wxEVT_COMMAND_TREE_SEL_CHANGING, this, item); + if ( !HandleWindowEvent(event) || event.IsAllowed() ) + { + if ( HasFlag(wxTR_MULTIPLE) ) { - if ( !TreeView_SelectItem(GetHwnd(), HITEM(item)) ) + if ( !::SelectItem(GetHwnd(), HITEM(item), select) ) { wxLogLastError(wxT("TreeView_SelectItem")); + return; } - else // ok + } + else // single selection + { + // use TreeView_SelectItem() to deselect the previous selection + if ( !TreeView_SelectItem(GetHwnd(), HITEM(item)) ) { - event.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED); - (void)GetEventHandler()->ProcessEvent(event); + wxLogLastError(wxT("TreeView_SelectItem")); + return; } } - //else: program vetoed the change + + event.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED); + (void)HandleWindowEvent(event); } + //else: program vetoed the change } void wxTreeCtrl::EnsureVisible(const wxTreeItemId& item) { + wxCHECK_RET( !IsHiddenRoot(item), _T("can't show hidden root item") ); + // no error return TreeView_EnsureVisible(GetHwnd(), HITEM(item)); } @@ -1982,8 +1839,8 @@ void wxTreeCtrl::DeleteTextCtrl() } } -wxTextCtrl* wxTreeCtrl::EditLabel(const wxTreeItemId& item, - wxClassInfo* textControlClass) +wxTextCtrl *wxTreeCtrl::EditLabel(const wxTreeItemId& item, + wxClassInfo *textControlClass) { wxASSERT( textControlClass->IsKindOf(CLASSINFO(wxTextCtrl)) ); @@ -2014,13 +1871,13 @@ void wxTreeCtrl::DoEndEditLabel(bool discardChanges) DeleteTextCtrl(); } -wxTreeItemId wxTreeCtrl::DoTreeHitTest(const wxPoint& point, int& flags) +wxTreeItemId wxTreeCtrl::DoTreeHitTest(const wxPoint& point, int& flags) const { TV_HITTESTINFO hitTestInfo; hitTestInfo.pt.x = (int)point.x; hitTestInfo.pt.y = (int)point.y; - TreeView_HitTest(GetHwnd(), &hitTestInfo); + (void) TreeView_HitTest(GetHwnd(), &hitTestInfo); flags = 0; @@ -2083,16 +1940,10 @@ public: static int CALLBACK Compare(LPARAM data1, LPARAM data2, LPARAM tree); private: - static wxTreeItemId GetIdFromData(wxTreeCtrl *tree, LPARAM item) + static wxTreeItemId GetIdFromData(LPARAM lParam) { - wxTreeItemData *data = (wxTreeItemData *)item; - if ( tree->IsDataIndirect(data) ) - { - data = ((wxTreeItemIndirectData *)data)->GetData(); + return ((wxTreeItemParam*)lParam)->GetItem(); } - - return data->GetId(); - } }; int CALLBACK wxTreeSortHelper::Compare(LPARAM pItem1, @@ -2104,8 +1955,8 @@ int CALLBACK wxTreeSortHelper::Compare(LPARAM pItem1, wxTreeCtrl *tree = (wxTreeCtrl *)htree; - return tree->OnCompareItems(GetIdFromData(tree, pItem1), - GetIdFromData(tree, pItem2)); + return tree->OnCompareItems(GetIdFromData(pItem1), + GetIdFromData(pItem2)); } void wxTreeCtrl::SortChildren(const wxTreeItemId& item) @@ -2115,6 +1966,10 @@ void wxTreeCtrl::SortChildren(const wxTreeItemId& item) // rely on the fact that TreeView_SortChildren does the same thing as our // default behaviour, i.e. sorts items alphabetically and so call it // directly if we're not in derived class (much more efficient!) + // RN: Note that if you find you're code doesn't sort as expected this + // may be why as if you don't use the DECLARE_CLASS/IMPLEMENT_CLASS + // combo for your derived wxTreeCtrl if will sort without + // OnCompareItems if ( GetClassInfo() == CLASSINFO(wxTreeCtrl) ) { TreeView_SortChildren(GetHwnd(), HITEM(item), 0); @@ -2133,8 +1988,26 @@ void wxTreeCtrl::SortChildren(const wxTreeItemId& item) // implementation // ---------------------------------------------------------------------------- -bool wxTreeCtrl::MSWCommand(WXUINT cmd, WXWORD id) +bool wxTreeCtrl::MSWShouldPreProcessMessage(WXMSG* msg) { + if ( msg->message == WM_KEYDOWN ) + { + // Only eat VK_RETURN if not being used by the application in + // conjunction with modifiers + if ( (msg->wParam == VK_RETURN) && !wxIsAnyModifierDown() ) + { + // we need VK_RETURN to generate wxEVT_COMMAND_TREE_ITEM_ACTIVATED + return false; + } + } + + return wxTreeCtrlBase::MSWShouldPreProcessMessage(msg); +} + +bool wxTreeCtrl::MSWCommand(WXUINT cmd, WXWORD id_) +{ + const int id = (signed short)id_; + if ( cmd == EN_UPDATE ) { wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, id); @@ -2172,34 +2045,47 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara { int x = GET_X_LPARAM(lParam), y = GET_Y_LPARAM(lParam); - // Convert the screen point to a client point - wxPoint MenuPoint = ScreenToClient(wxPoint(x, y)); - wxTreeEvent event( wxEVT_COMMAND_TREE_ITEM_MENU, GetId() ); + // the item for which the menu should be shown + wxTreeItemId item; - // can't use GetSelection() here as it would assert in multiselect mode - event.m_item = wxTreeItemId(TreeView_GetSelection(GetHwnd())); - event.SetEventObject( this ); + // the position where the menu should be shown in client coordinates + // (so that it can be passed directly to PopupMenu()) + wxPoint pt; - // Get the bounding rectangle for the item, including the non-text areas - wxRect ItemRect; - GetBoundingRect(event.m_item, ItemRect, false); - // If the point is inside the bounding rectangle, use it as the click position. - // This should be the case for WM_CONTEXTMENU as the result of a right-click - if (ItemRect.Inside(MenuPoint)) + if ( x == -1 || y == -1 ) { - event.m_pointDrag = MenuPoint; + // this means that the event was generated from keyboard (e.g. with + // Shift-F10 or special Windows menu key) + // + // use the Explorer standard of putting the menu at the left edge + // of the text, in the vertical middle of the text + item = wxTreeItemId(TreeView_GetSelection(GetHwnd())); + if ( item.IsOk() ) + { + // Use the bounding rectangle of only the text part + wxRect rect; + GetBoundingRect(item, rect, true); + pt = wxPoint(rect.GetX(), rect.GetY() + rect.GetHeight() / 2); + } } - // Use the Explorer standard of putting the menu at the left edge of the text, - // in the vertical middle of the text. Should be the case for the "menu" key - else + else // event from mouse, use mouse position { - // Use the bounding rectangle of only the text part - GetBoundingRect(event.m_item, ItemRect, true); - event.m_pointDrag = wxPoint(ItemRect.GetX(), ItemRect.GetY() + ItemRect.GetHeight() / 2); + pt = ScreenToClient(wxPoint(x, y)); + + TV_HITTESTINFO tvhti; + tvhti.pt.x = pt.x; + tvhti.pt.y = pt.y; + if ( TreeView_HitTest(GetHwnd(), &tvhti) ) + item = wxTreeItemId(tvhti.hItem); } - if ( GetEventHandler()->ProcessEvent(event) ) + // create the event + wxTreeEvent event(wxEVT_COMMAND_TREE_ITEM_MENU, this, item); + + event.m_pointDrag = pt; + + if ( HandleWindowEvent(event) ) processed = true; //else: continue with generating wxEVT_CONTEXT_MENU in base class code } @@ -2209,44 +2095,27 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara // same meaning for all of them int x = GET_X_LPARAM(lParam), y = GET_Y_LPARAM(lParam); - HTREEITEM htItem = GetItemFromPoint(GetHwnd(), x, y); - + TV_HITTESTINFO tvht; tvht.pt.x = x; tvht.pt.y = y; - - TreeView_HitTest(GetHwnd(), &tvht); + + HTREEITEM htItem = TreeView_HitTest(GetHwnd(), &tvht); switch ( nMsg ) { - case WM_RBUTTONDOWN: - // if the item we are about to right click on is not already - // selected or if we click outside of any item, remove the - // entire previous selection - if ( !htItem || !::IsItemSelected(GetHwnd(), htItem) ) - { - UnselectAll(); - } - - // select item and set the focus to the - // newly selected item - ::SelectItem(GetHwnd(), htItem); - ::SetFocus(GetHwnd(), htItem); - break; - -#if !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE case WM_LBUTTONDOWN: if ( htItem && isMultiple && (tvht.flags & TVHT_ONITEM) != 0 ) { m_htClickedItem = (WXHTREEITEM) htItem; m_ptClick = wxPoint(x, y); - + if ( wParam & MK_CONTROL ) { SetFocus(); // toggle selected state - ::ToggleItemSelection(GetHwnd(), htItem); + ToggleItemSelection(htItem); ::SetFocus(GetHwnd(), htItem); @@ -2280,7 +2149,7 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara { // avoid doing anything if we click on the only // currently selected item - + SetFocus(); wxArrayTreeItemIds selections; @@ -2309,13 +2178,52 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara ::SetFocus(GetHwnd(), htItem); processed = true; } + else // click on a single selected item + { + // don't interfere with the default processing in + // WM_MOUSEMOVE handler below as the default window + // proc will start the drag itself if we let have + // WM_LBUTTONDOWN + m_htClickedItem.Unset(); + } // reset on any click without Shift m_htSelStart.Unset(); } } break; -#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE + + case WM_RBUTTONDOWN: + // default handler removes the highlight from the currently + // focused item when right mouse button is pressed on another + // one but keeps the remaining items highlighted, which is + // confusing, so override this default behaviour for tree with + // multiple selections + if ( isMultiple ) + { + if ( !IsItemSelected(GetHwnd(), htItem) ) + { + UnselectAll(); + SelectItem(htItem); + ::SetFocus(GetHwnd(), htItem); + } + + // fire EVT_RIGHT_DOWN + HandleMouseEvent(nMsg, x, y, wParam); + + // send NM_RCLICK + NMHDR nmhdr; + nmhdr.hwndFrom = GetHwnd(); + nmhdr.idFrom = ::GetWindowLong(GetHwnd(), GWL_ID); + nmhdr.code = NM_RCLICK; + ::SendMessage(::GetParent(GetHwnd()), WM_NOTIFY, + nmhdr.idFrom, (LPARAM)&nmhdr); + + // prevent tree control default processing, as we've + // already done everything + processed = true; + } + break; case WM_MOUSEMOVE: #ifndef __WXWINCE__ @@ -2324,39 +2232,49 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara int cx = abs(m_ptClick.x - x); int cy = abs(m_ptClick.y - y); - if ( cx > GetSystemMetrics( SM_CXDRAG ) || cy > GetSystemMetrics( SM_CYDRAG ) ) + if ( cx > ::GetSystemMetrics(SM_CXDRAG) || + cy > ::GetSystemMetrics(SM_CYDRAG) ) { - HWND pWnd = ::GetParent( GetHwnd() ); - if ( pWnd ) - { - NM_TREEVIEW tv; - - tv.hdr.hwndFrom = GetHwnd(); - tv.hdr.idFrom = ::GetWindowLong( GetHwnd(), GWL_ID ); - tv.hdr.code = TVN_BEGINDRAG; - - tv.itemNew.hItem = HITEM(m_htClickedItem); - - TVITEM tviAux; - ZeroMemory(&tviAux, sizeof(tviAux)); - tviAux.hItem = HITEM(m_htClickedItem); - tviAux.mask = TVIF_STATE | TVIF_PARAM; - tviAux.stateMask = 0xffffffff; - TreeView_GetItem( GetHwnd(), &tviAux ); - - tv.itemNew.state = tviAux.state; - tv.itemNew.lParam = tviAux.lParam; - - tv.ptDrag.x = x; - tv.ptDrag.y = y; - - ::SendMessage( pWnd, WM_NOTIFY, tv.hdr.idFrom, (LPARAM)&tv ); - } + NM_TREEVIEW tv; + wxZeroMemory(tv); + + tv.hdr.hwndFrom = GetHwnd(); + tv.hdr.idFrom = ::GetWindowLong(GetHwnd(), GWL_ID); + tv.hdr.code = TVN_BEGINDRAG; + + tv.itemNew.hItem = HITEM(m_htClickedItem); + + + TVITEM tviAux; + wxZeroMemory(tviAux); + + tviAux.hItem = HITEM(m_htClickedItem); + tviAux.mask = TVIF_STATE | TVIF_PARAM; + tviAux.stateMask = 0xffffffff; + TreeView_GetItem(GetHwnd(), &tviAux); + + tv.itemNew.state = tviAux.state; + tv.itemNew.lParam = tviAux.lParam; + + tv.ptDrag.x = x; + tv.ptDrag.y = y; + + // do it before SendMessage() call below to avoid + // reentrancies here if there is another WM_MOUSEMOVE + // in the queue already m_htClickedItem.Unset(); + + ::SendMessage(GetHwndOf(GetParent()), WM_NOTIFY, + tv.hdr.idFrom, (LPARAM)&tv ); + + // don't pass it to the default window proc, it would + // start dragging again + processed = true; } } #endif // __WXWINCE__ - + +#if wxUSE_DRAGIMAGE if ( m_dragImage ) { m_dragImage->Move(wxPoint(x, y)); @@ -2369,6 +2287,7 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara m_dragImage->Show(); } } +#endif // wxUSE_DRAGIMAGE break; case WM_LBUTTONUP: @@ -2394,6 +2313,7 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara // fall through case WM_RBUTTONUP: +#if wxUSE_DRAGIMAGE if ( m_dragImage ) { m_dragImage->EndDrag(); @@ -2401,22 +2321,19 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara m_dragImage = NULL; // generate the drag end event - wxTreeEvent event(wxEVT_COMMAND_TREE_END_DRAG, m_windowId); - - event.m_item = htItem; + wxTreeEvent event(wxEVT_COMMAND_TREE_END_DRAG, this, htItem); event.m_pointDrag = wxPoint(x, y); - event.SetEventObject(this); - (void)GetEventHandler()->ProcessEvent(event); + (void)HandleWindowEvent(event); // if we don't do it, the tree seems to think that 2 items // are selected simultaneously which is quite weird TreeView_SelectDropTarget(GetHwnd(), 0); } +#endif // wxUSE_DRAGIMAGE break; } } -#if !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE else if ( (nMsg == WM_SETFOCUS || nMsg == WM_KILLFOCUS) && isMultiple ) { // the tree control greys out the selected item when it loses focus and @@ -2447,7 +2364,7 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara case VK_SPACE: if ( bCtrl ) { - ::ToggleItemSelection(GetHwnd(), htSel); + ToggleItemSelection(htSel); } else { @@ -2516,7 +2433,6 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara } } } -#endif // !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE else if ( nMsg == WM_COMMAND ) { // if we receive a EN_KILLFOCUS command from the in-place edit control @@ -2545,32 +2461,9 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara WXLRESULT wxTreeCtrl::MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam) { - // default WM_RBUTTONDOWN handler enters modal loop inside DefWindowProc() - // waiting for WM_RBUTTONUP and then sends the resulting WM_CONTEXTMENU to - // the parent window, not us, which completely breaks everything so simply - // don't let it see this message at all - if ( nMsg == WM_RBUTTONDOWN ) - return 0; - - // but because of the above we don't get NM_RCLICK which is normally - // generated by tree window proc when the modal loop mentioned above ends - // because the mouse is released -- synthesize it ourselves instead - if ( nMsg == WM_RBUTTONUP ) - { - NMHDR hdr; - hdr.hwndFrom = GetHwnd(); - hdr.idFrom = GetId(); - hdr.code = NM_RCLICK; - - WXLPARAM rc; - MSWOnNotify(GetId(), (LPARAM)&hdr, &rc); - - // continue as usual - } - if ( nMsg == WM_CHAR ) { - // also don't let the control process Space and Return keys because it + // don't let the control process Space and Return keys because it // doesn't do anything useful with them anyhow but always beeps // annoyingly when it receives them and there is no way to turn it off // simply if you just process TREEITEM_ACTIVATED event to which Space @@ -2578,6 +2471,24 @@ wxTreeCtrl::MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam) if ( wParam == VK_SPACE || wParam == VK_RETURN ) return 0; } +#if wxUSE_DRAGIMAGE + else if ( nMsg == WM_KEYDOWN ) + { + if ( wParam == VK_ESCAPE ) + { + if ( m_dragImage ) + { + m_dragImage->EndDrag(); + delete m_dragImage; + m_dragImage = NULL; + + // if we don't do it, the tree seems to think that 2 items + // are selected simultaneously which is quite weird + TreeView_SelectDropTarget(GetHwnd(), 0); + } + } + } +#endif // wxUSE_DRAGIMAGE return wxControl::MSWDefWindowProc(nMsg, wParam, lParam); } @@ -2585,7 +2496,7 @@ wxTreeCtrl::MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam) // process WM_NOTIFY Windows message bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) { - wxTreeEvent event(wxEVT_NULL, m_windowId); + wxTreeEvent event(wxEVT_NULL, this); wxEventType eventType = wxEVT_NULL; NMHDR *hdr = (NMHDR *)lParam; @@ -2681,8 +2592,8 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) break; } -#endif -#endif +#endif // TVN_GETINFOTIP +#endif // !__WXWINCE__ case TVN_GETDISPINFO: eventType = wxEVT_COMMAND_TREE_GET_INFO; @@ -2703,7 +2614,7 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) case TVN_ITEMEXPANDING: case TVN_ITEMEXPANDED: { - NM_TREEVIEW* tv = (NM_TREEVIEW*)lParam; + NM_TREEVIEW *tv = (NM_TREEVIEW*)lParam; int what; switch ( tv->action ) @@ -2738,12 +2649,11 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) // fabricate the lParam and wParam parameters sufficiently // similar to the ones from a "real" WM_KEYDOWN so that // CreateKeyEvent() works correctly - const bool isAltDown = ::GetKeyState(VK_MENU) < 0; - WXLPARAM lParam = (isAltDown ? KF_ALTDOWN : 0) << 16; + WXLPARAM lParam = (wxIsAltDown() ? KF_ALTDOWN : 0) << 16; WXWPARAM wParam = info->wVKey; - int keyCode = wxCharCodeMSWToWX(info->wVKey); + int keyCode = wxCharCodeMSWToWX(wParam); if ( !keyCode ) { // wxCharCodeMSWToWX() returns 0 to indicate that this is a @@ -2757,23 +2667,51 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) wParam); // a separate event for Space/Return - if ( !wxIsCtrlDown() && !wxIsShiftDown() && !isAltDown && + if ( !wxIsAnyModifierDown() && ((info->wVKey == VK_SPACE) || (info->wVKey == VK_RETURN)) ) { - wxTreeEvent event2(wxEVT_COMMAND_TREE_ITEM_ACTIVATED, - m_windowId); - event2.SetEventObject(this); - if ( !(GetWindowStyle() & wxTR_MULTIPLE) ) - { - event2.m_item = GetSelection(); - } - //else: don't know how to get it + wxTreeItemId item; + if ( !HasFlag(wxTR_MULTIPLE) ) + item = GetSelection(); - (void)GetEventHandler()->ProcessEvent(event2); + wxTreeEvent event2(wxEVT_COMMAND_TREE_ITEM_ACTIVATED, + this, item); + (void)HandleWindowEvent(event2); } } break; + + // Vista's tree control has introduced some problems with our + // multi-selection tree. When TreeView_SelectItem() is called, + // the wrong items are deselected. + + // Fortunately, Vista provides a new notification, TVN_ITEMCHANGING + // that can be used to regulate this incorrect behavior. The + // following messages will allow only the unlocked item's selection + // state to change + + case TVN_ITEMCHANGINGA: + case TVN_ITEMCHANGINGW: + { + // we only need to handles these in multi-select trees + if ( HasFlag(wxTR_MULTIPLE) ) + { + // get info about the item about to be changed + NMTVITEMCHANGE* info = (NMTVITEMCHANGE*)lParam; + if (TreeItemUnlocker::IsLocked(info->hItem)) + { + // item's state is locked, don't allow the change + // returning 1 will disallow the change + *result = 1; + return true; + } + } + + // allow the state change + } + return false; + // NB: MSLU is broken and sends TVN_SELCHANGEDA instead of // TVN_SELCHANGEDW in Unicode mode under Win98. Therefore // we have to handle both messages: @@ -2792,17 +2730,30 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) if (hdr->code == TVN_SELCHANGINGW || hdr->code == TVN_SELCHANGEDW) { - NM_TREEVIEWW* tv = (NM_TREEVIEWW *)lParam; + NM_TREEVIEWW *tv = (NM_TREEVIEWW *)lParam; event.m_item = tv->itemNew.hItem; event.m_itemOld = tv->itemOld.hItem; } else { - NM_TREEVIEWA* tv = (NM_TREEVIEWA *)lParam; + NM_TREEVIEWA *tv = (NM_TREEVIEWA *)lParam; event.m_item = tv->itemNew.hItem; event.m_itemOld = tv->itemOld.hItem; } } + + // we receive this message from WM_LBUTTONDOWN handler inside + // comctl32.dll and so before the click is passed to + // DefWindowProc() which sets the focus to the window which was + // clicked and this can lead to unexpected event sequences: for + // example, we may get a "selection change" event from the tree + // before getting a "kill focus" event for the text control which + // had the focus previously, thus breaking user code doing input + // validation + // + // to avoid such surprises, we force the generation of focus events + // now, before we generate the selection change ones + SetFocus(); break; // instead of explicitly checking for _WIN32_IE, check if the @@ -2835,9 +2786,15 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) wxTreeItemAttr * const attr = it->second; + wxTreeViewItem tvItem((void *)nmcd.dwItemSpec, + TVIF_STATE, TVIS_DROPHILITED); + DoGetItem(&tvItem); + const UINT tvItemState = tvItem.state; + // selection colours should override ours, - // otherwise it is too confusing ot the user - if ( !(nmcd.uItemState & CDIS_SELECTED) ) + // otherwise it is too confusing to the user + if ( !(nmcd.uItemState & CDIS_SELECTED) && + !(tvItemState & TVIS_DROPHILITED) ) { wxColour colBack; if ( attr->HasBackgroundColour() ) @@ -2851,8 +2808,9 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) // colour when we don't have focus (we can't keep // it when we do, it would usually be unreadable on // the almost inverted bg colour...) - if ( !(nmcd.uItemState & CDIS_SELECTED) || - FindFocus() != this ) + if ( ( !(nmcd.uItemState & CDIS_SELECTED) || + FindFocus() != this ) && + !(tvItemState & TVIS_DROPHILITED) ) { wxColour colText; if ( attr->HasTextColour() ) @@ -2931,10 +2889,12 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) return wxControl::MSWOnNotify(idCtrl, lParam, result); } - event.SetEventObject(this); event.SetEventType(eventType); - bool processed = GetEventHandler()->ProcessEvent(event); + if ( event.m_item.IsOk() ) + event.SetClientObject(GetItemData(event.m_item)); + + bool processed = HandleWindowEvent(event); // post processing switch ( hdr->code ) @@ -2947,8 +2907,20 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) *result = false; break; + case NM_RCLICK: + // prevent tree control from sending WM_CONTEXTMENU to our parent + // (which it does if NM_RCLICK is not handled) because we want to + // send it to the control itself + *result = + processed = true; + + ::SendMessage(GetHwnd(), WM_CONTEXTMENU, + (WPARAM)GetHwnd(), ::GetMessagePos()); + break; + case TVN_BEGINDRAG: case TVN_BEGINRDRAG: +#if wxUSE_DRAGIMAGE if ( event.IsAllowed() ) { // normally this is impossible because the m_dragImage is @@ -2959,6 +2931,7 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) m_dragImage->BeginDrag(wxPoint(0,0), this); m_dragImage->Show(); } +#endif // wxUSE_DRAGIMAGE break; case TVN_DELETEITEM: @@ -2967,20 +2940,11 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) // tables, but due to overhead of wxWin event system we // prefer to do it here ourself (otherwise deleting a tree // with many items is just too slow) - NM_TREEVIEW* tv = (NM_TREEVIEW *)lParam; + NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam; - wxTreeItemId item = event.m_item; - if ( HasIndirectData(item) ) - { - wxTreeItemIndirectData *data = (wxTreeItemIndirectData *) - tv->itemOld.lParam; - delete data; // can't be NULL here - } - else - { - wxTreeItemData *data = (wxTreeItemData *)tv->itemOld.lParam; - delete data; // may be NULL, ok - } + wxTreeItemParam *param = + (wxTreeItemParam *)tv->itemOld.lParam; + delete param; processed = true; // Make sure we don't get called twice } @@ -2994,15 +2958,15 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) if ( event.IsAllowed() ) { HWND hText = TreeView_GetEditControl(GetHwnd()); - if(hText != NULL) + if ( hText ) { // MBN: if m_textCtrl already has an HWND, it is a stale // pointer from a previous edit (because the user // didn't modify the label before dismissing the control, // and TVN_ENDLABELEDIT was not sent), so delete it - if(m_textCtrl && m_textCtrl->GetHWND() != 0) + if ( m_textCtrl && m_textCtrl->GetHWND() ) DeleteTextCtrl(); - if(!m_textCtrl) + if ( !m_textCtrl ) m_textCtrl = new wxTextCtrl(); m_textCtrl->SetParent(this); m_textCtrl->SetHWND((WXHWND)hText); @@ -3056,17 +3020,40 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) break; case TVN_ITEMEXPANDED: - // the item is not refreshed properly after expansion when it has - // an image depending on the expanded/collapsed state - bug in - // comctl32.dll or our code? { - NM_TREEVIEW* tv = (NM_TREEVIEW *)lParam; - wxTreeItemId id(tv->itemNew.hItem); + NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam; + const wxTreeItemId id(tv->itemNew.hItem); - int image = GetItemImage(id, wxTreeItemIcon_Expanded); - if ( image != -1 ) + if ( tv->action == TVE_COLLAPSE ) + { + if ( wxApp::GetComCtl32Version() >= 600 ) + { + // for some reason the item selection rectangle depends + // on whether it is expanded or collapsed (at least + // with comctl32.dll v6): it is wider (by 3 pixels) in + // the expanded state, so when the item collapses and + // then is deselected the rightmost 3 pixels of the + // previously drawn selection are left on the screen + // + // it's not clear if it's a bug in comctl32.dll or in + // our code (because it does not happen in Explorer but + // OTOH we don't do anything which could result in this + // AFAICS) but we do need to work around it to avoid + // ugly artifacts + RefreshItem(id); + } + } + else // expand { - RefreshItem(id); + // the item is also not refreshed properly after expansion when + // it has an image depending on the expanded/collapsed state: + // again, it's not clear if the bug is in comctl32.dll or our + // code... + int image = GetItemImage(id, wxTreeItemIcon_Expanded); + if ( image != -1 ) + { + RefreshItem(id); + } } } break; @@ -3074,16 +3061,20 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) case TVN_GETDISPINFO: // NB: so far the user can't set the image himself anyhow, so do it // anyway - but this may change later - //if ( /* !processed && */ 1 ) + //if ( /* !processed && */ ) { wxTreeItemId item = event.m_item; TV_DISPINFO *info = (TV_DISPINFO *)lParam; + + const wxTreeItemParam * const param = GetItemParam(item); + if ( !param ) + break; + if ( info->item.mask & TVIF_IMAGE ) { info->item.iImage = - DoGetItemImageFromData + param->GetImage ( - item, IsExpanded(item) ? wxTreeItemIcon_Expanded : wxTreeItemIcon_Normal ); @@ -3091,9 +3082,8 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) if ( info->item.mask & TVIF_SELECTEDIMAGE ) { info->item.iSelectedImage = - DoGetItemImageFromData + param->GetImage ( - item, IsExpanded(item) ? wxTreeItemIcon_SelectedExpanded : wxTreeItemIcon_Selected ); @@ -3152,4 +3142,3 @@ int wxTreeCtrl::GetState(const wxTreeItemId& node) } #endif // wxUSE_TREECTRL -