]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/treectrl.cpp
compilation fixes for wxUniv (moved wxDlgProc back to toplevel.cpp)
[wxWidgets.git] / src / msw / treectrl.cpp
index d328e047c7ebe6bc6e02992b395072315780f130..ffba0255fa063e8a837280b8d96e7c8f4a39001b 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        treectrl.cpp
+// Name:        src/msw/treectrl.cpp
 // Purpose:     wxTreeCtrl
 // Author:      Julian Smart
 // Modified by: Vadim Zeitlin to be less MSW-specific on 10.10.98
@@ -16,6 +16,7 @@
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
+
 #ifdef __GNUG__
     #pragma implementation "treectrl.h"
 #endif
     #pragma hdrstop
 #endif
 
-#include "wx/window.h"
+#if wxUSE_TREECTRL
+
 #include "wx/msw/private.h"
 
+// Set this to 1 to be _absolutely_ sure that repainting will work for all
+// comctl32.dll versions
+#define wxUSE_COMCTL32_SAFELY 0
+
 // Mingw32 is a bit mental even though this is done in winundef
 #ifdef GetFirstChild
     #undef GetFirstChild
 
 #if defined(__WIN95__)
 
+#include "wx/app.h"
 #include "wx/log.h"
 #include "wx/dynarray.h"
 #include "wx/imaglist.h"
-#include "wx/treectrl.h"
 #include "wx/settings.h"
+#include "wx/msw/treectrl.h"
+#include "wx/msw/dragimag.h"
 
-#ifdef __GNUWIN32__
-#ifndef wxUSE_NORLANDER_HEADERS
-#include "wx/msw/gnuwin32/extra.h"
-#endif
+#ifdef __GNUWIN32_OLD__
+    #include "wx/msw/gnuwin32/extra.h"
 #endif
 
-#if (defined(__WIN95__) && !defined(__GNUWIN32__)) || defined(__TWIN32__) || defined(wxUSE_NORLANDER_HEADERS)
+#if defined(__WIN95__) && !((defined(__GNUWIN32_OLD__) || defined(__TWIN32__)) && !defined(__CYGWIN10__))
     #include <commctrl.h>
 #endif
 
     #define TV_FIRST                0x1100
 #endif
 
+#ifndef TVS_CHECKBOXES
+    #define TVS_CHECKBOXES          0x0100
+#endif
+
+#ifndef TVS_FULLROWSELECT
+    #define TVS_FULLROWSELECT       0x1000
+#endif
+
 // old headers might miss these messages (comctl32.dll 4.71+ only)
 #ifndef TVM_SETBKCOLOR
     #define TVM_SETBKCOLOR          (TV_FIRST + 29)
     #define TVM_SETTEXTCOLOR        (TV_FIRST + 30)
 #endif
 
+// a macro to hide the ugliness of nested casts
+#define HITEM(item)     (HTREEITEM)(WXHTREEITEM)(item)
+
+// the native control doesn't support multiple selections under MSW and we
+// have 2 ways to emulate them: either using TVS_CHECKBOXES style and let
+// checkboxes be the selection status (checked == selected) or by really
+// emulating everything, i.e. intercepting mouse and key events &c. The first
+// approach is much easier but doesn't work with comctl32.dll < 4.71 and also
+// looks quite ugly.
+#define wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE 0
+
+// ----------------------------------------------------------------------------
+// private functions
+// ----------------------------------------------------------------------------
+
+// wrapper for TreeView_HitTest
+static HTREEITEM GetItemFromPoint(HWND hwndTV, int x, int y)
+{
+    TV_HITTESTINFO tvht;
+    tvht.pt.x = x;
+    tvht.pt.y = y;
+
+    return (HTREEITEM)TreeView_HitTest(hwndTV, &tvht);
+}
+
+#if !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
+
+// 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;
+
+    if ( !TreeView_GetItem(hwndTV, &tvi) )
+    {
+        wxLogLastError(wxT("TreeView_GetItem"));
+    }
+
+    return (tvi.state & TVIS_SELECTED) != 0;
+}
+
+static void SelectItem(HWND hwndTV, HTREEITEM hItem, bool select = TRUE)
+{
+    TV_ITEM tvi;
+    tvi.mask = TVIF_STATE | TVIF_HANDLE;
+    tvi.stateMask = TVIS_SELECTED;
+    tvi.state = select ? TVIS_SELECTED : 0;
+    tvi.hItem = hItem;
+
+    if ( TreeView_SetItem(hwndTV, &tvi) == -1 )
+    {
+        wxLogLastError(wxT("TreeView_SetItem"));
+    }
+}
+
+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,
+                        HTREEITEM htFirst,
+                        HTREEITEM htLast,
+                        bool unselectOthers = TRUE)
+{
+    // find the first (or last) item and select it
+    bool cont = TRUE;
+    HTREEITEM htItem = (HTREEITEM)TreeView_GetRoot(hwndTV);
+    while ( htItem && cont )
+    {
+        if ( (htItem == htFirst) || (htItem == htLast) )
+        {
+            if ( !IsItemSelected(hwndTV, htItem) )
+            {
+                SelectItem(hwndTV, htItem);
+            }
+
+            cont = FALSE;
+        }
+        else
+        {
+            if ( unselectOthers && IsItemSelected(hwndTV, htItem) )
+            {
+                UnselectItem(hwndTV, htItem);
+            }
+        }
+
+        htItem = (HTREEITEM)TreeView_GetNextVisible(hwndTV, htItem);
+    }
+
+    // select the items in range
+    cont = htFirst != htLast;
+    while ( htItem && cont )
+    {
+        if ( !IsItemSelected(hwndTV, htItem) )
+        {
+            SelectItem(hwndTV, htItem);
+        }
+
+        cont = (htItem != htFirst) && (htItem != htLast);
+
+        htItem = (HTREEITEM)TreeView_GetNextVisible(hwndTV, htItem);
+    }
+
+    // unselect the rest
+    if ( unselectOthers )
+    {
+        while ( htItem )
+        {
+            if ( IsItemSelected(hwndTV, htItem) )
+            {
+                UnselectItem(hwndTV, htItem);
+            }
+
+            htItem = (HTREEITEM)TreeView_GetNextVisible(hwndTV, htItem);
+        }
+    }
+
+    // seems to be necessary - otherwise the just selected items don't always
+    // appear as selected
+    UpdateWindow(hwndTV);
+}
+
+// helper function which tricks the standard control into changing the focused
+// item without changing anything else (if someone knows why Microsoft doesn't
+// allow to do it by just setting TVIS_FOCUSED flag, please tell me!)
+static void SetFocus(HWND hwndTV, HTREEITEM htItem)
+{
+    // the current focus
+    HTREEITEM htFocus = (HTREEITEM)TreeView_GetSelection(hwndTV);
+
+    if ( htItem )
+    {
+        // set the focus
+        if ( htItem != htFocus )
+        {
+            // remember the selection state of the item
+            bool wasSelected = IsItemSelected(hwndTV, htItem);
+
+            if ( htFocus && IsItemSelected(hwndTV, htFocus) )
+            {
+                // prevent the tree from unselecting the old focus which it
+                // would do by default (TreeView_SelectItem unselects the
+                // focused item)
+                TreeView_SelectItem(hwndTV, 0);
+                SelectItem(hwndTV, htFocus);
+            }
+
+            TreeView_SelectItem(hwndTV, htItem);
+
+            if ( !wasSelected )
+            {
+                // need to clear the selection which TreeView_SelectItem() gave
+                // us
+                UnselectItem(hwndTV, htItem);
+            }
+            //else: was selected, still selected - ok
+        }
+        //else: nothing to do, focus already there
+    }
+    else
+    {
+        if ( htFocus )
+        {
+            bool wasFocusSelected = IsItemSelected(hwndTV, htFocus);
+
+            // just clear the focus
+            TreeView_SelectItem(hwndTV, 0);
+
+            if ( wasFocusSelected )
+            {
+                // restore the selection state
+                SelectItem(hwndTV, htFocus);
+            }
+        }
+        //else: nothing to do, no focus already
+    }
+}
+
+#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
+
 // ----------------------------------------------------------------------------
 // private classes
 // ----------------------------------------------------------------------------
 
 // a convenient wrapper around TV_ITEM struct which adds a ctor
 #ifdef __VISUALC__
