X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b94ae1ea10f3794b36e8ad554381124ee9ec296b..ab5ebf521fca1ddff1de556db7c53b25b501cdeb:/src/msw/treectrl.cpp diff --git a/src/msw/treectrl.cpp b/src/msw/treectrl.cpp index a613f5e12e..dcbb70016a 100644 --- a/src/msw/treectrl.cpp +++ b/src/msw/treectrl.cpp @@ -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,7 +16,8 @@ // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ + +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma implementation "treectrl.h" #endif @@ -27,53 +28,224 @@ #pragma hdrstop #endif -#include "wx/msw/private.h" - -// Mingw32 is a bit mental even though this is done in winundef -#ifdef GetFirstChild - #undef GetFirstChild -#endif +#if wxUSE_TREECTRL -#ifdef GetNextSibling - #undef GetNextSibling -#endif +#include "wx/msw/private.h" -#if defined(__WIN95__) +// 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/treectrl.h" #include "wx/settings.h" - +#include "wx/msw/treectrl.h" #include "wx/msw/dragimag.h" -#ifdef __GNUWIN32_OLD__ - #include "wx/msw/gnuwin32/extra.h" -#endif +// include "properly" +#include "wx/msw/wrapcctl.h" -#if defined(__WIN95__) && !(defined(__GNUWIN32_OLD__) || defined(__TWIN32__)) - #include -#endif +// macros to hide the cast ugliness +// -------------------------------- -// Bug in headers, sometimes -#ifndef TVIS_FOCUSED - #define TVIS_FOCUSED 0x0001 -#endif +// ptr is the real item id, i.e. wxTreeItemId::m_pItem +#define HITEM_PTR(ptr) (HTREEITEM)(ptr) -#ifndef TV_FIRST - #define TV_FIRST 0x1100 -#endif +// item here is a wxTreeItemId +#define HITEM(item) HITEM_PTR((item).m_pItem) -#ifndef TVS_CHECKBOXES - #define TVS_CHECKBOXES 0x0100 -#endif +// 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 -// 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 +// ---------------------------------------------------------------------------- +// 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 bool 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")); + return false; + } + + return true; +} + +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 @@ -81,7 +253,7 @@ // 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 @@ -90,19 +262,52 @@ 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; + + DECLARE_NO_COPY_CLASS(wxVirtualNode) }; #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 +// OnVisit() returns false) items under the given one class wxTreeTraversal { public: @@ -112,12 +317,12 @@ public: } // do traverse the tree: visit all items (recursively by default) under the - // given one; return TRUE if all items were traversed or FALSE if the - // traversal was aborted because OnVisit returned FALSE - bool DoTraverse(const wxTreeItemId& root, bool recursively = TRUE); + // given one; return true if all items were traversed or false if the + // traversal was aborted because OnVisit returned false + bool DoTraverse(const wxTreeItemId& root, bool recursively = true); // override this function to do whatever is needed for each item, return - // FALSE to stop traversing + // false to stop traversing virtual bool OnVisit(const wxTreeItemId& item) = 0; protected: @@ -127,6 +332,8 @@ private: bool Traverse(const wxTreeItemId& root, bool recursively); const wxTreeCtrl *m_tree; + + DECLARE_NO_COPY_CLASS(wxTreeTraversal) }; // internal class for getting the selected items @@ -144,18 +351,30 @@ 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); } - return TRUE; + return true; } size_t GetCount() const { return m_selections.GetCount(); } private: wxArrayTreeItemIds& m_selections; + + DECLARE_NO_COPY_CLASS(TraverseSelections) }; // internal class for counting tree items @@ -172,17 +391,19 @@ public: DoTraverse(root, recursively); } - virtual bool OnVisit(const wxTreeItemId& item) + virtual bool OnVisit(const wxTreeItemId& WXUNUSED(item)) { m_count++; - return TRUE; + return true; } size_t GetCount() const { return m_count; } private: size_t m_count; + + DECLARE_NO_COPY_CLASS(TraverseCounter) }; // ---------------------------------------------------------------------------- @@ -195,11 +416,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 @@ -216,10 +438,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 @@ -238,39 +463,111 @@ 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) }; // ---------------------------------------------------------------------------- -// private functions +// wxWin macros // ---------------------------------------------------------------------------- -static HTREEITEM GetItemFromPoint(HWND hwndTV, int x, int y) -{ - TV_HITTESTINFO tvht; - tvht.pt.x = x; - tvht.pt.y = y; - - // TreeView_HitTest() doesn't do the right cast in mingw32 headers - return (HTREEITEM)TreeView_HitTest(hwndTV, &tvht); -} +#if wxUSE_EXTENDED_RTTI +WX_DEFINE_FLAGS( wxTreeCtrlStyle ) + +wxBEGIN_FLAGS( wxTreeCtrlStyle ) + // new style border flags, we put them first to + // use them for streaming out + wxFLAGS_MEMBER(wxBORDER_SIMPLE) + wxFLAGS_MEMBER(wxBORDER_SUNKEN) + wxFLAGS_MEMBER(wxBORDER_DOUBLE) + wxFLAGS_MEMBER(wxBORDER_RAISED) + wxFLAGS_MEMBER(wxBORDER_STATIC) + wxFLAGS_MEMBER(wxBORDER_NONE) + + // old style border flags + wxFLAGS_MEMBER(wxSIMPLE_BORDER) + wxFLAGS_MEMBER(wxSUNKEN_BORDER) + wxFLAGS_MEMBER(wxDOUBLE_BORDER) + wxFLAGS_MEMBER(wxRAISED_BORDER) + wxFLAGS_MEMBER(wxSTATIC_BORDER) + wxFLAGS_MEMBER(wxBORDER) + + // standard window styles + wxFLAGS_MEMBER(wxTAB_TRAVERSAL) + wxFLAGS_MEMBER(wxCLIP_CHILDREN) + wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW) + wxFLAGS_MEMBER(wxWANTS_CHARS) + wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE) + wxFLAGS_MEMBER(wxALWAYS_SHOW_SB ) + wxFLAGS_MEMBER(wxVSCROLL) + wxFLAGS_MEMBER(wxHSCROLL) + + wxFLAGS_MEMBER(wxTR_EDIT_LABELS) + wxFLAGS_MEMBER(wxTR_NO_BUTTONS) + wxFLAGS_MEMBER(wxTR_HAS_BUTTONS) + wxFLAGS_MEMBER(wxTR_TWIST_BUTTONS) + wxFLAGS_MEMBER(wxTR_NO_LINES) + wxFLAGS_MEMBER(wxTR_FULL_ROW_HIGHLIGHT) + wxFLAGS_MEMBER(wxTR_LINES_AT_ROOT) + wxFLAGS_MEMBER(wxTR_HIDE_ROOT) + wxFLAGS_MEMBER(wxTR_ROW_LINES) + wxFLAGS_MEMBER(wxTR_HAS_VARIABLE_ROW_HEIGHT) + wxFLAGS_MEMBER(wxTR_SINGLE) + wxFLAGS_MEMBER(wxTR_MULTIPLE) + wxFLAGS_MEMBER(wxTR_EXTENDED) + wxFLAGS_MEMBER(wxTR_DEFAULT_STYLE) + +wxEND_FLAGS( wxTreeCtrlStyle ) + +IMPLEMENT_DYNAMIC_CLASS_XTI(wxTreeCtrl, wxControl,"wx/treectrl.h") + +wxBEGIN_PROPERTIES_TABLE(wxTreeCtrl) + wxEVENT_PROPERTY( TextUpdated , wxEVT_COMMAND_TEXT_UPDATED , wxCommandEvent ) + wxEVENT_RANGE_PROPERTY( TreeEvent , wxEVT_COMMAND_TREE_BEGIN_DRAG , wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK , wxTreeEvent ) + wxPROPERTY_FLAGS( WindowStyle , wxTreeCtrlStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style +wxEND_PROPERTIES_TABLE() + +wxBEGIN_HANDLERS_TABLE(wxTreeCtrl) +wxEND_HANDLERS_TABLE() + +wxCONSTRUCTOR_5( wxTreeCtrl , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size , long , WindowStyle ) +#else +IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl, wxControl) +#endif // ---------------------------------------------------------------------------- -// macros +// constants // ---------------------------------------------------------------------------- -IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl, wxControl) +// indices in gs_expandEvents table below +enum +{ + IDX_COLLAPSE, + IDX_EXPAND, + IDX_WHAT_MAX +}; -// ---------------------------------------------------------------------------- -// variables -// ---------------------------------------------------------------------------- +enum +{ + IDX_DONE, + IDX_DOING, + IDX_HOW_MAX +}; -// handy table for sending events -static const wxEventType g_events[2][2] = +// 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 @@ -283,28 +580,28 @@ static const wxEventType g_events[2][2] = bool wxTreeTraversal::DoTraverse(const wxTreeItemId& root, bool recursively) { if ( !OnVisit(root) ) - return FALSE; + return false; return Traverse(root, recursively); } bool wxTreeTraversal::Traverse(const wxTreeItemId& root, bool recursively) { - long cookie; + wxTreeItemIdValue cookie; wxTreeItemId child = m_tree->GetFirstChild(root, cookie); while ( child.IsOk() ) { // depth first traversal - if ( recursively && !Traverse(child, TRUE) ) - return FALSE; + if ( recursively && !Traverse(child, true) ) + return false; if ( !OnVisit(child) ) - return FALSE; + return false; child = m_tree->GetNextChild(root, cookie); } - return TRUE; + return true; } // ---------------------------------------------------------------------------- @@ -315,9 +612,18 @@ void wxTreeCtrl::Init() { m_imageListNormal = NULL; m_imageListState = NULL; + m_ownsImageListNormal = m_ownsImageListState = false; m_textCtrl = NULL; - m_hasAnyAttr = FALSE; + m_hasAnyAttr = false; m_dragImage = NULL; + 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, @@ -330,12 +636,18 @@ bool wxTreeCtrl::Create(wxWindow *parent, { Init(); + if ( (style & wxBORDER_MASK) == wxBORDER_DEFAULT ) + style |= wxBORDER_SUNKEN; + if ( !CreateControl(parent, id, pos, size, style, validator, name) ) - return FALSE; + return false; - DWORD wstyle = WS_VISIBLE | WS_CHILD | WS_TABSTOP | - TVS_HASLINES | TVS_SHOWSELALWAYS; + DWORD exStyle = 0; + DWORD wstyle = MSWGetStyle(m_windowStyle, & exStyle); + wstyle |= WS_TABSTOP | TVS_SHOWSELALWAYS; + if ((m_windowStyle & wxTR_NO_LINES) == 0) + wstyle |= TVS_HASLINES; if ( m_windowStyle & wxTR_HAS_BUTTONS ) wstyle |= TVS_HASBUTTONS; @@ -345,7 +657,16 @@ bool wxTreeCtrl::Create(wxWindow *parent, if ( m_windowStyle & wxTR_LINES_AT_ROOT ) wstyle |= TVS_LINESATROOT; -#if !defined( __GNUWIN32_OLD__ ) && \ + 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)) @@ -354,14 +675,34 @@ bool wxTreeCtrl::Create(wxWindow *parent, // up the image list we need for this if we do have multiple selections if ( m_windowStyle & wxTR_MULTIPLE ) wstyle |= TVS_CHECKBOXES; +#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE + +#ifndef __WXWINCE__ + // Need so that TVN_GETINFOTIP messages will be sent + wstyle |= TVS_INFOTIP; #endif // Create the tree control. if ( !MSWCreateControl(WC_TREEVIEW, wstyle) ) - return FALSE; + 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. @@ -377,7 +718,7 @@ bool wxTreeCtrl::Create(wxWindow *parent, // create a mono bitmap of the standard size int x = GetSystemMetrics(SM_CXMENUCHECK); int y = GetSystemMetrics(SM_CYMENUCHECK); - wxImageList imagelistCheckboxes(x, y, FALSE, 2); + wxImageList imagelistCheckboxes(x, y, false, 2); HBITMAP hbmpCheck = CreateBitmap(x, y, // bitmap size 1, // # of color planes 1, // # bits needed for one pixel @@ -416,7 +757,9 @@ bool wxTreeCtrl::Create(wxWindow *parent, SetSize(pos.x, pos.y, size.x, size.y); - return TRUE; + wxSetCCUnicodeFormat(GetHwnd()); + + return true; } wxTreeCtrl::~wxTreeCtrl() @@ -424,44 +767,60 @@ wxTreeCtrl::~wxTreeCtrl() // delete any attributes if ( m_hasAnyAttr ) { - for ( wxNode *node = m_attrs.Next(); node; node = m_attrs.Next() ) - { - delete (wxTreeItemAttr *)node->Data(); - } + WX_CLEAR_HASH_MAP(wxMapTreeAttr, m_attrs); // prevent TVN_DELETEITEM handler from deleting the attributes again! - m_hasAnyAttr = FALSE; + m_hasAnyAttr = false; } 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; } // ---------------------------------------------------------------------------- // accessors // ---------------------------------------------------------------------------- +/* static */ wxVisualAttributes +wxTreeCtrl::GetClassDefaultAttributes(wxWindowVariant variant) +{ + wxVisualAttributes attrs = GetCompositeControlsDefaultAttributes(variant); + + // common controls have their own default font + attrs.font = wxGetCCDefaultFont(); + + return attrs; +} + + // simple wrappers which add error checking in debug mode 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; + return false; } - return TRUE; + return true; } void wxTreeCtrl::DoSetItem(wxTreeViewItem* tvItem) { if ( TreeView_SetItem(GetHwnd(), tvItem) == -1 ) { - wxLogLastError("TreeView_SetItem"); + wxLogLastError(wxT("TreeView_SetItem")); } } @@ -487,7 +846,7 @@ wxImageList *wxTreeCtrl::GetImageList() const wxImageList *wxTreeCtrl::GetStateImageList() const { - return m_imageListNormal; + return m_imageListState; } void wxTreeCtrl::SetAnyImageList(wxImageList *imageList, int which) @@ -500,12 +859,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, @@ -522,22 +899,26 @@ size_t wxTreeCtrl::GetChildrenCount(const wxTreeItemId& item, bool wxTreeCtrl::SetBackgroundColour(const wxColour &colour) { +#if !wxUSE_COMCTL32_SAFELY if ( !wxWindowBase::SetBackgroundColour(colour) ) - return FALSE; + return false; SendMessage(GetHwnd(), TVM_SETBKCOLOR, 0, colour.GetPixel()); +#endif - return TRUE; + return true; } bool wxTreeCtrl::SetForegroundColour(const wxColour &colour) { +#if !wxUSE_COMCTL32_SAFELY if ( !wxWindowBase::SetForegroundColour(colour) ) - return FALSE; + return false; SendMessage(GetHwnd(), TVM_SETTEXTCOLOR, 0, colour.GetPixel()); +#endif - return TRUE; + return true; } // ---------------------------------------------------------------------------- @@ -562,9 +943,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, @@ -620,6 +1018,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); @@ -653,15 +1057,35 @@ int wxTreeCtrl::GetItemImage(const wxTreeItemId& item, void wxTreeCtrl::SetItemImage(const wxTreeItemId& item, int image, wxTreeItemIcon which) { - int imageNormal, imageSel; + if ( IS_VIRTUAL_ROOT(item) ) + { + // TODO: Maybe a hidden root can still store images? + return; + } + + int imageNormal, + imageSel; + switch ( which ) { default: wxFAIL_MSG( wxT("unknown tree item image type") ); + // fall through case wxTreeItemIcon_Normal: - imageNormal = image; - imageSel = GetItemSelectedImage(item); + { + 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: @@ -677,7 +1101,7 @@ void wxTreeCtrl::SetItemImage(const wxTreeItemId& item, int image, // the wxTreeItemIndirectData GetItemXXXImage() will use it to // get the images imageNormal = GetItemImage(item); - imageSel = GetItemSelectedImage(item); + imageSel = GetItemImage(item, wxTreeItemIcon_Selected); // if it doesn't have it yet, add it wxTreeItemIndirectData *data = new @@ -706,23 +1130,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) ) @@ -752,18 +1194,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); @@ -771,6 +1223,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); @@ -778,56 +1233,110 @@ 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::SetItemTextColour(const wxTreeItemId& item, - const wxColour& col) +void wxTreeCtrl::RefreshItem(const wxTreeItemId& item) { - m_hasAnyAttr = TRUE; + if ( IS_VIRTUAL_ROOT(item) ) + return; - long id = (long)(WXHTREEITEM)item; - wxTreeItemAttr *attr = (wxTreeItemAttr *)m_attrs.Get(id); - if ( !attr ) + wxRect rect; + if ( GetBoundingRect(item, rect) ) { - attr = new wxTreeItemAttr; - m_attrs.Put(id, (wxObject *)attr); + RefreshRect(rect); } - - attr->SetTextColour(col); } -void wxTreeCtrl::SetItemBackgroundColour(const wxTreeItemId& item, - const wxColour& col) +wxColour wxTreeCtrl::GetItemTextColour(const wxTreeItemId& item) const { - m_hasAnyAttr = TRUE; + wxMapTreeAttr::const_iterator it = m_attrs.find(item.m_pItem); - long id = (long)(WXHTREEITEM)item; - wxTreeItemAttr *attr = (wxTreeItemAttr *)m_attrs.Get(id); - if ( !attr ) - { - attr = new wxTreeItemAttr; - m_attrs.Put(id, (wxObject *)attr); - } + return it == m_attrs.end() ? wxNullColour : it->second->GetTextColour(); +} - attr->SetBackgroundColour(col); +wxColour wxTreeCtrl::GetItemBackgroundColour(const wxTreeItemId& item) const +{ + wxMapTreeAttr::const_iterator it = m_attrs.find(item.m_pItem); + + return it == m_attrs.end() ? wxNullColour : it->second->GetBackgroundColour(); } -void wxTreeCtrl::SetItemFont(const wxTreeItemId& item, const wxFont& font) +wxFont wxTreeCtrl::GetItemFont(const wxTreeItemId& item) const { - m_hasAnyAttr = TRUE; + wxMapTreeAttr::const_iterator it = m_attrs.find(item.m_pItem); + + return it == m_attrs.end() ? wxNullFont : it->second->GetFont(); +} - long id = (long)(WXHTREEITEM)item; - wxTreeItemAttr *attr = (wxTreeItemAttr *)m_attrs.Get(id); - if ( !attr ) +void wxTreeCtrl::SetItemTextColour(const wxTreeItemId& item, + const wxColour& col) +{ + wxTreeItemAttr *attr; + wxMapTreeAttr::iterator it = m_attrs.find(item.m_pItem); + if ( it == m_attrs.end() ) { + m_hasAnyAttr = true; + + m_attrs[item.m_pItem] = attr = new wxTreeItemAttr; - m_attrs.Put(id, (wxObject *)attr); + } + else + { + attr = it->second; } - attr->SetFont(font); + attr->SetTextColour(col); + + RefreshItem(item); +} + +void wxTreeCtrl::SetItemBackgroundColour(const wxTreeItemId& item, + const wxColour& col) +{ + wxTreeItemAttr *attr; + wxMapTreeAttr::iterator it = m_attrs.find(item.m_pItem); + if ( it == m_attrs.end() ) + { + m_hasAnyAttr = true; + + m_attrs[item.m_pItem] = + attr = new wxTreeItemAttr; + } + else // already in the hash + { + attr = it->second; + } + + attr->SetBackgroundColour(col); + + RefreshItem(item); +} + +void wxTreeCtrl::SetItemFont(const wxTreeItemId& item, const wxFont& font) +{ + wxTreeItemAttr *attr; + wxMapTreeAttr::iterator it = m_attrs.find(item.m_pItem); + if ( it == m_attrs.end() ) + { + m_hasAnyAttr = true; + + m_attrs[item.m_pItem] = + attr = new wxTreeItemAttr; + } + else // already in the hash + { + attr = it->second; + } + + attr->SetFont(font); + + RefreshItem(item); } // ---------------------------------------------------------------------------- @@ -836,16 +1345,31 @@ void wxTreeCtrl::SetItemFont(const wxTreeItemId& item, const wxFont& font) bool wxTreeCtrl::IsVisible(const wxTreeItemId& item) const { + if ( item == wxTreeItemId(TVI_ROOT) ) + { + // virtual (hidden) root is never visible + return false; + } + // Bug in Gnu-Win32 headers, so don't use the macro TreeView_GetItemRect RECT rect; // this ugliness comes directly from MSDN - it *is* the correct way to pass // the HTREEITEM with TVM_GETITEMRECT - *(WXHTREEITEM *)&rect = (WXHTREEITEM)item; + *(HTREEITEM *)&rect = HITEM(item); - // FALSE means get item rect for the whole item, not only text - return SendMessage(GetHwnd(), TVM_GETITEMRECT, FALSE, (LPARAM)&rect) != 0; + // true means to get rect for just the text, not the whole line + if ( !::SendMessage(GetHwnd(), TVM_GETITEMRECT, true, (LPARAM)&rect) ) + { + // if TVM_GETITEMRECT returned false, then the item is definitely not + // visible (because its parent is not expanded) + return false; + } + // however if it returned true, the item might still be outside the + // currently visible part of the tree, test for it (notice that partly + // visible means visible here) + return rect.bottom > 0 && rect.top < GetClientSize().y; } bool wxTreeCtrl::ItemHasChildren(const wxTreeItemId& item) const @@ -889,45 +1413,91 @@ bool wxTreeCtrl::IsBold(const wxTreeItemId& item) const wxTreeItemId wxTreeCtrl::GetRootItem() const { - return wxTreeItemId((WXHTREEITEM) TreeView_GetRoot(GetHwnd())); + // Root may be real (visible) or virtual (hidden). + if ( GET_VIRTUAL_ROOT() ) + return TVI_ROOT; + + return wxTreeItemId(TreeView_GetRoot(GetHwnd())); } wxTreeItemId wxTreeCtrl::GetSelection() const { - wxCHECK_MSG( !(m_windowStyle & wxTR_MULTIPLE), (WXHTREEITEM)0, + wxCHECK_MSG( !(m_windowStyle & wxTR_MULTIPLE), wxTreeItemId(), wxT("this only works with single selection controls") ); - return wxTreeItemId((WXHTREEITEM) TreeView_GetSelection(GetHwnd())); + return wxTreeItemId(TreeView_GetSelection(GetHwnd())); } -wxTreeItemId wxTreeCtrl::GetParent(const wxTreeItemId& item) const +wxTreeItemId wxTreeCtrl::GetItemParent(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(hItem); } wxTreeItemId wxTreeCtrl::GetFirstChild(const wxTreeItemId& item, - long& _cookie) const + wxTreeItemIdValue& cookie) const { // remember the last child returned in 'cookie' - _cookie = (long)TreeView_GetChild(GetHwnd(), (HTREEITEM) (WXHTREEITEM)item); + cookie = TreeView_GetChild(GetHwnd(), HITEM(item)); - return wxTreeItemId((WXHTREEITEM)_cookie); + return wxTreeItemId(cookie); } wxTreeItemId wxTreeCtrl::GetNextChild(const wxTreeItemId& WXUNUSED(item), - long& _cookie) const + wxTreeItemIdValue& cookie) const { - wxTreeItemId l = wxTreeItemId((WXHTREEITEM)TreeView_GetNextSibling(GetHwnd(), - (HTREEITEM)(WXHTREEITEM)_cookie)); - _cookie = (long)l; + wxTreeItemId item(TreeView_GetNextSibling(GetHwnd(), + HITEM(wxTreeItemId(cookie)))); + cookie = item.m_pItem; - return l; + return item; } +#if WXWIN_COMPATIBILITY_2_4 + +wxTreeItemId wxTreeCtrl::GetFirstChild(const wxTreeItemId& item, + long& cookie) const +{ + cookie = (long)TreeView_GetChild(GetHwnd(), HITEM(item)); + + return wxTreeItemId((void *)cookie); +} + +wxTreeItemId wxTreeCtrl::GetNextChild(const wxTreeItemId& WXUNUSED(item), + long& cookie) const +{ + wxTreeItemId item(TreeView_GetNextSibling + ( + GetHwnd(), + HITEM(wxTreeItemId((void *)cookie) + ))); + cookie = (long)item.m_pItem; + + return item; +} + +#endif // WXWIN_COMPATIBILITY_2_4 + wxTreeItemId wxTreeCtrl::GetLastChild(const wxTreeItemId& item) const { // can this be done more efficiently? - long cookie; + wxTreeItemIdValue cookie; wxTreeItemId childLast, child = GetFirstChild(item, cookie); @@ -942,33 +1512,31 @@ 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(TreeView_GetNextSibling(GetHwnd(), HITEM(item))); } wxTreeItemId wxTreeCtrl::GetPrevSibling(const wxTreeItemId& item) const { - return wxTreeItemId((WXHTREEITEM) TreeView_GetPrevSibling(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item)); + return wxTreeItemId(TreeView_GetPrevSibling(GetHwnd(), HITEM(item))); } wxTreeItemId wxTreeCtrl::GetFirstVisibleItem() const { - return wxTreeItemId((WXHTREEITEM) TreeView_GetFirstVisible(GetHwnd())); + return wxTreeItemId(TreeView_GetFirstVisible(GetHwnd())); } 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(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(TreeView_GetPrevVisible(GetHwnd(), HITEM(item))); } // ---------------------------------------------------------------------------- @@ -990,6 +1558,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; @@ -1013,9 +1583,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 @@ -1030,6 +1604,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 ) { @@ -1060,33 +1639,46 @@ 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 ) { // associate the application tree item with Win32 tree item handle - data->SetId((WXHTREEITEM)id); + data->SetId(id); } - return wxTreeItemId((WXHTREEITEM)id); + return wxTreeItemId(id); } // for compatibility only +#if WXWIN_COMPATIBILITY_2_4 + wxTreeItemId wxTreeCtrl::InsertItem(const wxTreeItemId& parent, const wxString& text, int image, int selImage, long insertAfter) { - return DoInsertItem(parent, (WXHTREEITEM)insertAfter, text, + return DoInsertItem(parent, wxTreeItemId((void *)insertAfter), text, image, selImage, NULL); } +#endif // WXWIN_COMPATIBILITY_2_4 + 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(), wxTreeItemId(), text, image, selectedImage, data); } @@ -1095,7 +1687,7 @@ wxTreeItemId wxTreeCtrl::PrependItem(const wxTreeItemId& parent, int image, int selectedImage, wxTreeItemData *data) { - return DoInsertItem(parent, (WXHTREEITEM) TVI_FIRST, + return DoInsertItem(parent, TVI_FIRST, text, image, selectedImage, data); } @@ -1115,7 +1707,7 @@ wxTreeItemId wxTreeCtrl::InsertItem(const wxTreeItemId& parent, wxTreeItemData *data) { // find the item from index - long cookie; + wxTreeItemIdValue cookie; wxTreeItemId idPrev, idCur = GetFirstChild(parent, cookie); while ( index != 0 && idCur.IsOk() ) { @@ -1137,28 +1729,28 @@ wxTreeItemId wxTreeCtrl::AppendItem(const wxTreeItemId& parent, int image, int selectedImage, wxTreeItemData *data) { - return DoInsertItem(parent, (WXHTREEITEM) TVI_LAST, + return DoInsertItem(parent, TVI_LAST, text, image, selectedImage, data); } 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")); } } // delete all children (but don't delete the item itself) void wxTreeCtrl::DeleteChildren(const wxTreeItemId& item) { - long cookie; + wxTreeItemIdValue cookie; - wxArrayLong children; + wxArrayTreeItemIds children; wxTreeItemId child = GetFirstChild(item, cookie); while ( child.IsOk() ) { - children.Add((long)(WXHTREEITEM)child); + children.Add(child); child = GetNextChild(item, cookie); } @@ -1166,18 +1758,27 @@ void wxTreeCtrl::DeleteChildren(const wxTreeItemId& item) size_t nCount = children.Count(); for ( size_t n = 0; n < nCount; n++ ) { - if ( !TreeView_DeleteItem(GetHwnd(), (HTREEITEM)children[n]) ) + if ( !TreeView_DeleteItem(GetHwnd(), HITEM_PTR(children[n])) ) { - wxLogLastError("TreeView_DeleteItem"); + wxLogLastError(wxT("TreeView_DeleteItem")); } } } void wxTreeCtrl::DeleteAllItems() { + // delete the "virtual" root item. + if ( GET_VIRTUAL_ROOT() ) + { + delete GET_VIRTUAL_ROOT(); + m_pVirtualRoot = NULL; + } + + // and all the real items + if ( !TreeView_DeleteAllItems(GetHwnd()) ) { - wxLogLastError("TreeView_DeleteAllItems"); + wxLogLastError(wxT("TreeView_DeleteAllItems")); } } @@ -1189,6 +1790,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 @@ -1201,21 +1806,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 } @@ -1240,17 +1843,20 @@ void wxTreeCtrl::Toggle(const wxTreeItemId& item) DoExpand(item, TVE_TOGGLE); } +#if WXWIN_COMPATIBILITY_2_4 void wxTreeCtrl::ExpandItem(const wxTreeItemId& item, int action) { DoExpand(item, action); } +#endif 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()); } void wxTreeCtrl::UnselectAll() @@ -1261,7 +1867,11 @@ void wxTreeCtrl::UnselectAll() size_t count = GetSelections(selections); for ( size_t n = 0; n < count; n++ ) { - SetItemCheck(selections[n], FALSE); +#if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE + SetItemCheck(HITEM_PTR(selections[n]), false); +#else // !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE + ::UnselectItem(GetHwnd(), HITEM_PTR(selections[n])); +#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE/!wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE } } else @@ -1271,15 +1881,22 @@ void wxTreeCtrl::UnselectAll() } } -void wxTreeCtrl::SelectItem(const wxTreeItemId& item) +void wxTreeCtrl::SelectItem(const wxTreeItemId& item, bool select) { if ( m_windowStyle & wxTR_MULTIPLE ) { +#if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE // selecting the item means checking it - SetItemCheck(item); + SetItemCheck(item, select); +#else // !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE + ::SelectItem(GetHwnd(), HITEM(item), select); +#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE/!wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE } else { + wxASSERT_MSG( select, + _T("SelectItem(false) works only for multiselect") ); + // inspite of the docs (MSDN Jan 99 edition), we don't seem to receive // the notification from the control (i.e. TVN_SELCHANG{ED|ING}), so // send them ourselves @@ -1291,11 +1908,11 @@ 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 + else // ok { event.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED); (void)GetEventHandler()->ProcessEvent(event); @@ -1305,40 +1922,32 @@ void wxTreeCtrl::SelectItem(const wxTreeItemId& item) } } +void wxTreeCtrl::UnselectItem(const wxTreeItemId& item) +{ + SelectItem(item, false); +} + +void wxTreeCtrl::ToggleItemSelection(const wxTreeItemId& item) +{ + SelectItem(item, !IsSelected(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")); } } -wxTextCtrl* wxTreeCtrl::GetEditControl() const +wxTextCtrl *wxTreeCtrl::GetEditControl() const { - // normally, we could try to do something like this to return something - // even when the editing was started by the user and not by calling - // EditLabel() - but as nobody has asked for this so far and there might be - // problems in the code below, I leave it disabled for now (VZ) -#if 0 - if ( !m_textCtrl ) - { - HWND hwndText = TreeView_GetEditControl(GetHwnd()); - if ( hwndText ) - { - m_textCtrl = new wxTextCtrl(this, -1); - m_textCtrl->Hide(); - m_textCtrl->SetHWND((WXHWND)hwndText); - } - //else: not editing label right now - } -#endif // 0 - return m_textCtrl; } @@ -1346,6 +1955,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; @@ -1360,24 +1977,24 @@ wxTextCtrl* wxTreeCtrl::EditLabel(const wxTreeItemId& item, DeleteTextCtrl(); - HWND hWnd = (HWND) TreeView_EditLabel(GetHwnd(), (HTREEITEM) (WXHTREEITEM) item); + 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 + // returned false if ( !hWnd ) { + delete m_textCtrl; + m_textCtrl = NULL; return NULL; } - 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); @@ -1412,7 +2029,7 @@ wxTreeItemId wxTreeCtrl::HitTest(const wxPoint& point, int& flags) #undef TRANSLATE_FLAG - return wxTreeItemId((WXHTREEITEM) hitTestInfo.hItem); + return wxTreeItemId(hitTestInfo.hItem); } bool wxTreeCtrl::GetBoundingRect(const wxTreeItemId& item, @@ -1420,17 +2037,24 @@ bool wxTreeCtrl::GetBoundingRect(const wxTreeItemId& item, bool textOnly) const { RECT rc; - if ( TreeView_GetItemRect(GetHwnd(), (HTREEITEM)(WXHTREEITEM)item, + + // Virtual root items have no bounding rectangle + if ( IS_VIRTUAL_ROOT(item) ) + { + return false; + } + + if ( TreeView_GetItemRect(GetHwnd(), HITEM(item), &rc, textOnly) ) { rect = wxRect(wxPoint(rc.left, rc.top), wxPoint(rc.right, rc.bottom)); - return TRUE; + return true; } else { // couldn't retrieve rect: for example, item isn't visible - return FALSE; + return false; } } @@ -1438,14 +2062,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, @@ -1461,13 +2108,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 */); } @@ -1494,67 +2141,285 @@ bool wxTreeCtrl::MSWCommand(WXUINT cmd, WXWORD id) else { // nothing done - return FALSE; + return false; } // command processed - return TRUE; + return true; } // we hook into WndProc to process WM_MOUSEMOVE/WM_BUTTONUP messages - as we // only do it during dragging, minimize wxWin overhead (this is important for // WM_MOUSEMOVE as they're a lot of them) by catching Windows messages directly // instead of passing by wxWin events -long wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam) +WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam) { - if ( m_dragImage ) + bool processed = false; + WXLRESULT rc = 0; + bool isMultiple = (GetWindowStyle() & wxTR_MULTIPLE) != 0; + + if ( (nMsg >= WM_MOUSEFIRST) && (nMsg <= WM_MOUSELAST) ) { + // 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); + switch ( nMsg ) { - case WM_MOUSEMOVE: + case WM_RBUTTONDOWN: + // if the item we are about to right click on is not already + // selected or if we click outside of any item, remove the + // entire previous selection + if ( !htItem || !::IsItemSelected(GetHwnd(), htItem) ) { - int x = GET_X_LPARAM(lParam), - y = GET_Y_LPARAM(lParam); + UnselectAll(); + } - m_dragImage->Move(wxPoint(x, y), this); + // select item and set the focus to the + // newly selected item + ::SelectItem(GetHwnd(), htItem); + ::SetFocus(GetHwnd(), htItem); + break; - HTREEITEM htiTarget = GetItemFromPoint(GetHwnd(), x, y); - if ( htiTarget ) +#if !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE + case WM_LBUTTONDOWN: + if ( htItem && isMultiple ) + { + if ( wParam & MK_CONTROL ) + { + SetFocus(); + + // toggle selected state + ::ToggleItemSelection(GetHwnd(), htItem); + + ::SetFocus(GetHwnd(), htItem); + + // reset on any click without Shift + m_htSelStart.Unset(); + + 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 = TreeView_GetSelection(GetHwnd()); + } + + SelectRange(GetHwnd(), HITEM(m_htSelStart), htItem, + !(wParam & MK_CONTROL)); + + ::SetFocus(GetHwnd(), htItem); + + processed = true; + } + else // normal click + { + // avoid doing anything if we click on the only + // currently selected item + + wxArrayTreeItemIds selections; + size_t count = GetSelections(selections); + if ( count == 0 || + count > 1 || + HITEM_PTR(selections[0]) != htItem ) + { + // clear the previously selected items, if the + // user clicked outside of the present selection. + // otherwise, perform the deselection on mouse-up. + // this allows multiple drag and drop to work. + + if (IsItemSelected(GetHwnd(), htItem)) + { + ::SetFocus(GetHwnd(), htItem); + } + else + { + UnselectAll(); + + // prevent the click from starting in-place editing + // which should only happen if we click on the + // already selected item (and nothing else is + // selected) + + TreeView_SelectItem(GetHwnd(), 0); + ::SelectItem(GetHwnd(), htItem); + } + } + + // reset on any click without Shift + m_htSelStart.Unset(); + } + } + 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(this); - TreeView_SelectDropTarget(GetHwnd(), htiTarget); - m_dragImage->Show(this); + m_dragImage->Hide(); + TreeView_SelectDropTarget(GetHwnd(), htItem); + m_dragImage->Show(); } } break; case WM_LBUTTONUP: + + // facilitates multiple drag-and-drop + if (htItem && isMultiple) + { + wxArrayTreeItemIds selections; + size_t count = GetSelections(selections); + + if (count > 1 && + !(wParam & MK_CONTROL) && + !(wParam & MK_SHIFT)) + { + UnselectAll(); + TreeView_SelectItem(GetHwnd(), htItem); + } + } + + // fall through + case WM_RBUTTONUP: + if ( m_dragImage ) { - m_dragImage->EndDrag(this); + m_dragImage->EndDrag(); delete m_dragImage; m_dragImage = NULL; // generate the drag end event wxTreeEvent event(wxEVT_COMMAND_TREE_END_DRAG, m_windowId); - int x = GET_X_LPARAM(lParam), - y = GET_Y_LPARAM(lParam); - - event.m_item - = (WXHTREEITEM)GetItemFromPoint(GetHwnd(), x, y); + event.m_item = 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_PTR(selections[n]), + &rect, true) ) + { + ::InvalidateRect(GetHwnd(), &rect, false); + } + } + } + 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 = 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); + } - return wxControl::MSWWindowProc(nMsg, wParam, lParam); + processed = true; + } + } + } +#endif // !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE + else if ( nMsg == WM_CHAR ) + { + // don't let the control process Space and Return keys because it + // doesn't do anything useful with them anyhow but always beeps + // annoyingly when it receives them and there is no way to turn it off + // simply if you just process TREEITEM_ACTIVATED event to which Space + // and Enter presses are mapped in your code + if ( wParam == VK_SPACE || wParam == VK_RETURN ) + { + processed = true; + } + } + + if ( !processed ) + rc = wxControl::MSWWindowProc(nMsg, wParam, lParam); + + return rc; } // process WM_NOTIFY Windows message @@ -1566,25 +2431,6 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) switch ( hdr->code ) { - case NM_RCLICK: - { - if ( wxControl::MSWOnNotify(idCtrl, lParam, result) ) - return TRUE; - - 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 = wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK; - } - } - } - break; - case TVN_BEGINDRAG: eventType = wxEVT_COMMAND_TREE_BEGIN_DRAG; // fall through @@ -1597,7 +2443,7 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam; - event.m_item = (WXHTREEITEM) tv->itemNew.hItem; + event.m_item = tv->itemNew.hItem; event.m_pointDrag = wxPoint(tv->ptDrag.x, tv->ptDrag.y); // don't allow dragging by default: the user code must @@ -1612,8 +2458,9 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) eventType = wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT; TV_DISPINFO *info = (TV_DISPINFO *)lParam; - event.m_item = (WXHTREEITEM) info->item.hItem; + event.m_item = info->item.hItem; event.m_label = info->item.pszText; + event.m_editCancelled = false; } break; @@ -1622,12 +2469,16 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) eventType = wxEVT_COMMAND_TREE_DELETE_ITEM; NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam; - event.m_item = (WXHTREEITEM)tv->itemOld.hItem; + event.m_item = tv->itemOld.hItem; if ( m_hasAnyAttr ) { - delete (wxTreeItemAttr *)m_attrs. - Delete((long)tv->itemOld.hItem); + wxMapTreeAttr::iterator it = m_attrs.find(tv->itemOld.hItem); + if ( it != m_attrs.end() ) + { + delete it->second; + m_attrs.erase(it); + } } } break; @@ -1637,13 +2488,36 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) eventType = wxEVT_COMMAND_TREE_END_LABEL_EDIT; TV_DISPINFO *info = (TV_DISPINFO *)lParam; - event.m_item = (WXHTREEITEM)info->item.hItem; + event.m_item = info->item.hItem; event.m_label = info->item.pszText; - if (info->item.pszText == NULL) - return FALSE; + event.m_editCancelled = info->item.pszText == NULL; + break; + } + +#ifndef __WXWINCE__ + // These *must* not be removed or TVN_GETINFOTIP will + // not be processed each time the mouse is moved + // and the tooltip will only ever update once. + case TTN_NEEDTEXTA: + case TTN_NEEDTEXTW: + { + *result = 0; + break; } + case TVN_GETINFOTIP: + { + eventType = wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP; + NMTVGETINFOTIP *info = (NMTVGETINFOTIP*)lParam; + + // Which item are we trying to get a tooltip for? + event.m_item = info->hItem; + + break; + } +#endif + case TVN_GETDISPINFO: eventType = wxEVT_COMMAND_TREE_GET_INFO; // fall through @@ -1656,38 +2530,37 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) TV_DISPINFO *info = (TV_DISPINFO *)lParam; - event.m_item = (WXHTREEITEM) info->item.hItem; + event.m_item = info->item.hItem; break; } case TVN_ITEMEXPANDING: - event.m_code = FALSE; - // fall through - case TVN_ITEMEXPANDED: { NM_TREEVIEW* tv = (NM_TREEVIEW*)lParam; - bool expand = FALSE; + 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 = hdr->code == TVN_ITEMEXPANDING ? IDX_DOING + : IDX_DONE; + + eventType = gs_expandEvents[what][how]; - event.m_item = (WXHTREEITEM) tv->itemNew.hItem; + event.m_item = tv->itemNew.hItem; } break; @@ -1696,133 +2569,197 @@ 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); + // fabricate the lParam and wParam parameters sufficiently + // similar to the ones from a "real" WM_KEYDOWN so that + // CreateKeyEvent() works correctly + WXLPARAM lParam = + (::GetKeyState(VK_MENU) < 0 ? KF_ALTDOWN : 0) << 16; - // a separate event for this case - if ( info->wVKey == VK_SPACE || info->wVKey == VK_RETURN ) + WXWPARAM wParam = info->wVKey; + + int keyCode = wxCharCodeMSWToWX(info->wVKey); + if ( !keyCode ) + { + // wxCharCodeMSWToWX() returns 0 to indicate that this is a + // simple ASCII key + keyCode = wParam; + } + + event.m_evtKey = CreateKeyEvent(wxEVT_KEY_DOWN, + keyCode, + lParam, + wParam); + + // 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; - case TVN_SELCHANGED: + // NB: MSLU is broken and sends TVN_SELCHANGEDA instead of + // TVN_SELCHANGEDW in Unicode mode under Win98. Therefore + // we have to handle both messages: + case TVN_SELCHANGEDA: + case TVN_SELCHANGEDW: eventType = wxEVT_COMMAND_TREE_SEL_CHANGED; // fall through - case TVN_SELCHANGING: + case TVN_SELCHANGINGA: + case TVN_SELCHANGINGW: { if ( eventType == wxEVT_NULL ) eventType = wxEVT_COMMAND_TREE_SEL_CHANGING; //else: already set above - NM_TREEVIEW* tv = (NM_TREEVIEW *)lParam; - - event.m_item = (WXHTREEITEM) tv->itemNew.hItem; - event.m_itemOld = (WXHTREEITEM) tv->itemOld.hItem; + if (hdr->code == TVN_SELCHANGINGW || + hdr->code == TVN_SELCHANGEDW) + { + NM_TREEVIEWW* tv = (NM_TREEVIEWW *)lParam; + event.m_item = tv->itemNew.hItem; + event.m_itemOld = tv->itemOld.hItem; + } + else + { + NM_TREEVIEWA* tv = (NM_TREEVIEWA *)lParam; + event.m_item = tv->itemNew.hItem; + event.m_itemOld = tv->itemOld.hItem; + } } break; -#if defined(_WIN32_IE) && _WIN32_IE >= 0x300 + // instead of explicitly checking for _WIN32_IE, check if the + // required symbols are available in the headers +#if defined(CDDS_PREPAINT) && !wxUSE_COMCTL32_SAFELY case NM_CUSTOMDRAW: { 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: { - wxTreeItemAttr *attr = - (wxTreeItemAttr *)m_attrs.Get(nmcd.dwItemSpec); + wxMapTreeAttr::iterator + it = m_attrs.find((void *)nmcd.dwItemSpec); - if ( !attr ) + if ( it == m_attrs.end() ) { // nothing to do for this item - return CDRF_DODEFAULT; - } - - HFONT hFont; - wxColour colText, colBack; - if ( attr->HasFont() ) - { - wxFont font = attr->GetFont(); - hFont = (HFONT)font.GetResourceHandle(); - } - else - { - hFont = 0; - } - - if ( attr->HasTextColour() ) - { - colText = attr->GetTextColour(); - } - else - { - colText = GetForegroundColour(); + *result = CDRF_DODEFAULT; + break; } - // selection colours should override ours - if ( nmcd.uItemState & CDIS_SELECTED ) - { - DWORD clrBk = ::GetSysColor(COLOR_HIGHLIGHT); - lptvcd->clrTextBk = clrBk; + wxTreeItemAttr * const attr = it->second; - // try to make the text visible - lptvcd->clrText = wxColourToRGB(colText); - lptvcd->clrText |= ~clrBk; - lptvcd->clrText &= 0x00ffffff; - } - else + // selection colours should override ours, + // otherwise it is too confusing ot the user + if ( !(nmcd.uItemState & CDIS_SELECTED) ) { + wxColour colBack; if ( attr->HasBackgroundColour() ) { colBack = attr->GetBackgroundColour(); + lptvcd->clrTextBk = wxColourToRGB(colBack); } - else + } + + // but we still want to keep the special foreground + // 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 ) + { + wxColour colText; + if ( attr->HasTextColour() ) { - colBack = GetBackgroundColour(); + colText = attr->GetTextColour(); + lptvcd->clrText = wxColourToRGB(colText); } - - lptvcd->clrText = wxColourToRGB(colText); - lptvcd->clrTextBk = wxColourToRGB(colBack); } - // note that if we wanted to set colours for - // individual columns (subitems), we would have - // returned CDRF_NOTIFYSUBITEMREDRAW from here - if ( hFont ) + if ( attr->HasFont() ) { + HFONT hFont = GetHfontOf(attr->GetFont()); + ::SelectObject(nmcd.hdc, hFont); *result = CDRF_NEWFONT; } - else + else // no specific font { *result = CDRF_DODEFAULT; } - - return TRUE; } + break; default: *result = CDRF_DODEFAULT; - return TRUE; } } - break; -#endif // _WIN32_IE >= 0x300 + + // we always process it + return true; +#endif // have owner drawn support in headers + + case NM_CLICK: + { + DWORD pos = GetMessagePos(); + POINT point; + point.x = LOWORD(pos); + point.y = HIWORD(pos); + ::MapWindowPoints(HWND_DESKTOP, GetHwnd(), &point, 1); + int flags = 0; + wxTreeItemId item = HitTest(wxPoint(point.x, point.y), flags); + if (flags & wxTREE_HITTEST_ONITEMSTATEICON) + { + event.m_item = item; + eventType = wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK; + } + break; + } + + 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 = 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); @@ -1836,6 +2773,14 @@ 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() ) @@ -1846,7 +2791,7 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) m_dragImage = new wxDragImage(*this, event.m_item); m_dragImage->BeginDrag(wxPoint(0, 0), this); - m_dragImage->Show(this); + m_dragImage->Show(); } break; @@ -1864,8 +2809,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 { @@ -1873,34 +2816,92 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) delete data; // may be NULL, ok } - processed = TRUE; // Make sure we don't get called twice + processed = true; // Make sure we don't get called twice } break; case TVN_BEGINLABELEDIT: - // return TRUE to cancel label editing + // 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 DeleteTextCtrl(); break; +#ifndef __WXWINCE__ + case TVN_GETINFOTIP: + { + // If the user permitted a tooltip change, change it + if (event.IsAllowed()) + { + SetToolTip(event.m_label); + } + } + break; +#endif + case TVN_SELCHANGING: case TVN_ITEMEXPANDING: - // return TRUE to prevent the action from happening + // return true to prevent the action from happening *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(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; @@ -1931,22 +2932,51 @@ 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 +// State control. // ---------------------------------------------------------------------------- -IMPLEMENT_DYNAMIC_CLASS(wxTreeEvent, wxNotifyEvent) +// why do they define INDEXTOSTATEIMAGEMASK but not the inverse? +#define STATEIMAGEMASKTOINDEX(state) (((state) & TVIS_STATEIMAGEMASK) >> 12) + +void wxTreeCtrl::SetState(const wxTreeItemId& node, int state) +{ + TV_ITEM tvi; + tvi.hItem = (HTREEITEM)node.m_pItem; + tvi.mask = TVIF_STATE; + tvi.stateMask = TVIS_STATEIMAGEMASK; + + // Select the specified state, or -1 == cycle to the next one. + if ( state == -1 ) + { + TreeView_GetItem(GetHwnd(), &tvi); + + state = STATEIMAGEMASKTOINDEX(tvi.state) + 1; + if ( state == m_imageListState->GetImageCount() ) + state = 1; + } -wxTreeEvent::wxTreeEvent(wxEventType commandType, int id) - : wxNotifyEvent(commandType, id) + wxCHECK_RET( state < m_imageListState->GetImageCount(), + _T("wxTreeCtrl::SetState(): item index out of bounds") ); + + tvi.state = INDEXTOSTATEIMAGEMASK(state); + + TreeView_SetItem(GetHwnd(), &tvi); +} + +int wxTreeCtrl::GetState(const wxTreeItemId& node) { - m_code = 0; - m_itemOld = 0; + TV_ITEM tvi; + tvi.hItem = (HTREEITEM)node.m_pItem; + tvi.mask = TVIF_STATE; + tvi.stateMask = TVIS_STATEIMAGEMASK; + TreeView_GetItem(GetHwnd(), &tvi); + + return STATEIMAGEMASKTOINDEX(tvi.state); } -#endif // __WIN95__ +#endif // wxUSE_TREECTRL