X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6b037754f53cc35e177bf6787bace26c7cecc6e1..2356708db31b737c6eae53c2316b642aa5a2e68d:/src/msw/treectrl.cpp?ds=sidebyside diff --git a/src/msw/treectrl.cpp b/src/msw/treectrl.cpp index 6b4b2317b5..8363d6ca9f 100644 --- a/src/msw/treectrl.cpp +++ b/src/msw/treectrl.cpp @@ -27,35 +27,35 @@ #pragma hdrstop #endif -#ifndef WX_PRECOMP - #include "wx.h" +#include "wx/window.h" +#include "wx/msw/private.h" + +// Mingw32 is a bit mental even though this is done in winundef +#ifdef GetFirstChild + #undef GetFirstChild +#endif + +#ifdef GetNextSibling + #undef GetNextSibling #endif #if defined(__WIN95__) #include "wx/log.h" +#include "wx/dynarray.h" #include "wx/imaglist.h" +#include "wx/treectrl.h" -#include "wx/msw/private.h" - -#ifndef __GNUWIN32__ - #include +#ifdef __GNUWIN32__ +#ifndef wxUSE_NORLANDER_HEADERS +#include "wx/msw/gnuwin32/extra.h" #endif - -#ifdef GetFirstChild -#undef GetFirstChild #endif -#ifdef GetNextChild -#undef GetNextChild -#endif - -#ifdef GetNextSibling -#undef GetNextSibling +#if (defined(__WIN95__) && !defined(__GNUWIN32__)) || defined(__TWIN32__) || defined(wxUSE_NORLANDER_HEADERS) + #include #endif -#include "wx/treectrl.h" - // Bug in headers, sometimes #ifndef TVIS_FOCUSED #define TVIS_FOCUSED 0x0001 @@ -68,15 +68,45 @@ // a convenient wrapper around TV_ITEM struct which adds a ctor struct wxTreeViewItem : public TV_ITEM { - wxTreeViewItem(const wxTreeItemId& item, - UINT mask_, UINT stateMask_ = 0) + wxTreeViewItem(const wxTreeItemId& item, // the item handle + UINT mask_, // fields which are valid + UINT stateMask_ = 0) // for TVIF_STATE only { - mask = mask_; + // hItem member is always valid + mask = mask_ | TVIF_HANDLE; stateMask = stateMask_; hItem = (HTREEITEM) (WXHTREEITEM) item; } }; +// a class which encapsulates the tree traversal logic: it vists all (unless +// OnVisit() returns FALSE) items under the given one +class wxTreeTraversal +{ +public: + wxTreeTraversal(const wxTreeCtrl *tree) + { + m_tree = tree; + } + + // do traverse the tree: visit all items (recursively by default) under the + // given one; return TRUE if all items were traversed or FALSE if the + // traversal was aborted because OnVisit returned FALSE + bool DoTraverse(const wxTreeItemId& root, bool recursively = TRUE); + + // override this function to do whatever is needed for each item, return + // FALSE to stop traversing + virtual bool OnVisit(const wxTreeItemId& item) = 0; + +protected: + const wxTreeCtrl *GetTree() const { return m_tree; } + +private: + bool Traverse(const wxTreeItemId& root, bool recursively); + + const wxTreeCtrl *m_tree; +}; + // ---------------------------------------------------------------------------- // macros // ---------------------------------------------------------------------------- @@ -85,9 +115,6 @@ struct wxTreeViewItem : public TV_ITEM IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl, wxControl) #endif -// hide the ugly cast (of course, the macro is _quite_ ugly too...) -#define wxhWnd ((HWND)m_hWnd) - // ---------------------------------------------------------------------------- // variables // ---------------------------------------------------------------------------- @@ -103,6 +130,37 @@ static const wxEventType g_events[2][2] = // implementation // ============================================================================ +// ---------------------------------------------------------------------------- +// tree traversal +// ---------------------------------------------------------------------------- + +bool wxTreeTraversal::DoTraverse(const wxTreeItemId& root, bool recursively) +{ + if ( !OnVisit(root) ) + return FALSE; + + return Traverse(root, recursively); +} + +bool wxTreeTraversal::Traverse(const wxTreeItemId& root, bool recursively) +{ + long cookie; + wxTreeItemId child = m_tree->GetFirstChild(root, cookie); + while ( child.IsOk() ) + { + // depth first traversal + if ( recursively && !Traverse(child, TRUE) ) + return FALSE; + + if ( !OnVisit(child) ) + return FALSE; + + child = m_tree->GetNextChild(root, cookie); + } + + return TRUE; +} + // ---------------------------------------------------------------------------- // construction and destruction // ---------------------------------------------------------------------------- @@ -114,35 +172,21 @@ void wxTreeCtrl::Init() m_textCtrl = NULL; } -bool wxTreeCtrl::Create(wxWindow *parent, wxWindowID id, - const wxPoint& pos, const wxSize& size, - long style, const wxValidator& validator, +bool wxTreeCtrl::Create(wxWindow *parent, + wxWindowID id, + const wxPoint& pos, + const wxSize& size, + long style, + const wxValidator& validator, const wxString& name) { Init(); - wxSystemSettings settings; - - SetName(name); - SetValidator(validator); - - m_windowStyle = style; - - SetParent(parent); - - m_windowId = (id == -1) ? NewControlId() : id; - - DWORD wstyle = WS_VISIBLE | WS_CHILD | WS_TABSTOP | TVS_HASLINES; - - bool want3D; - WXDWORD exStyle = Determine3DEffects(WS_EX_CLIENTEDGE, &want3D) ; + if ( !CreateControl(parent, id, pos, size, style, validator, name) ) + return FALSE; - // Even with extended styles, need to combine with WS_BORDER - // for them to look right. - if ( want3D || wxStyleHasBorder(m_windowStyle) ) - { - wstyle |= WS_BORDER; - } + DWORD wstyle = WS_VISIBLE | WS_CHILD | WS_TABSTOP | + TVS_HASLINES | TVS_SHOWSELALWAYS; if ( m_windowStyle & wxTR_HAS_BUTTONS ) wstyle |= TVS_HASBUTTONS; @@ -153,26 +197,73 @@ bool wxTreeCtrl::Create(wxWindow *parent, wxWindowID id, if ( m_windowStyle & wxTR_LINES_AT_ROOT ) wstyle |= TVS_LINESATROOT; +#if !defined( __GNUWIN32__ ) && !defined(wxUSE_NORLANDER_HEADERS) + // 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 + // Create the tree control. - m_hWnd = (WXHWND)::CreateWindowEx - ( - exStyle, - WC_TREEVIEW, - "", - wstyle, - pos.x, pos.y, size.x, size.y, - (HWND)parent->GetHWND(), - (HMENU)m_windowId, - wxGetInstance(), - NULL - ); - - wxCHECK_MSG( m_hWnd, FALSE, "Failed to create tree ctrl" ); - - if ( parent ) - parent->AddChild(this); - - SubclassWin(m_hWnd); + if ( !MSWCreateControl(WC_TREEVIEW, wstyle) ) + return FALSE; + + // the treectrl with any other background looks ugly because the items + // background is white anyhow + SetBackgroundColour(*wxWHITE); + + // 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(_T("DrawFrameControl(check)")); + } + + bmp.SetHBITMAP((WXHBITMAP)hbmpCheck); + imagelistCheckboxes.Add(bmp); + + if ( !::DrawFrameControl(hdcMem, &rect, + DFC_BUTTON, + DFCS_BUTTONCHECK) ) + { + wxLogLastError(_T("DrawFrameControl(uncheck)")); + } + + bmp.SetHBITMAP((WXHBITMAP)hbmpCheck); + imagelistCheckboxes.Add(bmp); + + // clean up + ::DeleteDC(hdcMem); + + // set the imagelist + SetStateImageList(&imagelistCheckboxes); + } +#endif // 0 + + SetSize(pos.x, pos.y, size.x, size.y); return TRUE; } @@ -193,7 +284,7 @@ wxTreeCtrl::~wxTreeCtrl() bool wxTreeCtrl::DoGetItem(wxTreeViewItem* tvItem) const { - if ( !TreeView_GetItem(wxhWnd, tvItem) ) + if ( !TreeView_GetItem(GetHwnd(), tvItem) ) { wxLogLastError("TreeView_GetItem"); @@ -205,7 +296,7 @@ bool wxTreeCtrl::DoGetItem(wxTreeViewItem* tvItem) const void wxTreeCtrl::DoSetItem(wxTreeViewItem* tvItem) { - if ( TreeView_SetItem(wxhWnd, tvItem) == -1 ) + if ( TreeView_SetItem(GetHwnd(), tvItem) == -1 ) { wxLogLastError("TreeView_SetItem"); } @@ -213,17 +304,17 @@ void wxTreeCtrl::DoSetItem(wxTreeViewItem* tvItem) size_t wxTreeCtrl::GetCount() const { - return (size_t)TreeView_GetCount(wxhWnd); + return (size_t)TreeView_GetCount(GetHwnd()); } unsigned int wxTreeCtrl::GetIndent() const { - return TreeView_GetIndent(wxhWnd); + return TreeView_GetIndent(GetHwnd()); } void wxTreeCtrl::SetIndent(unsigned int indent) { - TreeView_SetIndent(wxhWnd, indent); + TreeView_SetIndent(GetHwnd(), indent); } wxImageList *wxTreeCtrl::GetImageList() const @@ -239,7 +330,7 @@ wxImageList *wxTreeCtrl::GetStateImageList() const void wxTreeCtrl::SetAnyImageList(wxImageList *imageList, int which) { // no error return - TreeView_SetImageList(wxhWnd, + TreeView_SetImageList(GetHwnd(), imageList ? imageList->GetHIMAGELIST() : 0, which); } @@ -254,13 +345,45 @@ void wxTreeCtrl::SetStateImageList(wxImageList *imageList) SetAnyImageList(m_imageListState = imageList, TVSIL_STATE); } +size_t wxTreeCtrl::GetChildrenCount(const wxTreeItemId& item, + bool recursively) const +{ + class TraverseCounter : public wxTreeTraversal + { + public: + TraverseCounter(const wxTreeCtrl *tree, + const wxTreeItemId& root, + bool recursively) + : wxTreeTraversal(tree) + { + m_count = 0; + + DoTraverse(root, recursively); + } + + virtual bool OnVisit(const wxTreeItemId& item) + { + m_count++; + + return TRUE; + } + + size_t GetCount() const { return m_count; } + + private: + size_t m_count; + } counter(this, item, recursively); + + return counter.GetCount(); +} + // ---------------------------------------------------------------------------- // Item access // ---------------------------------------------------------------------------- wxString wxTreeCtrl::GetItemText(const wxTreeItemId& item) const { - char buf[512]; // the size is arbitrary... + wxChar buf[512]; // the size is arbitrary... wxTreeViewItem tvItem(item, TVIF_TEXT); tvItem.pszText = buf; @@ -268,7 +391,7 @@ wxString wxTreeCtrl::GetItemText(const wxTreeItemId& item) const if ( !DoGetItem(&tvItem) ) { // don't return some garbage which was on stack, but an empty string - buf[0] = '\0'; + buf[0] = _T('\0'); } return wxString(buf); @@ -277,7 +400,17 @@ wxString wxTreeCtrl::GetItemText(const wxTreeItemId& item) const void wxTreeCtrl::SetItemText(const wxTreeItemId& item, const wxString& text) { wxTreeViewItem tvItem(item, TVIF_TEXT); - tvItem.pszText = (char *)text.c_str(); // conversion is ok + tvItem.pszText = (wxChar *)text.c_str(); // conversion is ok + DoSetItem(&tvItem); +} + +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); } @@ -291,9 +424,10 @@ int wxTreeCtrl::GetItemImage(const wxTreeItemId& item) const void wxTreeCtrl::SetItemImage(const wxTreeItemId& item, int image) { - wxTreeViewItem tvItem(item, TVIF_IMAGE); - tvItem.iImage = image; - DoSetItem(&tvItem); + // 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, image, GetItemSelectedImage(item)); } int wxTreeCtrl::GetItemSelectedImage(const wxTreeItemId& item) const @@ -306,9 +440,10 @@ int wxTreeCtrl::GetItemSelectedImage(const wxTreeItemId& item) const void wxTreeCtrl::SetItemSelectedImage(const wxTreeItemId& item, int image) { - wxTreeViewItem tvItem(item, TVIF_SELECTEDIMAGE); - tvItem.iSelectedImage = image; - DoSetItem(&tvItem); + // 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, GetItemImage(item), image); } wxTreeItemData *wxTreeCtrl::GetItemData(const wxTreeItemId& item) const @@ -336,16 +471,29 @@ void wxTreeCtrl::SetItemHasChildren(const wxTreeItemId& item, bool has) DoSetItem(&tvItem); } +void wxTreeCtrl::SetItemBold(const wxTreeItemId& item, bool bold) +{ + wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_BOLD); + tvItem.state = bold ? TVIS_BOLD : 0; + DoSetItem(&tvItem); +} + +void wxTreeCtrl::SetItemDropHighlight(const wxTreeItemId& item, bool highlight) +{ + wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_DROPHILITED); + tvItem.state = highlight ? TVIS_DROPHILITED : 0; + DoSetItem(&tvItem); +} + // ---------------------------------------------------------------------------- // Item status // ---------------------------------------------------------------------------- bool wxTreeCtrl::IsVisible(const wxTreeItemId& item) const { + // Bug in Gnu-Win32 headers, so don't use the macro TreeView_GetItemRect RECT rect; -// return (TreeView_GetItemRect(wxhWnd, (HTREEITEM) (WXHTREEITEM)item, &rect, FALSE) != 0); - // Bug in Gnu-Win32 headers, so don't use the macro. - return (SendMessage((wxhWnd), TVM_GETITEMRECT, (WPARAM) FALSE, (LPARAM) & rect) != 0); + return SendMessage(GetHwnd(), TVM_GETITEMRECT, FALSE, (LPARAM)&rect) != 0; } @@ -376,30 +524,41 @@ bool wxTreeCtrl::IsSelected(const wxTreeItemId& item) const return (tvItem.state & TVIS_SELECTED) != 0; } +bool wxTreeCtrl::IsBold(const wxTreeItemId& item) const +{ + wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_BOLD); + DoGetItem(&tvItem); + + return (tvItem.state & TVIS_BOLD) != 0; +} + // ---------------------------------------------------------------------------- // navigation // ---------------------------------------------------------------------------- wxTreeItemId wxTreeCtrl::GetRootItem() const { - return wxTreeItemId((WXHTREEITEM) TreeView_GetRoot(wxhWnd)); + return wxTreeItemId((WXHTREEITEM) TreeView_GetRoot(GetHwnd())); } wxTreeItemId wxTreeCtrl::GetSelection() const { - return wxTreeItemId((WXHTREEITEM) TreeView_GetSelection(wxhWnd)); + wxCHECK_MSG( !(m_windowStyle & wxTR_MULTIPLE), (WXHTREEITEM)0, + _T("this only works with single selection controls") ); + + return wxTreeItemId((WXHTREEITEM) TreeView_GetSelection(GetHwnd())); } wxTreeItemId wxTreeCtrl::GetParent(const wxTreeItemId& item) const { - return wxTreeItemId((WXHTREEITEM) TreeView_GetParent(wxhWnd, (HTREEITEM) (WXHTREEITEM) item)); + return wxTreeItemId((WXHTREEITEM) TreeView_GetParent(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item)); } wxTreeItemId wxTreeCtrl::GetFirstChild(const wxTreeItemId& item, long& _cookie) const { // remember the last child returned in 'cookie' - _cookie = (long)TreeView_GetChild(wxhWnd, (HTREEITEM) (WXHTREEITEM)item); + _cookie = (long)TreeView_GetChild(GetHwnd(), (HTREEITEM) (WXHTREEITEM)item); return wxTreeItemId((WXHTREEITEM)_cookie); } @@ -407,39 +566,114 @@ wxTreeItemId wxTreeCtrl::GetFirstChild(const wxTreeItemId& item, wxTreeItemId wxTreeCtrl::GetNextChild(const wxTreeItemId& WXUNUSED(item), long& _cookie) const { - return wxTreeItemId((WXHTREEITEM) TreeView_GetNextSibling(wxhWnd, - (HTREEITEM) (WXHTREEITEM)_cookie)); + wxTreeItemId l = wxTreeItemId((WXHTREEITEM)TreeView_GetNextSibling(GetHwnd(), + (HTREEITEM)(WXHTREEITEM)_cookie)); + _cookie = (long)l; + + return l; +} + +wxTreeItemId wxTreeCtrl::GetLastChild(const wxTreeItemId& item) const +{ + // can this be done more efficiently? + long cookie; + + wxTreeItemId childLast, + child = GetFirstChild(item, cookie); + while ( child.IsOk() ) + { + childLast = child; + child = GetNextChild(item, cookie); + } + + return childLast; } wxTreeItemId wxTreeCtrl::GetNextSibling(const wxTreeItemId& item) const { - return wxTreeItemId((WXHTREEITEM) TreeView_GetNextSibling(wxhWnd, (HTREEITEM) (WXHTREEITEM) item)); + return wxTreeItemId((WXHTREEITEM) TreeView_GetNextSibling(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item)); } wxTreeItemId wxTreeCtrl::GetPrevSibling(const wxTreeItemId& item) const { - return wxTreeItemId((WXHTREEITEM) TreeView_GetPrevSibling(wxhWnd, (HTREEITEM) (WXHTREEITEM) item)); + return wxTreeItemId((WXHTREEITEM) TreeView_GetPrevSibling(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item)); } wxTreeItemId wxTreeCtrl::GetFirstVisibleItem() const { - return wxTreeItemId((WXHTREEITEM) TreeView_GetFirstVisible(wxhWnd)); + return wxTreeItemId((WXHTREEITEM) TreeView_GetFirstVisible(GetHwnd())); } wxTreeItemId wxTreeCtrl::GetNextVisible(const wxTreeItemId& item) const { - wxASSERT_MSG( IsVisible(item), "The item you call GetNextVisible() " - "for must be visible itself!"); + wxASSERT_MSG( IsVisible(item), _T("The item you call GetNextVisible() " + "for must be visible itself!")); - return wxTreeItemId((WXHTREEITEM) TreeView_GetNextVisible(wxhWnd, (HTREEITEM) (WXHTREEITEM) item)); + return wxTreeItemId((WXHTREEITEM) TreeView_GetNextVisible(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item)); } wxTreeItemId wxTreeCtrl::GetPrevVisible(const wxTreeItemId& item) const { - wxASSERT_MSG( IsVisible(item), "The item you call GetPrevVisible() " - "for must be visible itself!"); + wxASSERT_MSG( IsVisible(item), _T("The item you call GetPrevVisible() " + "for must be visible itself!")); - return wxTreeItemId((WXHTREEITEM) TreeView_GetPrevVisible(wxhWnd, (HTREEITEM) (WXHTREEITEM) item)); + return wxTreeItemId((WXHTREEITEM) TreeView_GetPrevVisible(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item)); +} + +// ---------------------------------------------------------------------------- +// multiple selections emulation +// ---------------------------------------------------------------------------- + +bool wxTreeCtrl::IsItemChecked(const wxTreeItemId& item) const +{ + // 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) +{ + // receive the desired information. + wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_STATEIMAGEMASK); + + // state images are one-based + tvItem.state = (check ? 2 : 1) << 12; + + DoSetItem(&tvItem); +} + +size_t wxTreeCtrl::GetSelections(wxArrayTreeItemIds& selections) const +{ + class TraverseSelections : public wxTreeTraversal + { + public: + TraverseSelections(const wxTreeCtrl *tree, + wxArrayTreeItemIds& selections) + : wxTreeTraversal(tree), m_selections(selections) + { + m_selections.Empty(); + + DoTraverse(tree->GetRootItem()); + } + + virtual bool OnVisit(const wxTreeItemId& item) + { + if ( GetTree()->IsItemChecked(item) ) + { + m_selections.Add(item); + } + + return TRUE; + } + + private: + wxArrayTreeItemIds& m_selections; + } selector(this, selections); + + return selections.GetCount(); } // ---------------------------------------------------------------------------- @@ -455,11 +689,18 @@ wxTreeItemId wxTreeCtrl::DoInsertItem(const wxTreeItemId& parent, TV_INSERTSTRUCT tvIns; tvIns.hParent = (HTREEITEM) (WXHTREEITEM)parent; tvIns.hInsertAfter = (HTREEITEM) (WXHTREEITEM) hInsertAfter; + + // This is how we insert the item as the first child: supply a NULL hInsertAfter + if (tvIns.hInsertAfter == (HTREEITEM) 0) + { + tvIns.hInsertAfter = TVI_FIRST; + } + UINT mask = 0; if ( !text.IsEmpty() ) { mask |= TVIF_TEXT; - tvIns.item.pszText = (char *)text.c_str(); // cast is ok + tvIns.item.pszText = (wxChar *)text.c_str(); // cast is ok } if ( image != -1 ) @@ -488,12 +729,18 @@ wxTreeItemId wxTreeCtrl::DoInsertItem(const wxTreeItemId& parent, tvIns.item.mask = mask; - HTREEITEM id = (HTREEITEM) TreeView_InsertItem(wxhWnd, &tvIns); + HTREEITEM id = (HTREEITEM) TreeView_InsertItem(GetHwnd(), &tvIns); if ( id == 0 ) { wxLogLastError("TreeView_InsertItem"); } + if ( data != NULL ) + { + // associate the application tree item with Win32 tree item handle + data->SetId((WXHTREEITEM)id); + } + return wxTreeItemId((WXHTREEITEM)id); } @@ -544,19 +791,39 @@ wxTreeItemId wxTreeCtrl::AppendItem(const wxTreeItemId& parent, void wxTreeCtrl::Delete(const wxTreeItemId& item) { - wxTreeItemData *data = GetItemData(item); - if(data!=NULL) - delete data; // may be NULL, ok - - if ( !TreeView_DeleteItem(wxhWnd, (HTREEITEM)(WXHTREEITEM)item) ) + if ( !TreeView_DeleteItem(GetHwnd(), (HTREEITEM)(WXHTREEITEM)item) ) { wxLogLastError("TreeView_DeleteItem"); } } +// delete all children (but don't delete the item itself) +void wxTreeCtrl::DeleteChildren(const wxTreeItemId& item) +{ + long cookie; + + wxArrayLong children; + wxTreeItemId child = GetFirstChild(item, cookie); + while ( child.IsOk() ) + { + children.Add((long)(WXHTREEITEM)child); + + child = GetNextChild(item, cookie); + } + + size_t nCount = children.Count(); + for ( size_t n = 0; n < nCount; n++ ) + { + if ( !TreeView_DeleteItem(GetHwnd(), (HTREEITEM)children[n]) ) + { + wxLogLastError("TreeView_DeleteItem"); + } + } +} + void wxTreeCtrl::DeleteAllItems() { - if ( !TreeView_DeleteAllItems(wxhWnd) ) + if ( !TreeView_DeleteAllItems(GetHwnd()) ) { wxLogLastError("TreeView_DeleteAllItems"); } @@ -564,13 +831,25 @@ void wxTreeCtrl::DeleteAllItems() void wxTreeCtrl::DoExpand(const wxTreeItemId& item, int flag) { - wxASSERT_MSG( flag == TVE_COLLAPSE || flag == TVE_COLLAPSERESET || - flag == TVE_EXPAND || flag == TVE_TOGGLE, - "Unknown flag in wxTreeCtrl::DoExpand" ); + wxASSERT_MSG( flag == TVE_COLLAPSE || + flag == (TVE_COLLAPSE | TVE_COLLAPSERESET) || + flag == TVE_EXPAND || + flag == TVE_TOGGLE, + _T("Unknown flag in wxTreeCtrl::DoExpand") ); // TreeView_Expand doesn't send TVN_ITEMEXPAND(ING) messages, so we must - // emulate them - if ( TreeView_Expand(wxhWnd, (HTREEITEM) (WXHTREEITEM) item, flag) != 0 ) + // emulate them. This behaviour has changed slightly with comctl32.dll + // v 4.70 - now it does send them but only the first time. To maintain + // compatible behaviour and also in order to not have surprises with the + // future versions, don't rely on this and still do everything ourselves. + // To avoid that the messages be sent twice when the item is expanded for + // the first time we must clear TVIS_EXPANDEDONCE style manually. + + wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_EXPANDEDONCE); + tvItem.state = 0; + DoSetItem(&tvItem); + + if ( TreeView_Expand(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item, flag) != 0 ) { wxTreeEvent event(wxEVT_NULL, m_windowId); event.m_item = item; @@ -579,18 +858,14 @@ void wxTreeCtrl::DoExpand(const wxTreeItemId& item, int flag) event.SetEventObject(this); - // @@@ return values of {EXPAND|COLLAPS}ING event handler is discarded + // FIXME return value of {EXPAND|COLLAPS}ING event handler is discarded event.SetEventType(g_events[isExpanded][TRUE]); GetEventHandler()->ProcessEvent(event); event.SetEventType(g_events[isExpanded][FALSE]); GetEventHandler()->ProcessEvent(event); } - else - { - // I wonder if it really ever happens... - wxLogDebug("TreeView_Expand: change didn't took place."); - } + //else: change didn't took place, so do nothing at all } void wxTreeCtrl::Expand(const wxTreeItemId& item) @@ -605,7 +880,7 @@ void wxTreeCtrl::Collapse(const wxTreeItemId& item) void wxTreeCtrl::CollapseAndReset(const wxTreeItemId& item) { - DoExpand(item, TVE_COLLAPSERESET); + DoExpand(item, TVE_COLLAPSE | TVE_COLLAPSERESET); } void wxTreeCtrl::Toggle(const wxTreeItemId& item) @@ -615,31 +890,78 @@ void wxTreeCtrl::Toggle(const wxTreeItemId& item) void wxTreeCtrl::ExpandItem(const wxTreeItemId& item, int action) { - DoExpand(item, action); + DoExpand(item, action); } void wxTreeCtrl::Unselect() { + wxASSERT_MSG( !(m_windowStyle & wxTR_MULTIPLE), _T("doesn't make sense") ); + + // just remove the selection SelectItem(wxTreeItemId((WXHTREEITEM) 0)); } +void wxTreeCtrl::UnselectAll() +{ + if ( m_windowStyle & wxTR_MULTIPLE ) + { + wxArrayTreeItemIds selections; + size_t count = GetSelections(selections); + for ( size_t n = 0; n < count; n++ ) + { + SetItemCheck(selections[n], FALSE); + } + } + else + { + // just remove the selection + Unselect(); + } +} + void wxTreeCtrl::SelectItem(const wxTreeItemId& item) { - if ( !TreeView_SelectItem(wxhWnd, (HTREEITEM) (WXHTREEITEM) item) ) + if ( m_windowStyle & wxTR_MULTIPLE ) { - wxLogLastError("TreeView_SelectItem"); + // selecting the item means checking it + SetItemCheck(item); + } + else + { + // 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 + + 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() ) + { + if ( !TreeView_SelectItem(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item) ) + { + wxLogLastError("TreeView_SelectItem"); + } + else + { + event.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED); + (void)GetEventHandler()->ProcessEvent(event); + } + } + //else: program vetoed the change } } void wxTreeCtrl::EnsureVisible(const wxTreeItemId& item) { // no error return - TreeView_EnsureVisible(wxhWnd, (HTREEITEM) (WXHTREEITEM) item); + TreeView_EnsureVisible(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item); } void wxTreeCtrl::ScrollTo(const wxTreeItemId& item) { - if ( !TreeView_SelectSetFirstVisible(wxhWnd, (HTREEITEM) (WXHTREEITEM) item) ) + if ( !TreeView_SelectSetFirstVisible(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item) ) { wxLogLastError("TreeView_SelectSetFirstVisible"); } @@ -666,9 +988,14 @@ wxTextCtrl* wxTreeCtrl::EditLabel(const wxTreeItemId& item, { wxASSERT( textControlClass->IsKindOf(CLASSINFO(wxTextCtrl)) ); - HWND hWnd = (HWND) TreeView_EditLabel(wxhWnd, (HTREEITEM) (WXHTREEITEM) item); + HWND hWnd = (HWND) TreeView_EditLabel(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item); - wxCHECK_MSG( hWnd, NULL, "Can't edit tree ctrl label" ); + // this is not an error - the TVN_BEGINLABELEDIT handler might have + // returned FALSE + if ( !hWnd ) + { + return NULL; + } DeleteTextCtrl(); @@ -682,7 +1009,7 @@ wxTextCtrl* wxTreeCtrl::EditLabel(const wxTreeItemId& item, // End label editing, optionally cancelling the edit void wxTreeCtrl::EndEditLabel(const wxTreeItemId& item, bool discardChanges) { - TreeView_EndEditLabelNow(wxhWnd, discardChanges); + TreeView_EndEditLabelNow(GetHwnd(), discardChanges); DeleteTextCtrl(); } @@ -693,7 +1020,7 @@ wxTreeItemId wxTreeCtrl::HitTest(const wxPoint& point, int& flags) hitTestInfo.pt.x = (int)point.x; hitTestInfo.pt.y = (int)point.y; - TreeView_HitTest(wxhWnd, &hitTestInfo); + TreeView_HitTest(GetHwnd(), &hitTestInfo); flags = 0; @@ -718,17 +1045,61 @@ wxTreeItemId wxTreeCtrl::HitTest(const wxPoint& point, int& flags) return wxTreeItemId((WXHTREEITEM) hitTestInfo.hItem); } -void wxTreeCtrl::SortChildren(const wxTreeItemId& item, - wxTreeItemCmpFunc *cmpFunction) +bool wxTreeCtrl::GetBoundingRect(const wxTreeItemId& item, + wxRect& rect, + bool textOnly) const { - if ( cmpFunction == NULL ) + RECT rc; + if ( TreeView_GetItemRect(GetHwnd(), (HTREEITEM)(WXHTREEITEM)item, + &rc, textOnly) ) { - TreeView_SortChildren(wxhWnd, (HTREEITEM) (WXHTREEITEM) item, 0); + rect = wxRect(wxPoint(rc.left, rc.top), wxPoint(rc.right, rc.bottom)); + + return TRUE; } else { - // TODO: use TreeView_SortChildrenCB - wxFAIL_MSG("wxTreeCtrl::SortChildren not implemented"); + // couldn't retrieve rect: for example, item isn't visible + return FALSE; + } +} + +// ---------------------------------------------------------------------------- +// sorting stuff +// ---------------------------------------------------------------------------- + +static int CALLBACK TreeView_CompareCallback(wxTreeItemData *pItem1, + wxTreeItemData *pItem2, + wxTreeCtrl *tree) +{ + wxCHECK_MSG( pItem1 && pItem2, 0, + _T("sorting tree without data doesn't make sense") ); + + return tree->OnCompareItems(pItem1->GetId(), pItem2->GetId()); +} + +int wxTreeCtrl::OnCompareItems(const wxTreeItemId& item1, + const wxTreeItemId& item2) +{ + return wxStrcmp(GetItemText(item1), GetItemText(item2)); +} + +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!) + if ( GetClassInfo() == CLASSINFO(wxTreeCtrl) ) + { + TreeView_SortChildren(GetHwnd(), (HTREEITEM)(WXHTREEITEM)item, 0); + } + else + { + TV_SORTCB tvSort; + tvSort.hParent = (HTREEITEM)(WXHTREEITEM)item; + tvSort.lpfnCompare = (PFNTVCOMPARE)TreeView_CompareCallback; + tvSort.lParam = (LPARAM)this; + TreeView_SortChildrenCB(GetHwnd(), &tvSort, 0 /* reserved */); } } @@ -761,7 +1132,7 @@ bool wxTreeCtrl::MSWCommand(WXUINT cmd, WXWORD id) } // process WM_NOTIFY Windows message -bool wxTreeCtrl::MSWNotify(WXWPARAM wParam, WXLPARAM lParam) +bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) { wxTreeEvent event(wxEVT_NULL, m_windowId); wxEventType eventType = wxEVT_NULL; @@ -792,6 +1163,7 @@ bool wxTreeCtrl::MSWNotify(WXWPARAM wParam, WXLPARAM lParam) TV_DISPINFO *info = (TV_DISPINFO *)lParam; event.m_item = (WXHTREEITEM) info->item.hItem; + event.m_label = info->item.pszText; break; } @@ -809,7 +1181,8 @@ bool wxTreeCtrl::MSWNotify(WXWPARAM wParam, WXLPARAM lParam) eventType = wxEVT_COMMAND_TREE_END_LABEL_EDIT; TV_DISPINFO *info = (TV_DISPINFO *)lParam; - event.m_item = (WXHTREEITEM) info->item.hItem; + event.m_item = (WXHTREEITEM)info->item.hItem; + event.m_label = info->item.pszText; break; } @@ -849,8 +1222,8 @@ bool wxTreeCtrl::MSWNotify(WXWPARAM wParam, WXLPARAM lParam) break; default: - wxLogDebug("unexpected code %d in TVN_ITEMEXPAND " - "message", tv->action); + wxLogDebug(_T("unexpected code %d in TVN_ITEMEXPAND " + "message"), tv->action); } bool ing = (hdr->code == TVN_ITEMEXPANDING); @@ -866,6 +1239,16 @@ bool wxTreeCtrl::MSWNotify(WXWPARAM wParam, WXLPARAM lParam) TV_KEYDOWN *info = (TV_KEYDOWN *)lParam; event.m_code = wxCharCodeMSWToWX(info->wVKey); + + // a separate event for this case + if ( info->wVKey == VK_SPACE || info->wVKey == VK_RETURN ) + { + wxTreeEvent event2(wxEVT_COMMAND_TREE_ITEM_ACTIVATED, + m_windowId); + event2.SetEventObject(this); + + GetEventHandler()->ProcessEvent(event2); + } break; } @@ -887,46 +1270,67 @@ bool wxTreeCtrl::MSWNotify(WXWPARAM wParam, WXLPARAM lParam) } default: - return wxControl::MSWNotify(wParam, lParam); + return wxControl::MSWOnNotify(idCtrl, lParam, result); } event.SetEventObject(this); event.SetEventType(eventType); - bool rc = GetEventHandler()->ProcessEvent(event); + bool processed = GetEventHandler()->ProcessEvent(event); // post processing switch ( hdr->code ) { - // NB: we might process this message using wxWindows event tables, but - // due to overhead of wxWin event system we prefer to do it here - // (otherwise deleting a tree with many items is just too slow) case TVN_DELETEITEM: { + // NB: we might process this message using wxWindows event + // 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; wxTreeItemData *data = (wxTreeItemData *)tv->itemOld.lParam; delete data; // may be NULL, ok + + processed = TRUE; // Make sure we don't get called twice } break; + case TVN_BEGINLABELEDIT: + // return TRUE to cancel label editing + *result = !event.IsAllowed(); + break; + + case TVN_ENDLABELEDIT: + // return TRUE to set the label to the new string + *result = event.IsAllowed(); + + // ensure that we don't have the text ctrl which is going to be + // deleted any more + DeleteTextCtrl(); + break; + + case TVN_SELCHANGING: case TVN_ITEMEXPANDING: - // if user called Veto(), don't allow expansion/collapse by - // returning TRUE from here - rc = event.m_code != 0; + // return TRUE to prevent the action from happening + *result = !event.IsAllowed(); break; + + //default: + // for the other messages the return value is ignored and there is + // nothing special to do } - return rc; + return processed; } // ---------------------------------------------------------------------------- // Tree event // ---------------------------------------------------------------------------- -IMPLEMENT_DYNAMIC_CLASS(wxTreeEvent, wxCommandEvent) +IMPLEMENT_DYNAMIC_CLASS(wxTreeEvent, wxNotifyEvent) wxTreeEvent::wxTreeEvent(wxEventType commandType, int id) - : wxCommandEvent(commandType, id) + : wxNotifyEvent(commandType, id) { m_code = 0; m_itemOld = 0;