-#pragma warning( disable : 4097 )
+#pragma warning( disable : 4097 ) // inheriting from typedef
 #endif
 
 struct wxTreeViewItem : public TV_ITEM
@@ -87,17 +292,48 @@ struct wxTreeViewItem : public TV_ITEM
                    UINT mask_,                  // fields which are valid
                    UINT stateMask_ = 0)         // for TVIF_STATE only
     {
+        wxZeroMemory(*this);
+
         // hItem member is always valid
         mask = mask_ | TVIF_HANDLE;
         stateMask = stateMask_;
-        hItem = (HTREEITEM) (WXHTREEITEM) item;
+        hItem = HITEM(item);
     }
 };
 
+// wxVirutalNode is used in place of a single root when 'hidden' root is
+// specified.
+class wxVirtualNode : public wxTreeViewItem
+{
+public:
+    wxVirtualNode(wxTreeItemData *data)
+        : wxTreeViewItem(TVI_ROOT, 0)
+    {
+        m_data = data;
+    }
+
+    ~wxVirtualNode()
+    {
+        delete m_data;
+    }
+
+    wxTreeItemData *GetData() const { return m_data; }
+    void SetData(wxTreeItemData *data) { delete m_data; m_data = data; }
+
+private:
+    wxTreeItemData *m_data;
+};
+
 #ifdef __VISUALC__
 #pragma warning( default : 4097 )
 #endif
 
+// a macro to get the virtual root, returns NULL if none
+#define GET_VIRTUAL_ROOT() ((wxVirtualNode *)m_pVirtualRoot)
+
+// returns TRUE if the item is the virtual root
+#define IS_VIRTUAL_ROOT(item) (HITEM(item) == TVI_ROOT)
+
 // a class which encapsulates the tree traversal logic: it vists all (unless
 // OnVisit() returns FALSE) items under the given one
 class wxTreeTraversal
@@ -141,7 +377,17 @@ public:
 
     virtual bool OnVisit(const wxTreeItemId& item)
     {
+        // can't visit a virtual node.
+        if ( (GetTree()->GetRootItem() == item) && (GetTree()->GetWindowStyle() & wxTR_HIDE_ROOT))
+        {
+            return TRUE;
+        }
+
+#if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
         if ( GetTree()->IsItemChecked(item) )
+#else
+        if ( ::IsItemSelected(GetHwndOf(GetTree()), HITEM(item)) )
+#endif
         {
             m_selections.Add(item);
         }
@@ -169,7 +415,7 @@ public:
             DoTraverse(root, recursively);
         }
 
-    virtual bool OnVisit(const wxTreeItemId& item)
+    virtual bool OnVisit(const wxTreeItemId& WXUNUSED(item))
     {
         m_count++;
 
@@ -192,11 +438,12 @@ private:
 //
 // There is only one problem with this: when we retrieve the item's data, we
 // don't know whether we get a pointer to wxTreeItemData or
-// wxTreeItemIndirectData. So we have to maintain a list of all items which
-// have indirect data inside the listctrl itself.
+// wxTreeItemIndirectData. So we always set the item id to an invalid value
+// in this class and the code using the client data checks for it and retrieves
+// the real client data in this case.
 // ----------------------------------------------------------------------------
 
-class wxTreeItemIndirectData
+class wxTreeItemIndirectData : public wxTreeItemData
 {
 public:
     // ctor associates this data with the item and the real item data becomes
@@ -213,10 +460,13 @@ public:
 
         // and set ourselves as the new one
         tree->SetIndirectItemData(item, this);
+
+        // we must have the invalid value for the item
+        m_pItem = 0l;
     }
 
     // dtor deletes the associated data as well
-    ~wxTreeItemIndirectData() { delete m_data; }
+    virtual ~wxTreeItemIndirectData() { delete m_data; }
 
     // accessors
         // get the real data associated with the item
@@ -235,25 +485,47 @@ private:
     // all the images associated with the item
     int m_images[wxTreeItemIcon_Max];
 
+    // the real client data
     wxTreeItemData *m_data;
 };
 
 // ----------------------------------------------------------------------------
-// macros
+// wxWin macros
 // ----------------------------------------------------------------------------
 
-    IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl, wxControl)
+IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl, wxControl)
 
 // ----------------------------------------------------------------------------
-// variables
+// constants
 // ----------------------------------------------------------------------------
 
-// handy table for sending events
-static const wxEventType g_events[2][2] =
+// indices in gs_expandEvents table below
+enum
+{
+    IDX_COLLAPSE,
+    IDX_EXPAND,
+    IDX_WHAT_MAX
+};
+
+enum
+{
+    IDX_DONE,
+    IDX_DOING,
+    IDX_HOW_MAX
+};
+
+// handy table for sending events - it has to be initialized during run-time
+// now so can't be const any more
+static /* const */ wxEventType gs_expandEvents[IDX_WHAT_MAX][IDX_HOW_MAX];
+
+/*
+   but logically it's a const table with the following entries:
+=
 {
     { wxEVT_COMMAND_TREE_ITEM_COLLAPSED, wxEVT_COMMAND_TREE_ITEM_COLLAPSING },
     { wxEVT_COMMAND_TREE_ITEM_EXPANDED,  wxEVT_COMMAND_TREE_ITEM_EXPANDING  }
 };
+*/
 
 // ============================================================================
 // implementation
@@ -298,8 +570,19 @@ void wxTreeCtrl::Init()
 {
     m_imageListNormal = NULL;
     m_imageListState = NULL;
+    m_ownsImageListNormal = m_ownsImageListState = FALSE;
     m_textCtrl = NULL;
     m_hasAnyAttr = FALSE;
+    m_dragImage = NULL;
+    m_htSelStart = 0;
+    m_pVirtualRoot = NULL;
+
+    // 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
+    gs_expandEvents[IDX_COLLAPSE][IDX_DONE] = wxEVT_COMMAND_TREE_ITEM_COLLAPSED;
+    gs_expandEvents[IDX_COLLAPSE][IDX_DOING] = wxEVT_COMMAND_TREE_ITEM_COLLAPSING;
+    gs_expandEvents[IDX_EXPAND][IDX_DONE] = wxEVT_COMMAND_TREE_ITEM_EXPANDED;
+    gs_expandEvents[IDX_EXPAND][IDX_DOING] = wxEVT_COMMAND_TREE_ITEM_EXPANDING;
 }
 
 bool wxTreeCtrl::Create(wxWindow *parent,
@@ -316,8 +599,13 @@ bool wxTreeCtrl::Create(wxWindow *parent,
         return FALSE;
 
     DWORD wstyle = WS_VISIBLE | WS_CHILD | WS_TABSTOP |
-                   TVS_HASLINES | TVS_SHOWSELALWAYS;
+                   TVS_SHOWSELALWAYS;
+
+    if ( m_windowStyle & wxCLIP_SIBLINGS )
+        wstyle |= WS_CLIPSIBLINGS;
 
+    if ((m_windowStyle & wxTR_NO_LINES) == 0)
+        wstyle |= TVS_HASLINES;
     if ( m_windowStyle & wxTR_HAS_BUTTONS )
         wstyle |= TVS_HASBUTTONS;
 
@@ -327,21 +615,47 @@ bool wxTreeCtrl::Create(wxWindow *parent,
     if ( m_windowStyle & wxTR_LINES_AT_ROOT )
         wstyle |= TVS_LINESATROOT;
 
-#if !defined( __GNUWIN32__ ) && !defined( __BORLANDC__ ) && !defined( __WATCOMC__ ) && !defined(wxUSE_NORLANDER_HEADERS)
+    if ( m_windowStyle & wxTR_FULL_ROW_HIGHLIGHT )
+    {
+        if ( wxTheApp->GetComCtl32Version() >= 471 )
+            wstyle |= TVS_FULLROWSELECT;
+    }
+
+    // using TVS_CHECKBOXES for emulation of a multiselection tree control
+    // doesn't work without the new enough headers
+#if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE && \
+    !defined( __GNUWIN32_OLD__ ) && \
+    !defined( __BORLANDC__ ) && \
+    !defined( __WATCOMC__ ) && \
+    (!defined(__VISUALC__) || (__VISUALC__ > 1010))
+
     // we emulate the multiple selection tree controls by using checkboxes: set
     // up the image list we need for this if we do have multiple selections
-#if !defined(__VISUALC__) || (__VISUALC__ > 1010)
     if ( m_windowStyle & wxTR_MULTIPLE )
         wstyle |= TVS_CHECKBOXES;
-#endif
-#endif
+#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
 
     // Create the tree control.
     if ( !MSWCreateControl(WC_TREEVIEW, wstyle) )
         return FALSE;
 
-    SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_WINDOW));
+#if wxUSE_COMCTL32_SAFELY
+    wxWindow::SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
+    wxWindow::SetForegroundColour(wxWindow::GetParent()->GetForegroundColour());
+#elif 1
+    SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
+    SetForegroundColour(wxWindow::GetParent()->GetForegroundColour());
+#else
+    // This works around a bug in the Windows tree control whereby for some versions
+    // of comctrl32, setting any colour actually draws the background in black.
+    // This will initialise the background to the system colour.
+    // THIS FIX NOW REVERTED since it caused problems on _other_ systems.
+    // Assume the user has an updated comctl32.dll.
+    ::SendMessage(GetHwnd(), TVM_SETBKCOLOR, 0,-1);
+    wxWindow::SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
     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.
@@ -416,7 +730,11 @@ wxTreeCtrl::~wxTreeCtrl()
     DeleteTextCtrl();
 
     // delete user data to prevent memory leaks
+    // also deletes hidden root node storage.
     DeleteAllItems();
+
+    if (m_ownsImageListNormal) delete m_imageListNormal;
+    if (m_ownsImageListState) delete m_imageListState;
 }
 
 // ----------------------------------------------------------------------------
