]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/treectrl.cpp
Style listbox now shows current style
[wxWidgets.git] / src / msw / treectrl.cpp
index e0a4d592b30188881323538e4314d748be507e52..8a7ce1352577325c7e7165d7d094980877b2c32c 100644 (file)
 
 #if wxUSE_TREECTRL
 
-#include "wx/msw/private.h"
+#include "wx/treectrl.h"
 
-// include <commctrl.h> "properly"
-#include "wx/msw/wrapcctl.h"
+#ifndef WX_PRECOMP
+    #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
+    #include "wx/msw/missing.h"
+    #include "wx/dynarray.h"
+    #include "wx/log.h"
+    #include "wx/app.h"
+    #include "wx/settings.h"
+#endif
 
-#include "wx/msw/missing.h"
+#include "wx/msw/private.h"
 
 // Set this to 1 to be _absolutely_ sure that repainting will work for all
 // comctl32.dll versions
 #define wxUSE_COMCTL32_SAFELY 0
 
-#include "wx/app.h"
-#include "wx/log.h"
-#include "wx/dynarray.h"
 #include "wx/imaglist.h"
-#include "wx/settings.h"
-#include "wx/treectrl.h"
 #include "wx/msw/dragimag.h"
 
 // macros to hide the cast ugliness
@@ -266,27 +267,122 @@ struct wxTreeViewItem : public TV_ITEM
     }
 };
 
+// ----------------------------------------------------------------------------
+// This class is our userdata/lParam for the TV_ITEMs stored in the treeview.
+//
+// We need this for a couple of reasons:
+//
+// 1) This class is needed for support of different images: the Win32 common
+// control natively supports only 2 images (the normal one and another for the
+// selected state). We wish to provide support for 2 more of them for folder
+// items (i.e. those which have children): for expanded state and for expanded
+// selected state. For this we use this structure to store the additional items
+// images.
+//
+// 2) This class is also needed to hold the HITEM so that we can sort
+// it correctly in the MSW sort callback.
+//
+// In addition it makes other workarounds such as this easier and helps
+// simplify the code.
+// ----------------------------------------------------------------------------
+
+class wxTreeItemParam
+{
+public:
+    wxTreeItemParam()
+    {
+        m_data = NULL;
+
+        for ( size_t n = 0; n < WXSIZEOF(m_images); n++ )
+        {
+            m_images[n] = -1;
+        }
+    }
+
+    // dtor deletes the associated data as well
+    virtual ~wxTreeItemParam() { delete m_data; }
+
+    // accessors
+        // get the real data associated with the item
+    wxTreeItemData *GetData() const { return m_data; }
+        // change it
+    void SetData(wxTreeItemData *data) { m_data = data; }
+
+        // do we have such image?
+    bool HasImage(wxTreeItemIcon which) const { return m_images[which] != -1; }
+        // get image, falling back to the other images if this one is not
+        // specified
+    int GetImage(wxTreeItemIcon which) const
+    {
+        int image = m_images[which];
+        if ( image == -1 )
+        {
+            switch ( which )
+            {
+                case wxTreeItemIcon_SelectedExpanded:
+                    image = GetImage(wxTreeItemIcon_Expanded);
+                    if ( image != -1 )
+                        break;
+                    //else: fall through
+
+                case wxTreeItemIcon_Selected:
+                case wxTreeItemIcon_Expanded:
+                    image = GetImage(wxTreeItemIcon_Normal);
+                    break;
+
+                case wxTreeItemIcon_Normal:
+                    // no fallback
+                    break;
+
+                default:
+                    wxFAIL_MSG( _T("unsupported wxTreeItemIcon value") );
+            }
+        }
+
+        return image;
+    }
+        // change the given image
+    void SetImage(int image, wxTreeItemIcon which) { m_images[which] = image; }
+
+        // get item
+    const wxTreeItemId& GetItem() const { return m_item; }
+        // set item
+    void SetItem(const wxTreeItemId& item) { m_item = item; }
+
+protected:
+    // all the images associated with the item
+    int m_images[wxTreeItemIcon_Max];
+
+    // item for sort callbacks
+    wxTreeItemId m_item;
+
+    // the real client data
+    wxTreeItemData *m_data;
+
+    DECLARE_NO_COPY_CLASS(wxTreeItemParam)
+};
+
 // wxVirutalNode is used in place of a single root when 'hidden' root is
 // specified.
 class wxVirtualNode : public wxTreeViewItem
 {
 public:
-    wxVirtualNode(wxTreeItemData *data)
+    wxVirtualNode(wxTreeItemParam *param)
         : wxTreeViewItem(TVI_ROOT, 0)
     {
-        m_data = data;
+        m_param = param;
     }
 
     ~wxVirtualNode()
     {
-        delete m_data;
+        delete m_param;
     }
 
-    wxTreeItemData *GetData() const { return m_data; }
-    void SetData(wxTreeItemData *data) { delete m_data; m_data = data; }
+    wxTreeItemParam *GetParam() const { return m_param; }
+    void SetParam(wxTreeItemParam *param) { delete m_param; m_param = param; }
 
 private:
-    wxTreeItemData *m_data;
+    wxTreeItemParam *m_param;
 
     DECLARE_NO_COPY_CLASS(wxVirtualNode)
 };
@@ -311,6 +407,11 @@ public:
         m_tree = tree;
     }
 
