X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f73eddd2a5af3c58fff4e2a6154d9a395b7631a5..b5aaf62e977b828214d65c3712478410fb2c8a05:/src/msw/treectrl.cpp diff --git a/src/msw/treectrl.cpp b/src/msw/treectrl.cpp index f7e310659d..b408ac740d 100644 --- a/src/msw/treectrl.cpp +++ b/src/msw/treectrl.cpp @@ -37,6 +37,7 @@ #include "wx/settings.h" #endif +#include "wx/dynlib.h" #include "wx/msw/private.h" // Set this to 1 to be _absolutely_ sure that repainting will work for all @@ -52,6 +53,83 @@ // get HTREEITEM from wxTreeItemId #define HITEM(item) ((HTREEITEM)(((item).m_pItem))) + +// older SDKs are missing these +#ifndef TVN_ITEMCHANGINGA + +#define TVN_ITEMCHANGINGA (TVN_FIRST-16) +#define TVN_ITEMCHANGINGW (TVN_FIRST-17) + +typedef struct tagNMTVITEMCHANGE +{ + NMHDR hdr; + UINT uChanged; + HTREEITEM hItem; + UINT uStateNew; + UINT uStateOld; + LPARAM lParam; +} NMTVITEMCHANGE; + +#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. + +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; + +// another helper class: set the variable to true during its lifetime and reset +// it to false when it is destroyed +// +// it is currently always used with wxTreeCtrl::m_changingSelection +class TempSetter +{ +public: + TempSetter(bool& var) : m_var(var) + { + wxASSERT_MSG( !m_var, "variable shouldn't be already set" ); + m_var = true; + } + + ~TempSetter() + { + m_var = false; + } + +private: + bool& m_var; + + wxDECLARE_NO_COPY_CLASS(TempSetter); +}; + // ---------------------------------------------------------------------------- // private functions // ---------------------------------------------------------------------------- @@ -59,12 +137,13 @@ // wrappers for TreeView_GetItem/TreeView_SetItem static bool IsItemSelected(HWND hwndTV, HTREEITEM hItem) { - TV_ITEM tvi; tvi.mask = TVIF_STATE | TVIF_HANDLE; tvi.stateMask = TVIS_SELECTED; tvi.hItem = hItem; + TreeItemUnlocker unlocker(hItem); + if ( !TreeView_GetItem(hwndTV, &tvi) ) { wxLogLastError(wxT("TreeView_GetItem")); @@ -81,6 +160,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")); @@ -95,32 +176,60 @@ 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, +// deselects all the other ones +// +// returns true if the selection changed at all or false if nothing changed + +// flags for SelectRange() +enum +{ + SR_SIMULATE = 1, // don't do anything, just return true or false + SR_UNSELECT_OTHERS = 2 // deselect the items not in range +}; + +static bool SelectRange(HWND hwndTV, HTREEITEM htFirst, HTREEITEM htLast, - bool unselectOthers = true) + int flags) { // find the first (or last) item and select it + bool changed = false; bool cont = true; HTREEITEM htItem = (HTREEITEM)TreeView_GetRoot(hwndTV); + while ( htItem && cont ) { if ( (htItem == htFirst) || (htItem == htLast) ) { if ( !IsItemSelected(hwndTV, htItem) ) { - SelectItem(hwndTV, htItem); + if ( !(flags & SR_SIMULATE) ) + { + SelectItem(hwndTV, htItem); + } + + changed = true; } cont = false; } - else + else // not first or last { - if ( unselectOthers && IsItemSelected(hwndTV, htItem) ) + if ( flags & SR_UNSELECT_OTHERS ) { - UnselectItem(hwndTV, htItem); + if ( IsItemSelected(hwndTV, htItem) ) + { + if ( !(flags & SR_SIMULATE) ) + UnselectItem(hwndTV, htItem); + + changed = true; + } } } @@ -133,7 +242,12 @@ static void SelectRange(HWND hwndTV, { if ( !IsItemSelected(hwndTV, htItem) ) { - SelectItem(hwndTV, htItem); + if ( !(flags & SR_SIMULATE) ) + { + SelectItem(hwndTV, htItem); + } + + changed = true; } cont = (htItem != htFirst) && (htItem != htLast); @@ -141,14 +255,19 @@ static void SelectRange(HWND hwndTV, htItem = (HTREEITEM)TreeView_GetNextVisible(hwndTV, htItem); } - // unselect the rest - if ( unselectOthers ) + // optionally deselect the rest + if ( flags & SR_UNSELECT_OTHERS ) { while ( htItem ) { if ( IsItemSelected(hwndTV, htItem) ) { - UnselectItem(hwndTV, htItem); + if ( !(flags & SR_SIMULATE) ) + { + UnselectItem(hwndTV, htItem); + } + + changed = true; } htItem = (HTREEITEM)TreeView_GetNextVisible(hwndTV, htItem); @@ -157,7 +276,12 @@ static void SelectRange(HWND hwndTV, // seems to be necessary - otherwise the just selected items don't always // appear as selected - UpdateWindow(hwndTV); + if ( !(flags & SR_SIMULATE) ) + { + UpdateWindow(hwndTV); + } + + return changed; } // helper function which tricks the standard control into changing the focused @@ -307,7 +431,7 @@ public: break; default: - wxFAIL_MSG( _T("unsupported wxTreeItemIcon value") ); + wxFAIL_MSG( wxT("unsupported wxTreeItemIcon value") ); } } @@ -331,7 +455,7 @@ protected: // the real client data wxTreeItemData *m_data; - DECLARE_NO_COPY_CLASS(wxTreeItemParam) + wxDECLARE_NO_COPY_CLASS(wxTreeItemParam); }; // wxVirutalNode is used in place of a single root when 'hidden' root is @@ -356,7 +480,7 @@ public: private: wxTreeItemParam *m_param; - DECLARE_NO_COPY_CLASS(wxVirtualNode) + wxDECLARE_NO_COPY_CLASS(wxVirtualNode); }; #ifdef __VISUALC__ @@ -401,7 +525,7 @@ private: const wxTreeCtrl *m_tree; - DECLARE_NO_COPY_CLASS(wxTreeTraversal) + wxDECLARE_NO_COPY_CLASS(wxTreeTraversal); }; // internal class for getting the selected items @@ -441,7 +565,7 @@ public: private: wxArrayTreeItemIds& m_selections; - DECLARE_NO_COPY_CLASS(TraverseSelections) + wxDECLARE_NO_COPY_CLASS(TraverseSelections); }; // internal class for counting tree items @@ -470,7 +594,7 @@ public: private: size_t m_count; - DECLARE_NO_COPY_CLASS(TraverseCounter) + wxDECLARE_NO_COPY_CLASS(TraverseCounter); }; // ---------------------------------------------------------------------------- @@ -622,6 +746,11 @@ void wxTreeCtrl::Init() m_dragImage = NULL; #endif m_pVirtualRoot = NULL; + m_dragStarted = false; + m_focusLost = true; + m_changingSelection = false; + m_triggerStateImageClick = false; + m_mouseUpDeselect = false; // initialize the global array of events now as it can't be done statically // with the wxEVT_XXX values being allocated during run-time only @@ -651,7 +780,7 @@ bool wxTreeCtrl::Create(wxWindow *parent, DWORD wstyle = MSWGetStyle(m_windowStyle, & exStyle); wstyle |= WS_TABSTOP | TVS_SHOWSELALWAYS; - if ((m_windowStyle & wxTR_NO_LINES) == 0) + if ( !(m_windowStyle & wxTR_NO_LINES) ) wstyle |= TVS_HASLINES; if ( m_windowStyle & wxTR_HAS_BUTTONS ) wstyle |= TVS_HASBUTTONS; @@ -694,58 +823,6 @@ bool wxTreeCtrl::Create(wxWindow *parent, SetForegroundColour(wxWindow::GetParent()->GetForegroundColour()); #endif - - // VZ: this is some experimental code which may be used to get the - // TVS_CHECKBOXES style functionality for comctl32.dll < 4.71. - // AFAIK, the standard DLL does about the same thing anyhow. -#if 0 - if ( m_windowStyle & wxTR_MULTIPLE ) - { - wxBitmap bmp; - - // create the DC compatible with the current screen - HDC hdcMem = CreateCompatibleDC(NULL); - - // create a mono bitmap of the standard size - int x = ::GetSystemMetrics(SM_CXMENUCHECK); - int y = ::GetSystemMetrics(SM_CYMENUCHECK); - wxImageList imagelistCheckboxes(x, y, false, 2); - HBITMAP hbmpCheck = CreateBitmap(x, y, // bitmap size - 1, // # of color planes - 1, // # bits needed for one pixel - 0); // array containing colour data - SelectObject(hdcMem, hbmpCheck); - - // then draw a check mark into it - RECT rect = { 0, 0, x, y }; - if ( !::DrawFrameControl(hdcMem, &rect, - DFC_BUTTON, - DFCS_BUTTONCHECK | DFCS_CHECKED) ) - { - wxLogLastError(wxT("DrawFrameControl(check)")); - } - - bmp.SetHBITMAP((WXHBITMAP)hbmpCheck); - imagelistCheckboxes.Add(bmp); - - if ( !::DrawFrameControl(hdcMem, &rect, - DFC_BUTTON, - DFCS_BUTTONCHECK) ) - { - wxLogLastError(wxT("DrawFrameControl(uncheck)")); - } - - bmp.SetHBITMAP((WXHBITMAP)hbmpCheck); - imagelistCheckboxes.Add(bmp); - - // clean up - ::DeleteDC(hdcMem); - - // set the imagelist - SetStateImageList(&imagelistCheckboxes); - } -#endif // 0 - wxSetCCUnicodeFormat(GetHwnd()); return true; @@ -790,7 +867,7 @@ wxTreeCtrl::GetClassDefaultAttributes(wxWindowVariant variant) bool wxTreeCtrl::DoGetItem(wxTreeViewItem *tvItem) const { wxCHECK_MSG( tvItem->hItem != TVI_ROOT, false, - _T("can't retrieve virtual root item") ); + wxT("can't retrieve virtual root item") ); if ( !TreeView_GetItem(GetHwnd(), tvItem) ) { @@ -804,6 +881,8 @@ bool wxTreeCtrl::DoGetItem(wxTreeViewItem *tvItem) const void wxTreeCtrl::DoSetItem(wxTreeViewItem *tvItem) { + TreeItemUnlocker unlocker(tvItem->hItem); + if ( TreeView_SetItem(GetHwnd(), tvItem) == -1 ) { wxLogLastError(wxT("TreeView_SetItem")); @@ -1000,6 +1079,16 @@ wxTreeItemParam *wxTreeCtrl::GetItemParam(const wxTreeItemId& item) const return (wxTreeItemParam *)tvItem.lParam; } +bool wxTreeCtrl::HandleTreeEvent(wxTreeEvent& event) const +{ + if ( event.m_item.IsOk() ) + { + event.SetClientObject(GetItemData(event.m_item)); + } + + return HandleWindowEvent(event); +} + wxTreeItemData *wxTreeCtrl::GetItemData(const wxTreeItemId& item) const { wxTreeItemParam *data = GetItemParam(item); @@ -1206,6 +1295,12 @@ bool wxTreeCtrl::ItemHasChildren(const wxTreeItemId& item) const { wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") ); + if ( IS_VIRTUAL_ROOT(item) ) + { + wxTreeItemIdValue cookie; + return GetFirstChild(item, cookie).IsOk(); + } + wxTreeViewItem tvItem(item, TVIF_CHILDREN); DoGetItem(&tvItem); @@ -1257,9 +1352,14 @@ wxTreeItemId wxTreeCtrl::GetRootItem() const wxTreeItemId wxTreeCtrl::GetSelection() const { - wxCHECK_MSG( !(m_windowStyle & wxTR_MULTIPLE), wxTreeItemId(), + wxCHECK_MSG( !HasFlag(wxTR_MULTIPLE), wxTreeItemId(), wxT("this only works with single selection controls") ); + return GetFocusedItem(); +} + +wxTreeItemId wxTreeCtrl::GetFocusedItem() const +{ return wxTreeItemId(TreeView_GetSelection(GetHwnd())); } @@ -1385,33 +1485,6 @@ wxTreeItemId wxTreeCtrl::GetPrevVisible(const wxTreeItemId& item) const // multiple selections emulation // ---------------------------------------------------------------------------- -bool wxTreeCtrl::IsItemChecked(const wxTreeItemId& item) const -{ - wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") ); - - // receive the desired information. - wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_STATEIMAGEMASK); - DoGetItem(&tvItem); - - // state image indices are 1 based - return ((tvItem.state >> 12) - 1) == 1; -} - -void wxTreeCtrl::SetItemCheck(const wxTreeItemId& item, bool check) -{ - wxCHECK_RET( item.IsOk(), wxT("invalid tree item") ); - - // receive the desired information. - wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_STATEIMAGEMASK); - - DoGetItem(&tvItem); - - // state images are one-based - tvItem.state = (check ? 2 : 1) << 12; - - DoSetItem(&tvItem); -} - size_t wxTreeCtrl::GetSelections(wxArrayTreeItemIds& selections) const { TraverseSelections selector(this, selections); @@ -1431,7 +1504,7 @@ wxTreeItemId wxTreeCtrl::DoInsertAfter(const wxTreeItemId& parent, { wxCHECK_MSG( parent.IsOk() || !TreeView_GetRoot(GetHwnd()), wxTreeItemId(), - _T("can't have more than one root in the tree") ); + wxT("can't have more than one root in the tree") ); TV_INSERTSTRUCT tvIns; tvIns.hParent = HITEM(parent); @@ -1472,12 +1545,27 @@ wxTreeItemId wxTreeCtrl::DoInsertAfter(const wxTreeItemId& parent, tvIns.item.lParam = (LPARAM)param; tvIns.item.mask = mask; + // 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); @@ -1497,7 +1585,7 @@ wxTreeItemId wxTreeCtrl::AddRoot(const wxString& text, { if ( HasFlag(wxTR_HIDE_ROOT) ) { - wxASSERT_MSG( !m_pVirtualRoot, _T("tree can have only a single root") ); + wxASSERT_MSG( !m_pVirtualRoot, wxT("tree can have only a single root") ); // create a virtual root item, the parent for all the others wxTreeItemParam *param = new wxTreeItemParam; @@ -1538,7 +1626,7 @@ wxTreeItemId wxTreeCtrl::DoInsertItem(const wxTreeItemId& parent, // assert, not check: if the index is invalid, we will append the item // to the end - wxASSERT_MSG( index == 0, _T("bad index in wxTreeCtrl::InsertItem") ); + wxASSERT_MSG( index == 0, wxT("bad index in wxTreeCtrl::InsertItem") ); } return DoInsertAfter(parent, idPrev, text, image, selectedImage, data); @@ -1546,15 +1634,70 @@ wxTreeItemId wxTreeCtrl::DoInsertItem(const wxTreeItemId& parent, void wxTreeCtrl::Delete(const wxTreeItemId& item) { - if ( !TreeView_DeleteItem(GetHwnd(), HITEM(item)) ) + // unlock tree selections on vista, without this the + // tree ctrl will eventually crash after item deletion + TreeItemUnlocker unlock_all; + + if ( HasFlag(wxTR_MULTIPLE) ) + { + bool selected = IsSelected(item); + wxTreeItemId next; + + if ( selected ) + { + next = TreeView_GetNextVisible(GetHwnd(), HITEM(item)); + + if ( !next.IsOk() ) + { + next = TreeView_GetPrevVisible(GetHwnd(), HITEM(item)); + } + } + + { + TempSetter set(m_changingSelection); + if ( !TreeView_DeleteItem(GetHwnd(), HITEM(item)) ) + { + wxLogLastError(wxT("TreeView_DeleteItem")); + return; + } + } + + if ( !selected ) + { + return; + } + + if ( next.IsOk() ) + { + wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, this, next); + + if ( IsTreeEventAllowed(changingEvent) ) + { + wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, this, next); + (void)HandleTreeEvent(changedEvent); + } + else + { + DoUnselectItem(next); + ClearFocusedItem(); + } + } + } + else { - wxLogLastError(wxT("TreeView_DeleteItem")); + if ( !TreeView_DeleteItem(GetHwnd(), HITEM(item)) ) + { + wxLogLastError(wxT("TreeView_DeleteItem")); + } } } // 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; @@ -1569,15 +1712,15 @@ void wxTreeCtrl::DeleteChildren(const wxTreeItemId& item) size_t nCount = children.Count(); for ( size_t n = 0; n < nCount; n++ ) { - if ( !TreeView_DeleteItem(GetHwnd(), HITEM(children[n])) ) - { - wxLogLastError(wxT("TreeView_DeleteItem")); - } + Delete(children[n]); } } 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() ) { @@ -1617,15 +1760,22 @@ void wxTreeCtrl::DoExpand(const wxTreeItemId& item, int flag) tvItem.state = 0; DoSetItem(&tvItem); - if ( TreeView_Expand(GetHwnd(), HITEM(item), flag) != 0 ) + if ( IsExpanded(item) ) + { + wxTreeEvent event(wxEVT_COMMAND_TREE_ITEM_COLLAPSING, + this, wxTreeItemId(item)); + + if ( !IsTreeEventAllowed(event) ) + return; + } + + if ( TreeView_Expand(GetHwnd(), HITEM(item), flag) ) { - // note that the {EXPAND|COLLAPS}ING event is sent by TreeView_Expand() - // itself - wxTreeEvent event(gs_expandEvents[IsExpanded(item) ? IDX_EXPAND - : IDX_COLLAPSE] - [IDX_DONE], - this, item); - (void)GetEventHandler()->ProcessEvent(event); + if ( IsExpanded(item) ) + return; + + wxTreeEvent event(wxEVT_COMMAND_TREE_ITEM_COLLAPSED, this, item); + (void)HandleTreeEvent(event); } //else: change didn't took place, so do nothing at all } @@ -1652,70 +1802,158 @@ void wxTreeCtrl::Toggle(const wxTreeItemId& item) void wxTreeCtrl::Unselect() { - wxASSERT_MSG( !(m_windowStyle & wxTR_MULTIPLE), + wxASSERT_MSG( !HasFlag(wxTR_MULTIPLE), wxT("doesn't make sense, may be you want UnselectAll()?") ); - // just remove the selection - SelectItem(wxTreeItemId()); + // the current focus + HTREEITEM htFocus = (HTREEITEM)TreeView_GetSelection(GetHwnd()); + + if ( !htFocus ) + { + return; + } + + if ( HasFlag(wxTR_MULTIPLE) ) + { + wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, + this, wxTreeItemId()); + changingEvent.m_itemOld = htFocus; + + if ( IsTreeEventAllowed(changingEvent) ) + { + ClearFocusedItem(); + + wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, + this, wxTreeItemId()); + changedEvent.m_itemOld = htFocus; + (void)HandleTreeEvent(changedEvent); + } + } + else + { + ClearFocusedItem(); + } +} + +void wxTreeCtrl::DoUnselectAll() +{ + wxArrayTreeItemIds selections; + size_t count = GetSelections(selections); + + for ( size_t n = 0; n < count; n++ ) + { + DoUnselectItem(selections[n]); + } + + m_htSelStart.Unset(); } void wxTreeCtrl::UnselectAll() { - if ( m_windowStyle & wxTR_MULTIPLE ) + if ( HasFlag(wxTR_MULTIPLE) ) { - wxArrayTreeItemIds selections; - size_t count = GetSelections(selections); - for ( size_t n = 0; n < count; n++ ) + HTREEITEM htFocus = (HTREEITEM)TreeView_GetSelection(GetHwnd()); + if ( !htFocus ) return; + + wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, this); + changingEvent.m_itemOld = htFocus; + + if ( IsTreeEventAllowed(changingEvent) ) { - ::UnselectItem(GetHwnd(), HITEM(selections[n])); - } + DoUnselectAll(); - m_htSelStart.Unset(); + wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, this); + changedEvent.m_itemOld = htFocus; + (void)HandleTreeEvent(changedEvent); + } } else { - // just remove the selection Unselect(); } } +void wxTreeCtrl::DoSelectItem(const wxTreeItemId& item, bool select) +{ + TempSetter set(m_changingSelection); + + ::SelectItem(GetHwnd(), HITEM(item), select); +} + void wxTreeCtrl::SelectItem(const wxTreeItemId& item, bool select) { - wxCHECK_RET( !IsHiddenRoot(item), _T("can't select hidden root item") ); + wxCHECK_RET( !IsHiddenRoot(item), wxT("can't select hidden root item") ); - wxASSERT_MSG( select || HasFlag(wxTR_MULTIPLE), - _T("SelectItem(false) works only for multiselect") ); + if ( select == IsSelected(item) ) + { + // nothing to do, the item is already in the requested state + return; + } - wxTreeEvent event(wxEVT_COMMAND_TREE_SEL_CHANGING, this, item); - if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() ) + if ( HasFlag(wxTR_MULTIPLE) ) { - if ( HasFlag(wxTR_MULTIPLE) ) + wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, this, item); + + if ( IsTreeEventAllowed(changingEvent) ) { - if ( !::SelectItem(GetHwnd(), HITEM(item), select) ) + HTREEITEM htFocus = (HTREEITEM)TreeView_GetSelection(GetHwnd()); + DoSelectItem(item, select); + + if ( !htFocus ) { - wxLogLastError(wxT("TreeView_SelectItem")); - return; + SetFocusedItem(item); } + + wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, + this, item); + (void)HandleTreeEvent(changedEvent); + } + } + else // single selection + { + wxTreeItemId itemOld, itemNew; + if ( select ) + { + itemOld = GetSelection(); + itemNew = item; + } + else // deselecting the currently selected item + { + itemOld = item; + // leave itemNew invalid } - else // single selection + + // in spite 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 + + wxTreeEvent + changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, this, itemNew); + changingEvent.SetOldItem(itemOld); + + if ( IsTreeEventAllowed(changingEvent) ) { - // use TreeView_SelectItem() to deselect the previous selection - if ( !TreeView_SelectItem(GetHwnd(), HITEM(item)) ) + if ( !TreeView_SelectItem(GetHwnd(), HITEM(itemNew)) ) { wxLogLastError(wxT("TreeView_SelectItem")); - return; } - } + else // ok + { + SetFocusedItem(item); - event.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED); - (void)GetEventHandler()->ProcessEvent(event); + wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, + this, itemNew); + changedEvent.SetOldItem(itemOld); + (void)HandleTreeEvent(changedEvent); + } + } + //else: program vetoed the change } - //else: program vetoed the change } void wxTreeCtrl::EnsureVisible(const wxTreeItemId& item) { - wxCHECK_RET( !IsHiddenRoot(item), _T("can't show hidden root item") ); + wxCHECK_RET( !IsHiddenRoot(item), wxT("can't show hidden root item") ); // no error return TreeView_EnsureVisible(GetHwnd(), HITEM(item)); @@ -1844,6 +2082,37 @@ bool wxTreeCtrl::GetBoundingRect(const wxTreeItemId& item, } } +void wxTreeCtrl::ClearFocusedItem() +{ + TempSetter set(m_changingSelection); + + if ( !TreeView_SelectItem(GetHwnd(), 0) ) + { + wxLogLastError(wxT("TreeView_SelectItem")); + } +} + +void wxTreeCtrl::SetFocusedItem(const wxTreeItemId& item) +{ + TempSetter set(m_changingSelection); + + ::SetFocus(GetHwnd(), HITEM(item)); +} + +void wxTreeCtrl::DoUnselectItem(const wxTreeItemId& item) +{ + TempSetter set(m_changingSelection); + + ::UnselectItem(GetHwnd(), HITEM(item)); +} + +void wxTreeCtrl::DoToggleItemSelection(const wxTreeItemId& item) +{ + TempSetter set(m_changingSelection); + + ::ToggleItemSelection(GetHwnd(), HITEM(item)); +} + // ---------------------------------------------------------------------------- // sorting stuff // ---------------------------------------------------------------------------- @@ -1908,7 +2177,9 @@ bool wxTreeCtrl::MSWShouldPreProcessMessage(WXMSG* msg) { if ( msg->message == WM_KEYDOWN ) { - if ( msg->wParam == VK_RETURN ) + // 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; @@ -1944,38 +2215,457 @@ bool wxTreeCtrl::MSWCommand(WXUINT cmd, WXWORD id_) return true; } -// we hook into WndProc to process WM_MOUSEMOVE/WM_BUTTONUP messages - as we -// only do it during dragging, minimize wxWin overhead (this is important for -// WM_MOUSEMOVE as they're a lot of them) by catching Windows messages directly -// instead of passing by wxWin events -WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam) +bool wxTreeCtrl::MSWHandleSelectionKey(unsigned vkey) { - bool processed = false; - WXLRESULT rc = 0; - bool isMultiple = HasFlag(wxTR_MULTIPLE); + const bool bCtrl = wxIsCtrlDown(); + const bool bShift = wxIsShiftDown(); + const HTREEITEM htSel = (HTREEITEM)TreeView_GetSelection(GetHwnd()); - // This message is sent after a right-click, or when the "menu" key is pressed - if ( nMsg == WM_CONTEXTMENU ) + switch ( vkey ) { - int x = GET_X_LPARAM(lParam), - y = GET_Y_LPARAM(lParam); + case VK_RETURN: + case VK_SPACE: + if ( !htSel ) + break; - // the item for which the menu should be shown - wxTreeItemId item; + if ( vkey != VK_RETURN && bCtrl ) + { + wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, + this, htSel); + changingEvent.m_itemOld = htSel; - // the position where the menu should be shown in client coordinates - // (so that it can be passed directly to PopupMenu()) - wxPoint pt; + if ( IsTreeEventAllowed(changingEvent) ) + { + DoToggleItemSelection(wxTreeItemId(htSel)); - if ( x == -1 || y == -1 ) - { - // 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() ) + wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, + this, htSel); + changedEvent.m_itemOld = htSel; + (void)HandleTreeEvent(changedEvent); + } + } + else + { + wxArrayTreeItemIds selections; + size_t count = GetSelections(selections); + + if ( count != 1 || HITEM(selections[0]) != htSel ) + { + wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, + this, htSel); + changingEvent.m_itemOld = htSel; + + if ( IsTreeEventAllowed(changingEvent) ) + { + DoUnselectAll(); + DoSelectItem(wxTreeItemId(htSel)); + + wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, + this, htSel); + changedEvent.m_itemOld = htSel; + (void)HandleTreeEvent(changedEvent); + } + } + } + break; + + case VK_UP: + case VK_DOWN: + if ( !bCtrl && !bShift ) + { + wxArrayTreeItemIds selections; + wxTreeItemId next; + + if ( htSel ) + { + next = vkey == VK_UP + ? TreeView_GetPrevVisible(GetHwnd(), htSel) + : TreeView_GetNextVisible(GetHwnd(), htSel); + } + else + { + next = GetRootItem(); + + if ( IsHiddenRoot(next) ) + next = TreeView_GetChild(GetHwnd(), HITEM(next)); + } + + if ( !next.IsOk() ) + { + break; + } + + wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, + this, next); + changingEvent.m_itemOld = htSel; + + if ( IsTreeEventAllowed(changingEvent) ) + { + DoUnselectAll(); + DoSelectItem(next); + SetFocusedItem(next); + + wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, + this, next); + changedEvent.m_itemOld = htSel; + (void)HandleTreeEvent(changedEvent); + } + } + else if ( htSel ) + { + wxTreeItemId next = vkey == VK_UP + ? TreeView_GetPrevVisible(GetHwnd(), htSel) + : TreeView_GetNextVisible(GetHwnd(), htSel); + + if ( !next.IsOk() ) + { + break; + } + + if ( !m_htSelStart ) + { + m_htSelStart = htSel; + } + + if ( bShift && SelectRange(GetHwnd(), HITEM(m_htSelStart), HITEM(next), + SR_UNSELECT_OTHERS | SR_SIMULATE) ) + { + wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, this, next); + changingEvent.m_itemOld = htSel; + + if ( IsTreeEventAllowed(changingEvent) ) + { + SelectRange(GetHwnd(), HITEM(m_htSelStart), HITEM(next), + SR_UNSELECT_OTHERS); + + wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, this, next); + changedEvent.m_itemOld = htSel; + (void)HandleTreeEvent(changedEvent); + } + } + + SetFocusedItem(next); + } + break; + + case VK_LEFT: + if ( HasChildren(htSel) && IsExpanded(htSel) ) + { + Collapse(htSel); + } + else + { + wxTreeItemId next = GetItemParent(htSel); + + if ( next.IsOk() && !IsHiddenRoot(next) ) + { + wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, + this, next); + changingEvent.m_itemOld = htSel; + + if ( IsTreeEventAllowed(changingEvent) ) + { + DoUnselectAll(); + DoSelectItem(next); + SetFocusedItem(next); + + wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, + this, next); + changedEvent.m_itemOld = htSel; + (void)HandleTreeEvent(changedEvent); + } + } + } + break; + + case VK_RIGHT: + if ( !IsVisible(htSel) ) + { + EnsureVisible(htSel); + } + + if ( !HasChildren(htSel) ) + break; + + if ( !IsExpanded(htSel) ) + { + Expand(htSel); + } + else + { + wxTreeItemId next = TreeView_GetChild(GetHwnd(), htSel); + + wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, this, next); + changingEvent.m_itemOld = htSel; + + if ( IsTreeEventAllowed(changingEvent) ) + { + DoUnselectAll(); + DoSelectItem(next); + SetFocusedItem(next); + + wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, this, next); + changedEvent.m_itemOld = htSel; + (void)HandleTreeEvent(changedEvent); + } + } + break; + + case VK_HOME: + case VK_END: + { + wxTreeItemId next = GetRootItem(); + + if ( IsHiddenRoot(next) ) + { + next = TreeView_GetChild(GetHwnd(), HITEM(next)); + } + + if ( !next.IsOk() ) + break; + + if ( vkey == VK_END ) + { + for ( ;; ) + { + wxTreeItemId nextTemp = TreeView_GetNextVisible( + GetHwnd(), HITEM(next)); + + if ( !nextTemp.IsOk() ) + break; + + next = nextTemp; + } + } + + if ( htSel == HITEM(next) ) + break; + + if ( bShift ) + { + if ( !m_htSelStart ) + { + m_htSelStart = htSel; + } + + if ( SelectRange(GetHwnd(), + HITEM(m_htSelStart), HITEM(next), + SR_UNSELECT_OTHERS | SR_SIMULATE) ) + { + wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, + this, next); + changingEvent.m_itemOld = htSel; + + if ( IsTreeEventAllowed(changingEvent) ) + { + SelectRange(GetHwnd(), + HITEM(m_htSelStart), HITEM(next), + SR_UNSELECT_OTHERS); + SetFocusedItem(next); + + wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, + this, next); + changedEvent.m_itemOld = htSel; + (void)HandleTreeEvent(changedEvent); + } + } + } + else // no Shift + { + wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, + this, next); + changingEvent.m_itemOld = htSel; + + if ( IsTreeEventAllowed(changingEvent) ) + { + DoUnselectAll(); + DoSelectItem(next); + SetFocusedItem(next); + + wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, + this, next); + changedEvent.m_itemOld = htSel; + (void)HandleTreeEvent(changedEvent); + } + } + } + break; + + case VK_PRIOR: + case VK_NEXT: + if ( bCtrl ) + { + wxTreeItemId firstVisible = GetFirstVisibleItem(); + size_t visibleCount = TreeView_GetVisibleCount(GetHwnd()); + wxTreeItemId nextAdjacent = (vkey == VK_PRIOR) ? + TreeView_GetPrevVisible(GetHwnd(), HITEM(firstVisible)) : + TreeView_GetNextVisible(GetHwnd(), HITEM(firstVisible)); + + if ( !nextAdjacent ) + { + break; + } + + wxTreeItemId nextStart = firstVisible; + + for ( size_t n = 1; n < visibleCount; n++ ) + { + wxTreeItemId nextTemp = (vkey == VK_PRIOR) ? + TreeView_GetPrevVisible(GetHwnd(), HITEM(nextStart)) : + TreeView_GetNextVisible(GetHwnd(), HITEM(nextStart)); + + if ( nextTemp.IsOk() ) + { + nextStart = nextTemp; + } + else + { + break; + } + } + + EnsureVisible(nextStart); + + if ( vkey == VK_NEXT ) + { + wxTreeItemId nextEnd = nextStart; + + for ( size_t n = 1; n < visibleCount; n++ ) + { + wxTreeItemId nextTemp = + TreeView_GetNextVisible(GetHwnd(), HITEM(nextEnd)); + + if ( nextTemp.IsOk() ) + { + nextEnd = nextTemp; + } + else + { + break; + } + } + + EnsureVisible(nextEnd); + } + } + else // no Ctrl + { + size_t visibleCount = TreeView_GetVisibleCount(GetHwnd()); + wxTreeItemId nextAdjacent = (vkey == VK_PRIOR) ? + TreeView_GetPrevVisible(GetHwnd(), htSel) : + TreeView_GetNextVisible(GetHwnd(), htSel); + + if ( !nextAdjacent ) + { + break; + } + + wxTreeItemId next(htSel); + + for ( size_t n = 1; n < visibleCount; n++ ) + { + wxTreeItemId nextTemp = vkey == VK_PRIOR ? + TreeView_GetPrevVisible(GetHwnd(), HITEM(next)) : + TreeView_GetNextVisible(GetHwnd(), HITEM(next)); + + if ( !nextTemp.IsOk() ) + break; + + next = nextTemp; + } + + wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, + this, next); + changingEvent.m_itemOld = htSel; + + if ( IsTreeEventAllowed(changingEvent) ) + { + DoUnselectAll(); + m_htSelStart.Unset(); + DoSelectItem(next); + SetFocusedItem(next); + + wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, + this, next); + changedEvent.m_itemOld = htSel; + (void)HandleTreeEvent(changedEvent); + } + } + break; + + default: + return false; + } + + return true; +} + +bool wxTreeCtrl::MSWHandleTreeKeyDownEvent(WXWPARAM wParam, WXLPARAM lParam) +{ + wxTreeEvent keyEvent(wxEVT_COMMAND_TREE_KEY_DOWN, this); + + int keyCode = wxCharCodeMSWToWX(wParam); + + if ( !keyCode ) + { + // wxCharCodeMSWToWX() returns 0 to indicate that this is a + // simple ASCII key + keyCode = wParam; + } + + keyEvent.m_evtKey = CreateKeyEvent(wxEVT_KEY_DOWN, keyCode, + lParam, wParam); + + bool processed = HandleTreeEvent(keyEvent); + + // generate a separate event for Space/Return + if ( !wxIsCtrlDown() && !wxIsShiftDown() && !wxIsAltDown() && + ((wParam == VK_SPACE) || (wParam == VK_RETURN)) ) + { + const HTREEITEM htSel = (HTREEITEM)TreeView_GetSelection(GetHwnd()); + if ( htSel ) + { + wxTreeEvent activatedEvent(wxEVT_COMMAND_TREE_ITEM_ACTIVATED, + this, htSel); + (void)HandleTreeEvent(activatedEvent); + } + } + + return processed; +} + +// we hook into WndProc to process WM_MOUSEMOVE/WM_BUTTONUP messages - as we +// only do it during dragging, minimize wxWin overhead (this is important for +// WM_MOUSEMOVE as they're a lot of them) by catching Windows messages directly +// instead of passing by wxWin events +WXLRESULT +wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam) +{ + bool processed = false; + WXLRESULT rc = 0; + bool isMultiple = HasFlag(wxTR_MULTIPLE); + + if ( nMsg == WM_CONTEXTMENU ) + { + int x = GET_X_LPARAM(lParam), + y = GET_Y_LPARAM(lParam); + + // the item for which the menu should be shown + wxTreeItemId item; + + // the position where the menu should be shown in client coordinates + // (so that it can be passed directly to PopupMenu()) + wxPoint pt; + + if ( x == -1 || y == -1 ) + { + // 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; @@ -1990,6 +2680,7 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara TV_HITTESTINFO tvhti; tvhti.pt.x = pt.x; tvhti.pt.y = pt.y; + if ( TreeView_HitTest(GetHwnd(), &tvhti) ) item = wxTreeItemId(tvhti.hItem); } @@ -1999,7 +2690,7 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara event.m_pointDrag = pt; - if ( GetEventHandler()->ProcessEvent(event) ) + if ( HandleTreeEvent(event) ) processed = true; //else: continue with generating wxEVT_CONTEXT_MENU in base class code } @@ -2014,99 +2705,260 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara tvht.pt.x = x; tvht.pt.y = y; + HTREEITEM htOldItem = TreeView_GetSelection(GetHwnd()); HTREEITEM htItem = TreeView_HitTest(GetHwnd(), &tvht); switch ( nMsg ) { case WM_LBUTTONDOWN: - if ( htItem && isMultiple && (tvht.flags & TVHT_ONITEM) != 0 ) - { - m_htClickedItem = (WXHTREEITEM) htItem; - m_ptClick = wxPoint(x, y); + if ( !isMultiple ) + break; + + m_htClickedItem.Unset(); - if ( wParam & MK_CONTROL ) + if ( !(tvht.flags & TVHT_ONITEM) ) + { + if ( tvht.flags & TVHT_ONITEMBUTTON ) { + // either it's going to be handled by user code or + // we're going to use it ourselves to toggle the + // branch, in either case don't pass it to the base + // class which would generate another mouse click event + // for it even though it's already handled here + processed = true; SetFocus(); + if ( !HandleMouseEvent(nMsg, x, y, wParam) ) + { + if ( !IsExpanded(htItem) ) + { + Expand(htItem); + } + else + { + Collapse(htItem); + } + } + } + + m_focusLost = false; + break; + } + + processed = true; + SetFocus(); + m_htClickedItem = (WXHTREEITEM) htItem; + m_ptClick = wxPoint(x, y); + + if ( wParam & MK_CONTROL ) + { + if ( HandleMouseEvent(nMsg, x, y, wParam) ) + { + m_htClickedItem.Unset(); + break; + } + + wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, + this, htItem); + changingEvent.m_itemOld = htOldItem; + + if ( IsTreeEventAllowed(changingEvent) ) + { // toggle selected state - ToggleItemSelection(htItem); + DoToggleItemSelection(wxTreeItemId(htItem)); - ::SetFocus(GetHwnd(), htItem); + SetFocusedItem(wxTreeItemId(htItem)); // reset on any click without Shift m_htSelStart.Unset(); - processed = true; + wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, + this, htItem); + changedEvent.m_itemOld = htOldItem; + (void)HandleTreeEvent(changedEvent); } - else if ( wParam & MK_SHIFT ) + } + else if ( wParam & MK_SHIFT ) + { + if ( HandleMouseEvent(nMsg, x, y, wParam) ) { - // this selects all items between the starting one and - // the current - - if ( !m_htSelStart ) - { - // take the focused item - m_htSelStart = TreeView_GetSelection(GetHwnd()); - } + m_htClickedItem.Unset(); + break; + } - if ( m_htSelStart ) - SelectRange(GetHwnd(), HITEM(m_htSelStart), htItem, - !(wParam & MK_CONTROL)); - else - ::SelectItem(GetHwnd(), htItem); + int srFlags = 0; + bool willChange = true; - ::SetFocus(GetHwnd(), htItem); + if ( !(wParam & MK_CONTROL) ) + { + srFlags |= SR_UNSELECT_OTHERS; + } - processed = true; + if ( !m_htSelStart ) + { + // take the focused item + m_htSelStart = htOldItem; } - else // normal click + else { - // avoid doing anything if we click on the only - // currently selected item + willChange = SelectRange(GetHwnd(), HITEM(m_htSelStart), + htItem, srFlags | SR_SIMULATE); + } - SetFocus(); + if ( willChange ) + { + wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, + this, htItem); + changingEvent.m_itemOld = htOldItem; - wxArrayTreeItemIds selections; - size_t count = GetSelections(selections); - if ( count == 0 || - count > 1 || - HITEM(selections[0]) != htItem ) + if ( IsTreeEventAllowed(changingEvent) ) { - // clear the previously selected items, if the - // user clicked outside of the present selection. - // otherwise, perform the deselection on mouse-up. - // this allows multiple drag and drop to work. - - if (!IsItemSelected(GetHwnd(), htItem)) + // this selects all items between the starting one + // and the current + if ( m_htSelStart ) { - UnselectAll(); + SelectRange(GetHwnd(), HITEM(m_htSelStart), + htItem, srFlags); + } + else + { + DoSelectItem(wxTreeItemId(htItem)); + } - // prevent the click from starting in-place editing - // which should only happen if we click on the - // already selected item (and nothing else is - // selected) + SetFocusedItem(wxTreeItemId(htItem)); - TreeView_SelectItem(GetHwnd(), 0); - ::SelectItem(GetHwnd(), htItem); - } - ::SetFocus(GetHwnd(), htItem); - processed = true; + wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, + this, htItem); + changedEvent.m_itemOld = htOldItem; + (void)HandleTreeEvent(changedEvent); } - else // click on a single selected item + } + } + else // normal click + { + // avoid doing anything if we click on the only + // currently selected item + + wxArrayTreeItemIds selections; + size_t count = GetSelections(selections); + + if ( count == 0 || + count > 1 || + HITEM(selections[0]) != htItem ) + { + if ( HandleMouseEvent(nMsg, x, y, wParam) ) { - // 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(); + break; } - // reset on any click without Shift - m_htSelStart.Unset(); + // clear the previously selected items, if the user + // clicked outside of the present selection, otherwise, + // perform the deselection on mouse-up, this allows + // multiple drag and drop to work. + if ( !IsItemSelected(GetHwnd(), htItem)) + { + wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, + this, htItem); + changingEvent.m_itemOld = htOldItem; + + if ( IsTreeEventAllowed(changingEvent) ) + { + DoUnselectAll(); + DoSelectItem(wxTreeItemId(htItem)); + SetFocusedItem(wxTreeItemId(htItem)); + + wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, + this, htItem); + changedEvent.m_itemOld = htOldItem; + (void)HandleTreeEvent(changedEvent); + } + } + else + { + SetFocusedItem(wxTreeItemId(htItem)); + m_mouseUpDeselect = 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(); + + // prevent in-place editing from starting if focus lost + // since previous click + if ( m_focusLost ) + { + ClearFocusedItem(); + DoSelectItem(wxTreeItemId(htItem)); + SetFocusedItem(wxTreeItemId(htItem)); + } + else + { + processed = false; + } + } + + // reset on any click without Shift + m_htSelStart.Unset(); + } + + m_focusLost = false; + + // we consumed the event so we need to trigger state image + // click if needed + if ( processed ) + { + int htFlags = 0; + wxTreeItemId item = HitTest(wxPoint(x, y), htFlags); + + if ( htFlags & wxTREE_HITTEST_ONITEMSTATEICON ) + { + m_triggerStateImageClick = true; } } break; + case WM_RBUTTONDOWN: + if ( !isMultiple ) + break; + + processed = true; + SetFocus(); + + if ( HandleMouseEvent(nMsg, x, y, wParam) || !htItem ) + { + break; + } + + // 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 + if ( !IsItemSelected(GetHwnd(), htItem) ) + { + wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, + this, htItem); + changingEvent.m_itemOld = htOldItem; + + if ( IsTreeEventAllowed(changingEvent) ) + { + DoUnselectAll(); + DoSelectItem(wxTreeItemId(htItem)); + SetFocusedItem(wxTreeItemId(htItem)); + + wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, + this, htItem); + changedEvent.m_itemOld = htOldItem; + (void)HandleTreeEvent(changedEvent); + } + } + + break; + case WM_MOUSEMOVE: #ifndef __WXWINCE__ if ( m_htClickedItem ) @@ -2173,23 +3025,55 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara break; case WM_LBUTTONUP: - - // facilitates multiple drag-and-drop - if (htItem && isMultiple) + if ( isMultiple ) { - wxArrayTreeItemIds selections; - size_t count = GetSelections(selections); - - if (count > 1 && - !(wParam & MK_CONTROL) && - !(wParam & MK_SHIFT)) + // deselect other items if needed + if ( htItem ) { - UnselectAll(); - TreeView_SelectItem(GetHwnd(), htItem); - ::SelectItem(GetHwnd(), htItem); - ::SetFocus(GetHwnd(), htItem); + if ( m_mouseUpDeselect ) + { + m_mouseUpDeselect = false; + + wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, + this, htItem); + changingEvent.m_itemOld = htOldItem; + + if ( IsTreeEventAllowed(changingEvent) ) + { + DoUnselectAll(); + DoSelectItem(wxTreeItemId(htItem)); + SetFocusedItem(wxTreeItemId(htItem)); + + wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, + this, htItem); + changedEvent.m_itemOld = htOldItem; + (void)HandleTreeEvent(changedEvent); + } + } } + m_htClickedItem.Unset(); + + if ( m_triggerStateImageClick ) + { + if ( tvht.flags & TVHT_ONITEMSTATEICON ) + { + wxTreeEvent event(wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK, + this, htItem); + (void)HandleTreeEvent(event); + + m_triggerStateImageClick = false; + processed = true; + } + } + + if ( !m_dragStarted && + (tvht.flags & TVHT_ONITEMSTATEICON || + tvht.flags & TVHT_ONITEMICON || + tvht.flags & TVHT_ONITEM) ) + { + processed = true; + } } // fall through @@ -2203,117 +3087,95 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara m_dragImage = NULL; // generate the drag end event - wxTreeEvent event(wxEVT_COMMAND_TREE_END_DRAG, this, htItem); + wxTreeEvent event(wxEVT_COMMAND_TREE_END_DRAG, + this, htItem); event.m_pointDrag = wxPoint(x, y); - - (void)GetEventHandler()->ProcessEvent(event); + (void)HandleTreeEvent(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 + + if ( isMultiple && nMsg == WM_RBUTTONUP ) + { + // 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); + processed = true; + } + + m_dragStarted = false; + break; } } - else if ( (nMsg == WM_SETFOCUS || nMsg == WM_KILLFOCUS) && isMultiple ) + else if ( (nMsg == WM_SETFOCUS || nMsg == WM_KILLFOCUS) ) { - // the tree control greys out the selected item when it loses focus and - // paints it as selected again when it regains it, but it won't do it - // for the other items itself - help it - wxArrayTreeItemIds selections; - size_t count = GetSelections(selections); - RECT rect; - for ( size_t n = 0; n < count; n++ ) + if ( isMultiple ) { - // TreeView_GetItemRect() will return false if item is not visible, - // which may happen perfectly well - if ( TreeView_GetItemRect(GetHwnd(), HITEM(selections[n]), - &rect, TRUE) ) + // the tree control greys out the selected item when it loses focus + // and paints it as selected again when it regains it, but it won't + // do it for the other items itself - help it + wxArrayTreeItemIds selections; + size_t count = GetSelections(selections); + RECT rect; + + for ( size_t n = 0; n < count; n++ ) { - ::InvalidateRect(GetHwnd(), &rect, FALSE); + // TreeView_GetItemRect() will return false if item is not + // visible, which may happen perfectly well + if ( TreeView_GetItemRect(GetHwnd(), HITEM(selections[n]), + &rect, TRUE) ) + { + ::InvalidateRect(GetHwnd(), &rect, FALSE); + } } } + + if ( nMsg == WM_KILLFOCUS ) + { + m_focusLost = true; + } } - else if ( nMsg == WM_KEYDOWN && isMultiple ) + else if ( (nMsg == WM_KEYDOWN || nMsg == WM_SYSKEYDOWN) && isMultiple ) { - bool bCtrl = wxIsCtrlDown(), - bShift = wxIsShiftDown(); - - HTREEITEM htSel = (HTREEITEM)TreeView_GetSelection(GetHwnd()); + // normally we want to generate wxEVT_KEY_DOWN events from TVN_KEYDOWN + // notification but for the keys which can be used to change selection + // we need to do it from here so as to not apply the default behaviour + // if the events are handled by the user code switch ( wParam ) { + case VK_RETURN: case VK_SPACE: - if ( bCtrl ) - { - ToggleItemSelection(htSel); - } - else - { - UnselectAll(); - - ::SelectItem(GetHwnd(), htSel); - } - - processed = true; - break; - case VK_UP: case VK_DOWN: - if ( !bCtrl && !bShift ) - { - // no modifiers, just clear selection and then let the default - // processing to take place - UnselectAll(); - } - else if ( htSel ) - { - (void)wxControl::MSWWindowProc(nMsg, wParam, lParam); - - HTREEITEM htNext = (HTREEITEM) - TreeView_GetNextItem - ( - GetHwnd(), - htSel, - wParam == VK_UP ? TVGN_PREVIOUSVISIBLE - : TVGN_NEXTVISIBLE - ); - - if ( !htNext ) - { - // at the top/bottom - htNext = htSel; - } - - if ( bShift ) - { - if ( !m_htSelStart ) - m_htSelStart = htSel; - - SelectRange(GetHwnd(), HITEM(m_htSelStart), htNext); - } - else // bCtrl - { - // without changing selection - ::SetFocus(GetHwnd(), htNext); - } - - processed = true; - } - break; - + case VK_LEFT: + case VK_RIGHT: case VK_HOME: case VK_END: case VK_PRIOR: case VK_NEXT: - // TODO: handle Shift/Ctrl with these keys - if ( !bCtrl && !bShift ) + if ( !MSWHandleTreeKeyDownEvent(wParam, lParam) ) { - UnselectAll(); - - m_htSelStart.Unset(); + // use the key to update the selection if it was left + // unprocessed + MSWHandleSelectionKey(wParam); } + + // pretend that we did process it in any case as we already + // generated an event for it + processed = true; + + //default: for all the other keys leave processed as false so that + // the tree control generates a TVN_KEYDOWN for us } + } else if ( nMsg == WM_COMMAND ) { @@ -2525,55 +3387,60 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) case TVN_KEYDOWN: { - eventType = wxEVT_COMMAND_TREE_KEY_DOWN; TV_KEYDOWN *info = (TV_KEYDOWN *)lParam; // 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; + return MSWHandleTreeKeyDownEvent( + info->wVKey, (wxIsAltDown() ? KF_ALTDOWN : 0) << 16); + } - WXWPARAM wParam = info->wVKey; - int keyCode = wxCharCodeMSWToWX(wParam); - if ( !keyCode ) - { - // wxCharCodeMSWToWX() returns 0 to indicate that this is a - // simple ASCII key - keyCode = wParam; - } + // Vista's tree control has introduced some problems with our + // multi-selection tree. When TreeView_SelectItem() is called, + // the wrong items are deselected. - event.m_evtKey = CreateKeyEvent(wxEVT_KEY_DOWN, - keyCode, - lParam, - wParam); + // 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 - // a separate event for Space/Return - if ( !wxIsCtrlDown() && !wxIsShiftDown() && !isAltDown && - ((info->wVKey == VK_SPACE) || (info->wVKey == VK_RETURN)) ) + case TVN_ITEMCHANGINGA: + case TVN_ITEMCHANGINGW: + { + // we only need to handles these in multi-select trees + if ( HasFlag(wxTR_MULTIPLE) ) { - wxTreeItemId item; - if ( !HasFlag(wxTR_MULTIPLE) ) - item = GetSelection(); - - wxTreeEvent event2(wxEVT_COMMAND_TREE_ITEM_ACTIVATED, - this, item); - (void)GetEventHandler()->ProcessEvent(event2); + // 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 } - break; + 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: case TVN_SELCHANGEDA: case TVN_SELCHANGEDW: - eventType = wxEVT_COMMAND_TREE_SEL_CHANGED; + if ( !HasFlag(wxTR_MULTIPLE) || !m_changingSelection ) + { + eventType = wxEVT_COMMAND_TREE_SEL_CHANGED; + } // fall through case TVN_SELCHANGINGA: case TVN_SELCHANGINGW: + if ( !HasFlag(wxTR_MULTIPLE) || !m_changingSelection ) { if ( eventType == wxEVT_NULL ) eventType = wxEVT_COMMAND_TREE_SEL_CHANGING; @@ -2593,10 +3460,23 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) 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 - // required symbols are available in the headers + // instead of explicitly checking for _WIN32_IE, check if the + // required symbols are available in the headers #if defined(CDDS_PREPAINT) && !wxUSE_COMCTL32_SAFELY case NM_CUSTOMDRAW: { @@ -2609,6 +3489,68 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) // notify us before painting each item *result = m_hasAnyAttr ? CDRF_NOTIFYITEMDRAW : CDRF_DODEFAULT; + + // windows in TreeCtrl use one-based index for item state images, + // 0 indexed image is not being used, we're using zero-based index, + // so we have to add temp image (of zero index) to state image list + // before we draw any item, then after items are drawn we have to + // delete it (in POSTPAINT notify) + if (m_imageListState && m_imageListState->GetImageCount() > 0) + { + typedef BOOL (wxSTDCALL *ImageList_Copy_t) + (HIMAGELIST, int, HIMAGELIST, int, UINT); + static ImageList_Copy_t s_pfnImageList_Copy = NULL; + static bool loaded = false; + + if ( !loaded ) + { + wxLoadedDLL dllComCtl32(wxT("comctl32.dll")); + if ( dllComCtl32.IsLoaded() ) + wxDL_INIT_FUNC(s_pfn, ImageList_Copy, dllComCtl32); + } + + if ( !s_pfnImageList_Copy ) + { + // this code is broken with ImageList_Copy() + // but I don't care enough about Win95 support + // to write it now -- if anybody does, please + // do it + wxFAIL_MSG("TODO: implement this for Win95"); + break; + } + + const HIMAGELIST + hImageList = GetHimagelistOf(m_imageListState); + + // add temporary image + int width, height; + m_imageListState->GetSize(0, width, height); + + HBITMAP hbmpTemp = ::CreateBitmap(width, height, 1, 1, NULL); + int index = ::ImageList_Add(hImageList, hbmpTemp, hbmpTemp); + ::DeleteObject(hbmpTemp); + + if ( index != -1 ) + { + // move images to right + for ( int i = index; i > 0; i-- ) + { + (*s_pfnImageList_Copy)(hImageList, i, + hImageList, i-1, + ILCF_MOVE); + } + + // we must remove the image in POSTPAINT notify + *result |= CDRF_NOTIFYPOSTPAINT; + } + } + break; + + case CDDS_POSTPAINT: + // we are deleting temp image of 0 index, which was + // added before items were drawn (in PREPAINT notify) + if (m_imageListState && m_imageListState->GetImageCount() > 0) + m_imageListState->Remove(0); break; case CDDS_ITEMPREPAINT: @@ -2690,13 +3632,15 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) point.x = LOWORD(pos); point.y = HIWORD(pos); ::MapWindowPoints(HWND_DESKTOP, GetHwnd(), &point, 1); - int flags = 0; - wxTreeItemId item = HitTest(wxPoint(point.x, point.y), flags); - if (flags & wxTREE_HITTEST_ONITEMSTATEICON) + int htFlags = 0; + wxTreeItemId item = HitTest(wxPoint(point.x, point.y), htFlags); + + if ( htFlags & wxTREE_HITTEST_ONITEMSTATEICON ) { event.m_item = item; eventType = wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK; } + break; } @@ -2730,20 +3674,18 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) event.SetEventType(eventType); - if ( event.m_item.IsOk() ) - event.SetClientObject(GetItemData(event.m_item)); - - bool processed = GetEventHandler()->ProcessEvent(event); + bool processed = HandleTreeEvent(event); // post processing switch ( hdr->code ) { case NM_DBLCLK: - // we translate NM_DBLCLK into ACTIVATED event, so don't interpret - // the return code of this event handler as the return value for - // NM_DBLCLK - otherwise, double clicking the item to toggle its - // expanded status would never work - *result = false; + // we translate NM_DBLCLK into ACTIVATED event and if the user + // handled the activation of the item we shouldn't proceed with + // also using the same double click for toggling the item expanded + // state -- but OTOH do let the user to expand/collapse the item by + // double clicking on it if the activation is not handled specially + *result = processed; break; case NM_RCLICK: @@ -2764,11 +3706,13 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) { // normally this is impossible because the m_dragImage is // deleted once the drag operation is over - wxASSERT_MSG( !m_dragImage, _T("starting to drag once again?") ); + wxASSERT_MSG( !m_dragImage, wxT("starting to drag once again?") ); m_dragImage = new wxDragImage(*this, event.m_item); m_dragImage->BeginDrag(wxPoint(0,0), this); m_dragImage->Show(); + + m_dragStarted = true; } #endif // wxUSE_DRAGIMAGE break; @@ -2859,17 +3803,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); + 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; @@ -2921,40 +3888,29 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) // why do they define INDEXTOSTATEIMAGEMASK but not the inverse? #define STATEIMAGEMASKTOINDEX(state) (((state) & TVIS_STATEIMAGEMASK) >> 12) -void wxTreeCtrl::SetState(const wxTreeItemId& node, int state) +int wxTreeCtrl::DoGetItemState(const wxTreeItemId& item) const { - TV_ITEM tvi; - tvi.hItem = (HTREEITEM)node.m_pItem; - tvi.mask = TVIF_STATE; - tvi.stateMask = TVIS_STATEIMAGEMASK; - - // Select the specified state, or -1 == cycle to the next one. - if ( state == -1 ) - { - TreeView_GetItem(GetHwnd(), &tvi); - - state = STATEIMAGEMASKTOINDEX(tvi.state) + 1; - if ( state == m_imageListState->GetImageCount() ) - state = 1; - } - - wxCHECK_RET( state < m_imageListState->GetImageCount(), - _T("wxTreeCtrl::SetState(): item index out of bounds") ); + wxCHECK_MSG( item.IsOk(), wxTREE_ITEMSTATE_NONE, wxT("invalid tree item") ); - tvi.state = INDEXTOSTATEIMAGEMASK(state); + // receive the desired information + wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_STATEIMAGEMASK); + DoGetItem(&tvItem); - TreeView_SetItem(GetHwnd(), &tvi); + // state images are one-based + return STATEIMAGEMASKTOINDEX(tvItem.state) - 1; } -int wxTreeCtrl::GetState(const wxTreeItemId& node) +void wxTreeCtrl::DoSetItemState(const wxTreeItemId& item, int state) { - TV_ITEM tvi; - tvi.hItem = (HTREEITEM)node.m_pItem; - tvi.mask = TVIF_STATE; - tvi.stateMask = TVIS_STATEIMAGEMASK; - TreeView_GetItem(GetHwnd(), &tvi); + wxCHECK_RET( item.IsOk(), wxT("invalid tree item") ); + + wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_STATEIMAGEMASK); - return STATEIMAGEMASKTOINDEX(tvi.state); + // state images are one-based + // 0 if no state image display (wxTREE_ITEMSTATE_NONE = -1) + tvItem.state = INDEXTOSTATEIMAGEMASK(state + 1); + + DoSetItem(&tvItem); } #endif // wxUSE_TREECTRL