@@ -427,9 +745,12 @@ wxTreeCtrl::~wxTreeCtrl()
 
 bool wxTreeCtrl::DoGetItem(wxTreeViewItem* tvItem) const
 {
+    wxCHECK_MSG( tvItem->hItem != TVI_ROOT, FALSE,
+                 _T("can't retrieve virtual root item") );
+
     if ( !TreeView_GetItem(GetHwnd(), tvItem) )
     {
-        wxLogLastError("TreeView_GetItem");
+        wxLogLastError(wxT("TreeView_GetItem"));
 
         return FALSE;
     }
@@ -441,7 +762,7 @@ void wxTreeCtrl::DoSetItem(wxTreeViewItem* tvItem)
 {
     if ( TreeView_SetItem(GetHwnd(), tvItem) == -1 )
     {
-        wxLogLastError("TreeView_SetItem");
+        wxLogLastError(wxT("TreeView_SetItem"));
     }
 }
 
@@ -480,12 +801,30 @@ void wxTreeCtrl::SetAnyImageList(wxImageList *imageList, int which)
 
 void wxTreeCtrl::SetImageList(wxImageList *imageList)
 {
+    if (m_ownsImageListNormal)
+        delete m_imageListNormal;
+
     SetAnyImageList(m_imageListNormal = imageList, TVSIL_NORMAL);
+    m_ownsImageListNormal = FALSE;
 }
 
 void wxTreeCtrl::SetStateImageList(wxImageList *imageList)
 {
+    if (m_ownsImageListState) delete m_imageListState;
     SetAnyImageList(m_imageListState = imageList, TVSIL_STATE);
+    m_ownsImageListState = FALSE;
+}
+
+void wxTreeCtrl::AssignImageList(wxImageList *imageList)
+{
+    SetImageList(imageList);
+    m_ownsImageListNormal = TRUE;
+}
+
+void wxTreeCtrl::AssignStateImageList(wxImageList *imageList)
+{
+    SetStateImageList(imageList);
+    m_ownsImageListState = TRUE;
 }
 
 size_t wxTreeCtrl::GetChildrenCount(const wxTreeItemId& item,
@@ -502,20 +841,24 @@ size_t wxTreeCtrl::GetChildrenCount(const wxTreeItemId& item,
 
 bool wxTreeCtrl::SetBackgroundColour(const wxColour &colour)
 {
+#if !wxUSE_COMCTL32_SAFELY
     if ( !wxWindowBase::SetBackgroundColour(colour) )
         return FALSE;
 
     SendMessage(GetHwnd(), TVM_SETBKCOLOR, 0, colour.GetPixel());
+#endif
 
     return TRUE;
 }
 
 bool wxTreeCtrl::SetForegroundColour(const wxColour &colour)
 {
+#if !wxUSE_COMCTL32_SAFELY
     if ( !wxWindowBase::SetForegroundColour(colour) )
         return FALSE;
 
     SendMessage(GetHwnd(), TVM_SETTEXTCOLOR, 0, colour.GetPixel());
+#endif
 
     return TRUE;
 }
@@ -542,9 +885,26 @@ wxString wxTreeCtrl::GetItemText(const wxTreeItemId& item) const
 
 void wxTreeCtrl::SetItemText(const wxTreeItemId& item, const wxString& text)
 {
+    if ( IS_VIRTUAL_ROOT(item) )
+        return;
+
     wxTreeViewItem tvItem(item, TVIF_TEXT);
     tvItem.pszText = (wxChar *)text.c_str();  // conversion is ok
     DoSetItem(&tvItem);
+
+    // when setting the text of the item being edited, the text control should
+    // be updated to reflect the new text as well, otherwise calling
+    // SetItemText() in the OnBeginLabelEdit() handler doesn't have any effect
+    //
+    // don't use GetEditControl() here because m_textCtrl is not set yet
+    HWND hwndEdit = TreeView_GetEditControl(GetHwnd());
+    if ( hwndEdit )
+    {
+        if ( item == GetSelection() )
+        {
+            ::SetWindowText(hwndEdit, text);
+        }
+    }
 }
 
 int wxTreeCtrl::DoGetItemImageFromData(const wxTreeItemId& item,
@@ -600,6 +960,12 @@ void wxTreeCtrl::DoSetItemImages(const wxTreeItemId& item,
 int wxTreeCtrl::GetItemImage(const wxTreeItemId& item,
                              wxTreeItemIcon which) const
 {
+    if ( (HITEM(item) == TVI_ROOT) && (m_windowStyle & wxTR_HIDE_ROOT) )
+    {
+        // TODO: Maybe a hidden root can still provide images?
+        return -1;
+    }
+
     if ( HasIndirectData(item) )
     {
         return DoGetItemImageFromData(item, which);
@@ -633,6 +999,12 @@ int wxTreeCtrl::GetItemImage(const wxTreeItemId& item,
 void wxTreeCtrl::SetItemImage(const wxTreeItemId& item, int image,
                               wxTreeItemIcon which)
 {
+    if ( IS_VIRTUAL_ROOT(item) )
+    {
+        // TODO: Maybe a hidden root can still store images?
+        return;
+    }
+
     int imageNormal, imageSel;
     switch ( which )
     {
@@ -686,23 +1058,41 @@ void wxTreeCtrl::SetItemImage(const wxTreeItemId& item, int image,
 wxTreeItemData *wxTreeCtrl::GetItemData(const wxTreeItemId& item) const
 {
     wxTreeViewItem tvItem(item, TVIF_PARAM);
-    if ( !DoGetItem(&tvItem) )
+
+    // Hidden root may have data.
+    if ( IS_VIRTUAL_ROOT(item) )
     {
-        return NULL;
+        return GET_VIRTUAL_ROOT()->GetData();
     }
 
-    if ( HasIndirectData(item) )
+    // Visible node.
+    if ( !DoGetItem(&tvItem) )
     {
-        return ((wxTreeItemIndirectData *)tvItem.lParam)->GetData();
+        return NULL;
     }
-    else
+
+    wxTreeItemData *data = (wxTreeItemData *)tvItem.lParam;
+    if ( IsDataIndirect(data) )
     {
-        return (wxTreeItemData *)tvItem.lParam;
+        data = ((wxTreeItemIndirectData *)data)->GetData();
     }
+
+    return data;
 }
 
 void wxTreeCtrl::SetItemData(const wxTreeItemId& item, wxTreeItemData *data)
 {
+    if ( IS_VIRTUAL_ROOT(item) )
+    {
+        GET_VIRTUAL_ROOT()->SetData(data);
+    }
+
+    // first, associate this piece of data with this item
+    if ( data )
+    {
+        data->SetId(item);
+    }
+
     wxTreeViewItem tvItem(item, TVIF_PARAM);
 
     if ( HasIndirectData(item) )
@@ -732,18 +1122,28 @@ void wxTreeCtrl::SetIndirectItemData(const wxTreeItemId& item,
     // wxTreeItemIndirectData as well
     wxASSERT_MSG( !HasIndirectData(item), wxT("setting indirect data twice?") );
 
-    SetItemData(item, (wxTreeItemData *)data);
-
-    m_itemsWithIndirectData.Add(item);
+    SetItemData(item, data);
 }
 
 bool wxTreeCtrl::HasIndirectData(const wxTreeItemId& item) const
 {
-    return m_itemsWithIndirectData.Index(item) != wxNOT_FOUND;
+    // query the item itself
+    wxTreeViewItem tvItem(item, TVIF_PARAM);
+    if ( !DoGetItem(&tvItem) )
+    {
+        return FALSE;
+    }
+
+    wxTreeItemData *data = (wxTreeItemData *)tvItem.lParam;
+
+    return data && IsDataIndirect(data);
 }
 
 void wxTreeCtrl::SetItemHasChildren(const wxTreeItemId& item, bool has)
 {
+    if ( IS_VIRTUAL_ROOT(item) )
+        return;
+
     wxTreeViewItem tvItem(item, TVIF_CHILDREN);
     tvItem.cChildren = (int)has;
     DoSetItem(&tvItem);
@@ -751,6 +1151,9 @@ void wxTreeCtrl::SetItemHasChildren(const wxTreeItemId& item, bool has)
 
 void wxTreeCtrl::SetItemBold(const wxTreeItemId& item, bool bold)
 {
+    if ( IS_VIRTUAL_ROOT(item) )
+        return;
+
     wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_BOLD);
     tvItem.state = bold ? TVIS_BOLD : 0;
     DoSetItem(&tvItem);
@@ -758,11 +1161,26 @@ void wxTreeCtrl::SetItemBold(const wxTreeItemId& item, bool bold)
 
 void wxTreeCtrl::SetItemDropHighlight(const wxTreeItemId& item, bool highlight)
 {
+    if ( IS_VIRTUAL_ROOT(item) )
+        return;
+
     wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_DROPHILITED);
     tvItem.state = highlight ? TVIS_DROPHILITED : 0;
     DoSetItem(&tvItem);
 }
 
+void wxTreeCtrl::RefreshItem(const wxTreeItemId& item)
+{
+    if ( IS_VIRTUAL_ROOT(item) )
+        return;
+
+    wxRect rect;
+    if ( GetBoundingRect(item, rect) )
+    {
+        RefreshRect(rect);
+    }
+}
+
 void wxTreeCtrl::SetItemTextColour(const wxTreeItemId& item,
                                    const wxColour& col)
 {
@@ -777,6 +1195,8 @@ void wxTreeCtrl::SetItemTextColour(const wxTreeItemId& item,
     }
 
     attr->SetTextColour(col);
+
+    RefreshItem(item);
 }
 
 void wxTreeCtrl::SetItemBackgroundColour(const wxTreeItemId& item,
@@ -793,6 +1213,8 @@ void wxTreeCtrl::SetItemBackgroundColour(const wxTreeItemId& item,
     }
 
     attr->SetBackgroundColour(col);
+
+    RefreshItem(item);
 }
 
 void wxTreeCtrl::SetItemFont(const wxTreeItemId& item, const wxFont& font)
@@ -808,6 +1230,8 @@ void wxTreeCtrl::SetItemFont(const wxTreeItemId& item, const wxFont& font)
     }
 
     attr->SetFont(font);
+
+    RefreshItem(item);
 }
 
 // ----------------------------------------------------------------------------
@@ -825,7 +1249,6 @@ bool wxTreeCtrl::IsVisible(const wxTreeItemId& item) const
 
     // FALSE means get item rect for the whole item, not only text
     return SendMessage(GetHwnd(), TVM_GETITEMRECT, FALSE, (LPARAM)&rect) != 0;
-
 }
 
 bool wxTreeCtrl::ItemHasChildren(const wxTreeItemId& item) const
@@ -869,12 +1292,16 @@ bool wxTreeCtrl::IsBold(const wxTreeItemId& item) const
 
 wxTreeItemId wxTreeCtrl::GetRootItem() const
 {
+    // Root may be real (visible) or virtual (hidden).
+    if ( GET_VIRTUAL_ROOT() )
+        return TVI_ROOT;
+
     return wxTreeItemId((WXHTREEITEM) TreeView_GetRoot(GetHwnd()));
 }
 
 wxTreeItemId wxTreeCtrl::GetSelection() const
 {
-    wxCHECK_MSG( !(m_windowStyle & wxTR_MULTIPLE), (WXHTREEITEM)0,
+    wxCHECK_MSG( !(m_windowStyle & wxTR_MULTIPLE), (long)(WXHTREEITEM)0,
                  wxT("this only works with single selection controls") );
 
     return wxTreeItemId((WXHTREEITEM) TreeView_GetSelection(GetHwnd()));
@@ -882,14 +1309,31 @@ wxTreeItemId wxTreeCtrl::GetSelection() const
 
 wxTreeItemId wxTreeCtrl::GetParent(const wxTreeItemId& item) const
 {
-    return wxTreeItemId((WXHTREEITEM) TreeView_GetParent(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item));
+    HTREEITEM hItem;
+
+    if ( IS_VIRTUAL_ROOT(item) )
+    {
+        // no parent for the virtual root
+        hItem = 0;
+    }
+    else // normal item
+    {
+        hItem = TreeView_GetParent(GetHwnd(), HITEM(item));
+        if ( !hItem && HasFlag(wxTR_HIDE_ROOT) )
+        {
+            // the top level items should have the virtual root as their parent
+            hItem = TVI_ROOT;
+        }
+    }
+
+    return wxTreeItemId((WXHTREEITEM)hItem);
 }
 
 wxTreeItemId wxTreeCtrl::GetFirstChild(const wxTreeItemId& item,
                                        long& _cookie) const
 {
     // remember the last child returned in 'cookie'
-    _cookie = (long)TreeView_GetChild(GetHwnd(), (HTREEITEM) (WXHTREEITEM)item);
+    _cookie = (long)TreeView_GetChild(GetHwnd(), HITEM(item));
 
     return wxTreeItemId((WXHTREEITEM)_cookie);
 }
@@ -898,7 +1342,7 @@ wxTreeItemId wxTreeCtrl::GetNextChild(const wxTreeItemId& WXUNUSED(item),
                                       long& _cookie) const
 {
     wxTreeItemId l = wxTreeItemId((WXHTREEITEM)TreeView_GetNextSibling(GetHwnd(),
-                                   (HTREEITEM)(WXHTREEITEM)_cookie));
+                                   HITEM(_cookie)));
     _cookie = (long)l;
 
     return l;
@@ -922,12 +1366,12 @@ wxTreeItemId wxTreeCtrl::GetLastChild(const wxTreeItemId& item) const
 
 wxTreeItemId wxTreeCtrl::GetNextSibling(const wxTreeItemId& item) const
 {
-    return wxTreeItemId((WXHTREEITEM) TreeView_GetNextSibling(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item));
+    return wxTreeItemId((WXHTREEITEM) TreeView_GetNextSibling(GetHwnd(), HITEM(item)));
 }
 
 wxTreeItemId wxTreeCtrl::GetPrevSibling(const wxTreeItemId& item) const
 {
-    return wxTreeItemId((WXHTREEITEM) TreeView_GetPrevSibling(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item));
+    return wxTreeItemId((WXHTREEITEM) TreeView_GetPrevSibling(GetHwnd(), HITEM(item)));
 }
 
 wxTreeItemId wxTreeCtrl::GetFirstVisibleItem() const
@@ -937,18 +1381,16 @@ wxTreeItemId wxTreeCtrl::GetFirstVisibleItem() const
 
 wxTreeItemId wxTreeCtrl::GetNextVisible(const wxTreeItemId& item) const
 {
-    wxASSERT_MSG( IsVisible(item), wxT("The item you call GetNextVisible() "
-                                      "for must be visible itself!"));
+    wxASSERT_MSG( IsVisible(item), wxT("The item you call GetNextVisible() for must be visible itself!"));
 
-    return wxTreeItemId((WXHTREEITEM) TreeView_GetNextVisible(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item));
+    return wxTreeItemId((WXHTREEITEM) TreeView_GetNextVisible(GetHwnd(), HITEM(item)));
 }
 
 wxTreeItemId wxTreeCtrl::GetPrevVisible(const wxTreeItemId& item) const
 {
-    wxASSERT_MSG( IsVisible(item), wxT("The item you call GetPrevVisible() "
-                                      "for must be visible itself!"));
+    wxASSERT_MSG( IsVisible(item), wxT("The item you call GetPrevVisible() for must be visible itself!"));
 
-    return wxTreeItemId((WXHTREEITEM) TreeView_GetPrevVisible(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item));
+    return wxTreeItemId((WXHTREEITEM) TreeView_GetPrevVisible(GetHwnd(), HITEM(item)));
 }
 
 // ----------------------------------------------------------------------------
@@ -970,6 +1412,8 @@ void wxTreeCtrl::SetItemCheck(const wxTreeItemId& item, bool check)
     // receive the desired information.
     wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_STATEIMAGEMASK);
 
+    DoGetItem(&tvItem);
+
     // state images are one-based
     tvItem.state = (check ? 2 : 1) << 12;
 
@@ -993,9 +1437,13 @@ wxTreeItemId wxTreeCtrl::DoInsertItem(const wxTreeItemId& parent,
                                       int image, int selectedImage,
                                       wxTreeItemData *data)
 {
+    wxCHECK_MSG( parent.IsOk() || !TreeView_GetRoot(GetHwnd()),
+                 wxTreeItemId(),
+                 _T("can't have more than one root in the tree") );
+
     TV_INSERTSTRUCT tvIns;
-    tvIns.hParent = (HTREEITEM) (WXHTREEITEM)parent;
-    tvIns.hInsertAfter = (HTREEITEM) (WXHTREEITEM) hInsertAfter;
+    tvIns.hParent = HITEM(parent);
+    tvIns.hInsertAfter = HITEM(hInsertAfter);
 
     // this is how we insert the item as the first child: supply a NULL
     // hInsertAfter
@@ -1010,6 +1458,11 @@ wxTreeItemId wxTreeCtrl::DoInsertItem(const wxTreeItemId& parent,
         mask |= TVIF_TEXT;
         tvIns.item.pszText = (wxChar *)text.c_str();  // cast is ok
     }
+    else
+    {
+        tvIns.item.pszText = NULL;
+        tvIns.item.cchTextMax = 0;
+    }
 
     if ( image != -1 )
     {
@@ -1040,7 +1493,7 @@ wxTreeItemId wxTreeCtrl::DoInsertItem(const wxTreeItemId& parent,
     HTREEITEM id = (HTREEITEM) TreeView_InsertItem(GetHwnd(), &tvIns);
     if ( id == 0 )
     {
-        wxLogLastError("TreeView_InsertItem");
+        wxLogLastError(wxT("TreeView_InsertItem"));
     }
 
     if ( data != NULL )
@@ -1066,7 +1519,16 @@ wxTreeItemId wxTreeCtrl::AddRoot(const wxString& text,
                                  int image, int selectedImage,
                                  wxTreeItemData *data)
 {
-    return DoInsertItem(wxTreeItemId((WXHTREEITEM) 0), (WXHTREEITEM) 0,
+
+    if ( m_windowStyle & wxTR_HIDE_ROOT )
+    {
+        // create a virtual root item, the parent for all the others
+        m_pVirtualRoot = new wxVirtualNode(data);
+
+        return TVI_ROOT;
+    }
+
+    return DoInsertItem(wxTreeItemId((long)(WXHTREEITEM) 0), (long)(WXHTREEITEM) 0,
                         text, image, selectedImage, data);
 }
 
@@ -1123,9 +1585,9 @@ wxTreeItemId wxTreeCtrl::AppendItem(const wxTreeItemId& parent,
 
 void wxTreeCtrl::Delete(const wxTreeItemId& item)
 {
-    if ( !TreeView_DeleteItem(GetHwnd(), (HTREEITEM)(WXHTREEITEM)item) )
+    if ( !TreeView_DeleteItem(GetHwnd(), HITEM(item)) )
     {
-        wxLogLastError("TreeView_DeleteItem");
+        wxLogLastError(wxT("TreeView_DeleteItem"));
     }
 }
 
@@ -1148,16 +1610,19 @@ void wxTreeCtrl::DeleteChildren(const wxTreeItemId& item)
     {
         if ( !TreeView_DeleteItem(GetHwnd(), (HTREEITEM)children[n]) )
         {
-            wxLogLastError("TreeView_DeleteItem");
+            wxLogLastError(wxT("TreeView_DeleteItem"));
         }
     }
 }
 
 void wxTreeCtrl::DeleteAllItems()
 {
+    // delete stored root item.
+    delete GET_VIRTUAL_ROOT();
+
     if ( !TreeView_DeleteAllItems(GetHwnd()) )
     {
-        wxLogLastError("TreeView_DeleteAllItems");
+        wxLogLastError(wxT("TreeView_DeleteAllItems"));
     }
 }
 
@@ -1169,6 +1634,10 @@ void wxTreeCtrl::DoExpand(const wxTreeItemId& item, int flag)
                   flag == TVE_TOGGLE,
                   wxT("Unknown flag in wxTreeCtrl::DoExpand") );
 
+    // A hidden root can be neither expanded nor collapsed.
+    wxCHECK_RET( !(m_windowStyle & wxTR_HIDE_ROOT) || (HITEM(item) != TVI_ROOT),
+                 wxT("Can't expand/collapse hidden root node!") )
+
     // 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
@@ -1181,21 +1650,19 @@ void wxTreeCtrl::DoExpand(const wxTreeItemId& item, int flag)
     tvItem.state = 0;
     DoSetItem(&tvItem);
 
-    if ( TreeView_Expand(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item, flag) != 0 )
+    if ( TreeView_Expand(GetHwnd(), HITEM(item), flag) != 0 )
     {
         wxTreeEvent event(wxEVT_NULL, m_windowId);
         event.m_item = item;
-
-        bool isExpanded = IsExpanded(item);
-
         event.SetEventObject(this);
 
-        // FIXME return value of {EXPAND|COLLAPS}ING event handler is discarded
-        event.SetEventType(g_events[isExpanded][TRUE]);
-        GetEventHandler()->ProcessEvent(event);
+        // note that the {EXPAND|COLLAPS}ING event is sent by TreeView_Expand()
+        // itself
+        event.SetEventType(gs_expandEvents[IsExpanded(item) ? IDX_EXPAND
+                                                            : IDX_COLLAPSE]
+                                          [IDX_DONE]);
 
-        event.SetEventType(g_events[isExpanded][FALSE]);
-        GetEventHandler()->ProcessEvent(event);
+        (void)GetEventHandler()->ProcessEvent(event);
     }
     //else: change didn't took place, so do nothing at all
 }
@@ -1227,10 +1694,11 @@ void wxTreeCtrl::ExpandItem(const wxTreeItemId& item, int action)
 
 void wxTreeCtrl::Unselect()
 {
-    wxASSERT_MSG( !(m_windowStyle & wxTR_MULTIPLE), wxT("doesn't make sense") );
+    wxASSERT_MSG( !(m_windowStyle & wxTR_MULTIPLE),
+                  wxT("doesn't make sense, may be you want UnselectAll()?") );
 
     // just remove the selection
-    SelectItem(wxTreeItemId((WXHTREEITEM) 0));
+    SelectItem(wxTreeItemId((long) (WXHTREEITEM) 0));
 }
 
 void wxTreeCtrl::UnselectAll()
@@ -1241,7 +1709,11 @@ void wxTreeCtrl::UnselectAll()
         size_t count = GetSelections(selections);
         for ( size_t n = 0; n < count; n++ )
         {
+#if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
             SetItemCheck(selections[n], FALSE);
+#else // !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
+            ::UnselectItem(GetHwnd(), HITEM(selections[n]));
+#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE/!wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
         }
     }
     else
@@ -1255,8 +1727,12 @@ void wxTreeCtrl::SelectItem(const wxTreeItemId& item)
 {
     if ( m_windowStyle & wxTR_MULTIPLE )
     {
+#if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
         // selecting the item means checking it
         SetItemCheck(item);
+#else // !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
+        ::SelectItem(GetHwnd(), HITEM(item));
+#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE/!wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
     }
     else
     {
@@ -1271,9 +1747,9 @@ void wxTreeCtrl::SelectItem(const wxTreeItemId& item)
         event.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGING);
         if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
         {
-            if ( !TreeView_SelectItem(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item) )
+            if ( !TreeView_SelectItem(GetHwnd(), HITEM(item)) )
             {
-                wxLogLastError("TreeView_SelectItem");
+                wxLogLastError(wxT("TreeView_SelectItem"));
             }
             else
             {
@@ -1288,18 +1764,18 @@ void wxTreeCtrl::SelectItem(const wxTreeItemId& item)
 void wxTreeCtrl::EnsureVisible(const wxTreeItemId& item)
 {
     // no error return
-    TreeView_EnsureVisible(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item);
+    TreeView_EnsureVisible(GetHwnd(), HITEM(item));
 }
 
 void wxTreeCtrl::ScrollTo(const wxTreeItemId& item)
 {
-    if ( !TreeView_SelectSetFirstVisible(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item) )
+    if ( !TreeView_SelectSetFirstVisible(GetHwnd(), HITEM(item)) )
     {
-        wxLogLastError("TreeView_SelectSetFirstVisible");
+        wxLogLastError(wxT("TreeView_SelectSetFirstVisible"));
     }
 }
 
-wxTextCtrlwxTreeCtrl::GetEditControl() const
+wxTextCtrl *wxTreeCtrl::GetEditControl() const
 {
     return m_textCtrl;
 }
@@ -1308,6 +1784,14 @@ void wxTreeCtrl::DeleteTextCtrl()
 {
     if ( m_textCtrl )
     {
+        // the HWND corresponding to this control is deleted by the tree
+        // control itself and we don't know when exactly this happens, so check
+        // if the window still exists before calling UnsubclassWin()
+        if ( !::IsWindow(GetHwndOf(m_textCtrl)) )
+        {
+            m_textCtrl->SetHWND(0);
+        }
+
         m_textCtrl->UnsubclassWin();
         m_textCtrl->SetHWND(0);
         delete m_textCtrl;
@@ -1320,26 +1804,26 @@ wxTextCtrl* wxTreeCtrl::EditLabel(const wxTreeItemId& item,
 {
     wxASSERT( textControlClass->IsKindOf(CLASSINFO(wxTextCtrl)) );
 
-    HWND hWnd = (HWND) TreeView_EditLabel(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item);
+    DeleteTextCtrl();
+
+    m_textCtrl = (wxTextCtrl *)textControlClass->CreateObject();
+    HWND hWnd = (HWND) TreeView_EditLabel(GetHwnd(), HITEM(item));
 
     // this is not an error - the TVN_BEGINLABELEDIT handler might have
     // returned FALSE
     if ( !hWnd )
     {
+        delete m_textCtrl;
+        m_textCtrl = NULL;
         return NULL;
     }
 
-    DeleteTextCtrl();
-
-    m_textCtrl = (wxTextCtrl *)textControlClass->CreateObject();
-    m_textCtrl->SetHWND((WXHWND)hWnd);
-    m_textCtrl->SubclassWin((WXHWND)hWnd);
-
+    // textctrl is subclassed in MSWOnNotify
     return m_textCtrl;
 }
 
 // End label editing, optionally cancelling the edit
-void wxTreeCtrl::EndEditLabel(const wxTreeItemId& item, bool discardChanges)
+void wxTreeCtrl::EndEditLabel(const wxTreeItemId& WXUNUSED(item), bool discardChanges)
 {
     TreeView_EndEditLabelNow(GetHwnd(), discardChanges);
 
@@ -1382,7 +1866,7 @@ bool wxTreeCtrl::GetBoundingRect(const wxTreeItemId& item,
                                  bool textOnly) const
 {
     RECT rc;
-    if ( TreeView_GetItemRect(GetHwnd(), (HTREEITEM)(WXHTREEITEM)item,
+    if ( TreeView_GetItemRect(GetHwnd(), HITEM(item),
                               &rc, textOnly) )
     {
         rect = wxRect(wxPoint(rc.left, rc.top), wxPoint(rc.right, rc.bottom));
@@ -1400,14 +1884,37 @@ bool wxTreeCtrl::GetBoundingRect(const wxTreeItemId& item,
 // sorting stuff
 // ----------------------------------------------------------------------------
 
-static int CALLBACK TreeView_CompareCallback(wxTreeItemData *pItem1,
-                                             wxTreeItemData *pItem2,
-                                             wxTreeCtrl *tree)
+// this is just a tiny namespace which is friend to wxTreeCtrl and so can use
+// functions such as IsDataIndirect()
+class wxTreeSortHelper
+{
+public:
+    static int CALLBACK Compare(LPARAM data1, LPARAM data2, LPARAM tree);
+
+private:
+    static wxTreeItemId GetIdFromData(wxTreeCtrl *tree, LPARAM item)
+    {
+        wxTreeItemData *data = (wxTreeItemData *)item;
+        if ( tree->IsDataIndirect(data) )
+        {
+            data = ((wxTreeItemIndirectData *)data)->GetData();
+        }
+
+        return data->GetId();
+    }
+};
+
+int CALLBACK wxTreeSortHelper::Compare(LPARAM pItem1,
+                                       LPARAM pItem2,
+                                       LPARAM htree)
 {
     wxCHECK_MSG( pItem1 && pItem2, 0,
                  wxT("sorting tree without data doesn't make sense") );
 
-    return tree->OnCompareItems(pItem1->GetId(), pItem2->GetId());
+    wxTreeCtrl *tree = (wxTreeCtrl *)htree;
+
+    return tree->OnCompareItems(GetIdFromData(tree, pItem1),
+                                GetIdFromData(tree, pItem2));
 }
 
 int wxTreeCtrl::OnCompareItems(const wxTreeItemId& item1,
@@ -1423,13 +1930,13 @@ void wxTreeCtrl::SortChildren(const wxTreeItemId& item)
     // directly if we're not in derived class (much more efficient!)
     if ( GetClassInfo() == CLASSINFO(wxTreeCtrl) )
     {
-        TreeView_SortChildren(GetHwnd(), (HTREEITEM)(WXHTREEITEM)item, 0);
+        TreeView_SortChildren(GetHwnd(), HITEM(item), 0);
     }
     else
     {
         TV_SORTCB tvSort;
-        tvSort.hParent = (HTREEITEM)(WXHTREEITEM)item;
-        tvSort.lpfnCompare = (PFNTVCOMPARE)TreeView_CompareCallback;
+        tvSort.hParent = HITEM(item);
+        tvSort.lpfnCompare = wxTreeSortHelper::Compare;
         tvSort.lParam = (LPARAM)this;
         TreeView_SortChildrenCB(GetHwnd(), &tvSort, 0 /* reserved */);
     }
@@ -1463,34 +1970,220 @@ bool wxTreeCtrl::MSWCommand(WXUINT cmd, WXWORD id)
     return TRUE;
 }
 
-// process WM_NOTIFY Windows message
-bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
+// 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
+long wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 {
-    wxTreeEvent event(wxEVT_NULL, m_windowId);
-    wxEventType eventType = wxEVT_NULL;
-    NMHDR *hdr = (NMHDR *)lParam;
+    bool processed = FALSE;
+    long rc = 0;
+    bool isMultiple = (GetWindowStyle() & wxTR_MULTIPLE) != 0;
 
-    switch ( hdr->code )
+    if ( (nMsg >= WM_MOUSEFIRST) && (nMsg <= WM_MOUSELAST) )
     {
-        case NM_RCLICK:
-            {
-                if ( wxControl::MSWOnNotify(idCtrl, lParam, result) )
-                    return TRUE;
+        // we only process mouse messages here and these parameters have the same
+        // meaning for all of them
+        int x = GET_X_LPARAM(lParam),
+            y = GET_Y_LPARAM(lParam);
+        HTREEITEM htItem = GetItemFromPoint(GetHwnd(), x, y);
 
-                TV_HITTESTINFO tvhti;
-                ::GetCursorPos(&(tvhti.pt));
-                ::ScreenToClient(GetHwnd(),&(tvhti.pt));
-                if ( TreeView_HitTest(GetHwnd(),&tvhti) )
+        switch ( nMsg )
+        {
+#if !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
+            case WM_LBUTTONDOWN:
+                if ( htItem && isMultiple )
                 {
-                    if( tvhti.flags & TVHT_ONITEM )
+                    if ( wParam & MK_CONTROL )
                     {
-                        event.m_item = (WXHTREEITEM) tvhti.hItem;
-                        eventType = wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK;
+                        SetFocus();
+
+                        // toggle selected state
+                        ToggleItemSelection(GetHwnd(), htItem);
+
+                        ::SetFocus(GetHwnd(), htItem);
+
+                        // reset on any click without Shift
+                        m_htSelStart = 0;
+
+                        processed = TRUE;
+                    }
+                    else if ( wParam & MK_SHIFT )
+                    {
+                        // this selects all items between the starting one and
+                        // the current
+
+                        if ( !m_htSelStart )
+                        {
+                            // take the focused item
+                            m_htSelStart = (WXHTREEITEM)
+                                TreeView_GetSelection(GetHwnd());
+                        }
+
+                        SelectRange(GetHwnd(), HITEM(m_htSelStart), htItem,
+                                    !(wParam & MK_CONTROL));
+
+                        ::SetFocus(GetHwnd(), htItem);
+
+                        processed = TRUE;
+                    }
+                    else // normal click
+                    {
+                        // clear the selection and then let the default handler
+                        // do the job
+                        UnselectAll();
+
+                        // prevent the click from starting in-place editing
+                        // when there was no selection in the control
+                        TreeView_SelectItem(GetHwnd(), 0);
+
+                        // reset on any click without Shift
+                        m_htSelStart = 0;
                     }
                 }
+                break;
+#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
+
+            case WM_MOUSEMOVE:
+                if ( m_dragImage )
+                {
+                    m_dragImage->Move(wxPoint(x, y));
+                    if ( htItem )
+                    {
+                        // highlight the item as target (hiding drag image is
+                        // necessary - otherwise the display will be corrupted)
+                        m_dragImage->Hide();
+                        TreeView_SelectDropTarget(GetHwnd(), htItem);
+                        m_dragImage->Show();
+                    }
+                }
+                break;
+
+            case WM_LBUTTONUP:
+            case WM_RBUTTONUP:
+                if ( m_dragImage )
+                {
+                    m_dragImage->EndDrag();
+                    delete m_dragImage;
+                    m_dragImage = NULL;
+
+                    // generate the drag end event
+                    wxTreeEvent event(wxEVT_COMMAND_TREE_END_DRAG, m_windowId);
+
+                    event.m_item = (WXHTREEITEM)htItem;
+                    event.m_pointDrag = wxPoint(x, y);
+                    event.SetEventObject(this);
+
+                    (void)GetEventHandler()->ProcessEvent(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);
+                }
+                break;
+        }
+    }
+#if !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
+    else if ( (nMsg == WM_SETFOCUS || nMsg == WM_KILLFOCUS) && isMultiple )
+    {
+        // the tree control greys out the selected item when it loses focus and
+        // 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++ )
+        {
+            // 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);
             }
-            break;
+        }
+    }
+    else if ( nMsg == WM_KEYDOWN && isMultiple )
+    {
+        bool bCtrl = wxIsCtrlDown(),
+             bShift = wxIsShiftDown();
+
+        // we handle.arrows and space, but not page up/down and home/end: the
+        // latter should be easy, but not the former
 
+        HTREEITEM htSel = (HTREEITEM)TreeView_GetSelection(GetHwnd());
+        if ( !m_htSelStart )
+        {
+            m_htSelStart = (WXHTREEITEM)htSel;
+        }
+
+        if ( wParam == VK_SPACE )
+        {
+            if ( bCtrl )
+            {
+                ToggleItemSelection(GetHwnd(), htSel);
+            }
+            else
+            {
+                UnselectAll();
+
+                ::SelectItem(GetHwnd(), htSel);
+            }
+
+            processed = TRUE;
+        }
+        else if ( wParam == VK_UP || wParam == 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)(wParam == VK_UP
+                                    ? TreeView_GetPrevVisible(GetHwnd(), htSel)
+                                    : TreeView_GetNextVisible(GetHwnd(), htSel));
+
+                if ( !htNext )
+                {
+                    // at the top/bottom
+                    htNext = htSel;
+                }
+
+                if ( bShift )
+                {
+                    SelectRange(GetHwnd(), HITEM(m_htSelStart), htNext);
+                }
+                else // bCtrl
+                {
+                    // without changing selection
+                    ::SetFocus(GetHwnd(), htNext);
+                }
+
+                processed = TRUE;
+            }
+        }
+    }
+#endif // !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
+    if ( !processed )
+        rc = wxControl::MSWWindowProc(nMsg, wParam, lParam);
+
+    return rc;
+}
+
+// process WM_NOTIFY Windows message
+bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
+{
+    wxTreeEvent event(wxEVT_NULL, m_windowId);
+    wxEventType eventType = wxEVT_NULL;
+    NMHDR *hdr = (NMHDR *)lParam;
+
+    switch ( hdr->code )
+    {
         case TVN_BEGINDRAG:
             eventType = wxEVT_COMMAND_TREE_BEGIN_DRAG;
             // fall through
@@ -1505,6 +2198,11 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
 
                 event.m_item = (WXHTREEITEM) tv->itemNew.hItem;
                 event.m_pointDrag = wxPoint(tv->ptDrag.x, tv->ptDrag.y);
+
+                // don't allow dragging by default: the user code must
+                // explicitly say that it wants to allow it to avoid breaking
+                // the old apps
+                event.Veto();
             }
             break;
 
@@ -1562,31 +2260,30 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
             }
 
         case TVN_ITEMEXPANDING:
-            event.m_code = FALSE;
-            // fall through
-
         case TVN_ITEMEXPANDED:
             {
                 NM_TREEVIEW* tv = (NM_TREEVIEW*)lParam;
 
-                bool expand = FALSE;
+                int what;
                 switch ( tv->action )
                 {
+                    default:
+                        wxLogDebug(wxT("unexpected code %d in TVN_ITEMEXPAND message"), tv->action);
+                        // fall through
+
                     case TVE_EXPAND:
-                        expand = TRUE;
+                        what = IDX_EXPAND;
                         break;
 
                     case TVE_COLLAPSE:
-                        expand = FALSE;
+                        what = IDX_COLLAPSE;
                         break;
-
-                    default:
-                        wxLogDebug(wxT("unexpected code %d in TVN_ITEMEXPAND "
-                                      "message"), tv->action);
                 }
 
-                bool ing = ((int)hdr->code == TVN_ITEMEXPANDING);
-                eventType = g_events[expand][ing];
+                int how = (int)hdr->code == TVN_ITEMEXPANDING ? IDX_DOING
+                                                              : IDX_DONE;
+
+                eventType = gs_expandEvents[what][how];
 
                 event.m_item = (WXHTREEITEM) tv->itemNew.hItem;
             }
@@ -1597,16 +2294,27 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                 eventType = wxEVT_COMMAND_TREE_KEY_DOWN;
                 TV_KEYDOWN *info = (TV_KEYDOWN *)lParam;
 
-                event.m_code = wxCharCodeMSWToWX(info->wVKey);
+                // we pass 0 as 2 last CreateKeyEvent() parameters because we
+                // don't have access to the real key press flags here - but as
+                // it is only used to determin wxKeyEvent::m_altDown flag it's
+                // not too bad
+                event.m_evtKey = CreateKeyEvent(wxEVT_KEY_DOWN,
+                                                wxCharCodeMSWToWX(info->wVKey));
 
-                // a separate event for this case
-                if ( info->wVKey == VK_SPACE || info->wVKey == VK_RETURN )
+                // a separate event for Space/Return
+                if ( !wxIsCtrlDown() && !wxIsShiftDown() &&
+                     ((info->wVKey == VK_SPACE) || (info->wVKey == VK_RETURN)) )
                 {
                     wxTreeEvent event2(wxEVT_COMMAND_TREE_ITEM_ACTIVATED,
                                        m_windowId);
                     event2.SetEventObject(this);
+                    if ( !(GetWindowStyle() & wxTR_MULTIPLE) )
+                    {
+                        event2.m_item = GetSelection();
+                    }
+                    //else: don't know how to get it
 
-                    GetEventHandler()->ProcessEvent(event2);
+                    (void)GetEventHandler()->ProcessEvent(event2);
                 }
             }
             break;
@@ -1628,19 +2336,19 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
             }
             break;
 
-#if defined(_WIN32_IE) && _WIN32_IE >= 0x300
+#if defined(_WIN32_IE) && _WIN32_IE >= 0x300 && !wxUSE_COMCTL32_SAFELY && !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 0 ) )
         case NM_CUSTOMDRAW:
             {
                 LPNMTVCUSTOMDRAW lptvcd = (LPNMTVCUSTOMDRAW)lParam;
                 NMCUSTOMDRAW& nmcd = lptvcd->nmcd;
-                switch( nmcd.dwDrawStage )
+                switch ( nmcd.dwDrawStage )
                 {
                     case CDDS_PREPAINT:
                         // if we've got any items with non standard attributes,
                         // notify us before painting each item
                         *result = m_hasAnyAttr ? CDRF_NOTIFYITEMDRAW
                                                : CDRF_DODEFAULT;
-                        return TRUE;
+                        break;
 
                     case CDDS_ITEMPREPAINT:
                         {
@@ -1650,7 +2358,8 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                             if ( !attr )
                             {
                                 // nothing to do for this item
-                                return CDRF_DODEFAULT;
+                                *result = CDRF_DODEFAULT;
+                                break;
                             }
 
                             HFONT hFont;
@@ -1713,18 +2422,42 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                             {
                                 *result = CDRF_DODEFAULT;
                             }
-
-                            return TRUE;
                         }
+                        break;
 
                     default:
                         *result = CDRF_DODEFAULT;
-                        return TRUE;
                 }
             }
-            break;
+
+            // we always process it
+            return TRUE;
 #endif // _WIN32_IE >= 0x300
 
+        case NM_DBLCLK:
+        case NM_RCLICK:
+            {
+                TV_HITTESTINFO tvhti;
+                ::GetCursorPos(&tvhti.pt);
+                ::ScreenToClient(GetHwnd(), &tvhti.pt);
+                if ( TreeView_HitTest(GetHwnd(), &tvhti) )
+                {
+                    if ( tvhti.flags & TVHT_ONITEM )
+                    {
+                        event.m_item = (WXHTREEITEM) tvhti.hItem;
+                        eventType = (int)hdr->code == NM_DBLCLK
+                                    ? wxEVT_COMMAND_TREE_ITEM_ACTIVATED
+                                    : wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK;
+
+                        event.m_pointDrag.x = tvhti.pt.x;
+                        event.m_pointDrag.y = tvhti.pt.y;
+                    }
+
+                    break;
+                }
+            }
+            // fall through
+
         default:
             return wxControl::MSWOnNotify(idCtrl, lParam, result);
     }
@@ -1737,6 +2470,28 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
     // 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;
+            break;
+
+        case TVN_BEGINDRAG:
+        case TVN_BEGINRDRAG:
+            if ( event.IsAllowed() )
+            {
+                // 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?") );
+
+                m_dragImage = new wxDragImage(*this, event.m_item);
+                m_dragImage->BeginDrag(wxPoint(0, 0), this);
+                m_dragImage->Show();
+            }
+            break;
+
         case TVN_DELETEITEM:
             {
                 // NB: we might process this message using wxWindows event
@@ -1751,8 +2506,6 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                     wxTreeItemIndirectData *data = (wxTreeItemIndirectData *)
                                                         tv->itemOld.lParam;
                     delete data; // can't be NULL here
-
-                    m_itemsWithIndirectData.Remove(item);
                 }
                 else
                 {
@@ -1767,11 +2520,41 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
         case TVN_BEGINLABELEDIT:
             // return TRUE to cancel label editing
             *result = !event.IsAllowed();
+            // set ES_WANTRETURN ( like we do in BeginLabelEdit )
+            if(event.IsAllowed())
+            {
+                HWND hText = TreeView_GetEditControl(GetHwnd());
+                if(hText != NULL)
+                {
+                    // MBN: if m_textCtrl already has an HWND, it is a stale 
+                    // pointer from a previous edit (because the user
+                    // didn't modify the label before dismissing the control,
+                    // and TVN_ENDLABELEDIT was not sent), so delete it
+                    if(m_textCtrl && m_textCtrl->GetHWND() != 0)
+                        DeleteTextCtrl();
+                    if(!m_textCtrl)
+                        m_textCtrl = new wxTextCtrl();
+                    m_textCtrl->SetParent(this);
+                    m_textCtrl->SetHWND((WXHWND)hText);
+                    m_textCtrl->SubclassWin((WXHWND)hText);
+
+                    // set wxTE_PROCESS_ENTER style for the text control to
+                    // force it to process the Enter presses itself, otherwise
+                    // they could be stolen from it by the dialog
+                    // navigation code
+                    m_textCtrl->SetWindowStyle(m_textCtrl->GetWindowStyle()
+                                               | wxTE_PROCESS_ENTER);
+                }
+            }
             break;
 
         case TVN_ENDLABELEDIT:
-            // return TRUE to set the label to the new string
+            // return TRUE to set the label to the new string: note that we
+            // also must pretend that we did process the message or it is going
+            // to be passed to DefWindowProc() which will happily return FALSE
+            // cancelling the label change
             *result = event.IsAllowed();
+            processed = TRUE;
 
             // ensure that we don't have the text ctrl which is going to be
             // deleted any more
@@ -1784,10 +2567,26 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
             *result = !event.IsAllowed();
             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 = (WXHTREEITEM)tv->itemNew.hItem;
+
+                int image = GetItemImage(id, wxTreeItemIcon_Expanded);
+                if ( image != -1 )
+                {
+                    RefreshItem(id);
+                }
+            }
+            break;
+
         case TVN_GETDISPINFO:
             // NB: so far the user can't set the image himself anyhow, so do it
             //     anyway - but this may change later
-            if ( /* !processed && */ 1 )
+            //if ( /* !processed && */ 1 )
             {
                 wxTreeItemId item = event.m_item;
                 TV_DISPINFO *info = (TV_DISPINFO *)lParam;
@@ -1818,22 +2617,9 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
             // for the other messages the return value is ignored and there is
             // nothing special to do
     }
-
     return processed;
 }
 
-// ----------------------------------------------------------------------------
-// Tree event
-// ----------------------------------------------------------------------------
-
-IMPLEMENT_DYNAMIC_CLASS(wxTreeEvent, wxNotifyEvent)
-
-wxTreeEvent::wxTreeEvent(wxEventType commandType, int id)
-           : wxNotifyEvent(commandType, id)
-{
-    m_code = 0;
-    m_itemOld = 0;
-}
-
 #endif // __WIN95__
 
+#endif // wxUSE_TREECTRL