// Name: treectrl.cpp
// Purpose: wxTreeCtrl
// Author: Julian Smart
-// Modified by:
+// Modified by: Vadim Zeitlin to be less MSW-specific on 10.10.98
// Created: 1997
// RCS-ID: $Id$
// Copyright: (c) Julian Smart
-// Licence: wxWindows licence
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
#ifdef __GNUG__
-#pragma implementation "treectrl.h"
+ #pragma implementation "treectrl.h"
#endif
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#ifdef __BORLANDC__
-#pragma hdrstop
+ #pragma hdrstop
#endif
+#include "wx/window.h"
+#include "wx/msw/private.h"
+
#ifndef WX_PRECOMP
-#include "wx.h"
+ #include "wx/settings.h"
#endif
-#include "wx/log.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/treectrl.h"
-#include "wx/msw/private.h"
+#include "wx/log.h"
+#include "wx/dynarray.h"
+#include "wx/imaglist.h"
+#include "wx/msw/treectrl.h"
+
+#ifdef __GNUWIN32__
+#include "wx/msw/gnuwin32/extra.h"
+#endif
-#ifndef __GNUWIN32__
-#include <commctrl.h>
+#if (defined(__WIN95__) && !defined(__GNUWIN32__)) || defined(__TWIN32__)
+ #include <commctrl.h>
#endif
// Bug in headers, sometimes
#ifndef TVIS_FOCUSED
-#define TVIS_FOCUSED 0x0001
+ #define TVIS_FOCUSED 0x0001
#endif
-static void wxConvertToMSWTreeItem(wxTreeItem& info, TV_ITEM& tvItem);
-static void wxConvertFromMSWTreeItem(wxTreeItem& info, TV_ITEM& tvItem, HWND getFullInfo = 0);
+// ----------------------------------------------------------------------------
+// private classes
+// ----------------------------------------------------------------------------
-#if !USE_SHARED_LIBRARY
-IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl, wxControl)
-IMPLEMENT_DYNAMIC_CLASS(wxTreeItem, wxObject)
+// 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)
+ {
+ mask = mask_;
+ stateMask = stateMask_;
+ hItem = (HTREEITEM) (WXHTREEITEM) item;
+ }
+};
+// ----------------------------------------------------------------------------
+// macros
+// ----------------------------------------------------------------------------
+
+#if !USE_SHARED_LIBRARY
+ IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl, wxControl)
#endif
-wxTreeCtrl::wxTreeCtrl(void)
+// ----------------------------------------------------------------------------
+// variables
+// ----------------------------------------------------------------------------
+
+// handy table for sending events
+static const wxEventType g_events[2][2] =
+{
+ { wxEVT_COMMAND_TREE_ITEM_COLLAPSED, wxEVT_COMMAND_TREE_ITEM_COLLAPSING },
+ { wxEVT_COMMAND_TREE_ITEM_EXPANDED, wxEVT_COMMAND_TREE_ITEM_EXPANDING }
+};
+
+// ============================================================================
+// implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// construction and destruction
+// ----------------------------------------------------------------------------
+
+void wxTreeCtrl::Init()
{
- m_imageListNormal = NULL;
- m_imageListState = NULL;
- m_textCtrl = NULL;
+ m_imageListNormal = NULL;
+ m_imageListState = NULL;
+ m_textCtrl = NULL;
}
-bool wxTreeCtrl::Create(wxWindow *parent, wxWindowID id, const wxPoint& pos, const wxSize& size,
- long style, const wxValidator& validator, const wxString& name)
+bool wxTreeCtrl::Create(wxWindow *parent, wxWindowID id,
+ const wxPoint& pos, const wxSize& size,
+ long style, const wxValidator& validator,
+ const wxString& name)
{
- wxSystemSettings settings;
- SetBackgroundColour(settings.GetSystemColour(wxSYS_COLOUR_WINDOW));
- SetForegroundColour(parent->GetForegroundColour());
+ Init();
- SetName(name);
- SetValidator(validator);
+ wxSystemSettings settings;
- m_imageListNormal = NULL;
- m_imageListState = NULL;
- m_textCtrl = NULL;
+ SetName(name);
+ SetValidator(validator);
- int x = pos.x;
- int y = pos.y;
- int width = size.x;
- int height = size.y;
+ m_windowStyle = style;
- m_windowStyle = style;
+ SetParent(parent);
-// SetFont(wxTheFontList->FindOrCreateFont(11, wxSWISS, wxNORMAL, wxNORMAL));
+ m_windowId = (id == -1) ? NewControlId() : id;
- SetParent(parent);
+ DWORD wstyle = WS_VISIBLE | WS_CHILD | WS_TABSTOP | TVS_HASLINES | TVS_SHOWSELALWAYS ;
- if (width <= 0)
- width = 100;
- if (height <= 0)
- height = 30;
- if (x < 0)
- x = 0;
- if (y < 0)
- y = 0;
- m_windowId = (id == -1) ? NewControlId() : id;
+ bool want3D;
+ WXDWORD exStyle = Determine3DEffects(WS_EX_CLIENTEDGE, &want3D) ;
- DWORD wstyle = WS_VISIBLE | WS_CHILD | WS_TABSTOP | TVS_HASLINES;
-
- bool want3D;
- WXDWORD exStyle = Determine3DEffects(WS_EX_CLIENTEDGE, &want3D) ;
+ // Even with extended styles, need to combine with WS_BORDER
+ // for them to look right.
+ if ( want3D || wxStyleHasBorder(m_windowStyle) )
+ {
+ wstyle |= WS_BORDER;
+ }
- // Even with extended styles, need to combine with WS_BORDER
- // for them to look right.
- if (want3D || (m_windowStyle & wxSIMPLE_BORDER) || (m_windowStyle & wxRAISED_BORDER) ||
- (m_windowStyle & wxSUNKEN_BORDER) || (m_windowStyle & wxDOUBLE_BORDER))
- wstyle |= WS_BORDER;
+ if ( m_windowStyle & wxTR_HAS_BUTTONS )
+ wstyle |= TVS_HASBUTTONS;
- if ( m_windowStyle & wxTR_HAS_BUTTONS )
- wstyle |= TVS_HASBUTTONS;
+ if ( m_windowStyle & wxTR_EDIT_LABELS )
+ wstyle |= TVS_EDITLABELS;
- if ( m_windowStyle & wxTR_EDIT_LABELS )
- wstyle |= TVS_EDITLABELS;
+ if ( m_windowStyle & wxTR_LINES_AT_ROOT )
+ wstyle |= TVS_LINESATROOT;
- if ( m_windowStyle & wxTR_LINES_AT_ROOT )
- wstyle |= TVS_LINESATROOT;
+ // Create the tree control.
+ m_hWnd = (WXHWND)::CreateWindowEx
+ (
+ exStyle,
+ WC_TREEVIEW,
+ _T(""),
+ wstyle,
+ pos.x, pos.y, size.x, size.y,
+ (HWND)parent->GetHWND(),
+ (HMENU)m_windowId,
+ wxGetInstance(),
+ NULL
+ );
- // Create the toolbar control.
- HWND hWndTreeControl = CreateWindowEx(exStyle,
- WC_TREEVIEW,
- "",
- wstyle,
- x, y, width, height,
- (HWND) parent->GetHWND(),
- (HMENU)m_windowId,
- wxGetInstance(),
- NULL );
+ wxCHECK_MSG( m_hWnd, FALSE, _T("Failed to create tree ctrl") );
- m_hWnd = (WXHWND) hWndTreeControl;
- if (parent) parent->AddChild(this);
-
- SubclassWin((WXHWND) m_hWnd);
+ if ( parent )
+ parent->AddChild(this);
- return TRUE;
+ SubclassWin(m_hWnd);
+
+ return TRUE;
}
-wxTreeCtrl::~wxTreeCtrl(void)
+wxTreeCtrl::~wxTreeCtrl()
{
- if (m_textCtrl)
+ DeleteTextCtrl();
+
+ // delete user data to prevent memory leaks
+ DeleteAllItems();
+}
+
+// ----------------------------------------------------------------------------
+// accessors
+// ----------------------------------------------------------------------------
+
+// simple wrappers which add error checking in debug mode
+
+bool wxTreeCtrl::DoGetItem(wxTreeViewItem* tvItem) const
+{
+ if ( !TreeView_GetItem(GetHwnd(), tvItem) )
{
- m_textCtrl->UnsubclassWin();
- m_textCtrl->SetHWND((WXHWND) 0);
- delete m_textCtrl;
+ wxLogLastError("TreeView_GetItem");
+
+ return FALSE;
}
+
+ return TRUE;
}
-// Attributes
-int wxTreeCtrl::GetCount(void) const
+void wxTreeCtrl::DoSetItem(wxTreeViewItem* tvItem)
{
- return (int) TreeView_GetCount((HWND) GetHWND());
+ if ( TreeView_SetItem(GetHwnd(), tvItem) == -1 )
+ {
+ wxLogLastError("TreeView_SetItem");
+ }
}
-int wxTreeCtrl::GetIndent(void) const
+size_t wxTreeCtrl::GetCount() const
{
- return (int) TreeView_GetIndent((HWND) GetHWND());
+ return (size_t)TreeView_GetCount(GetHwnd());
}
-void wxTreeCtrl::SetIndent(int indent)
+unsigned int wxTreeCtrl::GetIndent() const
{
- TreeView_SetIndent((HWND) GetHWND(), indent);
+ return TreeView_GetIndent(GetHwnd());
}
-wxImageList *wxTreeCtrl::GetImageList(int which) const
+void wxTreeCtrl::SetIndent(unsigned int indent)
{
- if ( which == wxIMAGE_LIST_NORMAL )
- {
- return m_imageListNormal;
- }
- else if ( which == wxIMAGE_LIST_STATE )
- {
- return m_imageListState;
- }
- return NULL;
+ TreeView_SetIndent(GetHwnd(), indent);
}
-void wxTreeCtrl::SetImageList(wxImageList *imageList, int which)
+wxImageList *wxTreeCtrl::GetImageList() const
{
- int flags = 0;
- if ( which == wxIMAGE_LIST_NORMAL )
- {
- flags = TVSIL_NORMAL;
- m_imageListNormal = imageList;
- }
- else if ( which == wxIMAGE_LIST_STATE )
- {
- flags = TVSIL_STATE;
- m_imageListState = imageList;
- }
- TreeView_SetImageList((HWND) GetHWND(), (HIMAGELIST) imageList ? imageList->GetHIMAGELIST() : 0, flags);
+ return m_imageListNormal;
}
-long wxTreeCtrl::GetNextItem(long item, int code) const
+wxImageList *wxTreeCtrl::GetStateImageList() const
{
- UINT flag = 0;
- switch ( code )
- {
- case wxTREE_NEXT_CARET:
- flag = TVGN_CARET;
- break;
- case wxTREE_NEXT_CHILD:
- flag = TVGN_CHILD;
- break;
- case wxTREE_NEXT_DROPHILITE:
- flag = TVGN_DROPHILITE;
- break;
- case wxTREE_NEXT_FIRSTVISIBLE:
- flag = TVGN_FIRSTVISIBLE;
- break;
- case wxTREE_NEXT_NEXT:
- flag = TVGN_NEXT;
- break;
- case wxTREE_NEXT_NEXTVISIBLE:
- flag = TVGN_NEXTVISIBLE;
- break;
- case wxTREE_NEXT_PARENT:
- flag = TVGN_PARENT;
- break;
- case wxTREE_NEXT_PREVIOUS:
- flag = TVGN_PREVIOUS;
- break;
- case wxTREE_NEXT_PREVIOUSVISIBLE:
- flag = TVGN_PREVIOUSVISIBLE;
- break;
- case wxTREE_NEXT_ROOT:
- flag = TVGN_ROOT;
- break;
-
- default :
- break;
- }
- return (long) TreeView_GetNextItem( (HWND) GetHWND(), (HTREEITEM) item, flag);
+ return m_imageListNormal;
}
-bool wxTreeCtrl::ItemHasChildren(long item) const
+void wxTreeCtrl::SetAnyImageList(wxImageList *imageList, int which)
{
- TV_ITEM item2;
- item2.hItem = (HTREEITEM) item;
- item2.mask = TVIF_CHILDREN;
- TreeView_GetItem((HWND) GetHWND(), &item2);
- return (item2.cChildren != 0);
+ // no error return
+ TreeView_SetImageList(GetHwnd(),
+ imageList ? imageList->GetHIMAGELIST() : 0,
+ which);
}
-long wxTreeCtrl::GetChild(long item) const
+void wxTreeCtrl::SetImageList(wxImageList *imageList)
{
- return (long) ::SendMessage((HWND) GetHWND(), TVM_GETNEXTITEM, TVGN_CHILD, (LPARAM)item);
+ SetAnyImageList(m_imageListNormal = imageList, TVSIL_NORMAL);
}
-long wxTreeCtrl::GetParent(long item) const
+void wxTreeCtrl::SetStateImageList(wxImageList *imageList)
{
- return (long) ::SendMessage((HWND) GetHWND(), TVM_GETNEXTITEM, TVGN_PARENT, (LPARAM)item);
+ SetAnyImageList(m_imageListState = imageList, TVSIL_STATE);
}
-long wxTreeCtrl::GetFirstVisibleItem(void) const
+size_t wxTreeCtrl::GetChildrenCount(const wxTreeItemId& item, bool recursively)
{
- return (long) ::SendMessage((HWND) GetHWND(), TVM_GETNEXTITEM, TVGN_FIRSTVISIBLE, 0);
+ long cookie;
+
+ size_t result = 0;
+
+ wxArrayLong children;
+ wxTreeItemId child = GetFirstChild(item, cookie);
+ while ( child.IsOk() )
+ {
+ if ( recursively )
+ {
+ // recursive call
+ result += GetChildrenCount(child, TRUE);
+ }
+
+ // add the child to the result in any case
+ result++;
+
+ child = GetNextChild(item, cookie);
+ }
+
+ return result;
}
-long wxTreeCtrl::GetNextVisibleItem(long item) const
+// ----------------------------------------------------------------------------
+// Item access
+// ----------------------------------------------------------------------------
+
+wxString wxTreeCtrl::GetItemText(const wxTreeItemId& item) const
{
- return (long) ::SendMessage((HWND) GetHWND(), TVM_GETNEXTITEM, TVGN_NEXTVISIBLE, (LPARAM)item);
+ wxChar buf[512]; // the size is arbitrary...
+
+ wxTreeViewItem tvItem(item, TVIF_TEXT);
+ tvItem.pszText = buf;
+ tvItem.cchTextMax = WXSIZEOF(buf);
+ if ( !DoGetItem(&tvItem) )
+ {
+ // don't return some garbage which was on stack, but an empty string
+ buf[0] = _T('\0');
+ }
+
+ return wxString(buf);
}
-long wxTreeCtrl::GetSelection(void) const
+void wxTreeCtrl::SetItemText(const wxTreeItemId& item, const wxString& text)
{
- return (long) ::SendMessage((HWND) GetHWND(), TVM_GETNEXTITEM, TVGN_CARET, 0);
+ wxTreeViewItem tvItem(item, TVIF_TEXT);
+ tvItem.pszText = (wxChar *)text.c_str(); // conversion is ok
+ DoSetItem(&tvItem);
}
-long wxTreeCtrl::GetRootItem(void) const
+int wxTreeCtrl::GetItemImage(const wxTreeItemId& item) const
{
- return (long) ::SendMessage((HWND) GetHWND(), TVM_GETNEXTITEM, TVGN_ROOT, 0);
+ wxTreeViewItem tvItem(item, TVIF_IMAGE);
+ DoGetItem(&tvItem);
+
+ return tvItem.iImage;
}
-bool wxTreeCtrl::GetItem(wxTreeItem& info) const
+void wxTreeCtrl::SetItemImage(const wxTreeItemId& item, int image)
{
- TV_ITEM tvItem;
- tvItem.hItem = (HTREEITEM)info.m_itemId;
- tvItem.pszText = NULL;
- tvItem.mask =
- tvItem.stateMask = 0;
-
- // TODO: convert other bits in the mask
- if ( info.m_mask & wxTREE_MASK_TEXT )
- {
- tvItem.mask |= TVIF_TEXT;
- tvItem.pszText = new char[513];
- tvItem.cchTextMax = 512;
- }
- if ( info.m_mask & wxTREE_MASK_DATA )
- tvItem.mask |= TVIF_PARAM;
- if ( info.m_stateMask & wxTREE_STATE_EXPANDED ) {
- tvItem.mask |= TVIF_STATE;
- tvItem.stateMask |= TVIS_EXPANDED;
- }
+ wxTreeViewItem tvItem(item, TVIF_IMAGE);
+ tvItem.iImage = image;
+ DoSetItem(&tvItem);
+}
- bool success = TreeView_GetItem((HWND)GetHWND(), &tvItem) != 0;
+int wxTreeCtrl::GetItemSelectedImage(const wxTreeItemId& item) const
+{
+ wxTreeViewItem tvItem(item, TVIF_SELECTEDIMAGE);
+ DoGetItem(&tvItem);
- if ( !success )
- {
- wxLogSysError("TreeView_GetItem failed");
+ return tvItem.iSelectedImage;
+}
- if (tvItem.pszText)
- delete[] tvItem.pszText;
+void wxTreeCtrl::SetItemSelectedImage(const wxTreeItemId& item, int image)
+{
+ wxTreeViewItem tvItem(item, TVIF_SELECTEDIMAGE);
+ tvItem.iSelectedImage = image;
+ DoSetItem(&tvItem);
+}
- return FALSE;
- }
+wxTreeItemData *wxTreeCtrl::GetItemData(const wxTreeItemId& item) const
+{
+ wxTreeViewItem tvItem(item, TVIF_PARAM);
+ if ( !DoGetItem(&tvItem) )
+ {
+ return NULL;
+ }
- wxConvertFromMSWTreeItem(info, tvItem);
+ return (wxTreeItemData *)tvItem.lParam;
+}
- if (tvItem.pszText)
- delete[] tvItem.pszText;
+void wxTreeCtrl::SetItemData(const wxTreeItemId& item, wxTreeItemData *data)
+{
+ wxTreeViewItem tvItem(item, TVIF_PARAM);
+ tvItem.lParam = (LPARAM)data;
+ DoSetItem(&tvItem);
+}
- return success;
+void wxTreeCtrl::SetItemHasChildren(const wxTreeItemId& item, bool has)
+{
+ wxTreeViewItem tvItem(item, TVIF_CHILDREN);
+ tvItem.cChildren = (int)has;
+ DoSetItem(&tvItem);
}
-bool wxTreeCtrl::SetItem(wxTreeItem& info)
+void wxTreeCtrl::SetItemBold(const wxTreeItemId& item, bool bold)
{
- TV_ITEM item;
- wxConvertToMSWTreeItem(info, item);
- return (::SendMessage((HWND) GetHWND(), TVM_SETITEM, 0, (LPARAM)&item) != 0);
+ wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_BOLD);
+ tvItem.state = bold ? TVIS_BOLD : 0;
+ DoSetItem(&tvItem);
}
-int wxTreeCtrl::GetItemState(long item, long stateMask) const
+void wxTreeCtrl::SetItemDropHighlight(const wxTreeItemId& item, bool highlight)
{
- wxTreeItem info;
+ wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_DROPHILITED);
+ tvItem.state = highlight ? TVIS_DROPHILITED : 0;
+ DoSetItem(&tvItem);
+}
- info.m_mask = wxTREE_MASK_STATE ;
- info.m_stateMask = stateMask;
- info.m_itemId = item;
+// ----------------------------------------------------------------------------
+// Item status
+// ----------------------------------------------------------------------------
- if (!GetItem(info))
- return 0;
+bool wxTreeCtrl::IsVisible(const wxTreeItemId& item) const
+{
+ // Bug in Gnu-Win32 headers, so don't use the macro TreeView_GetItemRect
+ RECT rect;
+ return SendMessage(GetHwnd(), TVM_GETITEMRECT, FALSE, (LPARAM)&rect) != 0;
- return info.m_state;
}
-bool wxTreeCtrl::SetItemState(long item, long state, long stateMask)
+bool wxTreeCtrl::ItemHasChildren(const wxTreeItemId& item) const
{
- wxTreeItem info;
-
- info.m_mask = wxTREE_MASK_STATE ;
- info.m_state = state;
- info.m_stateMask = stateMask;
- info.m_itemId = item;
+ wxTreeViewItem tvItem(item, TVIF_CHILDREN);
+ DoGetItem(&tvItem);
- return SetItem(info);
+ return tvItem.cChildren != 0;
}
-bool wxTreeCtrl::SetItemImage(long item, int image, int selImage)
+bool wxTreeCtrl::IsExpanded(const wxTreeItemId& item) const
{
- wxTreeItem info;
+ // probably not a good idea to put it here
+ //wxASSERT( ItemHasChildren(item) );
- info.m_mask = wxTREE_MASK_IMAGE ;
- info.m_image = image;
- if ( selImage > -1)
- {
- info.m_selectedImage = selImage;
- info.m_mask |= wxTREE_MASK_SELECTED_IMAGE;
- }
- info.m_itemId = item;
+ wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_EXPANDED);
+ DoGetItem(&tvItem);
- return SetItem(info);
+ return (tvItem.state & TVIS_EXPANDED) != 0;
}
-wxString wxTreeCtrl::GetItemText(long item) const
+bool wxTreeCtrl::IsSelected(const wxTreeItemId& item) const
{
- wxTreeItem info;
+ wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_SELECTED);
+ DoGetItem(&tvItem);
- info.m_mask = wxTREE_MASK_TEXT ;
- info.m_itemId = item;
-
- if (!GetItem(info))
- return wxString("");
- return info.m_text;
+ return (tvItem.state & TVIS_SELECTED) != 0;
}
-void wxTreeCtrl::SetItemText(long item, const wxString& str)
+bool wxTreeCtrl::IsBold(const wxTreeItemId& item) const
{
- wxTreeItem info;
-
- info.m_mask = wxTREE_MASK_TEXT ;
- info.m_itemId = item;
- info.m_text = str;
+ wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_BOLD);
+ DoGetItem(&tvItem);
- SetItem(info);
+ return (tvItem.state & TVIS_BOLD) != 0;
}
-long wxTreeCtrl::GetItemData(long item) const
+// ----------------------------------------------------------------------------
+// navigation
+// ----------------------------------------------------------------------------
+
+wxTreeItemId wxTreeCtrl::GetRootItem() const
{
- wxTreeItem info;
+ return wxTreeItemId((WXHTREEITEM) TreeView_GetRoot(GetHwnd()));
+}
- info.m_mask = wxTREE_MASK_DATA ;
- info.m_itemId = item;
+wxTreeItemId wxTreeCtrl::GetSelection() const
+{
+ return wxTreeItemId((WXHTREEITEM) TreeView_GetSelection(GetHwnd()));
+}
- if (!GetItem(info))
- return 0;
- return info.m_data;
+wxTreeItemId wxTreeCtrl::GetParent(const wxTreeItemId& item) const
+{
+ return wxTreeItemId((WXHTREEITEM) TreeView_GetParent(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item));
}
-bool wxTreeCtrl::SetItemData(long item, long data)
+wxTreeItemId wxTreeCtrl::GetFirstChild(const wxTreeItemId& item,
+ long& _cookie) const
{
- wxTreeItem info;
+ // remember the last child returned in 'cookie'
+ _cookie = (long)TreeView_GetChild(GetHwnd(), (HTREEITEM) (WXHTREEITEM)item);
- info.m_mask = wxTREE_MASK_DATA ;
- info.m_itemId = item;
- info.m_data = data;
+ return wxTreeItemId((WXHTREEITEM)_cookie);
+}
+
+wxTreeItemId wxTreeCtrl::GetNextChild(const wxTreeItemId& WXUNUSED(item),
+ long& _cookie) const
+{
+ wxTreeItemId l = wxTreeItemId((WXHTREEITEM)TreeView_GetNextSibling(GetHwnd(),
+ (HTREEITEM)(WXHTREEITEM)_cookie));
+ _cookie = (long)l;
- return SetItem(info);
+ return l;
}
-bool wxTreeCtrl::GetItemRect(long item, wxRectangle& rect, bool textOnly) const
+wxTreeItemId wxTreeCtrl::GetLastChild(const wxTreeItemId& item) const
{
- RECT rect2;
+ // can this be done more efficiently?
+ long cookie;
- *(HTREEITEM*)& rect2 = (HTREEITEM) item;
- bool success = (::SendMessage((HWND) GetHWND(), TVM_GETITEMRECT, (WPARAM)textOnly,
- (LPARAM)&rect2) != 0);
+ wxTreeItemId childLast,
+ child = GetFirstChild(item, cookie);
+ while ( child.IsOk() )
+ {
+ childLast = child;
+ child = GetNextChild(item, cookie);
+ }
- rect.x = rect2.left;
- rect.y = rect2.top;
- rect.width = rect2.right - rect2.left;
- rect.height = rect2.bottom - rect2.left;
- return success;
+ return childLast;
}
-wxTextCtrl* wxTreeCtrl::GetEditControl(void) const
+wxTreeItemId wxTreeCtrl::GetNextSibling(const wxTreeItemId& item) const
{
- return m_textCtrl;
+ return wxTreeItemId((WXHTREEITEM) TreeView_GetNextSibling(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item));
}
-// Operations
-bool wxTreeCtrl::DeleteItem(long item)
+wxTreeItemId wxTreeCtrl::GetPrevSibling(const wxTreeItemId& item) const
{
- return (TreeView_DeleteItem((HWND) GetHWND(), (HTREEITEM) item) != 0);
+ return wxTreeItemId((WXHTREEITEM) TreeView_GetPrevSibling(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item));
}
-bool wxTreeCtrl::ExpandItem(long item, int action)
+wxTreeItemId wxTreeCtrl::GetFirstVisibleItem() const
{
- UINT mswAction = TVE_EXPAND;
- switch ( action )
- {
- case wxTREE_EXPAND_EXPAND:
- mswAction = TVE_EXPAND;
- break;
+ return wxTreeItemId((WXHTREEITEM) TreeView_GetFirstVisible(GetHwnd()));
+}
- case wxTREE_EXPAND_COLLAPSE:
- mswAction = TVE_COLLAPSE;
- break;
+wxTreeItemId wxTreeCtrl::GetNextVisible(const wxTreeItemId& item) const
+{
+ wxASSERT_MSG( IsVisible(item), _T("The item you call GetNextVisible() "
+ "for must be visible itself!"));
- case wxTREE_EXPAND_COLLAPSE_RESET:
- // @@@ it should also delete all the items! currently, if you do use this
- // code your program will probaly crash. Feel free to remove this if
- // it does work
- wxFAIL_MSG("wxTREE_EXPAND_COLLAPSE_RESET probably doesn't work.");
- mswAction = TVE_COLLAPSERESET;
- break;
+ return wxTreeItemId((WXHTREEITEM) TreeView_GetNextVisible(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item));
+}
- case wxTREE_EXPAND_TOGGLE:
- mswAction = TVE_TOGGLE;
- break;
+wxTreeItemId wxTreeCtrl::GetPrevVisible(const wxTreeItemId& item) const
+{
+ wxASSERT_MSG( IsVisible(item), _T("The item you call GetPrevVisible() "
+ "for must be visible itself!"));
- default:
- wxFAIL_MSG("unknown action in wxTreeCtrl::ExpandItem");
- }
+ return wxTreeItemId((WXHTREEITEM) TreeView_GetPrevVisible(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item));
+}
- bool bOk = TreeView_Expand((HWND)GetHWND(), (HTREEITEM)item, mswAction) != 0;
+// ----------------------------------------------------------------------------
+// Usual operations
+// ----------------------------------------------------------------------------
- // TreeView_Expand doesn't send TVN_EXPAND(ING) messages, so emulate them
- if ( bOk ) {
- wxTreeEvent event(wxEVT_NULL, m_windowId);
- event.m_item.m_itemId = item;
- event.m_item.m_mask =
- event.m_item.m_stateMask = 0xffff; // get all
- GetItem(event.m_item);
+wxTreeItemId wxTreeCtrl::DoInsertItem(const wxTreeItemId& parent,
+ wxTreeItemId hInsertAfter,
+ const wxString& text,
+ int image, int selectedImage,
+ wxTreeItemData *data)
+{
+ TV_INSERTSTRUCT tvIns;
+ tvIns.hParent = (HTREEITEM) (WXHTREEITEM)parent;
+ tvIns.hInsertAfter = (HTREEITEM) (WXHTREEITEM) hInsertAfter;
- bool bIsExpanded = (event.m_item.m_state & wxTREE_STATE_EXPANDED) != 0;
+ // This is how we insert the item as the first child: supply a NULL hInsertAfter
+ if (tvIns.hInsertAfter == (HTREEITEM) 0)
+ {
+ tvIns.hInsertAfter = TVI_FIRST;
+ }
- event.m_code = action;
- event.SetEventObject(this);
+ UINT mask = 0;
+ if ( !text.IsEmpty() )
+ {
+ mask |= TVIF_TEXT;
+ tvIns.item.pszText = (wxChar *)text.c_str(); // cast is ok
+ }
- // @@@ return values of {EXPAND|COLLAPS}ING event handler is discarded
- event.SetEventType(bIsExpanded ? wxEVT_COMMAND_TREE_ITEM_EXPANDING
- : wxEVT_COMMAND_TREE_ITEM_COLLAPSING);
- GetEventHandler()->ProcessEvent(event);
+ if ( image != -1 )
+ {
+ mask |= TVIF_IMAGE;
+ tvIns.item.iImage = image;
+
+ if ( selectedImage == -1 )
+ {
+ // take the same image for selected icon if not specified
+ selectedImage = image;
+ }
+ }
- event.SetEventType(bIsExpanded ? wxEVT_COMMAND_TREE_ITEM_EXPANDED
- : wxEVT_COMMAND_TREE_ITEM_COLLAPSED);
- GetEventHandler()->ProcessEvent(event);
- }
+ if ( selectedImage != -1 )
+ {
+ mask |= TVIF_SELECTEDIMAGE;
+ tvIns.item.iSelectedImage = selectedImage;
+ }
- return bOk;
-}
+ if ( data != NULL )
+ {
+ mask |= TVIF_PARAM;
+ tvIns.item.lParam = (LPARAM)data;
+ }
-long wxTreeCtrl::InsertItem(long parent, wxTreeItem& info, long insertAfter)
-{
- TV_INSERTSTRUCT tvInsertStruct;
- tvInsertStruct.hParent = (HTREEITEM) parent ;
- tvInsertStruct.hInsertAfter = (HTREEITEM) insertAfter ;
+ tvIns.item.mask = mask;
- wxConvertToMSWTreeItem(info, tvInsertStruct.item);
+ 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 (long) TreeView_InsertItem((HWND) GetHWND(), & tvInsertStruct);
+ return wxTreeItemId((WXHTREEITEM)id);
}
-long wxTreeCtrl::InsertItem(long parent, const wxString& label, int image, int selImage,
- long insertAfter)
+// for compatibility only
+wxTreeItemId wxTreeCtrl::InsertItem(const wxTreeItemId& parent,
+ const wxString& text,
+ int image, int selImage,
+ long insertAfter)
{
- wxTreeItem info;
- info.m_text = label;
- info.m_mask = wxTREE_MASK_TEXT;
- if ( image > -1 )
- {
- info.m_mask |= wxTREE_MASK_IMAGE | wxTREE_MASK_SELECTED_IMAGE;
- info.m_image = image;
- if ( selImage == -1 )
- info.m_selectedImage = image;
- else
- info.m_selectedImage = selImage;
- }
+ return DoInsertItem(parent, (WXHTREEITEM)insertAfter, text,
+ image, selImage, NULL);
+}
- return InsertItem(parent, info, insertAfter);
+wxTreeItemId wxTreeCtrl::AddRoot(const wxString& text,
+ int image, int selectedImage,
+ wxTreeItemData *data)
+{
+ return DoInsertItem(wxTreeItemId((WXHTREEITEM) 0), (WXHTREEITEM) 0,
+ text, image, selectedImage, data);
}
-bool wxTreeCtrl::SelectItem(long item)
+wxTreeItemId wxTreeCtrl::PrependItem(const wxTreeItemId& parent,
+ const wxString& text,
+ int image, int selectedImage,
+ wxTreeItemData *data)
{
- return (TreeView_SelectItem((HWND) GetHWND(), (HTREEITEM) item) != 0);
+ return DoInsertItem(parent, (WXHTREEITEM) TVI_FIRST,
+ text, image, selectedImage, data);
}
-bool wxTreeCtrl::ScrollTo(long item)
+wxTreeItemId wxTreeCtrl::InsertItem(const wxTreeItemId& parent,
+ const wxTreeItemId& idPrevious,
+ const wxString& text,
+ int image, int selectedImage,
+ wxTreeItemData *data)
{
- return (TreeView_SelectSetFirstVisible((HWND) GetHWND(), (HTREEITEM) item) != 0);
+ return DoInsertItem(parent, idPrevious, text, image, selectedImage, data);
}
-bool wxTreeCtrl::DeleteAllItems(void)
+wxTreeItemId wxTreeCtrl::AppendItem(const wxTreeItemId& parent,
+ const wxString& text,
+ int image, int selectedImage,
+ wxTreeItemData *data)
{
- return (TreeView_DeleteAllItems((HWND) GetHWND()) != 0);
+ return DoInsertItem(parent, (WXHTREEITEM) TVI_LAST,
+ text, image, selectedImage, data);
}
-wxTextCtrl* wxTreeCtrl::EditLabel(long item, wxClassInfo* textControlClass)
+void wxTreeCtrl::Delete(const wxTreeItemId& item)
{
- wxASSERT( (textControlClass->IsKindOf(CLASSINFO(wxTextCtrl))) );
+ if ( !TreeView_DeleteItem(GetHwnd(), (HTREEITEM)(WXHTREEITEM)item) )
+ {
+ wxLogLastError("TreeView_DeleteItem");
+ }
+}
- HWND hWnd = (HWND) TreeView_EditLabel((HWND) GetHWND(), item);
+// delete all children (but don't delete the item itself)
+void wxTreeCtrl::DeleteChildren(const wxTreeItemId& item)
+{
+ long cookie;
- if (m_textCtrl)
+ wxArrayLong children;
+ wxTreeItemId child = GetFirstChild(item, cookie);
+ while ( child.IsOk() )
{
- m_textCtrl->UnsubclassWin();
- m_textCtrl->SetHWND(0);
- delete m_textCtrl;
- m_textCtrl = NULL;
- }
+ children.Add((long)(WXHTREEITEM)child);
- m_textCtrl = (wxTextCtrl*) textControlClass->CreateObject();
- m_textCtrl->SetHWND((WXHWND) hWnd);
- m_textCtrl->SubclassWin((WXHWND) hWnd);
+ child = GetNextChild(item, cookie);
+ }
- return m_textCtrl;
+ size_t nCount = children.Count();
+ for ( size_t n = 0; n < nCount; n++ )
+ {
+ if ( !TreeView_DeleteItem(GetHwnd(), (HTREEITEM)children[n]) )
+ {
+ wxLogLastError("TreeView_DeleteItem");
+ }
+ }
}
-// End label editing, optionally cancelling the edit
-bool wxTreeCtrl::EndEditLabel(bool cancel)
+void wxTreeCtrl::DeleteAllItems()
{
- bool success = (TreeView_EndEditLabelNow((HWND) GetHWND(), cancel) != 0);
-
- if (m_textCtrl)
+ if ( !TreeView_DeleteAllItems(GetHwnd()) )
{
- m_textCtrl->UnsubclassWin();
- m_textCtrl->SetHWND(0);
- delete m_textCtrl;
- m_textCtrl = NULL;
+ wxLogLastError("TreeView_DeleteAllItems");
}
- return success;
}
-long wxTreeCtrl::HitTest(const wxPoint& point, int& flags)
+void wxTreeCtrl::DoExpand(const wxTreeItemId& item, int flag)
{
- TV_HITTESTINFO hitTestInfo;
- hitTestInfo.pt.x = (int) point.x;
- hitTestInfo.pt.y = (int) point.y;
+ 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. 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;
+
+ bool isExpanded = IsExpanded(item);
- TreeView_HitTest((HWND) GetHWND(), & hitTestInfo);
+ event.SetEventObject(this);
- flags = 0;
- if ( hitTestInfo.flags & TVHT_ABOVE )
- flags |= wxTREE_HITTEST_ABOVE;
- if ( hitTestInfo.flags & TVHT_BELOW )
- flags |= wxTREE_HITTEST_BELOW;
- if ( hitTestInfo.flags & TVHT_NOWHERE )
- flags |= wxTREE_HITTEST_NOWHERE;
- if ( hitTestInfo.flags & TVHT_ONITEMBUTTON )
- flags |= wxTREE_HITTEST_ONITEMBUTTON;
- if ( hitTestInfo.flags & TVHT_ONITEMICON )
- flags |= wxTREE_HITTEST_ONITEMICON;
- if ( hitTestInfo.flags & TVHT_ONITEMINDENT )
- flags |= wxTREE_HITTEST_ONITEMINDENT;
- if ( hitTestInfo.flags & TVHT_ONITEMLABEL )
- flags |= wxTREE_HITTEST_ONITEMLABEL;
- if ( hitTestInfo.flags & TVHT_ONITEMRIGHT )
- flags |= wxTREE_HITTEST_ONITEMRIGHT;
- if ( hitTestInfo.flags & TVHT_ONITEMSTATEICON )
- flags |= wxTREE_HITTEST_ONITEMSTATEICON;
- if ( hitTestInfo.flags & TVHT_TOLEFT )
- flags |= wxTREE_HITTEST_TOLEFT;
- if ( hitTestInfo.flags & TVHT_TORIGHT )
- flags |= wxTREE_HITTEST_TORIGHT;
+ // FIXME return value of {EXPAND|COLLAPS}ING event handler is discarded
+ event.SetEventType(g_events[isExpanded][TRUE]);
+ GetEventHandler()->ProcessEvent(event);
- return (long) hitTestInfo.hItem ;
+ event.SetEventType(g_events[isExpanded][FALSE]);
+ GetEventHandler()->ProcessEvent(event);
+ }
+ //else: change didn't took place, so do nothing at all
}
-/*
-wxImageList *wxTreeCtrl::CreateDragImage(long item)
+void wxTreeCtrl::Expand(const wxTreeItemId& item)
{
+ DoExpand(item, TVE_EXPAND);
}
-*/
-bool wxTreeCtrl::SortChildren(long item)
+void wxTreeCtrl::Collapse(const wxTreeItemId& item)
{
- return (TreeView_SortChildren((HWND) GetHWND(), (HTREEITEM) item, 0) != 0);
+ DoExpand(item, TVE_COLLAPSE);
}
-bool wxTreeCtrl::EnsureVisible(long item)
+void wxTreeCtrl::CollapseAndReset(const wxTreeItemId& item)
{
- return (TreeView_EnsureVisible((HWND) GetHWND(), (HTREEITEM) item) != 0);
+ DoExpand(item, TVE_COLLAPSE | TVE_COLLAPSERESET);
}
-bool wxTreeCtrl::MSWCommand(WXUINT cmd, WXWORD id)
+void wxTreeCtrl::Toggle(const wxTreeItemId& item)
{
- if (cmd == EN_UPDATE)
- {
- wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, id);
- event.SetEventObject( this );
- ProcessCommand(event);
- return TRUE;
- }
- else if (cmd == EN_KILLFOCUS)
- {
- wxCommandEvent event(wxEVT_KILL_FOCUS, id);
- event.SetEventObject( this );
- ProcessCommand(event);
- return TRUE;
- }
- else return FALSE;
+ DoExpand(item, TVE_TOGGLE);
+}
+
+void wxTreeCtrl::ExpandItem(const wxTreeItemId& item, int action)
+{
+ DoExpand(item, action);
}
-
-bool wxTreeCtrl::MSWNotify(WXWPARAM wParam, WXLPARAM lParam)
+
+void wxTreeCtrl::Unselect()
{
- wxTreeEvent event(wxEVT_NULL, m_windowId);
- wxEventType eventType = wxEVT_NULL;
- NMHDR* hdr1 = (NMHDR*) lParam;
- switch ( hdr1->code )
- {
- case TVN_BEGINDRAG:
- {
- eventType = wxEVT_COMMAND_TREE_BEGIN_DRAG;
- NM_TREEVIEW* hdr = (NM_TREEVIEW*)lParam;
- wxConvertFromMSWTreeItem(event.m_item, hdr->itemNew, (HWND) GetHWND());
- event.m_pointDrag.x = hdr->ptDrag.x;
- event.m_pointDrag.y = hdr->ptDrag.y;
- break;
- }
- case TVN_BEGINLABELEDIT:
+ SelectItem(wxTreeItemId((WXHTREEITEM) 0));
+}
+
+void wxTreeCtrl::SelectItem(const wxTreeItemId& 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
+
+ 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() )
{
- eventType = wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT;
- TV_DISPINFO *info = (TV_DISPINFO *)lParam;
- wxConvertFromMSWTreeItem(event.m_item, info->item, (HWND) GetHWND());
- break;
+ if ( !TreeView_SelectItem(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item) )
+ {
+ wxLogLastError("TreeView_SelectItem");
+ }
+ else
+ {
+ event.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED);
+ (void)GetEventHandler()->ProcessEvent(event);
+ }
}
- case TVN_BEGINRDRAG:
+ //else: program vetoed the change
+}
+
+void wxTreeCtrl::EnsureVisible(const wxTreeItemId& item)
+{
+ // no error return
+ TreeView_EnsureVisible(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item);
+}
+
+void wxTreeCtrl::ScrollTo(const wxTreeItemId& item)
+{
+ if ( !TreeView_SelectSetFirstVisible(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item) )
{
- eventType = wxEVT_COMMAND_TREE_BEGIN_RDRAG;
- NM_TREEVIEW* hdr = (NM_TREEVIEW*)lParam;
- wxConvertFromMSWTreeItem(event.m_item, hdr->itemNew, (HWND) GetHWND());
- event.m_pointDrag.x = hdr->ptDrag.x;
- event.m_pointDrag.y = hdr->ptDrag.y;
- break;
+ wxLogLastError("TreeView_SelectSetFirstVisible");
}
- case TVN_DELETEITEM:
+}
+
+wxTextCtrl* wxTreeCtrl::GetEditControl() const
+{
+ return m_textCtrl;
+}
+
+void wxTreeCtrl::DeleteTextCtrl()
+{
+ if ( m_textCtrl )
{
- eventType = wxEVT_COMMAND_TREE_DELETE_ITEM;
- NM_TREEVIEW* hdr = (NM_TREEVIEW*)lParam;
- wxConvertFromMSWTreeItem(event.m_item, hdr->itemOld, (HWND) GetHWND());
- event.m_pointDrag.x = hdr->ptDrag.x;
- event.m_pointDrag.y = hdr->ptDrag.y;
- break;
+ m_textCtrl->UnsubclassWin();
+ m_textCtrl->SetHWND(0);
+ delete m_textCtrl;
+ m_textCtrl = NULL;
}
- case TVN_ENDLABELEDIT:
+}
+
+wxTextCtrl* wxTreeCtrl::EditLabel(const wxTreeItemId& item,
+ wxClassInfo* textControlClass)
+{
+ wxASSERT( textControlClass->IsKindOf(CLASSINFO(wxTextCtrl)) );
+
+ HWND hWnd = (HWND) TreeView_EditLabel(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item);
+
+ wxCHECK_MSG( hWnd, NULL, _T("Can't edit tree ctrl label") );
+
+ DeleteTextCtrl();
+
+ m_textCtrl = (wxTextCtrl *)textControlClass->CreateObject();
+ m_textCtrl->SetHWND((WXHWND)hWnd);
+ m_textCtrl->SubclassWin((WXHWND)hWnd);
+
+ return m_textCtrl;
+}
+
+// End label editing, optionally cancelling the edit
+void wxTreeCtrl::EndEditLabel(const wxTreeItemId& item, bool discardChanges)
+{
+ TreeView_EndEditLabelNow(GetHwnd(), discardChanges);
+
+ DeleteTextCtrl();
+}
+
+wxTreeItemId wxTreeCtrl::HitTest(const wxPoint& point, int& flags)
+{
+ TV_HITTESTINFO hitTestInfo;
+ hitTestInfo.pt.x = (int)point.x;
+ hitTestInfo.pt.y = (int)point.y;
+
+ TreeView_HitTest(GetHwnd(), &hitTestInfo);
+
+ flags = 0;
+
+ // avoid repetition
+ #define TRANSLATE_FLAG(flag) if ( hitTestInfo.flags & TVHT_##flag ) \
+ flags |= wxTREE_HITTEST_##flag
+
+ TRANSLATE_FLAG(ABOVE);
+ TRANSLATE_FLAG(BELOW);
+ TRANSLATE_FLAG(NOWHERE);
+ TRANSLATE_FLAG(ONITEMBUTTON);
+ TRANSLATE_FLAG(ONITEMICON);
+ TRANSLATE_FLAG(ONITEMINDENT);
+ TRANSLATE_FLAG(ONITEMLABEL);
+ TRANSLATE_FLAG(ONITEMRIGHT);
+ TRANSLATE_FLAG(ONITEMSTATEICON);
+ TRANSLATE_FLAG(TOLEFT);
+ TRANSLATE_FLAG(TORIGHT);
+
+ #undef TRANSLATE_FLAG
+
+ return wxTreeItemId((WXHTREEITEM) hitTestInfo.hItem);
+}
+
+bool wxTreeCtrl::GetBoundingRect(const wxTreeItemId& item,
+ wxRect& rect,
+ bool textOnly) const
+{
+ RECT rc;
+ if ( TreeView_GetItemRect(GetHwnd(), (HTREEITEM)(WXHTREEITEM)item,
+ &rc, textOnly) )
{
- eventType = wxEVT_COMMAND_TREE_END_LABEL_EDIT;
- TV_DISPINFO *info = (TV_DISPINFO *)lParam;
- wxConvertFromMSWTreeItem(event.m_item, info->item, (HWND) GetHWND());
- break;
+ rect = wxRect(wxPoint(rc.left, rc.top), wxPoint(rc.right, rc.bottom));
+
+ return TRUE;
}
- case TVN_GETDISPINFO:
+ else
{
- eventType = wxEVT_COMMAND_TREE_GET_INFO;
- TV_DISPINFO *info = (TV_DISPINFO *)lParam;
- wxConvertFromMSWTreeItem(event.m_item, info->item, (HWND) GetHWND());
- break;
+ // couldn't retrieve rect: for example, item isn't visible
+ return FALSE;
}
- case TVN_ITEMEXPANDING:
- {
- NM_TREEVIEW* hdr = (NM_TREEVIEW*)lParam;
- wxConvertFromMSWTreeItem(event.m_item, hdr->itemNew, (HWND) GetHWND());
-
- switch ( hdr->action )
- {
- case TVE_EXPAND:
- eventType = wxEVT_COMMAND_TREE_ITEM_EXPANDING;
- break;
+}
- case TVE_COLLAPSE:
- eventType = wxEVT_COMMAND_TREE_ITEM_COLLAPSING;
- break;
+// ----------------------------------------------------------------------------
+// sorting stuff
+// ----------------------------------------------------------------------------
- case TVE_COLLAPSERESET:
- case TVE_TOGGLE:
- wxLogDebug("unexpected code in TVN_ITEMEXPANDING message");
- break;
- }
- break;
- }
+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") );
- case TVN_ITEMEXPANDED:
- {
- NM_TREEVIEW* hdr = (NM_TREEVIEW*)lParam;
- wxConvertFromMSWTreeItem(event.m_item, hdr->itemNew, (HWND) GetHWND());
- switch ( hdr->action )
- {
- case TVE_EXPAND:
- eventType = wxEVT_COMMAND_TREE_ITEM_EXPANDED;
- break;
+ return tree->OnCompareItems(pItem1->GetId(), pItem2->GetId());
+}
- case TVE_COLLAPSE:
- eventType = wxEVT_COMMAND_TREE_ITEM_COLLAPSED;
- break;
+int wxTreeCtrl::OnCompareItems(const wxTreeItemId& item1,
+ const wxTreeItemId& item2)
+{
+ return wxStrcmp(GetItemText(item1), GetItemText(item2));
+}
- case TVE_COLLAPSERESET:
- case TVE_TOGGLE:
- wxLogDebug("unexpected code in TVN_ITEMEXPANDED message");
- break;
- }
- break;
- }
- case TVN_KEYDOWN:
+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) )
{
- eventType = wxEVT_COMMAND_TREE_KEY_DOWN;
- TV_KEYDOWN *info = (TV_KEYDOWN *)lParam;
- event.m_code = wxCharCodeMSWToWX(info->wVKey);
- break;
+ TreeView_SortChildren(GetHwnd(), (HTREEITEM)(WXHTREEITEM)item, 0);
}
- case TVN_SELCHANGED:
+ else
{
- eventType = wxEVT_COMMAND_TREE_SEL_CHANGED;
- NM_TREEVIEW* hdr = (NM_TREEVIEW*)lParam;
- wxConvertFromMSWTreeItem(event.m_item, hdr->itemNew, (HWND) GetHWND());
- event.m_oldItem = (long) hdr->itemNew.hItem;
+ TV_SORTCB tvSort;
+ tvSort.hParent = (HTREEITEM)(WXHTREEITEM)item;
+ tvSort.lpfnCompare = (PFNTVCOMPARE)TreeView_CompareCallback;
+ tvSort.lParam = (LPARAM)this;
+ TreeView_SortChildrenCB(GetHwnd(), &tvSort, 0 /* reserved */);
+ }
+}
- break;
+// ----------------------------------------------------------------------------
+// implementation
+// ----------------------------------------------------------------------------
+
+bool wxTreeCtrl::MSWCommand(WXUINT cmd, WXWORD id)
+{
+ if ( cmd == EN_UPDATE )
+ {
+ wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, id);
+ event.SetEventObject( this );
+ ProcessCommand(event);
}
- case TVN_SELCHANGING:
+ else if ( cmd == EN_KILLFOCUS )
{
- eventType = wxEVT_COMMAND_TREE_SEL_CHANGING;
- NM_TREEVIEW* hdr = (NM_TREEVIEW*)lParam;
- wxConvertFromMSWTreeItem(event.m_item, hdr->itemNew, (HWND) GetHWND());
- event.m_oldItem = (long) hdr->itemNew.hItem;
- break;
+ wxCommandEvent event(wxEVT_KILL_FOCUS, id);
+ event.SetEventObject( this );
+ ProcessCommand(event);
}
- case TVN_SETDISPINFO:
+ else
{
- eventType = wxEVT_COMMAND_TREE_SET_INFO;
- TV_DISPINFO *info = (TV_DISPINFO *)lParam;
- wxConvertFromMSWTreeItem(event.m_item, info->item, (HWND) GetHWND());
- break;
+ // nothing done
+ return FALSE;
}
- default :
- return wxControl::MSWNotify(wParam, lParam);
- break;
- }
-
- event.SetEventObject(this);
- event.SetEventType(eventType);
-
- if ( !GetEventHandler()->ProcessEvent(event) )
- return FALSE;
-
- if (hdr1->code == TVN_GETDISPINFO)
- {
- TV_DISPINFO *info = (TV_DISPINFO *)lParam;
- wxConvertToMSWTreeItem(event.m_item, info->item);
- }
-
- return TRUE;
+ // command processed
+ return TRUE;
}
-// Tree item structure
-wxTreeItem::wxTreeItem(void)
+// process WM_NOTIFY Windows message
+bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
{
- m_mask = 0;
- m_itemId = 0;
- m_state = 0;
- m_stateMask = 0;
- m_image = -1;
- m_selectedImage = -1;
- m_children = 0;
- m_data = 0;
-}
+ wxTreeEvent event(wxEVT_NULL, m_windowId);
+ wxEventType eventType = wxEVT_NULL;
+ NMHDR *hdr = (NMHDR *)lParam;
-// If getFullInfo is TRUE, we explicitly query for more info if we haven't got it all.
-static void wxConvertFromMSWTreeItem(wxTreeItem& info, TV_ITEM& tvItem, HWND getFullInfo)
-{
- info.m_data = tvItem.lParam;
- info.m_mask = 0;
- info.m_state = 0;
- info.m_stateMask = 0;
+ switch ( hdr->code )
+ {
+ case TVN_BEGINDRAG:
+ eventType = wxEVT_COMMAND_TREE_BEGIN_DRAG;
+ // fall through
+
+ case TVN_BEGINRDRAG:
+ {
+ if ( eventType == wxEVT_NULL )
+ eventType = wxEVT_COMMAND_TREE_BEGIN_RDRAG;
+ //else: left drag, already set above
+
+ NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam;
+
+ event.m_item = (WXHTREEITEM) tv->itemNew.hItem;
+ event.m_pointDrag = wxPoint(tv->ptDrag.x, tv->ptDrag.y);
+ break;
+ }
+
+ case TVN_BEGINLABELEDIT:
+ {
+ eventType = wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT;
+ TV_DISPINFO *info = (TV_DISPINFO *)lParam;
+
+ event.m_item = (WXHTREEITEM) info->item.hItem;
+ break;
+ }
+
+ case TVN_DELETEITEM:
+ {
+ eventType = wxEVT_COMMAND_TREE_DELETE_ITEM;
+ NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam;
+
+ event.m_item = (WXHTREEITEM) tv->itemOld.hItem;
+ break;
+ }
+
+ case TVN_ENDLABELEDIT:
+ {
+ eventType = wxEVT_COMMAND_TREE_END_LABEL_EDIT;
+ TV_DISPINFO *info = (TV_DISPINFO *)lParam;
+
+ event.m_item = (WXHTREEITEM) info->item.hItem;
+ break;
+ }
+
+ case TVN_GETDISPINFO:
+ eventType = wxEVT_COMMAND_TREE_GET_INFO;
+ // fall through
+
+ case TVN_SETDISPINFO:
+ {
+ if ( eventType == wxEVT_NULL )
+ eventType = wxEVT_COMMAND_TREE_SET_INFO;
+ //else: get, already set above
+
+ TV_DISPINFO *info = (TV_DISPINFO *)lParam;
+
+ event.m_item = (WXHTREEITEM) info->item.hItem;
+ break;
+ }
+
+ case TVN_ITEMEXPANDING:
+ event.m_code = FALSE;
+ // fall through
+
+ case TVN_ITEMEXPANDED:
+ {
+ NM_TREEVIEW* tv = (NM_TREEVIEW*)lParam;
+
+ bool expand = FALSE;
+ switch ( tv->action )
+ {
+ case TVE_EXPAND:
+ expand = TRUE;
+ break;
+
+ case TVE_COLLAPSE:
+ expand = FALSE;
+ break;
+
+ default:
+ wxLogDebug(_T("unexpected code %d in TVN_ITEMEXPAND "
+ "message"), tv->action);
+ }
+
+ bool ing = (hdr->code == TVN_ITEMEXPANDING);
+ eventType = g_events[expand][ing];
+
+ event.m_item = (WXHTREEITEM) tv->itemNew.hItem;
+ break;
+ }
+
+ case TVN_KEYDOWN:
+ {
+ eventType = wxEVT_COMMAND_TREE_KEY_DOWN;
+ 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;
+ }
+
+ case TVN_SELCHANGED:
+ eventType = wxEVT_COMMAND_TREE_SEL_CHANGED;
+ // fall through
+
+ case TVN_SELCHANGING:
+ {
+ if ( eventType == wxEVT_NULL )
+ eventType = wxEVT_COMMAND_TREE_SEL_CHANGING;
+ //else: already set above
+
+ NM_TREEVIEW* tv = (NM_TREEVIEW *)lParam;
+
+ event.m_item = (WXHTREEITEM) tv->itemNew.hItem;
+ event.m_itemOld = (WXHTREEITEM) tv->itemOld.hItem;
+ break;
+ }
+
+ default:
+ return wxControl::MSWOnNotify(idCtrl, lParam, result);
+ }
- long oldMask = tvItem.mask;
+ event.SetEventObject(this);
+ event.SetEventType(eventType);
- bool needText = FALSE;
- if (getFullInfo != 0)
- {
- if ( tvItem.mask & TVIF_TEXT )
- needText = FALSE;
- else
- needText = TRUE;
+ bool processed = GetEventHandler()->ProcessEvent(event);
- if ( needText )
+ // post processing
+ if ( hdr->code == TVN_DELETEITEM )
{
- tvItem.pszText = new char[513];
- tvItem.cchTextMax = 512;
+ // 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)
+ 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
}
- tvItem.mask |= TVIF_HANDLE | TVIF_STATE | TVIF_TEXT | TVIF_IMAGE | TVIF_SELECTEDIMAGE | TVIF_CHILDREN | TVIF_PARAM ;
- ::SendMessage(getFullInfo, TVM_GETITEM, 0, (LPARAM)& tvItem) ;
- }
- if ( tvItem.mask & TVIF_HANDLE )
- {
- info.m_mask |= wxTREE_MASK_HANDLE;
- info.m_itemId = (long) tvItem.hItem;
- }
- if ( tvItem.mask & TVIF_STATE )
- {
- info.m_mask |= wxTREE_MASK_STATE;
- if ( tvItem.stateMask & TVIS_BOLD)
- {
- info.m_stateMask |= wxTREE_STATE_BOLD ;
- if ( tvItem.state & TVIS_BOLD )
- info.m_state |= wxTREE_STATE_BOLD ;
- }
-
- if ( tvItem.stateMask & TVIS_CUT)
- {
- info.m_stateMask |= wxTREE_STATE_CUT ;
- if ( tvItem.state & TVIS_CUT )
- info.m_state |= wxTREE_STATE_CUT ;
- }
-
- if ( tvItem.stateMask & TVIS_DROPHILITED)
- {
- info.m_stateMask |= wxTREE_STATE_DROPHILITED ;
- if ( tvItem.state & TVIS_DROPHILITED )
- info.m_state |= wxTREE_STATE_DROPHILITED ;
- }
- if ( tvItem.stateMask & TVIS_EXPANDED)
- {
- info.m_stateMask |= wxTREE_STATE_EXPANDED ;
- if ( tvItem.state & TVIS_EXPANDED )
- info.m_state |= wxTREE_STATE_EXPANDED ;
- }
- if ( tvItem.stateMask & TVIS_EXPANDEDONCE)
- {
- info.m_stateMask |= wxTREE_STATE_EXPANDEDONCE ;
- if ( tvItem.state & TVIS_EXPANDEDONCE )
- info.m_state |= wxTREE_STATE_EXPANDEDONCE ;
- }
- if ( tvItem.stateMask & TVIS_FOCUSED)
- {
- info.m_stateMask |= wxTREE_STATE_FOCUSED ;
- if ( tvItem.state & TVIS_FOCUSED )
- info.m_state |= wxTREE_STATE_FOCUSED ;
- }
- if ( tvItem.stateMask & TVIS_SELECTED)
- {
- info.m_stateMask |= wxTREE_STATE_SELECTED ;
- if ( tvItem.state & TVIS_SELECTED )
- info.m_state |= wxTREE_STATE_SELECTED ;
- }
- }
-
- if ( tvItem.mask & TVIF_TEXT )
- {
- info.m_mask |= wxTREE_MASK_TEXT;
- info.m_text = tvItem.pszText;
- }
- if ( tvItem.mask & TVIF_IMAGE )
- {
- info.m_mask |= wxTREE_MASK_IMAGE;
- info.m_image = tvItem.iImage;
- }
- if ( tvItem.mask & TVIF_SELECTEDIMAGE )
- {
- info.m_mask |= wxTREE_MASK_SELECTED_IMAGE;
- info.m_selectedImage = tvItem.iSelectedImage;
- }
- if ( tvItem.mask & TVIF_CHILDREN )
- {
- info.m_mask |= wxTREE_MASK_CHILDREN;
- info.m_children = tvItem.cChildren;
- }
- if ( tvItem.mask & TVIF_PARAM )
- info.m_mask |= wxTREE_MASK_DATA;
-
- if (needText)
- {
- if (tvItem.pszText)
- delete[] tvItem.pszText;
- }
- tvItem.mask = oldMask ;
-}
-
-static void wxConvertToMSWTreeItem(wxTreeItem& info, TV_ITEM& tvItem)
-{
- tvItem.hItem = (HTREEITEM) info.m_itemId ;
-
- tvItem.iImage = info.m_image ;
- tvItem.iSelectedImage = info.m_selectedImage;
- tvItem.cChildren = info.m_children;
- tvItem.lParam = info.m_data;
- tvItem.mask = 0;
- tvItem.stateMask = 0;
- tvItem.state = 0;
-
- if (info.m_mask & wxTREE_MASK_HANDLE)
- tvItem.mask |= TVIF_HANDLE ;
- if (info.m_mask & wxTREE_MASK_STATE)
- tvItem.mask |= TVIF_STATE ;
- if (info.m_mask & wxTREE_MASK_TEXT)
- {
- tvItem.mask |= TVIF_TEXT ;
- tvItem.pszText = (char *) (const char *)info.m_text ;
- if ( tvItem.pszText )
- tvItem.cchTextMax = info.m_text.Length();
- else
- tvItem.cchTextMax = 0;
- }
- if (info.m_mask & wxTREE_MASK_IMAGE)
- tvItem.mask |= TVIF_IMAGE ;
- if (info.m_mask & wxTREE_MASK_SELECTED_IMAGE)
- tvItem.mask |= TVIF_SELECTEDIMAGE ;
- if (info.m_mask & wxTREE_MASK_CHILDREN)
- tvItem.mask |= TVIF_CHILDREN ;
- if (info.m_mask & wxTREE_MASK_DATA)
- tvItem.mask |= TVIF_PARAM ;
-
- if (info.m_stateMask & wxTREE_STATE_BOLD)
- {
- tvItem.stateMask |= TVIS_BOLD ;
- tvItem.state |= TVIS_BOLD;
- }
- if (info.m_stateMask & wxTREE_STATE_CUT)
- {
- tvItem.stateMask |= TVIS_CUT ;
- if ( info.m_state & wxTREE_STATE_CUT )
- tvItem.state |= TVIS_CUT;
- }
- if (info.m_stateMask & wxTREE_STATE_DROPHILITED)
- {
- tvItem.stateMask |= TVIS_DROPHILITED;
- if ( info.m_state & wxTREE_STATE_DROPHILITED )
- tvItem.state |= TVIS_DROPHILITED;
- }
- if (info.m_stateMask & wxTREE_STATE_EXPANDED)
- {
- tvItem.stateMask |= TVIS_EXPANDED;
- if ( info.m_state & wxTREE_STATE_EXPANDED )
- tvItem.state |= TVIS_EXPANDED;
- }
- if (info.m_stateMask & wxTREE_STATE_EXPANDEDONCE)
- {
- tvItem.stateMask |= TVIS_EXPANDEDONCE;
- if ( info.m_state & wxTREE_STATE_EXPANDEDONCE )
- tvItem.state |= TVIS_EXPANDEDONCE;
- }
- if (info.m_stateMask & wxTREE_STATE_FOCUSED)
- {
- tvItem.stateMask |= TVIS_FOCUSED;
- if ( info.m_state & wxTREE_STATE_FOCUSED )
- tvItem.state |= TVIS_FOCUSED;
- }
- if (info.m_stateMask & wxTREE_STATE_SELECTED)
- {
- tvItem.stateMask |= TVIS_SELECTED;
- if ( info.m_state & wxTREE_STATE_SELECTED )
- tvItem.state |= TVIS_SELECTED;
- }
+ *result = !event.IsAllowed();
+
+ return processed;
}
+// ----------------------------------------------------------------------------
// Tree event
-IMPLEMENT_DYNAMIC_CLASS(wxTreeEvent, wxCommandEvent)
+// ----------------------------------------------------------------------------
+
+IMPLEMENT_DYNAMIC_CLASS(wxTreeEvent, wxNotifyEvent)
-wxTreeEvent::wxTreeEvent(wxEventType commandType, int id):
- wxCommandEvent(commandType, id)
+wxTreeEvent::wxTreeEvent(wxEventType commandType, int id)
+ : wxNotifyEvent(commandType, id)
{
- m_code = 0;
- m_oldItem = 0;
+ m_code = 0;
+ m_itemOld = 0;
}
-#endif
+#endif // __WIN95__