+    // give it a virtual dtor: not really needed as the class is never used
+    // polymorphically and not even allocated on heap at all, but this is safer
+    // (in case it ever is) and silences the compiler warnings for now
+    virtual ~wxTreeTraversal() { }
+
     // do traverse the tree: visit all items (recursively by default) under the
     // given one; return true if all items were traversed or false if the
     // traversal was aborted because OnVisit returned false
@@ -347,16 +448,18 @@ public:
 
     virtual bool OnVisit(const wxTreeItemId& item)
     {
+        const wxTreeCtrl * const tree = GetTree();
+
         // can't visit a virtual node.
-        if ( (GetTree()->GetRootItem() == item) && (GetTree()->GetWindowStyle() & wxTR_HIDE_ROOT))
+        if ( (tree->GetRootItem() == item) && tree->HasFlag(wxTR_HIDE_ROOT) )
         {
             return true;
         }
 
 #if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
-        if ( GetTree()->IsItemChecked(item) )
+        if ( tree->IsItemChecked(item) )
 #else
-        if ( ::IsItemSelected(GetHwndOf(GetTree()), HITEM(item)) )
+        if ( ::IsItemSelected(GetHwndOf(tree), HITEM(item)) )
 #endif
         {
             m_selections.Add(item);
@@ -402,69 +505,6 @@ private:
     DECLARE_NO_COPY_CLASS(TraverseCounter)
 };
 
-// ----------------------------------------------------------------------------
-// This class is needed for support of different images: the Win32 common
-// control natively supports only 2 images (the normal one and another for the
-// selected state). We wish to provide support for 2 more of them for folder
-// items (i.e. those which have children): for expanded state and for expanded
-// selected state. For this we use this structure to store the additional items
-// images.
-//
-// There is only one problem with this: when we retrieve the item's data, we
-// don't know whether we get a pointer to wxTreeItemData or
-// wxTreeItemIndirectData. So we always set the item id to an invalid value
-// in this class and the code using the client data checks for it and retrieves
-// the real client data in this case.
-// ----------------------------------------------------------------------------
-
-class wxTreeItemIndirectData : public wxTreeItemData
-{
-public:
-    // ctor associates this data with the item and the real item data becomes
-    // available through our GetData() method
-    wxTreeItemIndirectData(wxTreeCtrl *tree, const wxTreeItemId& item)
-    {
-        for ( size_t n = 0; n < WXSIZEOF(m_images); n++ )
-        {
-            m_images[n] = -1;
-        }
-
-        // save the old data
-        m_data = tree->GetItemData(item);
-
-        // and set ourselves as the new one
-        tree->SetIndirectItemData(item, this);
-
-        // we must have the invalid value for the item
-        m_pItem = 0l;
-    }
-
-    // dtor deletes the associated data as well
-    virtual ~wxTreeItemIndirectData() { delete m_data; }
-
-    // accessors
-        // get the real data associated with the item
-    wxTreeItemData *GetData() const { return m_data; }
-        // change it
-    void SetData(wxTreeItemData *data) { m_data = data; }
-
-        // do we have such image?
-    bool HasImage(wxTreeItemIcon which) const { return m_images[which] != -1; }
-        // get image
-    int GetImage(wxTreeItemIcon which) const { return m_images[which]; }
-        // change it
-    void SetImage(int image, wxTreeItemIcon which) { m_images[which] = image; }
-
-private:
-    // all the images associated with the item
-    int m_images[wxTreeItemIcon_Max];
-
-    // the real client data
-    wxTreeItemData *m_data;
-
-    DECLARE_NO_COPY_CLASS(wxTreeItemIndirectData)
-};
-
 // ----------------------------------------------------------------------------
 // wxWin macros
 // ----------------------------------------------------------------------------
@@ -789,7 +829,7 @@ wxTreeCtrl::GetClassDefaultAttributes(wxWindowVariant variant)
 
 // simple wrappers which add error checking in debug mode
 
-bool wxTreeCtrl::DoGetItem(wxTreeViewItemtvItem) const
+bool wxTreeCtrl::DoGetItem(wxTreeViewItem *tvItem) const
 {
     wxCHECK_MSG( tvItem->hItem != TVI_ROOT, false,
                  _T("can't retrieve virtual root item") );
@@ -804,7 +844,7 @@ bool wxTreeCtrl::DoGetItem(wxTreeViewItem* tvItem) const
     return true;
 }
 
-void wxTreeCtrl::DoSetItem(wxTreeViewItemtvItem)
+void wxTreeCtrl::DoSetItem(wxTreeViewItem *tvItem)
 {
     if ( TreeView_SetItem(GetHwnd(), tvItem) == -1 )
     {
@@ -812,9 +852,9 @@ void wxTreeCtrl::DoSetItem(wxTreeViewItem* tvItem)
     }
 }
 
-size_t wxTreeCtrl::GetCount() const
+unsigned int wxTreeCtrl::GetCount() const
 {
-    return (size_t)TreeView_GetCount(GetHwnd());
+    return (unsigned int)TreeView_GetCount(GetHwnd());
 }
 
 unsigned int wxTreeCtrl::GetIndent() const
@@ -830,9 +870,9 @@ void wxTreeCtrl::SetIndent(unsigned int indent)
 void wxTreeCtrl::SetAnyImageList(wxImageList *imageList, int which)
 {
     // no error return
-    TreeView_SetImageList(GetHwnd(),
-                          imageList ? imageList->GetHIMAGELIST() : 0,
-                          which);
+    (void) TreeView_SetImageList(GetHwnd(),
+                                 imageList ? imageList->GetHIMAGELIST() : 0,
+                                 which);
 }
 
 void wxTreeCtrl::SetImageList(wxImageList *imageList)
@@ -892,6 +932,11 @@ bool wxTreeCtrl::SetForegroundColour(const wxColour &colour)
 // Item access
 // ----------------------------------------------------------------------------
 
+bool wxTreeCtrl::IsHiddenRoot(const wxTreeItemId& item) const
+{
+    return HITEM(item) == TVI_ROOT && HasFlag(wxTR_HIDE_ROOT);
+}
+
 wxString wxTreeCtrl::GetItemText(const wxTreeItemId& item) const
 {
     wxCHECK_MSG( item.IsOk(), wxEmptyString, wxT("invalid tree item") );
@@ -936,258 +981,87 @@ void wxTreeCtrl::SetItemText(const wxTreeItemId& item, const wxString& text)
     }
 }
 
