X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f6bcfd974ef26faf6f91a62cac09827e09463fd1..9d5507f7a2701395e1d5c121bd877bb9066ee6ea:/src/msw/treectrl.cpp?ds=inline diff --git a/src/msw/treectrl.cpp b/src/msw/treectrl.cpp index 73e8d4d856..8c48543587 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,9 +16,6 @@ // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ - #pragma implementation "treectrl.h" -#endif // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -27,92 +24,83 @@ #pragma hdrstop #endif -#include "wx/msw/private.h" +#if wxUSE_TREECTRL -// Set this to 1 to be _absolutely_ sure that repainting will work for all comctl32.dll versions -#define wxUSE_COMCTL32_SAFELY 0 +#include "wx/treectrl.h" -// Mingw32 is a bit mental even though this is done in winundef -#ifdef GetFirstChild - #undef GetFirstChild +#ifndef WX_PRECOMP + #include "wx/msw/wrapcctl.h" // include "properly" + #include "wx/msw/missing.h" + #include "wx/dynarray.h" + #include "wx/log.h" + #include "wx/app.h" + #include "wx/settings.h" #endif -#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/log.h" -#include "wx/dynarray.h" #include "wx/imaglist.h" -#include "wx/treectrl.h" -#include "wx/settings.h" - #include "wx/msw/dragimag.h" -#ifdef __GNUWIN32_OLD__ - #include "wx/msw/gnuwin32/extra.h" -#endif +// macros to hide the cast ugliness +// -------------------------------- -#if defined(__WIN95__) && !(defined(__GNUWIN32_OLD__) || defined(__TWIN32__)) - #include -#endif +// get HTREEITEM from wxTreeItemId +#define HITEM(item) ((HTREEITEM)(((item).m_pItem))) -// Bug in headers, sometimes -#ifndef TVIS_FOCUSED - #define TVIS_FOCUSED 0x0001 -#endif -#ifndef TV_FIRST - #define TV_FIRST 0x1100 -#endif +// older SDKs are missing these +#ifndef TVN_ITEMCHANGINGA -#ifndef TVS_CHECKBOXES - #define TVS_CHECKBOXES 0x0100 -#endif +#define TVN_ITEMCHANGINGA (TVN_FIRST-16) +#define TVN_ITEMCHANGINGW (TVN_FIRST-17) + +typedef struct tagNMTVITEMCHANGE +{ + NMHDR hdr; + UINT uChanged; + HTREEITEM hItem; + UINT uStateNew; + UINT uStateOld; + LPARAM lParam; +} NMTVITEMCHANGE; -// old headers might miss these messages (comctl32.dll 4.71+ only) -#ifndef TVM_SETBKCOLOR - #define TVM_SETBKCOLOR (TV_FIRST + 29) - #define TVM_SETTEXTCOLOR (TV_FIRST + 30) #endif -// a macro to hide the ugliness of nested casts -#define HITEM(item) (HTREEITEM)(WXHTREEITEM)(item) -// the native control doesn't support multiple selections under MSW and we -// have 2 ways to emulate them: either using TVS_CHECKBOXES style and let -// checkboxes be the selection status (checked == selected) or by really -// emulating everything, i.e. intercepting mouse and key events &c. The first -// approach is much easier but doesn't work with comctl32.dll < 4.71 and also -// looks quite ugly. -#define wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE 0 +// this global variable is used on vista systems for preventing unwanted +// item state changes in the vista tree control. It is only used in +// multi-select mode on vista systems. -// ---------------------------------------------------------------------------- -// private functions -// ---------------------------------------------------------------------------- +static HTREEITEM gs_unlockItem = NULL; -// wrapper for TreeView_HitTest -static HTREEITEM GetItemFromPoint(HWND hwndTV, int x, int y) +class TreeItemUnlocker { - TV_HITTESTINFO tvht; - tvht.pt.x = x; - tvht.pt.y = y; +public: + TreeItemUnlocker(HTREEITEM item) { gs_unlockItem = item; } + ~TreeItemUnlocker() { gs_unlockItem = NULL; } +}; - return (HTREEITEM)TreeView_HitTest(hwndTV, &tvht); -} -#if !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE +// ---------------------------------------------------------------------------- +// private functions +// ---------------------------------------------------------------------------- // 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; + TreeItemUnlocker unlocker(hItem); + if ( !TreeView_GetItem(hwndTV, &tvi) ) { wxLogLastError(wxT("TreeView_GetItem")); @@ -121,7 +109,7 @@ static bool IsItemSelected(HWND hwndTV, HTREEITEM hItem) return (tvi.state & TVIS_SELECTED) != 0; } -static void SelectItem(HWND hwndTV, HTREEITEM hItem, bool select = TRUE) +static bool SelectItem(HWND hwndTV, HTREEITEM hItem, bool select = true) { TV_ITEM tvi; tvi.mask = TVIF_STATE | TVIF_HANDLE; @@ -129,20 +117,20 @@ static void SelectItem(HWND hwndTV, HTREEITEM hItem, bool select = TRUE) tvi.state = select ? TVIS_SELECTED : 0; tvi.hItem = hItem; + TreeItemUnlocker unlocker(hItem); + if ( TreeView_SetItem(hwndTV, &tvi) == -1 ) { wxLogLastError(wxT("TreeView_SetItem")); + return false; } -} -static inline void UnselectItem(HWND hwndTV, HTREEITEM htItem) -{ - SelectItem(hwndTV, htItem, FALSE); + return true; } -static inline void ToggleItemSelection(HWND hwndTV, HTREEITEM htItem) +static inline void UnselectItem(HWND hwndTV, HTREEITEM htItem) { - SelectItem(hwndTV, htItem, !IsItemSelected(hwndTV, htItem)); + SelectItem(hwndTV, htItem, false); } // helper function which selects all items in a range and, optionally, @@ -150,10 +138,10 @@ static inline void ToggleItemSelection(HWND hwndTV, HTREEITEM htItem) static void SelectRange(HWND hwndTV, HTREEITEM htFirst, HTREEITEM htLast, - bool unselectOthers = TRUE) + bool unselectOthers = true) { // find the first (or last) item and select it - bool cont = TRUE; + bool cont = true; HTREEITEM htItem = (HTREEITEM)TreeView_GetRoot(hwndTV); while ( htItem && cont ) { @@ -164,7 +152,7 @@ static void SelectRange(HWND hwndTV, SelectItem(hwndTV, htItem); } - cont = FALSE; + cont = false; } else { @@ -213,60 +201,57 @@ static void SelectRange(HWND 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) +// +// returns true if the focus was changed, false if the given item was already +// the focused one +static bool SetFocus(HWND hwndTV, HTREEITEM htItem) { // the current focus HTREEITEM htFocus = (HTREEITEM)TreeView_GetSelection(hwndTV); + if ( htItem == htFocus ) + return false; + if ( htItem ) { - // set the focus - if ( htItem != htFocus ) - { - // remember the selection state of the item - bool wasSelected = IsItemSelected(hwndTV, htItem); + // 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); - } + 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); + 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 + if ( !wasSelected ) + { + // need to clear the selection which TreeView_SelectItem() gave + // us + UnselectItem(hwndTV, htItem); } - //else: nothing to do, focus already there + //else: was selected, still selected - ok } - else + else // reset focus { - if ( htFocus ) - { - bool wasFocusSelected = IsItemSelected(hwndTV, htFocus); + bool wasFocusSelected = IsItemSelected(hwndTV, htFocus); - // just clear the focus - TreeView_SelectItem(hwndTV, 0); + // just clear the focus + TreeView_SelectItem(hwndTV, 0); - if ( wasFocusSelected ) - { - // restore the selection state - SelectItem(hwndTV, htFocus); - } + if ( wasFocusSelected ) + { + // restore the selection state + SelectItem(hwndTV, htFocus); } - //else: nothing to do, no focus already } -} -#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE + return true; +} // ---------------------------------------------------------------------------- // private classes @@ -283,6 +268,8 @@ 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_; @@ -290,12 +277,138 @@ 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(wxTreeItemParam *param) + : wxTreeViewItem(TVI_ROOT, 0) + { + m_param = param; + } + + ~wxVirtualNode() + { + delete m_param; + } + + wxTreeItemParam *GetParam() const { return m_param; } + void SetParam(wxTreeItemParam *param) { delete m_param; m_param = param; } + +private: + wxTreeItemParam *m_param; + + 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: @@ -304,13 +417,18 @@ 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 - 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: @@ -320,6 +438,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 @@ -332,27 +452,34 @@ public: { m_selections.Empty(); - DoTraverse(tree->GetRootItem()); + if (tree->GetCount() > 0) + DoTraverse(tree->GetRootItem()); } virtual bool OnVisit(const wxTreeItemId& item) { -#if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE - if ( GetTree()->IsItemChecked(item) ) -#else - if ( ::IsItemSelected(GetHwndOf(GetTree()), HITEM(item)) ) -#endif + const wxTreeCtrl * const tree = GetTree(); + + // can't visit a virtual node. + if ( (tree->GetRootItem() == item) && tree->HasFlag(wxTR_HIDE_ROOT) ) + { + return true; + } + + if ( ::IsItemSelected(GetHwndOf(tree), HITEM(item)) ) { 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 @@ -369,91 +496,122 @@ 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) }; // ---------------------------------------------------------------------------- -// 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 have to maintain a list of all items which -// have indirect data inside the listctrl itself. +// wxWin macros // ---------------------------------------------------------------------------- -class wxTreeItemIndirectData -{ -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); - } +#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) +#if WXWIN_COMPATIBILITY_2_8 + wxFLAGS_MEMBER(wxTR_EXTENDED) +#endif + wxFLAGS_MEMBER(wxTR_DEFAULT_STYLE) - // dtor deletes the associated data as well - ~wxTreeItemIndirectData() { delete m_data; } +wxEND_FLAGS( wxTreeCtrlStyle ) - // accessors - // get the real data associated with the item - wxTreeItemData *GetData() const { return m_data; } - // change it - void SetData(wxTreeItemData *data) { m_data = data; } +IMPLEMENT_DYNAMIC_CLASS_XTI(wxTreeCtrl, wxControl,"wx/treectrl.h") - // 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; } +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 , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style +wxEND_PROPERTIES_TABLE() -private: - // all the images associated with the item - int m_images[wxTreeItemIcon_Max]; +wxBEGIN_HANDLERS_TABLE(wxTreeCtrl) +wxEND_HANDLERS_TABLE() - wxTreeItemData *m_data; -}; +wxCONSTRUCTOR_5( wxTreeCtrl , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size , long , WindowStyle ) +#else +IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl, wxControl) +#endif // ---------------------------------------------------------------------------- -// wxWin 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 @@ -466,28 +624,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; } // ---------------------------------------------------------------------------- @@ -496,13 +654,19 @@ bool wxTreeTraversal::Traverse(const wxTreeItemId& root, bool recursively) void wxTreeCtrl::Init() { - m_imageListNormal = NULL; - m_imageListState = NULL; m_textCtrl = NULL; - m_hasAnyAttr = FALSE; + m_hasAnyAttr = false; +#if wxUSE_DRAGIMAGE m_dragImage = NULL; +#endif + m_pVirtualRoot = NULL; - m_htSelStart = 0; + // 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, @@ -515,12 +679,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 /* | WS_CLIPSIBLINGS */; + WXDWORD 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; @@ -530,29 +700,26 @@ bool wxTreeCtrl::Create(wxWindow *parent, if ( m_windowStyle & wxTR_LINES_AT_ROOT ) wstyle |= TVS_LINESATROOT; - // 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)) + if ( m_windowStyle & wxTR_FULL_ROW_HIGHLIGHT ) + { + if ( wxApp::GetComCtl32Version() >= 471 ) + wstyle |= TVS_FULLROWSELECT; + } - // we emulate the multiple selection tree controls by using checkboxes: set - // up the image list we need for this if we do have multiple selections - if ( m_windowStyle & wxTR_MULTIPLE ) - wstyle |= TVS_CHECKBOXES; -#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE +#if !defined(__WXWINCE__) && defined(TVS_INFOTIP) + // Need so that TVN_GETINFOTIP messages will be sent + wstyle |= TVS_INFOTIP; +#endif // Create the tree control. - if ( !MSWCreateControl(WC_TREEVIEW, wstyle) ) - return FALSE; + if ( !MSWCreateControl(WC_TREEVIEW, wstyle, pos, size) ) + return false; #if wxUSE_COMCTL32_SAFELY - wxWindow::SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_WINDOW)); + wxWindow::SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW)); wxWindow::SetForegroundColour(wxWindow::GetParent()->GetForegroundColour()); #elif 1 - SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_WINDOW)); + 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 @@ -561,7 +728,7 @@ bool wxTreeCtrl::Create(wxWindow *parent, // 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::GetSystemColour(wxSYS_COLOUR_WINDOW)); + wxWindow::SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW)); SetForegroundColour(wxWindow::GetParent()->GetForegroundColour()); #endif @@ -578,9 +745,9 @@ bool wxTreeCtrl::Create(wxWindow *parent, HDC hdcMem = CreateCompatibleDC(NULL); // create a mono bitmap of the standard size - int x = GetSystemMetrics(SM_CXMENUCHECK); - int y = GetSystemMetrics(SM_CYMENUCHECK); - wxImageList imagelistCheckboxes(x, y, FALSE, 2); + int x = ::GetSystemMetrics(SM_CXMENUCHECK); + int y = ::GetSystemMetrics(SM_CYMENUCHECK); + wxImageList imagelistCheckboxes(x, y, false, 2); HBITMAP hbmpCheck = CreateBitmap(x, y, // bitmap size 1, // # of color planes 1, // # bits needed for one pixel @@ -617,9 +784,9 @@ bool wxTreeCtrl::Create(wxWindow *parent, } #endif // 0 - SetSize(pos.x, pos.y, size.x, size.y); + wxSetCCUnicodeFormat(GetHwnd()); - return TRUE; + return true; } wxTreeCtrl::~wxTreeCtrl() @@ -627,18 +794,16 @@ 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(); } @@ -646,31 +811,48 @@ wxTreeCtrl::~wxTreeCtrl() // 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 +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(wxT("TreeView_GetItem")); - return FALSE; + return false; } - return TRUE; + return true; } -void wxTreeCtrl::DoSetItem(wxTreeViewItem* tvItem) +void wxTreeCtrl::DoSetItem(wxTreeViewItem *tvItem) { + TreeItemUnlocker unlocker(tvItem->hItem); + if ( TreeView_SetItem(GetHwnd(), tvItem) == -1 ) { wxLogLastError(wxT("TreeView_SetItem")); } } -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 @@ -683,39 +865,36 @@ void wxTreeCtrl::SetIndent(unsigned int indent) TreeView_SetIndent(GetHwnd(), indent); } -wxImageList *wxTreeCtrl::GetImageList() const -{ - return m_imageListNormal; -} - -wxImageList *wxTreeCtrl::GetStateImageList() const -{ - return m_imageListNormal; -} - 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) { + 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; } size_t wxTreeCtrl::GetChildrenCount(const wxTreeItemId& item, bool recursively) const { - TraverseCounter counter(this, item, recursively); + wxCHECK_MSG( item.IsOk(), 0u, wxT("invalid tree item") ); + TraverseCounter counter(this, item, recursively); return counter.GetCount() - 1; } @@ -727,32 +906,39 @@ 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()); + ::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()); + ::SendMessage(GetHwnd(), TVM_SETTEXTCOLOR, 0, colour.GetPixel()); #endif - return TRUE; + return true; } // ---------------------------------------------------------------------------- // 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") ); + wxChar buf[512]; // the size is arbitrary... wxTreeViewItem tvItem(item, TVIF_TEXT); @@ -769,272 +955,256 @@ wxString wxTreeCtrl::GetItemText(const wxTreeItemId& item) const void wxTreeCtrl::SetItemText(const wxTreeItemId& item, const wxString& text) { + wxCHECK_RET( item.IsOk(), wxT("invalid tree item") ); + + if ( IS_VIRTUAL_ROOT(item) ) + return; + wxTreeViewItem tvItem(item, TVIF_TEXT); - tvItem.pszText = (wxChar *)text.c_str(); // conversion is ok + tvItem.pszText = (wxChar *)text.wx_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 == m_idEdited ) + { + ::SetWindowText(hwndEdit, text.wx_str()); + } + } } -int wxTreeCtrl::DoGetItemImageFromData(const wxTreeItemId& item, - wxTreeItemIcon which) const +int wxTreeCtrl::GetItemImage(const wxTreeItemId& item, + wxTreeItemIcon which) const { - wxTreeViewItem tvItem(item, TVIF_PARAM); - if ( !DoGetItem(&tvItem) ) + wxCHECK_MSG( item.IsOk(), -1, wxT("invalid tree item") ); + + if ( IsHiddenRoot(item) ) { + // no images for hidden root item return -1; } - return ((wxTreeItemIndirectData *)tvItem.lParam)->GetImage(which); + wxTreeItemParam *param = GetItemParam(item); + + return param && param->HasImage(which) ? param->GetImage(which) : -1; } -void wxTreeCtrl::DoSetItemImageFromData(const wxTreeItemId& item, - int image, - wxTreeItemIcon which) const +void wxTreeCtrl::SetItemImage(const wxTreeItemId& item, int image, + wxTreeItemIcon which) { - wxTreeViewItem tvItem(item, TVIF_PARAM); - if ( !DoGetItem(&tvItem) ) + wxCHECK_RET( item.IsOk(), wxT("invalid tree item") ); + wxCHECK_RET( which >= 0 && + which < wxTreeItemIcon_Max, + wxT("invalid image index")); + + + if ( IsHiddenRoot(item) ) { + // no images for hidden root item return; } - wxTreeItemIndirectData *data = ((wxTreeItemIndirectData *)tvItem.lParam); + wxTreeItemParam *data = GetItemParam(item); + if ( !data ) + return; data->SetImage(image, which); - // make sure that we have selected images as well - if ( which == wxTreeItemIcon_Normal && - !data->HasImage(wxTreeItemIcon_Selected) ) + RefreshItem(item); +} + +wxTreeItemParam *wxTreeCtrl::GetItemParam(const wxTreeItemId& item) const +{ + wxCHECK_MSG( item.IsOk(), NULL, wxT("invalid tree item") ); + + wxTreeViewItem tvItem(item, TVIF_PARAM); + + // hidden root may still have data. + if ( IS_VIRTUAL_ROOT(item) ) { - data->SetImage(image, wxTreeItemIcon_Selected); + return GET_VIRTUAL_ROOT()->GetParam(); } - if ( which == wxTreeItemIcon_Expanded && - !data->HasImage(wxTreeItemIcon_SelectedExpanded) ) + // visible node. + if ( !DoGetItem(&tvItem) ) { - data->SetImage(image, wxTreeItemIcon_SelectedExpanded); + return NULL; } + + return (wxTreeItemParam *)tvItem.lParam; } -void wxTreeCtrl::DoSetItemImages(const wxTreeItemId& item, - int image, - int imageSel) +wxTreeItemData *wxTreeCtrl::GetItemData(const wxTreeItemId& item) const { - wxTreeViewItem tvItem(item, TVIF_IMAGE | TVIF_SELECTEDIMAGE); - tvItem.iSelectedImage = imageSel; - tvItem.iImage = image; - DoSetItem(&tvItem); + wxTreeItemParam *data = GetItemParam(item); + + return data ? data->GetData() : NULL; } -int wxTreeCtrl::GetItemImage(const wxTreeItemId& item, - wxTreeItemIcon which) const +void wxTreeCtrl::SetItemData(const wxTreeItemId& item, wxTreeItemData *data) { - if ( HasIndirectData(item) ) + // first, associate this piece of data with this item + if ( data ) { - return DoGetItemImageFromData(item, which); + data->SetId(item); } - UINT mask; - switch ( which ) - { - default: - wxFAIL_MSG( wxT("unknown tree item image type") ); + wxTreeItemParam *param = GetItemParam(item); - case wxTreeItemIcon_Normal: - mask = TVIF_IMAGE; - break; + wxCHECK_RET( param, wxT("failed to change tree items data") ); - case wxTreeItemIcon_Selected: - mask = TVIF_SELECTEDIMAGE; - break; + param->SetData(data); +} - case wxTreeItemIcon_Expanded: - case wxTreeItemIcon_SelectedExpanded: - return -1; - } +void wxTreeCtrl::SetItemHasChildren(const wxTreeItemId& item, bool has) +{ + wxCHECK_RET( item.IsOk(), wxT("invalid tree item") ); - wxTreeViewItem tvItem(item, mask); - DoGetItem(&tvItem); + if ( IS_VIRTUAL_ROOT(item) ) + return; - return mask == TVIF_IMAGE ? tvItem.iImage : tvItem.iSelectedImage; + wxTreeViewItem tvItem(item, TVIF_CHILDREN); + tvItem.cChildren = (int)has; + DoSetItem(&tvItem); } -void wxTreeCtrl::SetItemImage(const wxTreeItemId& item, int image, - wxTreeItemIcon which) +void wxTreeCtrl::SetItemBold(const wxTreeItemId& item, bool bold) { - int imageNormal, imageSel; - switch ( which ) - { - default: - wxFAIL_MSG( wxT("unknown tree item image type") ); - - case wxTreeItemIcon_Normal: - imageNormal = image; - imageSel = GetItemSelectedImage(item); - 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 = GetItemSelectedImage(item); - - // 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); + wxCHECK_RET( item.IsOk(), wxT("invalid tree item") ); - // 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; - } + if ( IS_VIRTUAL_ROOT(item) ) + return; - // 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); + wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_BOLD); + tvItem.state = bold ? TVIS_BOLD : 0; + DoSetItem(&tvItem); } -wxTreeItemData *wxTreeCtrl::GetItemData(const wxTreeItemId& item) const +void wxTreeCtrl::SetItemDropHighlight(const wxTreeItemId& item, bool highlight) { - wxTreeViewItem tvItem(item, TVIF_PARAM); - if ( !DoGetItem(&tvItem) ) - { - return NULL; - } + if ( IS_VIRTUAL_ROOT(item) ) + return; - if ( HasIndirectData(item) ) - { - return ((wxTreeItemIndirectData *)tvItem.lParam)->GetData(); - } - else - { - return (wxTreeItemData *)tvItem.lParam; - } + wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_DROPHILITED); + tvItem.state = highlight ? TVIS_DROPHILITED : 0; + DoSetItem(&tvItem); } -void wxTreeCtrl::SetItemData(const wxTreeItemId& item, wxTreeItemData *data) +void wxTreeCtrl::RefreshItem(const wxTreeItemId& item) { - wxTreeViewItem tvItem(item, TVIF_PARAM); + if ( IS_VIRTUAL_ROOT(item) ) + return; - if ( HasIndirectData(item) ) - { - if ( DoGetItem(&tvItem) ) - { - ((wxTreeItemIndirectData *)tvItem.lParam)->SetData(data); - } - else - { - wxFAIL_MSG( wxT("failed to change tree items data") ); - } - } - else + wxRect rect; + if ( GetBoundingRect(item, rect) ) { - tvItem.lParam = (LPARAM)data; - DoSetItem(&tvItem); + RefreshRect(rect); } } -void wxTreeCtrl::SetIndirectItemData(const wxTreeItemId& item, - wxTreeItemIndirectData *data) +wxColour wxTreeCtrl::GetItemTextColour(const wxTreeItemId& item) const { - // 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?") ); - - SetItemData(item, (wxTreeItemData *)data); + wxCHECK_MSG( item.IsOk(), wxNullColour, wxT("invalid tree item") ); - m_itemsWithIndirectData.Add(item); + wxMapTreeAttr::const_iterator it = m_attrs.find(item.m_pItem); + return it == m_attrs.end() ? wxNullColour : it->second->GetTextColour(); } -bool wxTreeCtrl::HasIndirectData(const wxTreeItemId& item) const +wxColour wxTreeCtrl::GetItemBackgroundColour(const wxTreeItemId& item) const { - return m_itemsWithIndirectData.Index(item) != wxNOT_FOUND; -} + wxCHECK_MSG( item.IsOk(), wxNullColour, wxT("invalid tree item") ); -void wxTreeCtrl::SetItemHasChildren(const wxTreeItemId& item, bool has) -{ - wxTreeViewItem tvItem(item, TVIF_CHILDREN); - tvItem.cChildren = (int)has; - DoSetItem(&tvItem); + wxMapTreeAttr::const_iterator it = m_attrs.find(item.m_pItem); + return it == m_attrs.end() ? wxNullColour : it->second->GetBackgroundColour(); } -void wxTreeCtrl::SetItemBold(const wxTreeItemId& item, bool bold) +wxFont wxTreeCtrl::GetItemFont(const wxTreeItemId& item) const { - wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_BOLD); - tvItem.state = bold ? TVIS_BOLD : 0; - DoSetItem(&tvItem); -} + wxCHECK_MSG( item.IsOk(), wxNullFont, wxT("invalid tree item") ); -void wxTreeCtrl::SetItemDropHighlight(const wxTreeItemId& item, bool highlight) -{ - wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_DROPHILITED); - tvItem.state = highlight ? TVIS_DROPHILITED : 0; - DoSetItem(&tvItem); + wxMapTreeAttr::const_iterator it = m_attrs.find(item.m_pItem); + return it == m_attrs.end() ? wxNullFont : it->second->GetFont(); } void wxTreeCtrl::SetItemTextColour(const wxTreeItemId& item, const wxColour& col) { - m_hasAnyAttr = TRUE; + wxCHECK_RET( item.IsOk(), wxT("invalid tree item") ); - long id = (long)(WXHTREEITEM)item; - wxTreeItemAttr *attr = (wxTreeItemAttr *)m_attrs.Get(id); - if ( !attr ) + 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->SetTextColour(col); + + RefreshItem(item); } void wxTreeCtrl::SetItemBackgroundColour(const wxTreeItemId& item, const wxColour& col) { - m_hasAnyAttr = TRUE; + wxCHECK_RET( item.IsOk(), wxT("invalid tree item") ); - long id = (long)(WXHTREEITEM)item; - wxTreeItemAttr *attr = (wxTreeItemAttr *)m_attrs.Get(id); - if ( !attr ) + 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 // already in the hash + { + attr = it->second; } attr->SetBackgroundColour(col); + + RefreshItem(item); } void wxTreeCtrl::SetItemFont(const wxTreeItemId& item, const wxFont& font) { - m_hasAnyAttr = TRUE; + wxCHECK_RET( item.IsOk(), wxT("invalid tree item") ); - long id = (long)(WXHTREEITEM)item; - wxTreeItemAttr *attr = (wxTreeItemAttr *)m_attrs.Get(id); - if ( !attr ) + 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 // already in the hash + { + attr = it->second; } attr->SetFont(font); + + // Reset the item's text to ensure that the bounding rect will be adjusted + // for the new font. + SetItemText(item, GetItemText(item)); + + RefreshItem(item); } // ---------------------------------------------------------------------------- @@ -1043,20 +1213,39 @@ void wxTreeCtrl::SetItemFont(const wxTreeItemId& item, const wxFont& font) bool wxTreeCtrl::IsVisible(const wxTreeItemId& item) const { + wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") ); + + 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 { + wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") ); + wxTreeViewItem tvItem(item, TVIF_CHILDREN); DoGetItem(&tvItem); @@ -1065,8 +1254,7 @@ bool wxTreeCtrl::ItemHasChildren(const wxTreeItemId& item) const bool wxTreeCtrl::IsExpanded(const wxTreeItemId& item) const { - // probably not a good idea to put it here - //wxASSERT( ItemHasChildren(item) ); + wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") ); wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_EXPANDED); DoGetItem(&tvItem); @@ -1076,6 +1264,8 @@ bool wxTreeCtrl::IsExpanded(const wxTreeItemId& item) const bool wxTreeCtrl::IsSelected(const wxTreeItemId& item) const { + wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") ); + wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_SELECTED); DoGetItem(&tvItem); @@ -1084,6 +1274,8 @@ bool wxTreeCtrl::IsSelected(const wxTreeItemId& item) const bool wxTreeCtrl::IsBold(const wxTreeItemId& item) const { + wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") ); + wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_BOLD); DoGetItem(&tvItem); @@ -1096,45 +1288,78 @@ 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(), HITEM(item))); + wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree 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 { + wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") ); + // remember the last child returned in 'cookie' - _cookie = (long)TreeView_GetChild(GetHwnd(), HITEM(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(), - HITEM(_cookie))); - _cookie = (long)l; + wxTreeItemId fromCookie(cookie); + + HTREEITEM hitem = HITEM(fromCookie); + + hitem = TreeView_GetNextSibling(GetHwnd(), hitem); + + wxTreeItemId item(hitem); - return l; + cookie = item.m_pItem; + + return item; } wxTreeItemId wxTreeCtrl::GetLastChild(const wxTreeItemId& item) const { + wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") ); + // can this be done more efficiently? - long cookie; + wxTreeItemIdValue cookie; wxTreeItemId childLast, child = GetFirstChild(item, cookie); @@ -1149,31 +1374,51 @@ wxTreeItemId wxTreeCtrl::GetLastChild(const wxTreeItemId& item) const wxTreeItemId wxTreeCtrl::GetNextSibling(const wxTreeItemId& item) const { - return wxTreeItemId((WXHTREEITEM) TreeView_GetNextSibling(GetHwnd(), HITEM(item))); + wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") ); + return wxTreeItemId(TreeView_GetNextSibling(GetHwnd(), HITEM(item))); } wxTreeItemId wxTreeCtrl::GetPrevSibling(const wxTreeItemId& item) const { - return wxTreeItemId((WXHTREEITEM) TreeView_GetPrevSibling(GetHwnd(), HITEM(item))); + wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree 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 { + wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") ); wxASSERT_MSG( IsVisible(item), wxT("The item you call GetNextVisible() for must be visible itself!")); - return wxTreeItemId((WXHTREEITEM) TreeView_GetNextVisible(GetHwnd(), HITEM(item))); + wxTreeItemId next(TreeView_GetNextVisible(GetHwnd(), HITEM(item))); + if ( next.IsOk() && !IsVisible(next) ) + { + // Win32 considers that any non-collapsed item is visible while we want + // to return only really visible items + next.Unset(); + } + + return next; } wxTreeItemId wxTreeCtrl::GetPrevVisible(const wxTreeItemId& item) const { + wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") ); wxASSERT_MSG( IsVisible(item), wxT("The item you call GetPrevVisible() for must be visible itself!")); - return wxTreeItemId((WXHTREEITEM) TreeView_GetPrevVisible(GetHwnd(), HITEM(item))); + wxTreeItemId prev(TreeView_GetPrevVisible(GetHwnd(), HITEM(item))); + if ( prev.IsOk() && !IsVisible(prev) ) + { + // just as above, Win32 function will happily return the previous item + // in the tree for the first visible item too + prev.Unset(); + } + + return prev; } // ---------------------------------------------------------------------------- @@ -1182,6 +1427,8 @@ wxTreeItemId wxTreeCtrl::GetPrevVisible(const wxTreeItemId& item) const bool wxTreeCtrl::IsItemChecked(const wxTreeItemId& item) const { + wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") ); + // receive the desired information. wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_STATEIMAGEMASK); DoGetItem(&tvItem); @@ -1192,9 +1439,13 @@ bool wxTreeCtrl::IsItemChecked(const wxTreeItemId& item) const void wxTreeCtrl::SetItemCheck(const wxTreeItemId& item, bool check) { + wxCHECK_RET( item.IsOk(), wxT("invalid tree item") ); + // receive the desired information. wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_STATEIMAGEMASK); + DoGetItem(&tvItem); + // state images are one-based tvItem.state = (check ? 2 : 1) << 12; @@ -1212,11 +1463,11 @@ size_t wxTreeCtrl::GetSelections(wxArrayTreeItemIds& selections) const // Usual operations // ---------------------------------------------------------------------------- -wxTreeItemId wxTreeCtrl::DoInsertItem(const wxTreeItemId& parent, - wxTreeItemId hInsertAfter, - const wxString& text, - int image, int selectedImage, - wxTreeItemData *data) +wxTreeItemId wxTreeCtrl::DoInsertAfter(const wxTreeItemId& parent, + const wxTreeItemId& hInsertAfter, + const wxString& text, + int image, int selectedImage, + wxTreeItemData *data) { wxCHECK_MSG( parent.IsOk() || !TreeView_GetRoot(GetHwnd()), wxTreeItemId(), @@ -1234,10 +1485,10 @@ wxTreeItemId wxTreeCtrl::DoInsertItem(const wxTreeItemId& parent, } UINT mask = 0; - if ( !text.IsEmpty() ) + if ( !text.empty() ) { mask |= TVIF_TEXT; - tvIns.item.pszText = (wxChar *)text.c_str(); // cast is ok + tvIns.item.pszText = (wxChar *)text.wx_str(); // cast is ok } else { @@ -1245,114 +1496,92 @@ wxTreeItemId wxTreeCtrl::DoInsertItem(const wxTreeItemId& parent, tvIns.item.cchTextMax = 0; } - if ( image != -1 ) - { - mask |= TVIF_IMAGE; - tvIns.item.iImage = image; + // create the param which will store the other item parameters + wxTreeItemParam *param = new wxTreeItemParam; - if ( selectedImage == -1 ) - { - // take the same image for selected icon if not specified - selectedImage = image; - } - } - - 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 - data->SetId((WXHTREEITEM)id); + param->SetData(data); + data->SetId(id); } - return wxTreeItemId((WXHTREEITEM)id); -} - -// for compatibility only -wxTreeItemId wxTreeCtrl::InsertItem(const wxTreeItemId& parent, - const wxString& text, - int image, int selImage, - long insertAfter) -{ - return DoInsertItem(parent, (WXHTREEITEM)insertAfter, text, - image, selImage, NULL); + return wxTreeItemId(id); } wxTreeItemId wxTreeCtrl::AddRoot(const wxString& text, int image, int selectedImage, wxTreeItemData *data) { - return DoInsertItem(wxTreeItemId((WXHTREEITEM) 0), (WXHTREEITEM) 0, - text, image, selectedImage, data); -} + if ( HasFlag(wxTR_HIDE_ROOT) ) + { + wxASSERT_MSG( !m_pVirtualRoot, _T("tree can have only a single root") ); -wxTreeItemId wxTreeCtrl::PrependItem(const wxTreeItemId& parent, - const wxString& text, - int image, int selectedImage, - wxTreeItemData *data) -{ - return DoInsertItem(parent, (WXHTREEITEM) TVI_FIRST, - text, image, selectedImage, data); -} + // create a virtual root item, the parent for all the others + wxTreeItemParam *param = new wxTreeItemParam; + param->SetData(data); -wxTreeItemId wxTreeCtrl::InsertItem(const wxTreeItemId& parent, - const wxTreeItemId& idPrevious, - const wxString& text, - int image, int selectedImage, - wxTreeItemData *data) -{ - return DoInsertItem(parent, idPrevious, text, image, selectedImage, data); + m_pVirtualRoot = new wxVirtualNode(param); + + return TVI_ROOT; + } + + return DoInsertAfter(wxTreeItemId(), wxTreeItemId(), + text, image, selectedImage, data); } -wxTreeItemId wxTreeCtrl::InsertItem(const wxTreeItemId& parent, - size_t index, - const wxString& text, - int image, int selectedImage, - wxTreeItemData *data) +wxTreeItemId wxTreeCtrl::DoInsertItem(const wxTreeItemId& parent, + size_t index, + const wxString& text, + int image, int selectedImage, + wxTreeItemData *data) { - // find the item from index - long cookie; - wxTreeItemId idPrev, idCur = GetFirstChild(parent, cookie); - while ( index != 0 && idCur.IsOk() ) + wxTreeItemId idPrev; + if ( index == (size_t)-1 ) { - index--; - - idPrev = idCur; - idCur = GetNextChild(parent, cookie); + // special value: append to the end + idPrev = TVI_LAST; } + else // find the item from index + { + wxTreeItemIdValue cookie; + wxTreeItemId idCur = GetFirstChild(parent, cookie); + while ( index != 0 && idCur.IsOk() ) + { + index--; - // assert, not check: if the index is invalid, we will append the item - // to the end - wxASSERT_MSG( index == 0, _T("bad index in wxTreeCtrl::InsertItem") ); + idPrev = idCur; + idCur = GetNextChild(parent, cookie); + } - return DoInsertItem(parent, idPrev, text, image, selectedImage, data); -} + // assert, not check: if the index is invalid, we will append the item + // to the end + wxASSERT_MSG( index == 0, _T("bad index in wxTreeCtrl::InsertItem") ); + } -wxTreeItemId wxTreeCtrl::AppendItem(const wxTreeItemId& parent, - const wxString& text, - int image, int selectedImage, - wxTreeItemData *data) -{ - return DoInsertItem(parent, (WXHTREEITEM) TVI_LAST, - text, image, selectedImage, data); + return DoInsertAfter(parent, idPrev, text, image, selectedImage, data); } void wxTreeCtrl::Delete(const wxTreeItemId& item) @@ -1366,13 +1595,13 @@ void wxTreeCtrl::Delete(const wxTreeItemId& item) // 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); } @@ -1380,7 +1609,7 @@ 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(children[n])) ) { wxLogLastError(wxT("TreeView_DeleteItem")); } @@ -1389,6 +1618,15 @@ void wxTreeCtrl::DeleteChildren(const wxTreeItemId& item) 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(wxT("TreeView_DeleteAllItems")); @@ -1403,6 +1641,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( !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 // v 4.70 - now it does send them but only the first time. To maintain @@ -1417,19 +1659,13 @@ 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; - - 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); - - event.SetEventType(g_events[isExpanded][FALSE]); - GetEventHandler()->ProcessEvent(event); + // note that the {EXPAND|COLLAPS}ING event is sent by TreeView_Expand() + // itself + wxTreeEvent event(gs_expandEvents[IsExpanded(item) ? IDX_EXPAND + : IDX_COLLAPSE] + [IDX_DONE], + this, item); + (void)HandleWindowEvent(event); } //else: change didn't took place, so do nothing at all } @@ -1454,18 +1690,13 @@ void wxTreeCtrl::Toggle(const wxTreeItemId& item) DoExpand(item, TVE_TOGGLE); } -void wxTreeCtrl::ExpandItem(const wxTreeItemId& item, int action) -{ - DoExpand(item, action); -} - void wxTreeCtrl::Unselect() { 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() @@ -1476,12 +1707,10 @@ void wxTreeCtrl::UnselectAll() size_t count = GetSelections(selections); for ( size_t n = 0; n < count; n++ ) { -#if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE - SetItemCheck(selections[n], FALSE); -#else // !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE ::UnselectItem(GetHwnd(), HITEM(selections[n])); -#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE/!wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE } + + m_htSelStart.Unset(); } else { @@ -1490,46 +1719,44 @@ 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); -#else // !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE - ::SelectItem(GetHwnd(), HITEM(item)); -#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE/!wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE - } - else - { - // 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 + wxCHECK_RET( !IsHiddenRoot(item), _T("can't select hidden root item") ); - wxTreeEvent event(wxEVT_NULL, m_windowId); - event.m_item = item; - event.SetEventObject(this); + wxASSERT_MSG( select || HasFlag(wxTR_MULTIPLE), + _T("SelectItem(false) works only for multiselect") ); - event.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGING); - if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() ) + wxTreeEvent event(wxEVT_COMMAND_TREE_SEL_CHANGING, this, item); + if ( !HandleWindowEvent(event) || event.IsAllowed() ) + { + if ( HasFlag(wxTR_MULTIPLE) ) { - if ( !TreeView_SelectItem(GetHwnd(), HITEM(item)) ) + if ( !::SelectItem(GetHwnd(), HITEM(item), select) ) { wxLogLastError(wxT("TreeView_SelectItem")); + return; } - else + } + else // single selection + { + // use TreeView_SelectItem() to deselect the previous selection + if ( !TreeView_SelectItem(GetHwnd(), HITEM(item)) ) { - event.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED); - (void)GetEventHandler()->ProcessEvent(event); + wxLogLastError(wxT("TreeView_SelectItem")); + return; } } - //else: program vetoed the change + + event.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED); + (void)HandleWindowEvent(event); } + //else: program vetoed the change } 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)); } @@ -1542,26 +1769,8 @@ void wxTreeCtrl::ScrollTo(const wxTreeItemId& item) } } -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; } @@ -1569,51 +1778,62 @@ 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; m_textCtrl = NULL; + + m_idEdited.Unset(); } } -wxTextCtrl* wxTreeCtrl::EditLabel(const wxTreeItemId& item, - wxClassInfo* textControlClass) +wxTextCtrl *wxTreeCtrl::EditLabel(const wxTreeItemId& item, + wxClassInfo *textControlClass) { wxASSERT( textControlClass->IsKindOf(CLASSINFO(wxTextCtrl)) ); DeleteTextCtrl(); + m_idEdited = 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::DoEndEditLabel(bool discardChanges) { TreeView_EndEditLabelNow(GetHwnd(), discardChanges); DeleteTextCtrl(); } -wxTreeItemId wxTreeCtrl::HitTest(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; @@ -1635,7 +1855,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, @@ -1643,17 +1863,24 @@ bool wxTreeCtrl::GetBoundingRect(const wxTreeItemId& item, bool textOnly) const { RECT rc; + + // 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; } } @@ -1661,27 +1888,44 @@ 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(LPARAM lParam) + { + return ((wxTreeItemParam*)lParam)->GetItem(); + } +}; + +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; -int wxTreeCtrl::OnCompareItems(const wxTreeItemId& item1, - const wxTreeItemId& item2) -{ - return wxStrcmp(GetItemText(item1), GetItemText(item2)); + return tree->OnCompareItems(GetIdFromData(pItem1), + GetIdFromData(pItem2)); } void wxTreeCtrl::SortChildren(const wxTreeItemId& item) { + wxCHECK_RET( item.IsOk(), wxT("invalid tree 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); @@ -1690,7 +1934,7 @@ void wxTreeCtrl::SortChildren(const wxTreeItemId& item) { TV_SORTCB tvSort; tvSort.hParent = HITEM(item); - tvSort.lpfnCompare = (PFNTVCOMPARE)TreeView_CompareCallback; + tvSort.lpfnCompare = wxTreeSortHelper::Compare; tvSort.lParam = (LPARAM)this; TreeView_SortChildrenCB(GetHwnd(), &tvSort, 0 /* reserved */); } @@ -1700,8 +1944,26 @@ void wxTreeCtrl::SortChildren(const wxTreeItemId& item) // implementation // ---------------------------------------------------------------------------- -bool wxTreeCtrl::MSWCommand(WXUINT cmd, WXWORD id) +bool wxTreeCtrl::MSWShouldPreProcessMessage(WXMSG* msg) +{ + if ( msg->message == WM_KEYDOWN ) + { + // Only eat VK_RETURN if not being used by the application in + // conjunction with modifiers + if ( (msg->wParam == VK_RETURN) && !wxIsAnyModifierDown() ) + { + // we need VK_RETURN to generate wxEVT_COMMAND_TREE_ITEM_ACTIVATED + return false; + } + } + + return wxTreeCtrlBase::MSWShouldPreProcessMessage(msg); +} + +bool wxTreeCtrl::MSWCommand(WXUINT cmd, WXWORD id_) { + const int id = (signed short)id_; + if ( cmd == EN_UPDATE ) { wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, id); @@ -1717,51 +1979,106 @@ 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) { - bool processed = FALSE; - long rc = 0; + bool processed = false; + WXLRESULT rc = 0; + bool isMultiple = HasFlag(wxTR_MULTIPLE); + + // This message is sent after a right-click, or when the "menu" key is pressed + if ( nMsg == WM_CONTEXTMENU ) + { + int x = GET_X_LPARAM(lParam), + y = GET_Y_LPARAM(lParam); + + // the item for which the menu should be shown + wxTreeItemId item; + + // the position where the menu should be shown in client coordinates + // (so that it can be passed directly to PopupMenu()) + wxPoint pt; + + if ( x == -1 || y == -1 ) + { + // this means that the event was generated from keyboard (e.g. with + // Shift-F10 or special Windows menu key) + // + // use the Explorer standard of putting the menu at the left edge + // of the text, in the vertical middle of the text + item = wxTreeItemId(TreeView_GetSelection(GetHwnd())); + if ( item.IsOk() ) + { + // Use the bounding rectangle of only the text part + wxRect rect; + GetBoundingRect(item, rect, true); + pt = wxPoint(rect.GetX(), rect.GetY() + rect.GetHeight() / 2); + } + } + else // event from mouse, use mouse position + { + pt = ScreenToClient(wxPoint(x, y)); - bool isMultiple = (GetWindowStyle() & wxTR_MULTIPLE) != 0; + TV_HITTESTINFO tvhti; + tvhti.pt.x = pt.x; + tvhti.pt.y = pt.y; + if ( TreeView_HitTest(GetHwnd(), &tvhti) ) + item = wxTreeItemId(tvhti.hItem); + } + + // create the event + wxTreeEvent event(wxEVT_COMMAND_TREE_ITEM_MENU, this, item); - if ( (nMsg >= WM_MOUSEFIRST) && (nMsg <= WM_MOUSELAST) ) + event.m_pointDrag = pt; + + if ( HandleWindowEvent(event) ) + processed = true; + //else: continue with generating wxEVT_CONTEXT_MENU in base class code + } + else if ( (nMsg >= WM_MOUSEFIRST) && (nMsg <= WM_MOUSELAST) ) { - // we only process mouse messages here and these parameters have the same - // meaning for all of them + // we only process mouse messages here and these parameters have the + // same meaning for all of them int x = GET_X_LPARAM(lParam), y = GET_Y_LPARAM(lParam); - HTREEITEM htItem = GetItemFromPoint(GetHwnd(), x, y); + + TV_HITTESTINFO tvht; + tvht.pt.x = x; + tvht.pt.y = y; + + HTREEITEM htItem = TreeView_HitTest(GetHwnd(), &tvht); switch ( nMsg ) { -#if !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE case WM_LBUTTONDOWN: - if ( htItem && isMultiple ) + if ( htItem && isMultiple && (tvht.flags & TVHT_ONITEM) != 0 ) { + m_htClickedItem = (WXHTREEITEM) htItem; + m_ptClick = wxPoint(x, y); + if ( wParam & MK_CONTROL ) { SetFocus(); // toggle selected state - ToggleItemSelection(GetHwnd(), htItem); + ToggleItemSelection(htItem); ::SetFocus(GetHwnd(), htItem); // reset on any click without Shift - m_htSelStart = 0; + m_htSelStart.Unset(); - processed = TRUE; + processed = true; } else if ( wParam & MK_SHIFT ) { @@ -1771,35 +2088,149 @@ long wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam) if ( !m_htSelStart ) { // take the focused item - m_htSelStart = (WXHTREEITEM) - TreeView_GetSelection(GetHwnd()); + m_htSelStart = TreeView_GetSelection(GetHwnd()); } - SelectRange(GetHwnd(), HITEM(m_htSelStart), htItem, + if ( m_htSelStart ) + SelectRange(GetHwnd(), HITEM(m_htSelStart), htItem, !(wParam & MK_CONTROL)); + else + ::SelectItem(GetHwnd(), htItem); ::SetFocus(GetHwnd(), htItem); - processed = TRUE; + processed = true; } else // normal click { - // clear the selection and then let the default handler - // do the job - UnselectAll(); + // avoid doing anything if we click on the only + // currently selected item - // prevent the click from starting in-place editing - // when there was no selection in the control - TreeView_SelectItem(GetHwnd(), 0); + SetFocus(); + + wxArrayTreeItemIds selections; + size_t count = GetSelections(selections); + if ( count == 0 || + count > 1 || + HITEM(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)) + { + 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); + } + ::SetFocus(GetHwnd(), htItem); + processed = true; + } + else // click on a single selected item + { + // don't interfere with the default processing in + // WM_MOUSEMOVE handler below as the default window + // proc will start the drag itself if we let have + // WM_LBUTTONDOWN + m_htClickedItem.Unset(); + } // reset on any click without Shift - m_htSelStart = 0; + m_htSelStart.Unset(); + } + } + break; + + case WM_RBUTTONDOWN: + // default handler removes the highlight from the currently + // focused item when right mouse button is pressed on another + // one but keeps the remaining items highlighted, which is + // confusing, so override this default behaviour for tree with + // multiple selections + if ( isMultiple ) + { + if ( !IsItemSelected(GetHwnd(), htItem) ) + { + UnselectAll(); + SelectItem(htItem); + ::SetFocus(GetHwnd(), htItem); } + + // fire EVT_RIGHT_DOWN + HandleMouseEvent(nMsg, x, y, wParam); + + // send NM_RCLICK + NMHDR nmhdr; + nmhdr.hwndFrom = GetHwnd(); + nmhdr.idFrom = ::GetWindowLong(GetHwnd(), GWL_ID); + nmhdr.code = NM_RCLICK; + ::SendMessage(::GetParent(GetHwnd()), WM_NOTIFY, + nmhdr.idFrom, (LPARAM)&nmhdr); + + // prevent tree control default processing, as we've + // already done everything + processed = true; } break; -#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE case WM_MOUSEMOVE: +#ifndef __WXWINCE__ + if ( m_htClickedItem ) + { + int cx = abs(m_ptClick.x - x); + int cy = abs(m_ptClick.y - y); + + if ( cx > ::GetSystemMetrics(SM_CXDRAG) || + cy > ::GetSystemMetrics(SM_CYDRAG) ) + { + NM_TREEVIEW tv; + wxZeroMemory(tv); + + tv.hdr.hwndFrom = GetHwnd(); + tv.hdr.idFrom = ::GetWindowLong(GetHwnd(), GWL_ID); + tv.hdr.code = TVN_BEGINDRAG; + + tv.itemNew.hItem = HITEM(m_htClickedItem); + + + TVITEM tviAux; + wxZeroMemory(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; + + // do it before SendMessage() call below to avoid + // reentrancies here if there is another WM_MOUSEMOVE + // in the queue already + m_htClickedItem.Unset(); + + ::SendMessage(GetHwndOf(GetParent()), WM_NOTIFY, + tv.hdr.idFrom, (LPARAM)&tv ); + + // don't pass it to the default window proc, it would + // start dragging again + processed = true; + } + } +#endif // __WXWINCE__ + +#if wxUSE_DRAGIMAGE if ( m_dragImage ) { m_dragImage->Move(wxPoint(x, y)); @@ -1812,10 +2243,33 @@ long wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam) m_dragImage->Show(); } } +#endif // wxUSE_DRAGIMAGE 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); + ::SelectItem(GetHwnd(), htItem); + ::SetFocus(GetHwnd(), htItem); + } + m_htClickedItem.Unset(); + } + + // fall through + case WM_RBUTTONUP: +#if wxUSE_DRAGIMAGE if ( m_dragImage ) { m_dragImage->EndDrag(); @@ -1823,22 +2277,19 @@ long wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam) m_dragImage = NULL; // generate the drag end event - wxTreeEvent event(wxEVT_COMMAND_TREE_END_DRAG, m_windowId); - - event.m_item = (WXHTREEITEM)htItem; + wxTreeEvent event(wxEVT_COMMAND_TREE_END_DRAG, this, htItem); event.m_pointDrag = wxPoint(x, y); - event.SetEventObject(this); - (void)GetEventHandler()->ProcessEvent(event); + (void)HandleWindowEvent(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); } +#endif // wxUSE_DRAGIMAGE 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 @@ -1849,7 +2300,7 @@ long wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam) RECT rect; for ( size_t n = 0; n < count; n++ ) { - // TreeView_GetItemRect() will return FALSE if item is not visible, + // TreeView_GetItemRect() will return false if item is not visible, // which may happen perfectly well if ( TreeView_GetItemRect(GetHwnd(), HITEM(selections[n]), &rect, TRUE) ) @@ -1863,67 +2314,99 @@ long wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam) bool bCtrl = wxIsCtrlDown(), bShift = wxIsShiftDown(); - // we handle.arrows and space, but not page up/down and home/end: the - // latter should be easy, but not the former - HTREEITEM htSel = (HTREEITEM)TreeView_GetSelection(GetHwnd()); - if ( !m_htSelStart ) - { - m_htSelStart = (WXHTREEITEM)htSel; - } - - if ( wParam == VK_SPACE ) + switch ( wParam ) { - if ( bCtrl ) - { - ToggleItemSelection(GetHwnd(), htSel); - } - else - { - UnselectAll(); - - ::SelectItem(GetHwnd(), htSel); - } + case VK_SPACE: + if ( bCtrl ) + { + ToggleItemSelection(htSel); + } + else + { + UnselectAll(); - 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); + ::SelectItem(GetHwnd(), htSel); + } - HTREEITEM htNext = (HTREEITEM)(wParam == VK_UP - ? TreeView_GetPrevVisible(GetHwnd(), htSel) - : TreeView_GetNextVisible(GetHwnd(), htSel)); + processed = true; + break; - if ( !htNext ) + case VK_UP: + case VK_DOWN: + if ( !bCtrl && !bShift ) { - // at the top/bottom - htNext = htSel; + // no modifiers, just clear selection and then let the default + // processing to take place + UnselectAll(); } - - if ( bShift ) + else if ( htSel ) { - SelectRange(GetHwnd(), HITEM(m_htSelStart), htNext); + (void)wxControl::MSWWindowProc(nMsg, wParam, lParam); + + HTREEITEM htNext = (HTREEITEM) + TreeView_GetNextItem + ( + GetHwnd(), + htSel, + wParam == VK_UP ? TVGN_PREVIOUSVISIBLE + : TVGN_NEXTVISIBLE + ); + + if ( !htNext ) + { + // at the top/bottom + htNext = htSel; + } + + if ( bShift ) + { + if ( !m_htSelStart ) + m_htSelStart = htSel; + + SelectRange(GetHwnd(), HITEM(m_htSelStart), htNext); + } + else // bCtrl + { + // without changing selection + ::SetFocus(GetHwnd(), htNext); + } + + processed = true; } - else // bCtrl + break; + + case VK_HOME: + case VK_END: + case VK_PRIOR: + case VK_NEXT: + // TODO: handle Shift/Ctrl with these keys + if ( !bCtrl && !bShift ) { - // without changing selection - ::SetFocus(GetHwnd(), htNext); + UnselectAll(); + + m_htSelStart.Unset(); } + } + } + else if ( nMsg == WM_COMMAND ) + { + // if we receive a EN_KILLFOCUS command from the in-place edit control + // used for label editing, make sure to end editing + WORD id, cmd; + WXHWND hwnd; + UnpackCommand(wParam, lParam, &id, &hwnd, &cmd); + + if ( cmd == EN_KILLFOCUS ) + { + if ( m_textCtrl && m_textCtrl->GetHandle() == hwnd ) + { + DoEndEditLabel(); - processed = TRUE; + processed = true; } } } -#endif // !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE if ( !processed ) rc = wxControl::MSWWindowProc(nMsg, wParam, lParam); @@ -1931,10 +2414,45 @@ long wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam) return rc; } +WXLRESULT +wxTreeCtrl::MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam) +{ + 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 ) + return 0; + } +#if wxUSE_DRAGIMAGE + else if ( nMsg == WM_KEYDOWN ) + { + if ( wParam == VK_ESCAPE ) + { + if ( m_dragImage ) + { + m_dragImage->EndDrag(); + delete m_dragImage; + m_dragImage = NULL; + + // 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); + } + } + } +#endif // wxUSE_DRAGIMAGE + + return wxControl::MSWDefWindowProc(nMsg, wParam, 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; @@ -1952,7 +2470,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 @@ -1967,8 +2485,13 @@ 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; + // although the user event handler may still veto it, it is + // important to set it now so that calls to SetItemText() from + // the event handler would change the text controls contents + m_idEdited = + event.m_item = info->item.hItem; event.m_label = info->item.pszText; + event.m_editCancelled = false; } break; @@ -1977,12 +2500,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; @@ -1992,13 +2519,38 @@ 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; + } + +#ifdef TVN_GETINFOTIP + 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 // TVN_GETINFOTIP +#endif // !__WXWINCE__ + case TVN_GETDISPINFO: eventType = wxEVT_COMMAND_TREE_GET_INFO; // fall through @@ -2011,37 +2563,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; + 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; - event.m_item = (WXHTREEITEM) tv->itemNew.hItem; + eventType = gs_expandEvents[what][how]; + + event.m_item = tv->itemNew.hItem; } break; @@ -2050,139 +2602,219 @@ 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 = (wxIsAltDown() ? KF_ALTDOWN : 0) << 16; + + WXWPARAM wParam = info->wVKey; + + int keyCode = wxCharCodeMSWToWX(wParam); + 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() && + if ( !wxIsAnyModifierDown() && ((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)HandleWindowEvent(event2); } } break; - case TVN_SELCHANGED: + + // Vista's tree control has introduced some problems with our + // multi-selection tree. When TreeView_SelectItem() is called, + // the wrong items are deselected. + + // Fortunately, Vista provides a new notification, TVN_ITEMCHANGING + // that can be used to regulate this incorrect behavior. The + // following messages will allow only the unlocked item's selection + // state to change + case TVN_ITEMCHANGINGA: + case TVN_ITEMCHANGINGW: + { + // we only need to handles these in multi-select trees + if ( HasFlag(wxTR_MULTIPLE) ) + { + // get info about the item about to be changed + NMTVITEMCHANGE* info = (NMTVITEMCHANGE*)lParam; + if (info->hItem != gs_unlockItem) + { + // item's state is locked, don't allow the change + // returning 1 will disallow the change + *result = 1; + return true; + } + } + + // allow the state change + } + return false; + + // 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; + } } + + // we receive this message from WM_LBUTTONDOWN handler inside + // comctl32.dll and so before the click is passed to + // DefWindowProc() which sets the focus to the window which was + // clicked and this can lead to unexpected event sequences: for + // example, we may get a "selection change" event from the tree + // before getting a "kill focus" event for the text control which + // had the focus previously, thus breaking user code doing input + // validation + // + // to avoid such surprises, we force the generation of focus events + // now, before we generate the selection change ones + SetFocus(); break; -#if defined(_WIN32_IE) && _WIN32_IE >= 0x300 && !wxUSE_COMCTL32_SAFELY + // 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; + *result = CDRF_DODEFAULT; + break; } - HFONT hFont; - wxColour colText, colBack; - if ( attr->HasFont() ) - { - wxFont font = attr->GetFont(); - hFont = (HFONT)font.GetResourceHandle(); - } - else - { - hFont = 0; - } + wxTreeItemAttr * const attr = it->second; - if ( attr->HasTextColour() ) - { - colText = attr->GetTextColour(); - } - else - { - colText = GetForegroundColour(); - } + wxTreeViewItem tvItem((void *)nmcd.dwItemSpec, + TVIF_STATE, TVIS_DROPHILITED); + DoGetItem(&tvItem); + const UINT tvItemState = tvItem.state; - // selection colours should override ours - if ( nmcd.uItemState & CDIS_SELECTED ) - { - DWORD clrBk = ::GetSysColor(COLOR_HIGHLIGHT); - lptvcd->clrTextBk = clrBk; - - // 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 to the user + if ( !(nmcd.uItemState & CDIS_SELECTED) && + !(tvItemState & TVIS_DROPHILITED) ) { + 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 ) && + !(tvItemState & TVIS_DROPHILITED) ) + { + 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: @@ -2194,10 +2826,13 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) { if ( tvhti.flags & TVHT_ONITEM ) { - event.m_item = (WXHTREEITEM) tvhti.hItem; + 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; @@ -2209,10 +2844,12 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) return wxControl::MSWOnNotify(idCtrl, lParam, result); } - event.SetEventObject(this); event.SetEventType(eventType); - bool processed = GetEventHandler()->ProcessEvent(event); + if ( event.m_item.IsOk() ) + event.SetClientObject(GetItemData(event.m_item)); + + bool processed = HandleWindowEvent(event); // post processing switch ( hdr->code ) @@ -2222,11 +2859,23 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) // 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; + *result = false; + break; + + case NM_RCLICK: + // prevent tree control from sending WM_CONTEXTMENU to our parent + // (which it does if NM_RCLICK is not handled) because we want to + // send it to the control itself + *result = + processed = true; + + ::SendMessage(GetHwnd(), WM_CONTEXTMENU, + (WPARAM)GetHwnd(), ::GetMessagePos()); break; case TVN_BEGINDRAG: case TVN_BEGINRDRAG: +#if wxUSE_DRAGIMAGE if ( event.IsAllowed() ) { // normally this is impossible because the m_dragImage is @@ -2234,71 +2883,153 @@ bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) wxASSERT_MSG( !m_dragImage, _T("starting to drag once again?") ); m_dragImage = new wxDragImage(*this, event.m_item); - m_dragImage->BeginDrag(wxPoint(0, 0), this); + m_dragImage->BeginDrag(wxPoint(0,0), this); m_dragImage->Show(); } +#endif // wxUSE_DRAGIMAGE break; case TVN_DELETEITEM: { - // NB: we might process this message using wxWindows event + // NB: we might process this message using wxWidgets event // tables, but due to overhead of wxWin event system we // prefer to do it here ourself (otherwise deleting a tree // with many items is just too slow) - NM_TREEVIEW* tv = (NM_TREEVIEW *)lParam; - - wxTreeItemId item = event.m_item; - if ( HasIndirectData(item) ) - { - wxTreeItemIndirectData *data = (wxTreeItemIndirectData *) - tv->itemOld.lParam; - delete data; // can't be NULL here + NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam; - m_itemsWithIndirectData.Remove(item); - } - 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 + 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 ) + { + // 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() ) + 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); + } + } + else // we had set m_idEdited before + { + m_idEdited.Unset(); + } 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__ +#ifdef TVN_GETINFOTIP + case TVN_GETINFOTIP: + { + // If the user permitted a tooltip change, change it + if (event.IsAllowed()) + { + SetToolTip(event.m_label); + } + } + break; +#endif +#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: + { + NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam; + const wxTreeItemId id(tv->itemNew.hItem); + + if ( tv->action == TVE_COLLAPSE ) + { + if ( wxApp::GetComCtl32Version() >= 600 ) + { + // for some reason the item selection rectangle depends + // on whether it is expanded or collapsed (at least + // with comctl32.dll v6): it is wider (by 3 pixels) in + // the expanded state, so when the item collapses and + // then is deselected the rightmost 3 pixels of the + // previously drawn selection are left on the screen + // + // it's not clear if it's a bug in comctl32.dll or in + // our code (because it does not happen in Explorer but + // OTOH we don't do anything which could result in this + // AFAICS) but we do need to work around it to avoid + // ugly artifacts + RefreshItem(id); + } + } + else // expand + { + // the item is also not refreshed properly after expansion when + // it has an image depending on the expanded/collapsed state: + // again, it's not clear if the bug is in comctl32.dll or our + // code... + 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 && */ ) { 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 ); @@ -2306,9 +3037,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 ); @@ -2320,22 +3050,50 @@ 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) -wxTreeEvent::wxTreeEvent(wxEventType commandType, int id) - : wxNotifyEvent(commandType, id) +void wxTreeCtrl::SetState(const wxTreeItemId& node, int state) { - m_code = 0; - m_itemOld = 0; + 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; + } + + wxCHECK_RET( state < m_imageListState->GetImageCount(), + _T("wxTreeCtrl::SetState(): item index out of bounds") ); + + tvi.state = INDEXTOSTATEIMAGEMASK(state); + + TreeView_SetItem(GetHwnd(), &tvi); } -#endif // __WIN95__ +int wxTreeCtrl::GetState(const wxTreeItemId& node) +{ + 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 // wxUSE_TREECTRL