-int wxTreeCtrl::DoGetItemImageFromData(const wxTreeItemId& item,
-                                       wxTreeItemIcon which) const
-{
-    wxTreeViewItem tvItem(item, TVIF_PARAM);
-    if ( !DoGetItem(&tvItem) )
-    {
-        return -1;
-    }
-
-    return ((wxTreeItemIndirectData *)tvItem.lParam)->GetImage(which);
-}
-
-void wxTreeCtrl::DoSetItemImageFromData(const wxTreeItemId& item,
-                                        int image,
-                                        wxTreeItemIcon which) const
-{
-    wxTreeViewItem tvItem(item, TVIF_PARAM);
-    if ( !DoGetItem(&tvItem) )
-    {
-        return;
-    }
-
-    wxTreeItemIndirectData *data = ((wxTreeItemIndirectData *)tvItem.lParam);
-
-    data->SetImage(image, which);
-
-    // make sure that we have selected images as well
-    if ( which == wxTreeItemIcon_Normal &&
-         !data->HasImage(wxTreeItemIcon_Selected) )
-    {
-        data->SetImage(image, wxTreeItemIcon_Selected);
-    }
-
-    if ( which == wxTreeItemIcon_Expanded &&
-         !data->HasImage(wxTreeItemIcon_SelectedExpanded) )
-    {
-        data->SetImage(image, wxTreeItemIcon_SelectedExpanded);
-    }
-}
-
-void wxTreeCtrl::DoSetItemImages(const wxTreeItemId& item,
-                                 int image,
-                                 int imageSel)
-{
-    wxTreeViewItem tvItem(item, TVIF_IMAGE | TVIF_SELECTEDIMAGE);
-    tvItem.iSelectedImage = imageSel;
-    tvItem.iImage = image;
-    DoSetItem(&tvItem);
-}
-
 int wxTreeCtrl::GetItemImage(const wxTreeItemId& item,
                              wxTreeItemIcon which) const
 {
     wxCHECK_MSG( item.IsOk(), -1, wxT("invalid tree item") );
 
-    if ( (HITEM(item) == TVI_ROOT) && (m_windowStyle & wxTR_HIDE_ROOT) )
+    if ( IsHiddenRoot(item) )
     {
-        // TODO: Maybe a hidden root can still provide images?
+        // no images for hidden root item
         return -1;
     }
 
-    if ( HasIndirectData(item) )
-    {
-        return DoGetItemImageFromData(item, which);
-    }
-
-    UINT mask;
-    switch ( which )
-    {
-        default:
-            wxFAIL_MSG( wxT("unknown tree item image type") );
+    wxTreeItemParam *param = GetItemParam(item);
 
-        case wxTreeItemIcon_Normal:
-            mask = TVIF_IMAGE;
-            break;
-
-        case wxTreeItemIcon_Selected:
-            mask = TVIF_SELECTEDIMAGE;
-            break;
-
-        case wxTreeItemIcon_Expanded:
-        case wxTreeItemIcon_SelectedExpanded:
-            return -1;
-    }
-
-    wxTreeViewItem tvItem(item, mask);
-    DoGetItem(&tvItem);
-
-    return mask == TVIF_IMAGE ? tvItem.iImage : tvItem.iSelectedImage;
+    return param && param->HasImage(which) ? param->GetImage(which) : -1;
 }
 
 void wxTreeCtrl::SetItemImage(const wxTreeItemId& item, int image,
                               wxTreeItemIcon which)
 {
     wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
+    wxCHECK_RET( which >= 0 &&
+                 which < wxTreeItemIcon_Max,
+                 wxT("invalid image index"));
 
-    if ( IS_VIRTUAL_ROOT(item) )
+
+    if ( IsHiddenRoot(item) )
     {
-        // TODO: Maybe a hidden root can still store images?
+        // no images for hidden root item
         return;
     }
 
-    int imageNormal,
-        imageSel;
-
-    switch ( which )
-    {
-        default:
-            wxFAIL_MSG( wxT("unknown tree item image type") );
-            // fall through
-
-        case wxTreeItemIcon_Normal:
-            {
-                const int imageNormalOld = GetItemImage(item);
-                const int imageSelOld =
-                    GetItemImage(item, wxTreeItemIcon_Selected);
-
-                // always set the normal image
-                imageNormal = image;
-
-                // if the selected and normal images were the same, they should
-                // be the same after the update, otherwise leave the selected
-                // image as it was
-                imageSel = imageNormalOld == imageSelOld ? image : imageSelOld;
-            }
-            break;
-
-        case wxTreeItemIcon_Selected:
-            imageNormal = GetItemImage(item);
-            imageSel = image;
-            break;
-
-        case wxTreeItemIcon_Expanded:
-        case wxTreeItemIcon_SelectedExpanded:
-            if ( !HasIndirectData(item) )
-            {
-                // we need to get the old images first, because after we create
-                // the wxTreeItemIndirectData GetItemXXXImage() will use it to
-                // get the images
-                imageNormal = GetItemImage(item);
-                imageSel = GetItemImage(item, wxTreeItemIcon_Selected);
-
-                // if it doesn't have it yet, add it
-                wxTreeItemIndirectData *data = new
-                    wxTreeItemIndirectData(this, item);
-
-                // copy the data to the new location
-                data->SetImage(imageNormal, wxTreeItemIcon_Normal);
-                data->SetImage(imageSel, wxTreeItemIcon_Selected);
-            }
-
-            DoSetItemImageFromData(item, image, which);
+    wxTreeItemParam *data = GetItemParam(item);
+    if ( !data )
+        return;
 
-            // reset the normal/selected images because we won't use them any
-            // more - now they're stored inside the indirect data
-            imageNormal =
-            imageSel = I_IMAGECALLBACK;
-            break;
-    }
+    data->SetImage(image, which);
 
-    // NB: at least in version 5.00.0518.9 of comctl32.dll we need to always
-    //     change both normal and selected image - otherwise the change simply
-    //     doesn't take place!
-    DoSetItemImages(item, imageNormal, imageSel);
+    RefreshItem(item);
 }
 
-wxTreeItemData *wxTreeCtrl::GetItemData(const wxTreeItemId& item) const
+wxTreeItemParam *wxTreeCtrl::GetItemParam(const wxTreeItemId& item) const
 {
     wxCHECK_MSG( item.IsOk(), NULL, wxT("invalid tree item") );
 
     wxTreeViewItem tvItem(item, TVIF_PARAM);
 
-    // Hidden root may have data.
+    // hidden root may still have data.
     if ( IS_VIRTUAL_ROOT(item) )
     {
-        return GET_VIRTUAL_ROOT()->GetData();
+        return GET_VIRTUAL_ROOT()->GetParam();
     }
 
-    // Visible node.
+    // visible node.
     if ( !DoGetItem(&tvItem) )
     {
         return NULL;
     }
 
-    wxTreeItemData *data = (wxTreeItemData *)tvItem.lParam;
-    if ( IsDataIndirect(data) )
-    {
-        data = ((wxTreeItemIndirectData *)data)->GetData();
-    }
-
-    return data;
+    return (wxTreeItemParam *)tvItem.lParam;
 }
 
-void wxTreeCtrl::SetItemData(const wxTreeItemId& item, wxTreeItemData *data)
+wxTreeItemData *wxTreeCtrl::GetItemData(const wxTreeItemId& item) const
 {
-    wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
+    wxTreeItemParam *data = GetItemParam(item);
 
-    if ( IS_VIRTUAL_ROOT(item) )
-    {
-        GET_VIRTUAL_ROOT()->SetData(data);
-    }
+    return data ? data->GetData() : NULL;
+}
 
+void wxTreeCtrl::SetItemData(const wxTreeItemId& item, wxTreeItemData *data)
+{
     // first, associate this piece of data with this item
     if ( data )
     {
         data->SetId(item);
     }
 
-    wxTreeViewItem tvItem(item, TVIF_PARAM);
+    wxTreeItemParam *param = GetItemParam(item);
 
-    if ( HasIndirectData(item) )
-    {
-        if ( DoGetItem(&tvItem) )
-        {
-            ((wxTreeItemIndirectData *)tvItem.lParam)->SetData(data);
-        }
-        else
-        {
-            wxFAIL_MSG( wxT("failed to change tree items data") );
-        }
-    }
-    else
-    {
-        tvItem.lParam = (LPARAM)data;
-        DoSetItem(&tvItem);
-    }
-}
-
-void wxTreeCtrl::SetIndirectItemData(const wxTreeItemId& item,
-                                     wxTreeItemIndirectData *data)
-{
-    // this should never happen because it's unnecessary and will probably lead
-    // to crash too because the code elsewhere supposes that the pointer the
-    // wxTreeItemIndirectData has is a real wxItemData and not
-    // wxTreeItemIndirectData as well
-    wxASSERT_MSG( !HasIndirectData(item), wxT("setting indirect data twice?") );
+    wxCHECK_RET( param, wxT("failed to change tree items data") );
 
-    SetItemData(item, data);
-}
-
-bool wxTreeCtrl::HasIndirectData(const wxTreeItemId& item) const
-{
-    // query the item itself
-    wxTreeViewItem tvItem(item, TVIF_PARAM);
-    if ( !DoGetItem(&tvItem) )
-    {
-        return false;
-    }
-
-    wxTreeItemData *data = (wxTreeItemData *)tvItem.lParam;
-
-    return data && IsDataIndirect(data);
+    param->SetData(data);
 }
 
 void wxTreeCtrl::SetItemHasChildren(const wxTreeItemId& item, bool has)
@@ -1634,41 +1508,35 @@ wxTreeItemId wxTreeCtrl::DoInsertAfter(const wxTreeItemId& parent,
         tvIns.item.cchTextMax = 0;
     }
 
-    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;
-        }
-    }
+    // create the param which will store the other item parameters
+    wxTreeItemParam *param = new wxTreeItemParam;
 
-    if ( selectedImage != -1 )
-    {
-        mask |= TVIF_SELECTEDIMAGE;
-        tvIns.item.iSelectedImage = selectedImage;
-    }
+    // we return the images on demand as they depend on whether the item is
+    // expanded or collapsed too in our case
+    mask |= TVIF_IMAGE | TVIF_SELECTEDIMAGE;
+    tvIns.item.iImage = I_IMAGECALLBACK;
+    tvIns.item.iSelectedImage = I_IMAGECALLBACK;
 
-    if ( data != NULL )
-    {
-        mask |= TVIF_PARAM;
-        tvIns.item.lParam = (LPARAM)data;
-    }
+    param->SetImage(image, wxTreeItemIcon_Normal);
+    param->SetImage(selectedImage, wxTreeItemIcon_Selected);
 
+    mask |= TVIF_PARAM;
+    tvIns.item.lParam = (LPARAM)param;
     tvIns.item.mask = mask;
 
-    HTREEITEM id = (HTREEITEM) TreeView_InsertItem(GetHwnd(), &tvIns);
+    HTREEITEM id = TreeView_InsertItem(GetHwnd(), &tvIns);
     if ( id == 0 )
     {
         wxLogLastError(wxT("TreeView_InsertItem"));
     }
 
+    // associate the application tree item with Win32 tree item handle
+    param->SetItem(id);
+
+    // setup wxTreeItemData
     if ( data != NULL )
     {
-        // associate the application tree item with Win32 tree item handle
+        param->SetData(data);
         data->SetId(id);
     }
 
@@ -1700,10 +1568,13 @@ wxTreeItemId wxTreeCtrl::AddRoot(const wxString& text,
                                  wxTreeItemData *data)
 {
 
-    if ( m_windowStyle & wxTR_HIDE_ROOT )
+    if ( HasFlag(wxTR_HIDE_ROOT) )
     {
         // create a virtual root item, the parent for all the others
-        m_pVirtualRoot = new wxVirtualNode(data);
+        wxTreeItemParam *param = new wxTreeItemParam;
+        param->SetData(data);
+
+        m_pVirtualRoot = new wxVirtualNode(param);
 
         return TVI_ROOT;
     }
@@ -1802,8 +1673,8 @@ void wxTreeCtrl::DoExpand(const wxTreeItemId& item, int flag)
                   wxT("Unknown flag in wxTreeCtrl::DoExpand") );
 
     // A hidden root can be neither expanded nor collapsed.
-    wxCHECK_RET( !(m_windowStyle & wxTR_HIDE_ROOT) || (HITEM(item) != TVI_ROOT),
-                 wxT("Can't expand/collapse hidden root node!") )
+    wxCHECK_RET( !IsHiddenRoot(item),
+                 wxT("Can't expand/collapse hidden root node!") );
 
     // TreeView_Expand doesn't send TVN_ITEMEXPAND(ING) messages, so we must
     // emulate them. This behaviour has changed slightly with comctl32.dll
@@ -1819,16 +1690,12 @@ void wxTreeCtrl::DoExpand(const wxTreeItemId& item, int flag)
 
     if ( TreeView_Expand(GetHwnd(), HITEM(item), flag) != 0 )
     {
-        wxTreeEvent event(wxEVT_NULL, m_windowId);
-        event.m_item = item;
-        event.SetEventObject(this);
-
         // note that the {EXPAND|COLLAPS}ING event is sent by TreeView_Expand()
         // itself
-        event.SetEventType(gs_expandEvents[IsExpanded(item) ? IDX_EXPAND
-                                                            : IDX_COLLAPSE]
-                                          [IDX_DONE]);
-
+        wxTreeEvent event(gs_expandEvents[IsExpanded(item) ? IDX_EXPAND
+                                                           : IDX_COLLAPSE]
+                                         [IDX_DONE],
+                           this, item);
         (void)GetEventHandler()->ProcessEvent(event);
     }
     //else: change didn't took place, so do nothing at all
@@ -1916,11 +1783,7 @@ void wxTreeCtrl::SelectItem(const wxTreeItemId& item, bool select)
         // 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);
+        wxTreeEvent event(wxEVT_COMMAND_TREE_SEL_CHANGING, this, item);
         if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
         {
             if ( !TreeView_SelectItem(GetHwnd(), HITEM(item)) )
@@ -1939,6 +1802,8 @@ void wxTreeCtrl::SelectItem(const wxTreeItemId& item, bool select)
 
 void wxTreeCtrl::EnsureVisible(const wxTreeItemId& item)
 {
+    wxCHECK_RET( !IsHiddenRoot(item), _T("can't show hidden root item") );
+
     // no error return
     TreeView_EnsureVisible(GetHwnd(), HITEM(item));
 }
@@ -1977,8 +1842,8 @@ void wxTreeCtrl::DeleteTextCtrl()
     }
 }
 
-wxTextCtrlwxTreeCtrl::EditLabel(const wxTreeItemId& item,
-                                  wxClassInfotextControlClass)
+wxTextCtrl *wxTreeCtrl::EditLabel(const wxTreeItemId& item,
+                                  wxClassInfo *textControlClass)
 {
     wxASSERT( textControlClass->IsKindOf(CLASSINFO(wxTextCtrl)) );
 
@@ -2009,13 +1874,13 @@ void wxTreeCtrl::DoEndEditLabel(bool discardChanges)
     DeleteTextCtrl();
 }
 
-wxTreeItemId wxTreeCtrl::DoTreeHitTest(const wxPoint& point, int& flags)
+wxTreeItemId wxTreeCtrl::DoTreeHitTest(const wxPoint& point, int& flags) const
 {
     TV_HITTESTINFO hitTestInfo;
     hitTestInfo.pt.x = (int)point.x;
     hitTestInfo.pt.y = (int)point.y;
 
-    TreeView_HitTest(GetHwnd(), &hitTestInfo);
+    (void) TreeView_HitTest(GetHwnd(), &hitTestInfo);
 
     flags = 0;
 
@@ -2078,16 +1943,10 @@ public:
     static int CALLBACK Compare(LPARAM data1, LPARAM data2, LPARAM tree);
 
 private:
-    static wxTreeItemId GetIdFromData(wxTreeCtrl *tree, LPARAM item)
+    static wxTreeItemId GetIdFromData(LPARAM lParam)
     {
-        wxTreeItemData *data = (wxTreeItemData *)item;
-        if ( tree->IsDataIndirect(data) )
-        {
-            data = ((wxTreeItemIndirectData *)data)->GetData();
+        return ((wxTreeItemParam*)lParam)->GetItem();
         }
-
-        return data->GetId();
-    }
 };
 
 int CALLBACK wxTreeSortHelper::Compare(LPARAM pItem1,
@@ -2099,8 +1958,8 @@ int CALLBACK wxTreeSortHelper::Compare(LPARAM pItem1,
 
     wxTreeCtrl *tree = (wxTreeCtrl *)htree;
 
-    return tree->OnCompareItems(GetIdFromData(tree, pItem1),
-                                GetIdFromData(tree, pItem2));
+    return tree->OnCompareItems(GetIdFromData(pItem1),
+                                GetIdFromData(pItem2));
 }
 
 void wxTreeCtrl::SortChildren(const wxTreeItemId& item)
@@ -2110,6 +1969,10 @@ void wxTreeCtrl::SortChildren(const wxTreeItemId& item)
     // rely on the fact that TreeView_SortChildren does the same thing as our
     // default behaviour, i.e. sorts items alphabetically and so call it
     // directly if we're not in derived class (much more efficient!)
+    // RN: Note that if you find you're code doesn't sort as expected this
+    //     may be why as if you don't use the DECLARE_CLASS/IMPLEMENT_CLASS
+    //     combo for your derived wxTreeCtrl if will sort without
+    //     OnCompareItems
     if ( GetClassInfo() == CLASSINFO(wxTreeCtrl) )
     {
         TreeView_SortChildren(GetHwnd(), HITEM(item), 0);
@@ -2128,6 +1991,20 @@ void wxTreeCtrl::SortChildren(const wxTreeItemId& item)
 // implementation
 // ----------------------------------------------------------------------------
 
+bool wxTreeCtrl::MSWShouldPreProcessMessage(WXMSG* msg)
+{
+    if ( msg->message == WM_KEYDOWN )
+    {
+        if ( msg->wParam == VK_RETURN )
+        {
+            // we need VK_RETURN to generate wxEVT_COMMAND_TREE_ITEM_ACTIVATED
+            return false;
+        }
+    }
+
+    return wxTreeCtrlBase::MSWShouldPreProcessMessage(msg);
+}
+
 bool wxTreeCtrl::MSWCommand(WXUINT cmd, WXWORD id)
 {
     if ( cmd == EN_UPDATE )
@@ -2170,11 +2047,9 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara
         // Convert the screen point to a client point
         wxPoint MenuPoint = ScreenToClient(wxPoint(x, y));
 
-        wxTreeEvent event( wxEVT_COMMAND_TREE_ITEM_MENU, GetId() );
-
         // can't use GetSelection() here as it would assert in multiselect mode
-        event.m_item = wxTreeItemId(TreeView_GetSelection(GetHwnd()));
-        event.SetEventObject( this );
+        wxTreeEvent event(wxEVT_COMMAND_TREE_ITEM_MENU, this,
+                          wxTreeItemId(TreeView_GetSelection(GetHwnd())));
 
         // Get the bounding rectangle for the item, including the non-text areas
         wxRect ItemRect;
@@ -2205,12 +2080,12 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara
         int x = GET_X_LPARAM(lParam),
             y = GET_Y_LPARAM(lParam);
         HTREEITEM htItem = GetItemFromPoint(GetHwnd(), x, y);
-        
+
         TV_HITTESTINFO tvht;
         tvht.pt.x = x;
         tvht.pt.y = y;
-    
-        TreeView_HitTest(GetHwnd(), &tvht);
+
+        (void) TreeView_HitTest(GetHwnd(), &tvht);
 
         switch ( nMsg )
         {
@@ -2235,7 +2110,7 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara
                 {
                     m_htClickedItem = (WXHTREEITEM) htItem;
                     m_ptClick = wxPoint(x, y);
-                    
+
                     if ( wParam & MK_CONTROL )
                     {
                         SetFocus();
@@ -2275,7 +2150,7 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara
                     {
                         // avoid doing anything if we click on the only
                         // currently selected item
-                        
+
                         SetFocus();
 
                         wxArrayTreeItemIds selections;
@@ -2329,29 +2204,29 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara
                             tv.hdr.hwndFrom = GetHwnd();
                             tv.hdr.idFrom = ::GetWindowLong( GetHwnd(), GWL_ID );
                             tv.hdr.code = TVN_BEGINDRAG;
-            
+
                             tv.itemNew.hItem = HITEM(m_htClickedItem);
-                            
+
                             TVITEM tviAux;
                             ZeroMemory(&tviAux, sizeof(tviAux));
                             tviAux.hItem = HITEM(m_htClickedItem);
                             tviAux.mask = TVIF_STATE | TVIF_PARAM;
                             tviAux.stateMask = 0xffffffff;
                             TreeView_GetItem( GetHwnd(), &tviAux );
-                            
+
                             tv.itemNew.state = tviAux.state;
                             tv.itemNew.lParam = tviAux.lParam;
-            
+
                             tv.ptDrag.x = x;
                             tv.ptDrag.y = y;
-            
+
                             ::SendMessage( pWnd, WM_NOTIFY, tv.hdr.idFrom, (LPARAM)&tv );
                         }
                         m_htClickedItem.Unset();
                     }
                 }
 #endif // __WXWINCE__
-                
+
                 if ( m_dragImage )
                 {
                     m_dragImage->Move(wxPoint(x, y));
@@ -2396,12 +2271,7 @@ WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lPara
                     m_dragImage = NULL;
 
                     // generate the drag end event
-                    wxTreeEvent event(wxEVT_COMMAND_TREE_END_DRAG, m_windowId);
-
-                    event.m_item = htItem;
-                    event.m_pointDrag = wxPoint(x, y);
-                    event.SetEventObject(this);
-
+                    wxTreeEvent event(wxEVT_COMMAND_TREE_END_DRAG, this, htItem);
                     (void)GetEventHandler()->ProcessEvent(event);
 
                     // if we don't do it, the tree seems to think that 2 items
@@ -2580,7 +2450,7 @@ wxTreeCtrl::MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 // process WM_NOTIFY Windows message
 bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
 {
-    wxTreeEvent event(wxEVT_NULL, m_windowId);
+    wxTreeEvent event(wxEVT_NULL, this);
     wxEventType eventType = wxEVT_NULL;
     NMHDR *hdr = (NMHDR *)lParam;
 
@@ -2698,7 +2568,7 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
         case TVN_ITEMEXPANDING:
         case TVN_ITEMEXPANDED:
             {
-                NM_TREEVIEWtv = (NM_TREEVIEW*)lParam;
+                NM_TREEVIEW *tv = (NM_TREEVIEW*)lParam;
 
                 int what;
                 switch ( tv->action )
@@ -2738,7 +2608,7 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
 
                 WXWPARAM wParam = info->wVKey;
 
-                int keyCode = wxCharCodeMSWToWX(info->wVKey);
+                int keyCode = wxCharCodeMSWToWX(wParam);
                 if ( !keyCode )
                 {
                     // wxCharCodeMSWToWX() returns 0 to indicate that this is a
@@ -2755,16 +2625,13 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                 if ( !wxIsCtrlDown() && !wxIsShiftDown() && !isAltDown &&
                      ((info->wVKey == VK_SPACE) || (info->wVKey == VK_RETURN)) )
                 {
-                    wxTreeEvent event2(wxEVT_COMMAND_TREE_ITEM_ACTIVATED,
-                                       m_windowId);
-                    event2.SetEventObject(this);
-                    if ( !(GetWindowStyle() & wxTR_MULTIPLE) )
-                    {
-                        event2.m_item = GetSelection();
-                    }
-                    //else: don't know how to get it
+                   wxTreeItemId item;
+                   if ( !HasFlag(wxTR_MULTIPLE) )
+                       item = GetSelection();
 
-                    (void)GetEventHandler()->ProcessEvent(event2);
+                   wxTreeEvent event2(wxEVT_COMMAND_TREE_ITEM_ACTIVATED,
+                                        this, item);
+                   (void)GetEventHandler()->ProcessEvent(event2);
                 }
             }
             break;
@@ -2787,13 +2654,13 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                 if (hdr->code == TVN_SELCHANGINGW ||
                     hdr->code == TVN_SELCHANGEDW)
                 {
-                    NM_TREEVIEWWtv = (NM_TREEVIEWW *)lParam;
+                    NM_TREEVIEWW *tv = (NM_TREEVIEWW *)lParam;
                     event.m_item = tv->itemNew.hItem;
                     event.m_itemOld = tv->itemOld.hItem;
                 }
                 else
                 {
-                    NM_TREEVIEWAtv = (NM_TREEVIEWA *)lParam;
+                    NM_TREEVIEWA *tv = (NM_TREEVIEWA *)lParam;
                     event.m_item = tv->itemNew.hItem;
                     event.m_itemOld = tv->itemOld.hItem;
                 }
@@ -2830,9 +2697,15 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
 
                             wxTreeItemAttr * const attr = it->second;
 
+                            wxTreeViewItem tvItem((void *)nmcd.dwItemSpec,
+                                                  TVIF_STATE, TVIS_DROPHILITED);
+                            DoGetItem(&tvItem);
+                            const UINT tvItemState = tvItem.state;
+
                             // selection colours should override ours,
-                            // otherwise it is too confusing ot the user
-                            if ( !(nmcd.uItemState & CDIS_SELECTED) )
+                            // otherwise it is too confusing to the user
+                            if ( !(nmcd.uItemState & CDIS_SELECTED) &&
+                                 !(tvItemState & TVIS_DROPHILITED) )
                             {
                                 wxColour colBack;
                                 if ( attr->HasBackgroundColour() )
@@ -2846,8 +2719,9 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                             // colour when we don't have focus (we can't keep
                             // it when we do, it would usually be unreadable on
                             // the almost inverted bg colour...)
-                            if ( !(nmcd.uItemState & CDIS_SELECTED) ||
-                                    FindFocus() != this )
+                            if ( ( !(nmcd.uItemState & CDIS_SELECTED) ||
+                                    FindFocus() != this ) &&
+                                 !(tvItemState & TVIS_DROPHILITED) )
                             {
                                 wxColour colText;
                                 if ( attr->HasTextColour() )
@@ -2926,9 +2800,11 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
             return wxControl::MSWOnNotify(idCtrl, lParam, result);
     }
 
-    event.SetEventObject(this);
     event.SetEventType(eventType);
 
+    if ( event.m_item.IsOk() )
+        event.SetClientObject(GetItemData(event.m_item));
+
     bool processed = GetEventHandler()->ProcessEvent(event);
 
     // post processing
@@ -2962,20 +2838,11 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                 //     tables, but due to overhead of wxWin event system we
                 //     prefer to do it here ourself (otherwise deleting a tree
                 //     with many items is just too slow)
-                NM_TREEVIEWtv = (NM_TREEVIEW *)lParam;
+                NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam;
 
-                wxTreeItemId item = event.m_item;
-                if ( HasIndirectData(item) )
-                {
-                    wxTreeItemIndirectData *data = (wxTreeItemIndirectData *)
-                                                        tv->itemOld.lParam;
-                    delete data; // can't be NULL here
-                }
-                else
-                {
-                    wxTreeItemData *data = (wxTreeItemData *)tv->itemOld.lParam;
-                    delete data; // may be NULL, ok
-                }
+                wxTreeItemParam *param =
+                        (wxTreeItemParam *)tv->itemOld.lParam;
+                delete param;
 
                 processed = true; // Make sure we don't get called twice
             }
@@ -2989,15 +2856,15 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
             if ( event.IsAllowed() )
             {
                 HWND hText = TreeView_GetEditControl(GetHwnd());
-                if(hText != NULL)
+                if ( hText )
                 {
                     // MBN: if m_textCtrl already has an HWND, it is a stale
                     // pointer from a previous edit (because the user
                     // didn't modify the label before dismissing the control,
                     // and TVN_ENDLABELEDIT was not sent), so delete it
-                    if(m_textCtrl && m_textCtrl->GetHWND() != 0)
+                    if ( m_textCtrl && m_textCtrl->GetHWND() )
                         DeleteTextCtrl();
-                    if(!m_textCtrl)
+                    if ( !m_textCtrl )
                         m_textCtrl = new wxTextCtrl();
                     m_textCtrl->SetParent(this);
                     m_textCtrl->SetHWND((WXHWND)hText);
@@ -3055,7 +2922,7 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
             // an image depending on the expanded/collapsed state - bug in
             // comctl32.dll or our code?
             {
-                NM_TREEVIEWtv = (NM_TREEVIEW *)lParam;
+                NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam;
                 wxTreeItemId id(tv->itemNew.hItem);
 
                 int image = GetItemImage(id, wxTreeItemIcon_Expanded);
@@ -3069,16 +2936,20 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
         case TVN_GETDISPINFO:
             // NB: so far the user can't set the image himself anyhow, so do it
             //     anyway - but this may change later
-            //if ( /* !processed && */ )
+            //if ( /* !processed && */ )
             {
                 wxTreeItemId item = event.m_item;
                 TV_DISPINFO *info = (TV_DISPINFO *)lParam;
+
+                const wxTreeItemParam * const param = GetItemParam(item);
+                if ( !param )
+                    break;
+
                 if ( info->item.mask & TVIF_IMAGE )
                 {
                     info->item.iImage =
-                        DoGetItemImageFromData
+                        param->GetImage
                         (
-                         item,
                          IsExpanded(item) ? wxTreeItemIcon_Expanded
                                           : wxTreeItemIcon_Normal
                         );
@@ -3086,9 +2957,8 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                 if ( info->item.mask & TVIF_SELECTEDIMAGE )
                 {
                     info->item.iSelectedImage =
-                        DoGetItemImageFromData
+                        param->GetImage
                         (
-                         item,
                          IsExpanded(item) ? wxTreeItemIcon_SelectedExpanded
                                           : wxTreeItemIcon_Selected
                         );
@@ -3147,4 +3017,3 @@ int wxTreeCtrl::GetState(const wxTreeItemId& node)
 }
 
 #endif // wxUSE_TREECTRL
-