/////////////////////////////////////////////////////////////////////////////
-// 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
// ----------------------------------------------------------------------------
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
- #pragma implementation "treectrl.h"
-#endif
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#pragma hdrstop
#endif
-#include "wx/msw/private.h"
-
-// Set this to 1 to be _absolutely_ sure that repainting will work for all comctl32.dll versions
-#define wxUSE_COMCTL32_SAFELY 0
+#if wxUSE_TREECTRL
-// Mingw32 is a bit mental even though this is done in winundef
-#ifdef GetFirstChild
- #undef GetFirstChild
-#endif
+#include "wx/treectrl.h"
-#ifdef GetNextSibling
- #undef GetNextSibling
+#ifndef WX_PRECOMP
+ #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
+ #include "wx/msw/missing.h"
+ #include "wx/dynarray.h"
+ #include "wx/log.h"
+ #include "wx/app.h"
+ #include "wx/settings.h"
#endif
-#if defined(__WIN95__)
+#include "wx/dynlib.h"
+#include "wx/msw/private.h"
-#include "wx/log.h"
-#include "wx/dynarray.h"
#include "wx/imaglist.h"
-#include "wx/settings.h"
-#include "wx/msw/treectrl.h"
#include "wx/msw/dragimag.h"
+#include "wx/msw/uxtheme.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 <commctrl.h>
-#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 helper class is used on vista systems for preventing unwanted
+// item state changes in the vista tree control. It is only effective in
+// multi-select mode on vista systems.
+
+// The vista tree control includes some new code that originally broke the
+// multi-selection tree, causing seemingly spurious item selection state changes
+// during Shift or Ctrl-click item selection. (To witness the original broken
+// behaviour, simply make IsLocked() below always return false). This problem was
+// solved by using the following class to 'unlock' an item's selection state.
+
+class TreeItemUnlocker
+{
+public:
+ // unlock a single item
+ TreeItemUnlocker(HTREEITEM item)
+ {
+ m_oldUnlockedItem = ms_unlockedItem;
+ ms_unlockedItem = item;
+ }
+
+ // unlock all items, don't use unless absolutely necessary
+ TreeItemUnlocker()
+ {
+ m_oldUnlockedItem = ms_unlockedItem;
+ ms_unlockedItem = (HTREEITEM)-1;
+ }
+
+ // lock everything back
+ ~TreeItemUnlocker() { ms_unlockedItem = m_oldUnlockedItem; }
+
+
+ // check if the item state is currently locked
+ static bool IsLocked(HTREEITEM item)
+ { return ms_unlockedItem != (HTREEITEM)-1 && item != ms_unlockedItem; }
+
+private:
+ static HTREEITEM ms_unlockedItem;
+ HTREEITEM m_oldUnlockedItem;
+
+ wxDECLARE_NO_COPY_CLASS(TreeItemUnlocker);
+};
+
+HTREEITEM TreeItemUnlocker::ms_unlockedItem = NULL;
+
+// another helper class: set the variable to true during its lifetime and reset
+// it to false when it is destroyed
+//
+// it is currently always used with wxTreeCtrl::m_changingSelection
+class TempSetter
+{
+public:
+ TempSetter(bool& var) : m_var(var)
+ {
+ wxASSERT_MSG( !m_var, "variable shouldn't be already set" );
+ m_var = true;
+ }
+
+ ~TempSetter()
+ {
+ m_var = false;
+ }
+
+private:
+ bool& m_var;
+
+ wxDECLARE_NO_COPY_CLASS(TempSetter);
+};
// ----------------------------------------------------------------------------
// private functions
// ----------------------------------------------------------------------------
-// wrapper for TreeView_HitTest
-static HTREEITEM GetItemFromPoint(HWND hwndTV, int x, int y)
+namespace
+{
+
+// Work around a problem with TreeView_GetItemRect() when using MinGW/Cygwin:
+// it results in warnings about breaking strict aliasing rules because HITEM is
+// passed via a RECT pointer, so use a union to avoid them and define our own
+// version of the standard macro using it.
+union TVGetItemRectParam
{
- TV_HITTESTINFO tvht;
- tvht.pt.x = x;
- tvht.pt.y = y;
+ RECT rect;
+ HTREEITEM hItem;
+};
- return (HTREEITEM)TreeView_HitTest(hwndTV, &tvht);
+inline bool
+wxTreeView_GetItemRect(HWND hwnd,
+ HTREEITEM hItem,
+ TVGetItemRectParam& param,
+ BOOL fItemRect)
+{
+ param.hItem = hItem;
+ return ::SendMessage(hwnd, TVM_GETITEMRECT, fItemRect,
+ (LPARAM)¶m) == TRUE;
}
-#if !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
+} // anonymous namespace
// wrappers for TreeView_GetItem/TreeView_SetItem
static bool IsItemSelected(HWND hwndTV, HTREEITEM hItem)
tvi.stateMask = TVIS_SELECTED;
tvi.hItem = hItem;
+ TreeItemUnlocker unlocker(hItem);
+
if ( !TreeView_GetItem(hwndTV, &tvi) )
{
wxLogLastError(wxT("TreeView_GetItem"));
return (tvi.state & TVIS_SELECTED) != 0;
}
-static void SelectItem(HWND hwndTV, HTREEITEM hItem, bool select = TRUE)
+static bool SelectItem(HWND hwndTV, HTREEITEM hItem, bool select = true)
{
TV_ITEM tvi;
tvi.mask = TVIF_STATE | TVIF_HANDLE;
tvi.state = select ? TVIS_SELECTED : 0;
tvi.hItem = hItem;
+ TreeItemUnlocker unlocker(hItem);
+
if ( TreeView_SetItem(hwndTV, &tvi) == -1 )
{
wxLogLastError(wxT("TreeView_SetItem"));
+ return false;
}
+
+ return true;
}
static inline void UnselectItem(HWND hwndTV, HTREEITEM htItem)
{
- SelectItem(hwndTV, htItem, FALSE);
+ SelectItem(hwndTV, htItem, false);
}
static inline void ToggleItemSelection(HWND hwndTV, HTREEITEM htItem)
}
// helper function which selects all items in a range and, optionally,
-// unselects all others
-static void SelectRange(HWND hwndTV,
+// deselects all the other ones
+//
+// returns true if the selection changed at all or false if nothing changed
+
+// flags for SelectRange()
+enum
+{
+ SR_SIMULATE = 1, // don't do anything, just return true or false
+ SR_UNSELECT_OTHERS = 2 // deselect the items not in range
+};
+
+static bool SelectRange(HWND hwndTV,
HTREEITEM htFirst,
HTREEITEM htLast,
- bool unselectOthers = TRUE)
+ int flags)
{
// find the first (or last) item and select it
- bool cont = TRUE;
+ bool changed = false;
+ bool cont = true;
HTREEITEM htItem = (HTREEITEM)TreeView_GetRoot(hwndTV);
+
while ( htItem && cont )
{
if ( (htItem == htFirst) || (htItem == htLast) )
{
if ( !IsItemSelected(hwndTV, htItem) )
{
- SelectItem(hwndTV, htItem);
+ if ( !(flags & SR_SIMULATE) )
+ {
+ SelectItem(hwndTV, htItem);
+ }
+
+ changed = true;
}
- cont = FALSE;
+ cont = false;
}
- else
+ else // not first or last
{
- if ( unselectOthers && IsItemSelected(hwndTV, htItem) )
+ if ( flags & SR_UNSELECT_OTHERS )
{
- UnselectItem(hwndTV, htItem);
+ if ( IsItemSelected(hwndTV, htItem) )
+ {
+ if ( !(flags & SR_SIMULATE) )
+ UnselectItem(hwndTV, htItem);
+
+ changed = true;
+ }
}
}
{
if ( !IsItemSelected(hwndTV, htItem) )
{
- SelectItem(hwndTV, htItem);
+ if ( !(flags & SR_SIMULATE) )
+ {
+ SelectItem(hwndTV, htItem);
+ }
+
+ changed = true;
}
cont = (htItem != htFirst) && (htItem != htLast);
htItem = (HTREEITEM)TreeView_GetNextVisible(hwndTV, htItem);
}
- // unselect the rest
- if ( unselectOthers )
+ // optionally deselect the rest
+ if ( flags & SR_UNSELECT_OTHERS )
{
while ( htItem )
{
if ( IsItemSelected(hwndTV, htItem) )
{
- UnselectItem(hwndTV, htItem);
+ if ( !(flags & SR_SIMULATE) )
+ {
+ UnselectItem(hwndTV, htItem);
+ }
+
+ changed = true;
}
htItem = (HTREEITEM)TreeView_GetNextVisible(hwndTV, htItem);
// seems to be necessary - otherwise the just selected items don't always
// appear as selected
- UpdateWindow(hwndTV);
+ if ( !(flags & SR_SIMULATE) )
+ {
+ UpdateWindow(hwndTV);
+ }
+
+ return changed;
}
// 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
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_;
}
};
+// ----------------------------------------------------------------------------
+// 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:
+ // We consider that expanded icon is more important than
+ // selected so test for it first.
+ image = m_images[wxTreeItemIcon_Expanded];
+ if ( image == -1 )
+ image = m_images[wxTreeItemIcon_Selected];
+ if ( image != -1 )
+ break;
+ //else: fall through
+
+ case wxTreeItemIcon_Selected:
+ case wxTreeItemIcon_Expanded:
+ image = m_images[wxTreeItemIcon_Normal];
+ break;
+
+ case wxTreeItemIcon_Normal:
+ // no fallback
+ break;
+
+ default:
+ wxFAIL_MSG( wxT("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;
+
+ wxDECLARE_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;
+
+ wxDECLARE_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:
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:
bool Traverse(const wxTreeItemId& root, bool recursively);
const wxTreeCtrl *m_tree;
+
+ wxDECLARE_NO_COPY_CLASS(wxTreeTraversal);
};
// internal class for getting the selected items
{
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;
+
+ wxDECLARE_NO_COPY_CLASS(TraverseSelections);
};
// internal class for counting tree items
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;
-};
-
-// ----------------------------------------------------------------------------
-// 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.
-// ----------------------------------------------------------------------------
-
-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);
- }
-
- // dtor deletes the associated data as well
- ~wxTreeItemIndirectData() { delete m_data; }
-
- // accessors
- // get the real data associated with the item
- wxTreeItemData *GetData() const { return m_data; }
- // change it
- void SetData(wxTreeItemData *data) { m_data = data; }
-
- // do we have such image?
- bool HasImage(wxTreeItemIcon which) const { return m_images[which] != -1; }
- // get image
- int GetImage(wxTreeItemIcon which) const { return m_images[which]; }
- // change it
- void SetImage(int image, wxTreeItemIcon which) { m_images[which] = image; }
-
-private:
- // all the images associated with the item
- int m_images[wxTreeItemIcon_Max];
-
- wxTreeItemData *m_data;
+ wxDECLARE_NO_COPY_CLASS(TraverseCounter);
};
// ----------------------------------------------------------------------------
// wxWin macros
// ----------------------------------------------------------------------------
-IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl, wxControl)
-
// ----------------------------------------------------------------------------
-// variables
+// constants
// ----------------------------------------------------------------------------
-// handy table for sending events
-static const wxEventType g_events[2][2] =
+// indices in gs_expandEvents table below
+enum
+{
+ IDX_COLLAPSE,
+ IDX_EXPAND,
+ IDX_WHAT_MAX
+};
+
+enum
+{
+ IDX_DONE,
+ IDX_DOING,
+ IDX_HOW_MAX
+};
+
+// handy table for sending events - it has to be initialized during run-time
+// now so can't be const any more
+static /* const */ wxEventType gs_expandEvents[IDX_WHAT_MAX][IDX_HOW_MAX];
+
+/*
+ but logically it's a const table with the following entries:
+=
{
{ wxEVT_COMMAND_TREE_ITEM_COLLAPSED, wxEVT_COMMAND_TREE_ITEM_COLLAPSING },
{ wxEVT_COMMAND_TREE_ITEM_EXPANDED, wxEVT_COMMAND_TREE_ITEM_EXPANDING }
};
+*/
// ============================================================================
// implementation
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;
}
// ----------------------------------------------------------------------------
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_dragStarted = false;
+ m_focusLost = true;
+ m_changingSelection = false;
+ m_triggerStateImageClick = false;
+ m_mouseUpDeselect = false;
- 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,
{
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_SHOWSELALWAYS /* | WS_CLIPSIBLINGS */;
+ WXDWORD exStyle = 0;
+ DWORD wstyle = MSWGetStyle(m_windowStyle, & exStyle);
+ wstyle |= WS_TABSTOP | TVS_SHOWSELALWAYS;
- if ((m_windowStyle & wxTR_NO_LINES) == 0)
+ if ( !(m_windowStyle & wxTR_NO_LINES) )
wstyle |= TVS_HASLINES;
if ( m_windowStyle & wxTR_HAS_BUTTONS )
wstyle |= TVS_HASBUTTONS;
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))
-
- // 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 ( m_windowStyle & wxTR_FULL_ROW_HIGHLIGHT )
+ {
+ if ( wxApp::GetComCtl32Version() >= 471 )
+ wstyle |= TVS_FULLROWSELECT;
+ }
- // Create the tree control.
- if ( !MSWCreateControl(WC_TREEVIEW, wstyle) )
- return FALSE;
-
-#if wxUSE_COMCTL32_SAFELY
- wxWindow::SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_WINDOW));
- wxWindow::SetForegroundColour(wxWindow::GetParent()->GetForegroundColour());
-#elif 1
- SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_WINDOW));
- SetForegroundColour(wxWindow::GetParent()->GetForegroundColour());
-#else
- // This works around a bug in the Windows tree control whereby for some versions
- // of comctrl32, setting any colour actually draws the background in black.
- // This will initialise the background to the system colour.
- // THIS FIX NOW REVERTED since it caused problems on _other_ systems.
- // Assume the user has an updated comctl32.dll.
- ::SendMessage(GetHwnd(), TVM_SETBKCOLOR, 0,-1);
- wxWindow::SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_WINDOW));
- SetForegroundColour(wxWindow::GetParent()->GetForegroundColour());
+#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, pos, size) )
+ return false;
- // VZ: this is some experimental code which may be used to get the
- // TVS_CHECKBOXES style functionality for comctl32.dll < 4.71.
- // AFAIK, the standard DLL does about the same thing anyhow.
-#if 0
- if ( m_windowStyle & wxTR_MULTIPLE )
- {
- wxBitmap bmp;
-
- // create the DC compatible with the current screen
- 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);
- HBITMAP hbmpCheck = CreateBitmap(x, y, // bitmap size
- 1, // # of color planes
- 1, // # bits needed for one pixel
- 0); // array containing colour data
- SelectObject(hdcMem, hbmpCheck);
-
- // then draw a check mark into it
- RECT rect = { 0, 0, x, y };
- if ( !::DrawFrameControl(hdcMem, &rect,
- DFC_BUTTON,
- DFCS_BUTTONCHECK | DFCS_CHECKED) )
- {
- wxLogLastError(wxT("DrawFrameControl(check)"));
- }
+ SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
+ SetForegroundColour(wxWindow::GetParent()->GetForegroundColour());
- bmp.SetHBITMAP((WXHBITMAP)hbmpCheck);
- imagelistCheckboxes.Add(bmp);
+ wxSetCCUnicodeFormat(GetHwnd());
- if ( !::DrawFrameControl(hdcMem, &rect,
- DFC_BUTTON,
- DFCS_BUTTONCHECK) )
+ if ( m_windowStyle & wxTR_TWIST_BUTTONS )
+ {
+ // Under Vista and later Explorer uses rotating ("twist") buttons
+ // instead of the default "+/-" ones so apply its theme to the tree
+ // control to implement this style.
+ if ( wxGetWinVersion() >= wxWinVersion_Vista )
{
- wxLogLastError(wxT("DrawFrameControl(uncheck)"));
+ if ( wxUxThemeEngine *theme = wxUxThemeEngine::GetIfActive() )
+ {
+ theme->SetWindowTheme(GetHwnd(), L"EXPLORER", NULL);
+ }
}
-
- bmp.SetHBITMAP((WXHBITMAP)hbmpCheck);
- imagelistCheckboxes.Add(bmp);
-
- // clean up
- ::DeleteDC(hdcMem);
-
- // set the imagelist
- SetStateImageList(&imagelistCheckboxes);
}
-#endif // 0
-
- SetSize(pos.x, pos.y, size.x, size.y);
- return TRUE;
+ return true;
}
wxTreeCtrl::~wxTreeCtrl()
{
+ m_isBeingDeleted = true;
+
// 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();
}
// 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,
+ wxT("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
TreeView_SetIndent(GetHwnd(), indent);
}
-wxImageList *wxTreeCtrl::GetImageList() const
+void wxTreeCtrl::SetAnyImageList(wxImageList *imageList, int which)
{
- return m_imageListNormal;
+ // no error return
+ (void) TreeView_SetImageList(GetHwnd(),
+ imageList ? imageList->GetHIMAGELIST() : 0,
+ which);
}
-wxImageList *wxTreeCtrl::GetStateImageList() const
+void wxTreeCtrl::SetImageList(wxImageList *imageList)
{
- return m_imageListNormal;
-}
-
-void wxTreeCtrl::SetAnyImageList(wxImageList *imageList, int which)
-{
- // no error return
- TreeView_SetImageList(GetHwnd(),
- imageList ? imageList->GetHIMAGELIST() : 0,
- which);
-}
-
-void wxTreeCtrl::SetImageList(wxImageList *imageList)
-{
- SetAnyImageList(m_imageListNormal = imageList, TVSIL_NORMAL);
+ 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;
}
bool wxTreeCtrl::SetBackgroundColour(const wxColour &colour)
{
-#if !wxUSE_COMCTL32_SAFELY
if ( !wxWindowBase::SetBackgroundColour(colour) )
- return FALSE;
+ return false;
- SendMessage(GetHwnd(), TVM_SETBKCOLOR, 0, colour.GetPixel());
-#endif
+ ::SendMessage(GetHwnd(), TVM_SETBKCOLOR, 0, colour.GetPixel());
- return TRUE;
+ return true;
}
bool wxTreeCtrl::SetForegroundColour(const wxColour &colour)
{
-#if !wxUSE_COMCTL32_SAFELY
if ( !wxWindowBase::SetForegroundColour(colour) )
- return FALSE;
+ return false;
- SendMessage(GetHwnd(), TVM_SETTEXTCOLOR, 0, colour.GetPixel());
-#endif
+ ::SendMessage(GetHwnd(), TVM_SETTEXTCOLOR, 0, colour.GetPixel());
- 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);
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 = wxMSW_CONV_LPTSTR(text);
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.t_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) )
- {
- data->SetImage(image, wxTreeItemIcon_Selected);
- }
-
- if ( which == wxTreeItemIcon_Expanded &&
- !data->HasImage(wxTreeItemIcon_SelectedExpanded) )
- {
- data->SetImage(image, wxTreeItemIcon_SelectedExpanded);
- }
+ RefreshItem(item);
}
-void wxTreeCtrl::DoSetItemImages(const wxTreeItemId& item,
- int image,
- int imageSel)
+wxTreeItemParam *wxTreeCtrl::GetItemParam(const wxTreeItemId& item) const
{
- wxTreeViewItem tvItem(item, TVIF_IMAGE | TVIF_SELECTEDIMAGE);
- tvItem.iSelectedImage = imageSel;
- tvItem.iImage = image;
- DoSetItem(&tvItem);
-}
+ wxCHECK_MSG( item.IsOk(), NULL, wxT("invalid tree item") );
-int wxTreeCtrl::GetItemImage(const wxTreeItemId& item,
- wxTreeItemIcon which) const
-{
- if ( HasIndirectData(item) )
+ wxTreeViewItem tvItem(item, TVIF_PARAM);
+
+ // hidden root may still have data.
+ if ( IS_VIRTUAL_ROOT(item) )
{
- return DoGetItemImageFromData(item, which);
+ return GET_VIRTUAL_ROOT()->GetParam();
}
- UINT mask;
- switch ( which )
+ // visible node.
+ if ( !DoGetItem(&tvItem) )
{
- default:
- wxFAIL_MSG( wxT("unknown tree item image type") );
-
- case wxTreeItemIcon_Normal:
- mask = TVIF_IMAGE;
- break;
-
- case wxTreeItemIcon_Selected:
- mask = TVIF_SELECTEDIMAGE;
- break;
-
- case wxTreeItemIcon_Expanded:
- case wxTreeItemIcon_SelectedExpanded:
- return -1;
+ return NULL;
}
- wxTreeViewItem tvItem(item, mask);
- DoGetItem(&tvItem);
-
- return mask == TVIF_IMAGE ? tvItem.iImage : tvItem.iSelectedImage;
+ return (wxTreeItemParam *)tvItem.lParam;
}
-void wxTreeCtrl::SetItemImage(const wxTreeItemId& item, int image,
- wxTreeItemIcon which)
+bool wxTreeCtrl::HandleTreeEvent(wxTreeEvent& event) const
{
- int imageNormal, imageSel;
- switch ( which )
+ if ( event.m_item.IsOk() )
{
- 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);
-
- // 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;
+ event.SetClientObject(GetItemData(event.m_item));
}
- // 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);
+ return HandleWindowEvent(event);
}
wxTreeItemData *wxTreeCtrl::GetItemData(const wxTreeItemId& item) const
{
- wxTreeViewItem tvItem(item, TVIF_PARAM);
- if ( !DoGetItem(&tvItem) )
- {
- return NULL;
- }
+ wxTreeItemParam *data = GetItemParam(item);
- if ( HasIndirectData(item) )
- {
- return ((wxTreeItemIndirectData *)tvItem.lParam)->GetData();
- }
- else
- {
- return (wxTreeItemData *)tvItem.lParam;
- }
+ return data ? data->GetData() : NULL;
}
void wxTreeCtrl::SetItemData(const wxTreeItemId& item, wxTreeItemData *data)
{
- wxTreeViewItem tvItem(item, TVIF_PARAM);
-
- if ( HasIndirectData(item) )
- {
- if ( DoGetItem(&tvItem) )
- {
- ((wxTreeItemIndirectData *)tvItem.lParam)->SetData(data);
- }
- else
- {
- wxFAIL_MSG( wxT("failed to change tree items data") );
- }
- }
- else
+ // first, associate this piece of data with this item
+ if ( data )
{
- tvItem.lParam = (LPARAM)data;
- DoSetItem(&tvItem);
+ data->SetId(item);
}
-}
-
-void wxTreeCtrl::SetIndirectItemData(const wxTreeItemId& item,
- wxTreeItemIndirectData *data)
-{
- // this should never happen because it's unnecessary and will probably lead
- // to crash too because the code elsewhere supposes that the pointer the
- // wxTreeItemIndirectData has is a real wxItemData and not
- // wxTreeItemIndirectData as well
- wxASSERT_MSG( !HasIndirectData(item), wxT("setting indirect data twice?") );
- SetItemData(item, (wxTreeItemData *)data);
+ wxTreeItemParam *param = GetItemParam(item);
- m_itemsWithIndirectData.Add(item);
-}
+ wxCHECK_RET( param, wxT("failed to change tree items data") );
-bool wxTreeCtrl::HasIndirectData(const wxTreeItemId& item) const
-{
- return m_itemsWithIndirectData.Index(item) != wxNOT_FOUND;
+ param->SetData(data);
}
void wxTreeCtrl::SetItemHasChildren(const wxTreeItemId& item, bool has)
{
+ wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
+
+ if ( IS_VIRTUAL_ROOT(item) )
+ return;
+
wxTreeViewItem tvItem(item, TVIF_CHILDREN);
tvItem.cChildren = (int)has;
DoSetItem(&tvItem);
void wxTreeCtrl::SetItemBold(const wxTreeItemId& item, bool bold)
{
+ wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
+
+ if ( IS_VIRTUAL_ROOT(item) )
+ return;
+
wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_BOLD);
tvItem.state = bold ? TVIS_BOLD : 0;
DoSetItem(&tvItem);
void wxTreeCtrl::SetItemDropHighlight(const wxTreeItemId& item, bool highlight)
{
+ if ( IS_VIRTUAL_ROOT(item) )
+ return;
+
wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_DROPHILITED);
tvItem.state = highlight ? TVIS_DROPHILITED : 0;
DoSetItem(&tvItem);
}
+void wxTreeCtrl::RefreshItem(const wxTreeItemId& item)
+{
+ if ( IS_VIRTUAL_ROOT(item) )
+ return;
+
+ wxRect rect;
+ if ( GetBoundingRect(item, rect) )
+ {
+ RefreshRect(rect);
+ }
+}
+
+wxColour wxTreeCtrl::GetItemTextColour(const wxTreeItemId& item) const
+{
+ wxCHECK_MSG( item.IsOk(), wxNullColour, wxT("invalid tree item") );
+
+ wxMapTreeAttr::const_iterator it = m_attrs.find(item.m_pItem);
+ return it == m_attrs.end() ? wxNullColour : it->second->GetTextColour();
+}
+
+wxColour wxTreeCtrl::GetItemBackgroundColour(const wxTreeItemId& item) const
+{
+ wxCHECK_MSG( item.IsOk(), wxNullColour, wxT("invalid tree item") );
+
+ wxMapTreeAttr::const_iterator it = m_attrs.find(item.m_pItem);
+ return it == m_attrs.end() ? wxNullColour : it->second->GetBackgroundColour();
+}
+
+wxFont wxTreeCtrl::GetItemFont(const wxTreeItemId& item) const
+{
+ wxCHECK_MSG( item.IsOk(), wxNullFont, wxT("invalid tree item") );
+
+ 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);
}
// ----------------------------------------------------------------------------
bool wxTreeCtrl::IsVisible(const wxTreeItemId& item) const
{
- // Bug in Gnu-Win32 headers, so don't use the macro TreeView_GetItemRect
- RECT rect;
+ wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") );
+
+ if ( item == wxTreeItemId(TVI_ROOT) )
+ {
+ // virtual (hidden) root is never visible
+ return false;
+ }
- // this ugliness comes directly from MSDN - it *is* the correct way to pass
- // the HTREEITEM with TVM_GETITEMRECT
- *(WXHTREEITEM *)&rect = (WXHTREEITEM)item;
+ // Bug in Gnu-Win32 headers, so don't use the macro TreeView_GetItemRect
+ TVGetItemRectParam param;
- // 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 ( !wxTreeView_GetItemRect(GetHwnd(), HITEM(item), param, TRUE) )
+ {
+ // 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 param.rect.bottom > 0 && param.rect.top < GetClientSize().y;
}
bool wxTreeCtrl::ItemHasChildren(const wxTreeItemId& item) const
{
+ wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") );
+
+ if ( IS_VIRTUAL_ROOT(item) )
+ {
+ wxTreeItemIdValue cookie;
+ return GetFirstChild(item, cookie).IsOk();
+ }
+
wxTreeViewItem tvItem(item, TVIF_CHILDREN);
DoGetItem(&tvItem);
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);
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);
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);
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), (long)(WXHTREEITEM)0,
+ wxCHECK_MSG( !HasFlag(wxTR_MULTIPLE), wxTreeItemId(),
wxT("this only works with single selection controls") );
- return wxTreeItemId((WXHTREEITEM) TreeView_GetSelection(GetHwnd()));
+ return GetFocusedItem();
+}
+
+wxTreeItemId wxTreeCtrl::GetFocusedItem() const
+{
+ 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);
- return l;
+ hitem = TreeView_GetNextSibling(GetHwnd(), hitem);
+
+ wxTreeItemId item(hitem);
+
+ 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);
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;
}
// ----------------------------------------------------------------------------
// multiple selections emulation
// ----------------------------------------------------------------------------
-bool wxTreeCtrl::IsItemChecked(const wxTreeItemId& item) const
-{
- // receive the desired information.
- wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_STATEIMAGEMASK);
- DoGetItem(&tvItem);
-
- // state image indices are 1 based
- return ((tvItem.state >> 12) - 1) == 1;
-}
-
-void wxTreeCtrl::SetItemCheck(const wxTreeItemId& item, bool check)
-{
- // receive the desired information.
- wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_STATEIMAGEMASK);
-
- // state images are one-based
- tvItem.state = (check ? 2 : 1) << 12;
-
- DoSetItem(&tvItem);
-}
-
size_t wxTreeCtrl::GetSelections(wxArrayTreeItemIds& selections) const
{
TraverseSelections selector(this, selections);
// 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(),
- _T("can't have more than one root in the tree") );
+ wxT("can't have more than one root in the tree") );
TV_INSERTSTRUCT tvIns;
tvIns.hParent = HITEM(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 = wxMSW_CONV_LPTSTR(text);
}
else
{
tvIns.item.cchTextMax = 0;
}
- if ( image != -1 )
- {
- mask |= TVIF_IMAGE;
- tvIns.item.iImage = image;
-
- if ( selectedImage == -1 )
- {
- // take the same image for selected icon if not specified
- selectedImage = image;
- }
- }
+ // create the param which will store the other item parameters
+ wxTreeItemParam *param = new wxTreeItemParam;
- if ( selectedImage != -1 )
- {
- mask |= TVIF_SELECTEDIMAGE;
- tvIns.item.iSelectedImage = selectedImage;
- }
+ // we return the images on demand as they depend on whether the item is
+ // expanded or collapsed too in our case
+ mask |= TVIF_IMAGE | TVIF_SELECTEDIMAGE;
+ tvIns.item.iImage = I_IMAGECALLBACK;
+ tvIns.item.iSelectedImage = I_IMAGECALLBACK;
- if ( data != NULL )
- {
- mask |= TVIF_PARAM;
- tvIns.item.lParam = (LPARAM)data;
- }
+ param->SetImage(image, wxTreeItemIcon_Normal);
+ param->SetImage(selectedImage, wxTreeItemIcon_Selected);
+ mask |= TVIF_PARAM;
+ tvIns.item.lParam = (LPARAM)param;
tvIns.item.mask = mask;
- HTREEITEM id = (HTREEITEM) TreeView_InsertItem(GetHwnd(), &tvIns);
+ // don't use the hack below for the children of hidden root: this results
+ // in a crash inside comctl32.dll when we call TreeView_GetItemRect()
+ const bool firstChild = !IsHiddenRoot(parent) &&
+ !TreeView_GetChild(GetHwnd(), HITEM(parent));
+
+ HTREEITEM id = TreeView_InsertItem(GetHwnd(), &tvIns);
if ( id == 0 )
{
wxLogLastError(wxT("TreeView_InsertItem"));
}
- if ( data != NULL )
+ // apparently some Windows versions (2000 and XP are reported to do this)
+ // sometimes don't refresh the tree after adding the first child and so we
+ // need this to make the "[+]" appear
+ if ( firstChild )
{
- // associate the application tree item with Win32 tree item handle
- data->SetId((WXHTREEITEM)id);
+ TVGetItemRectParam param;
+
+ wxTreeView_GetItemRect(GetHwnd(), HITEM(parent), param, FALSE);
+ ::InvalidateRect(GetHwnd(), ¶m.rect, FALSE);
}
- return wxTreeItemId((WXHTREEITEM)id);
-}
+ // associate the application tree item with Win32 tree item handle
+ param->SetItem(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);
+ // setup wxTreeItemData
+ if ( data != NULL )
+ {
+ param->SetData(data);
+ data->SetId(id);
+ }
+
+ return wxTreeItemId(id);
}
wxTreeItemId wxTreeCtrl::AddRoot(const wxString& text,
int image, int selectedImage,
wxTreeItemData *data)
{
- return DoInsertItem(wxTreeItemId((long) (WXHTREEITEM) 0), (long)(WXHTREEITEM) 0,
- text, image, selectedImage, data);
-}
+ if ( HasFlag(wxTR_HIDE_ROOT) )
+ {
+ wxASSERT_MSG( !m_pVirtualRoot, wxT("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, wxT("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)
{
- if ( !TreeView_DeleteItem(GetHwnd(), HITEM(item)) )
- {
- wxLogLastError(wxT("TreeView_DeleteItem"));
- }
-}
-
-// delete all children (but don't delete the item itself)
-void wxTreeCtrl::DeleteChildren(const wxTreeItemId& item)
-{
- long cookie;
+ // unlock tree selections on vista, without this the
+ // tree ctrl will eventually crash after item deletion
+ TreeItemUnlocker unlock_all;
- wxArrayLong children;
- wxTreeItemId child = GetFirstChild(item, cookie);
- while ( child.IsOk() )
+ if ( HasFlag(wxTR_MULTIPLE) )
{
- children.Add((long)(WXHTREEITEM)child);
-
- child = GetNextChild(item, cookie);
- }
+ bool selected = IsSelected(item);
+ wxTreeItemId next;
- size_t nCount = children.Count();
- for ( size_t n = 0; n < nCount; n++ )
- {
- if ( !TreeView_DeleteItem(GetHwnd(), (HTREEITEM)children[n]) )
+ if ( selected )
{
- wxLogLastError(wxT("TreeView_DeleteItem"));
+ next = TreeView_GetNextVisible(GetHwnd(), HITEM(item));
+
+ if ( !next.IsOk() )
+ {
+ next = TreeView_GetPrevVisible(GetHwnd(), HITEM(item));
+ }
}
- }
-}
-void wxTreeCtrl::DeleteAllItems()
+ {
+ TempSetter set(m_changingSelection);
+ if ( !TreeView_DeleteItem(GetHwnd(), HITEM(item)) )
+ {
+ wxLogLastError(wxT("TreeView_DeleteItem"));
+ return;
+ }
+ }
+
+ if ( !selected )
+ {
+ return;
+ }
+
+ if ( item == m_htSelStart )
+ m_htSelStart.Unset();
+
+ if ( item == m_htClickedItem )
+ m_htClickedItem.Unset();
+
+ if ( next.IsOk() )
+ {
+ wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, this, next);
+
+ if ( IsTreeEventAllowed(changingEvent) )
+ {
+ wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, this, next);
+ (void)HandleTreeEvent(changedEvent);
+ }
+ else
+ {
+ DoUnselectItem(next);
+ ClearFocusedItem();
+ }
+ }
+ }
+ else
+ {
+ if ( !TreeView_DeleteItem(GetHwnd(), HITEM(item)) )
+ {
+ wxLogLastError(wxT("TreeView_DeleteItem"));
+ }
+ }
+}
+
+// delete all children (but don't delete the item itself)
+void wxTreeCtrl::DeleteChildren(const wxTreeItemId& item)
{
+ // unlock tree selections on vista for the duration of this call
+ TreeItemUnlocker unlock_all;
+
+ wxTreeItemIdValue cookie;
+
+ wxArrayTreeItemIds children;
+ wxTreeItemId child = GetFirstChild(item, cookie);
+ while ( child.IsOk() )
+ {
+ children.Add(child);
+
+ child = GetNextChild(item, cookie);
+ }
+
+ size_t nCount = children.Count();
+ for ( size_t n = 0; n < nCount; n++ )
+ {
+ Delete(children[n]);
+ }
+}
+
+void wxTreeCtrl::DeleteAllItems()
+{
+ // unlock tree selections on vista for the duration of this call
+ TreeItemUnlocker unlock_all;
+
+ // invalidate all the items we store as they're going to become invalid
+ m_htSelStart =
+ m_htClickedItem = wxTreeItemId();
+
+ // 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"));
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
tvItem.state = 0;
DoSetItem(&tvItem);
- if ( TreeView_Expand(GetHwnd(), HITEM(item), flag) != 0 )
+ if ( IsExpanded(item) )
{
- wxTreeEvent event(wxEVT_NULL, m_windowId);
- event.m_item = item;
-
- bool isExpanded = IsExpanded(item);
+ wxTreeEvent event(wxEVT_COMMAND_TREE_ITEM_COLLAPSING,
+ this, wxTreeItemId(item));
- event.SetEventObject(this);
+ if ( !IsTreeEventAllowed(event) )
+ return;
+ }
- // FIXME return value of {EXPAND|COLLAPS}ING event handler is discarded
- event.SetEventType(g_events[isExpanded][TRUE]);
- GetEventHandler()->ProcessEvent(event);
+ if ( TreeView_Expand(GetHwnd(), HITEM(item), flag) )
+ {
+ if ( IsExpanded(item) )
+ return;
- event.SetEventType(g_events[isExpanded][FALSE]);
- GetEventHandler()->ProcessEvent(event);
+ wxTreeEvent event(wxEVT_COMMAND_TREE_ITEM_COLLAPSED, this, item);
+ (void)HandleTreeEvent(event);
}
//else: change didn't took place, so do nothing at all
}
DoExpand(item, TVE_TOGGLE);
}
-void wxTreeCtrl::ExpandItem(const wxTreeItemId& item, int action)
+void wxTreeCtrl::Unselect()
{
- DoExpand(item, action);
+ wxASSERT_MSG( !HasFlag(wxTR_MULTIPLE),
+ wxT("doesn't make sense, may be you want UnselectAll()?") );
+
+ // the current focus
+ HTREEITEM htFocus = (HTREEITEM)TreeView_GetSelection(GetHwnd());
+
+ if ( !htFocus )
+ {
+ return;
+ }
+
+ if ( HasFlag(wxTR_MULTIPLE) )
+ {
+ wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING,
+ this, wxTreeItemId());
+ changingEvent.m_itemOld = htFocus;
+
+ if ( IsTreeEventAllowed(changingEvent) )
+ {
+ ClearFocusedItem();
+
+ wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED,
+ this, wxTreeItemId());
+ changedEvent.m_itemOld = htFocus;
+ (void)HandleTreeEvent(changedEvent);
+ }
+ }
+ else
+ {
+ ClearFocusedItem();
+ }
}
-void wxTreeCtrl::Unselect()
+void wxTreeCtrl::DoUnselectAll()
{
- wxASSERT_MSG( !(m_windowStyle & wxTR_MULTIPLE),
- wxT("doesn't make sense, may be you want UnselectAll()?") );
+ wxArrayTreeItemIds selections;
+ size_t count = GetSelections(selections);
+
+ for ( size_t n = 0; n < count; n++ )
+ {
+ DoUnselectItem(selections[n]);
+ }
- // just remove the selection
- SelectItem(wxTreeItemId((long) (WXHTREEITEM) 0));
+ m_htSelStart.Unset();
}
void wxTreeCtrl::UnselectAll()
{
- if ( m_windowStyle & wxTR_MULTIPLE )
+ if ( HasFlag(wxTR_MULTIPLE) )
{
- wxArrayTreeItemIds selections;
- size_t count = GetSelections(selections);
- for ( size_t n = 0; n < count; n++ )
+ HTREEITEM htFocus = (HTREEITEM)TreeView_GetSelection(GetHwnd());
+ if ( !htFocus ) return;
+
+ wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, this);
+ changingEvent.m_itemOld = htFocus;
+
+ if ( IsTreeEventAllowed(changingEvent) )
{
-#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
+ DoUnselectAll();
+
+ wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, this);
+ changedEvent.m_itemOld = htFocus;
+ (void)HandleTreeEvent(changedEvent);
}
}
else
{
- // just remove the selection
Unselect();
}
}
-void wxTreeCtrl::SelectItem(const wxTreeItemId& item)
+void wxTreeCtrl::DoSelectChildren(const wxTreeItemId& parent)
{
- if ( m_windowStyle & wxTR_MULTIPLE )
+ DoUnselectAll();
+
+ wxTreeItemIdValue cookie;
+ wxTreeItemId child = GetFirstChild(parent, cookie);
+ while ( child.IsOk() )
{
-#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
+ DoSelectItem(child, true);
+ child = GetNextChild(child, cookie);
}
- else
+}
+
+void wxTreeCtrl::SelectChildren(const wxTreeItemId& parent)
+{
+ wxCHECK_RET( HasFlag(wxTR_MULTIPLE),
+ "this only works with multiple selection controls" );
+
+ HTREEITEM htFocus = (HTREEITEM)TreeView_GetSelection(GetHwnd());
+
+ wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, this);
+ changingEvent.m_itemOld = htFocus;
+
+ if ( IsTreeEventAllowed(changingEvent) )
+ {
+ DoSelectChildren(parent);
+
+ wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, this);
+ changedEvent.m_itemOld = htFocus;
+ (void)HandleTreeEvent(changedEvent);
+ }
+}
+
+void wxTreeCtrl::DoSelectItem(const wxTreeItemId& item, bool select)
+{
+ TempSetter set(m_changingSelection);
+
+ ::SelectItem(GetHwnd(), HITEM(item), select);
+}
+
+void wxTreeCtrl::SelectItem(const wxTreeItemId& item, bool select)
+{
+ wxCHECK_RET( !IsHiddenRoot(item), wxT("can't select hidden root item") );
+
+ if ( select == IsSelected(item) )
{
- // inspite of the docs (MSDN Jan 99 edition), we don't seem to receive
- // the notification from the control (i.e. TVN_SELCHANG{ED|ING}), so
- // send them ourselves
+ // nothing to do, the item is already in the requested state
+ return;
+ }
- wxTreeEvent event(wxEVT_NULL, m_windowId);
- event.m_item = item;
- event.SetEventObject(this);
+ if ( HasFlag(wxTR_MULTIPLE) )
+ {
+ wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, this, item);
- event.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGING);
- if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
+ if ( IsTreeEventAllowed(changingEvent) )
{
- if ( !TreeView_SelectItem(GetHwnd(), HITEM(item)) )
+ HTREEITEM htFocus = (HTREEITEM)TreeView_GetSelection(GetHwnd());
+ DoSelectItem(item, select);
+
+ if ( !htFocus )
+ {
+ SetFocusedItem(item);
+ }
+
+ wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED,
+ this, item);
+ (void)HandleTreeEvent(changedEvent);
+ }
+ }
+ else // single selection
+ {
+ wxTreeItemId itemOld, itemNew;
+ if ( select )
+ {
+ itemOld = GetSelection();
+ itemNew = item;
+ }
+ else // deselecting the currently selected item
+ {
+ itemOld = item;
+ // leave itemNew invalid
+ }
+
+ // Recent versions of comctl32.dll send TVN_SELCHANG{ED,ING} events
+ // when we call TreeView_SelectItem() but apparently some old ones did
+ // not so send the events ourselves and ignore those generated by
+ // TreeView_SelectItem() if m_changingSelection is set.
+ wxTreeEvent
+ changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, this, itemNew);
+ changingEvent.SetOldItem(itemOld);
+
+ if ( IsTreeEventAllowed(changingEvent) )
+ {
+ TempSetter set(m_changingSelection);
+
+ if ( !TreeView_SelectItem(GetHwnd(), HITEM(itemNew)) )
{
wxLogLastError(wxT("TreeView_SelectItem"));
}
- else
+ else // ok
{
- event.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED);
- (void)GetEventHandler()->ProcessEvent(event);
+ ::SetFocus(GetHwnd(), HITEM(item));
+
+ wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED,
+ this, itemNew);
+ changedEvent.SetOldItem(itemOld);
+ (void)HandleTreeEvent(changedEvent);
}
}
//else: program vetoed the change
void wxTreeCtrl::EnsureVisible(const wxTreeItemId& item)
{
+ wxCHECK_RET( !IsHiddenRoot(item), wxT("can't show hidden root item") );
+
// no error return
TreeView_EnsureVisible(GetHwnd(), HITEM(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;
}
{
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;
+ wxDELETE(m_textCtrl);
+
+ m_idEdited.Unset();
}
}
-wxTextCtrl* wxTreeCtrl::EditLabel(const wxTreeItemId& item,
- wxClassInfo* textControlClass)
+wxTextCtrl *wxTreeCtrl::EditLabel(const wxTreeItemId& item,
+ wxClassInfo *textControlClass)
{
- wxASSERT( textControlClass->IsKindOf(CLASSINFO(wxTextCtrl)) );
+ wxASSERT( textControlClass->IsKindOf(wxCLASSINFO(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 )
{
+ wxDELETE(m_textCtrl);
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;
#undef TRANSLATE_FLAG
- return wxTreeItemId((WXHTREEITEM) hitTestInfo.hItem);
+ return wxTreeItemId(hitTestInfo.hItem);
}
bool wxTreeCtrl::GetBoundingRect(const wxTreeItemId& item,
wxRect& rect,
bool textOnly) const
{
- RECT rc;
- if ( TreeView_GetItemRect(GetHwnd(), HITEM(item),
- &rc, textOnly) )
+ // Virtual root items have no bounding rectangle
+ if ( IS_VIRTUAL_ROOT(item) )
+ {
+ return false;
+ }
+
+ TVGetItemRectParam param;
+
+ if ( wxTreeView_GetItemRect(GetHwnd(), HITEM(item), param, textOnly) )
{
- rect = wxRect(wxPoint(rc.left, rc.top), wxPoint(rc.right, rc.bottom));
+ rect = wxRect(wxPoint(param.rect.left, param.rect.top),
+ wxPoint(param.rect.right, param.rect.bottom));
- return TRUE;
+ return true;
}
else
{
// couldn't retrieve rect: for example, item isn't visible
- return FALSE;
+ return false;
+ }
+}
+
+void wxTreeCtrl::ClearFocusedItem()
+{
+ TempSetter set(m_changingSelection);
+
+ if ( !TreeView_SelectItem(GetHwnd(), 0) )
+ {
+ wxLogLastError(wxT("TreeView_SelectItem"));
}
}
+void wxTreeCtrl::SetFocusedItem(const wxTreeItemId& item)
+{
+ wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
+
+ TempSetter set(m_changingSelection);
+
+ ::SetFocus(GetHwnd(), HITEM(item));
+}
+
+void wxTreeCtrl::DoUnselectItem(const wxTreeItemId& item)
+{
+ TempSetter set(m_changingSelection);
+
+ ::UnselectItem(GetHwnd(), HITEM(item));
+}
+
+void wxTreeCtrl::DoToggleItemSelection(const wxTreeItemId& item)
+{
+ TempSetter set(m_changingSelection);
+
+ ::ToggleItemSelection(GetHwnd(), HITEM(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!)
- if ( GetClassInfo() == CLASSINFO(wxTreeCtrl) )
+ // 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() == wxCLASSINFO(wxTreeCtrl) )
{
TreeView_SortChildren(GetHwnd(), HITEM(item), 0);
}
{
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 */);
}
// 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);
else
{
// nothing done
- return FALSE;
+ return false;
}
// command processed
- return TRUE;
+ return true;
+}
+
+bool wxTreeCtrl::MSWIsOnItem(unsigned flags) const
+{
+ unsigned mask = TVHT_ONITEM;
+ if ( HasFlag(wxTR_FULL_ROW_HIGHLIGHT) )
+ mask |= TVHT_ONITEMINDENT | TVHT_ONITEMRIGHT;
+
+ return (flags & mask) != 0;
+}
+
+bool wxTreeCtrl::MSWHandleSelectionKey(unsigned vkey)
+{
+ const bool bCtrl = wxIsCtrlDown();
+ const bool bShift = wxIsShiftDown();
+ const HTREEITEM htSel = (HTREEITEM)TreeView_GetSelection(GetHwnd());
+
+ switch ( vkey )
+ {
+ case VK_RETURN:
+ case VK_SPACE:
+ if ( !htSel )
+ break;
+
+ if ( vkey != VK_RETURN && bCtrl )
+ {
+ wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING,
+ this, htSel);
+ changingEvent.m_itemOld = htSel;
+
+ if ( IsTreeEventAllowed(changingEvent) )
+ {
+ DoToggleItemSelection(wxTreeItemId(htSel));
+
+ wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED,
+ this, htSel);
+ changedEvent.m_itemOld = htSel;
+ (void)HandleTreeEvent(changedEvent);
+ }
+ }
+ else
+ {
+ wxArrayTreeItemIds selections;
+ size_t count = GetSelections(selections);
+
+ if ( count != 1 || HITEM(selections[0]) != htSel )
+ {
+ wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING,
+ this, htSel);
+ changingEvent.m_itemOld = htSel;
+
+ if ( IsTreeEventAllowed(changingEvent) )
+ {
+ DoUnselectAll();
+ DoSelectItem(wxTreeItemId(htSel));
+
+ wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED,
+ this, htSel);
+ changedEvent.m_itemOld = htSel;
+ (void)HandleTreeEvent(changedEvent);
+ }
+ }
+ }
+ break;
+
+ case VK_UP:
+ case VK_DOWN:
+ if ( !bCtrl && !bShift )
+ {
+ wxArrayTreeItemIds selections;
+ wxTreeItemId next;
+
+ if ( htSel )
+ {
+ next = vkey == VK_UP
+ ? TreeView_GetPrevVisible(GetHwnd(), htSel)
+ : TreeView_GetNextVisible(GetHwnd(), htSel);
+ }
+ else
+ {
+ next = GetRootItem();
+
+ if ( IsHiddenRoot(next) )
+ next = TreeView_GetChild(GetHwnd(), HITEM(next));
+ }
+
+ if ( !next.IsOk() )
+ {
+ break;
+ }
+
+ wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING,
+ this, next);
+ changingEvent.m_itemOld = htSel;
+
+ if ( IsTreeEventAllowed(changingEvent) )
+ {
+ DoUnselectAll();
+ DoSelectItem(next);
+ SetFocusedItem(next);
+
+ wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED,
+ this, next);
+ changedEvent.m_itemOld = htSel;
+ (void)HandleTreeEvent(changedEvent);
+ }
+ }
+ else if ( htSel )
+ {
+ wxTreeItemId next = vkey == VK_UP
+ ? TreeView_GetPrevVisible(GetHwnd(), htSel)
+ : TreeView_GetNextVisible(GetHwnd(), htSel);
+
+ if ( !next.IsOk() )
+ {
+ break;
+ }
+
+ if ( !m_htSelStart )
+ {
+ m_htSelStart = htSel;
+ }
+
+ if ( bShift && SelectRange(GetHwnd(), HITEM(m_htSelStart), HITEM(next),
+ SR_UNSELECT_OTHERS | SR_SIMULATE) )
+ {
+ wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, this, next);
+ changingEvent.m_itemOld = htSel;
+
+ if ( IsTreeEventAllowed(changingEvent) )
+ {
+ SelectRange(GetHwnd(), HITEM(m_htSelStart), HITEM(next),
+ SR_UNSELECT_OTHERS);
+
+ wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, this, next);
+ changedEvent.m_itemOld = htSel;
+ (void)HandleTreeEvent(changedEvent);
+ }
+ }
+
+ SetFocusedItem(next);
+ }
+ break;
+
+ case VK_LEFT:
+ if ( HasChildren(htSel) && IsExpanded(htSel) )
+ {
+ Collapse(htSel);
+ }
+ else
+ {
+ wxTreeItemId next = GetItemParent(htSel);
+
+ if ( next.IsOk() && !IsHiddenRoot(next) )
+ {
+ wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING,
+ this, next);
+ changingEvent.m_itemOld = htSel;
+
+ if ( IsTreeEventAllowed(changingEvent) )
+ {
+ DoUnselectAll();
+ DoSelectItem(next);
+ SetFocusedItem(next);
+
+ wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED,
+ this, next);
+ changedEvent.m_itemOld = htSel;
+ (void)HandleTreeEvent(changedEvent);
+ }
+ }
+ }
+ break;
+
+ case VK_RIGHT:
+ if ( !IsVisible(htSel) )
+ {
+ EnsureVisible(htSel);
+ }
+
+ if ( !HasChildren(htSel) )
+ break;
+
+ if ( !IsExpanded(htSel) )
+ {
+ Expand(htSel);
+ }
+ else
+ {
+ wxTreeItemId next = TreeView_GetChild(GetHwnd(), htSel);
+
+ wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING, this, next);
+ changingEvent.m_itemOld = htSel;
+
+ if ( IsTreeEventAllowed(changingEvent) )
+ {
+ DoUnselectAll();
+ DoSelectItem(next);
+ SetFocusedItem(next);
+
+ wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED, this, next);
+ changedEvent.m_itemOld = htSel;
+ (void)HandleTreeEvent(changedEvent);
+ }
+ }
+ break;
+
+ case VK_HOME:
+ case VK_END:
+ {
+ wxTreeItemId next = GetRootItem();
+
+ if ( IsHiddenRoot(next) )
+ {
+ next = TreeView_GetChild(GetHwnd(), HITEM(next));
+ }
+
+ if ( !next.IsOk() )
+ break;
+
+ if ( vkey == VK_END )
+ {
+ for ( ;; )
+ {
+ wxTreeItemId nextTemp = TreeView_GetNextVisible(
+ GetHwnd(), HITEM(next));
+
+ if ( !nextTemp.IsOk() )
+ break;
+
+ next = nextTemp;
+ }
+ }
+
+ if ( htSel == HITEM(next) )
+ break;
+
+ if ( bShift )
+ {
+ if ( !m_htSelStart )
+ {
+ m_htSelStart = htSel;
+ }
+
+ if ( SelectRange(GetHwnd(),
+ HITEM(m_htSelStart), HITEM(next),
+ SR_UNSELECT_OTHERS | SR_SIMULATE) )
+ {
+ wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING,
+ this, next);
+ changingEvent.m_itemOld = htSel;
+
+ if ( IsTreeEventAllowed(changingEvent) )
+ {
+ SelectRange(GetHwnd(),
+ HITEM(m_htSelStart), HITEM(next),
+ SR_UNSELECT_OTHERS);
+ SetFocusedItem(next);
+
+ wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED,
+ this, next);
+ changedEvent.m_itemOld = htSel;
+ (void)HandleTreeEvent(changedEvent);
+ }
+ }
+ }
+ else // no Shift
+ {
+ wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING,
+ this, next);
+ changingEvent.m_itemOld = htSel;
+
+ if ( IsTreeEventAllowed(changingEvent) )
+ {
+ DoUnselectAll();
+ DoSelectItem(next);
+ SetFocusedItem(next);
+
+ wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED,
+ this, next);
+ changedEvent.m_itemOld = htSel;
+ (void)HandleTreeEvent(changedEvent);
+ }
+ }
+ }
+ break;
+
+ case VK_PRIOR:
+ case VK_NEXT:
+ if ( bCtrl )
+ {
+ wxTreeItemId firstVisible = GetFirstVisibleItem();
+ size_t visibleCount = TreeView_GetVisibleCount(GetHwnd());
+ wxTreeItemId nextAdjacent = (vkey == VK_PRIOR) ?
+ TreeView_GetPrevVisible(GetHwnd(), HITEM(firstVisible)) :
+ TreeView_GetNextVisible(GetHwnd(), HITEM(firstVisible));
+
+ if ( !nextAdjacent )
+ {
+ break;
+ }
+
+ wxTreeItemId nextStart = firstVisible;
+
+ for ( size_t n = 1; n < visibleCount; n++ )
+ {
+ wxTreeItemId nextTemp = (vkey == VK_PRIOR) ?
+ TreeView_GetPrevVisible(GetHwnd(), HITEM(nextStart)) :
+ TreeView_GetNextVisible(GetHwnd(), HITEM(nextStart));
+
+ if ( nextTemp.IsOk() )
+ {
+ nextStart = nextTemp;
+ }
+ else
+ {
+ break;
+ }
+ }
+
+ EnsureVisible(nextStart);
+
+ if ( vkey == VK_NEXT )
+ {
+ wxTreeItemId nextEnd = nextStart;
+
+ for ( size_t n = 1; n < visibleCount; n++ )
+ {
+ wxTreeItemId nextTemp =
+ TreeView_GetNextVisible(GetHwnd(), HITEM(nextEnd));
+
+ if ( nextTemp.IsOk() )
+ {
+ nextEnd = nextTemp;
+ }
+ else
+ {
+ break;
+ }
+ }
+
+ EnsureVisible(nextEnd);
+ }
+ }
+ else // no Ctrl
+ {
+ size_t visibleCount = TreeView_GetVisibleCount(GetHwnd());
+ wxTreeItemId nextAdjacent = (vkey == VK_PRIOR) ?
+ TreeView_GetPrevVisible(GetHwnd(), htSel) :
+ TreeView_GetNextVisible(GetHwnd(), htSel);
+
+ if ( !nextAdjacent )
+ {
+ break;
+ }
+
+ wxTreeItemId next(htSel);
+
+ for ( size_t n = 1; n < visibleCount; n++ )
+ {
+ wxTreeItemId nextTemp = vkey == VK_PRIOR ?
+ TreeView_GetPrevVisible(GetHwnd(), HITEM(next)) :
+ TreeView_GetNextVisible(GetHwnd(), HITEM(next));
+
+ if ( !nextTemp.IsOk() )
+ break;
+
+ next = nextTemp;
+ }
+
+ wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING,
+ this, next);
+ changingEvent.m_itemOld = htSel;
+
+ if ( IsTreeEventAllowed(changingEvent) )
+ {
+ DoUnselectAll();
+ m_htSelStart.Unset();
+ DoSelectItem(next);
+ SetFocusedItem(next);
+
+ wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED,
+ this, next);
+ changedEvent.m_itemOld = htSel;
+ (void)HandleTreeEvent(changedEvent);
+ }
+ }
+ break;
+
+ default:
+ return false;
+ }
+
+ return true;
+}
+
+bool wxTreeCtrl::MSWHandleTreeKeyDownEvent(WXWPARAM wParam, WXLPARAM lParam)
+{
+ wxTreeEvent keyEvent(wxEVT_COMMAND_TREE_KEY_DOWN, this);
+ keyEvent.m_evtKey = CreateKeyEvent(wxEVT_KEY_DOWN, wParam, lParam);
+
+ bool processed = HandleTreeEvent(keyEvent);
+
+ // generate a separate event for Space/Return
+ if ( !wxIsCtrlDown() && !wxIsShiftDown() && !wxIsAltDown() &&
+ ((wParam == VK_SPACE) || (wParam == VK_RETURN)) )
+ {
+ const HTREEITEM htSel = (HTREEITEM)TreeView_GetSelection(GetHwnd());
+ if ( htSel )
+ {
+ wxTreeEvent activatedEvent(wxEVT_COMMAND_TREE_ITEM_ACTIVATED,
+ this, htSel);
+ (void)HandleTreeEvent(activatedEvent);
+ }
+ }
+
+ return processed;
}
// 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);
+
+ 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));
+
+ 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
+ if ( item.IsOk() )
+ {
+ wxTreeEvent event(wxEVT_COMMAND_TREE_ITEM_MENU, this, item);
- bool isMultiple = (GetWindowStyle() & wxTR_MULTIPLE) != 0;
+ event.m_pointDrag = pt;
- if ( (nMsg >= WM_MOUSEFIRST) && (nMsg <= WM_MOUSELAST) )
+ if ( HandleTreeEvent(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 htOldItem = TreeView_GetSelection(GetHwnd());
+ HTREEITEM htItem = TreeView_HitTest(GetHwnd(), &tvht);
switch ( nMsg )
{
-#if !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
case WM_LBUTTONDOWN:
- if ( htItem && isMultiple )
+ if ( !isMultiple )
+ break;
+
+ m_htClickedItem.Unset();
+
+ if ( !MSWIsOnItem(tvht.flags) )
+ {
+ if ( tvht.flags & TVHT_ONITEMBUTTON )
+ {
+ // either it's going to be handled by user code or
+ // we're going to use it ourselves to toggle the
+ // branch, in either case don't pass it to the base
+ // class which would generate another mouse click event
+ // for it even though it's already handled here
+ processed = true;
+ SetFocus();
+
+ if ( !HandleMouseEvent(nMsg, x, y, wParam) )
+ {
+ if ( !IsExpanded(htItem) )
+ {
+ Expand(htItem);
+ }
+ else
+ {
+ Collapse(htItem);
+ }
+ }
+ }
+
+ m_focusLost = false;
+ break;
+ }
+
+ processed = true;
+ SetFocus();
+ m_htClickedItem = (WXHTREEITEM) htItem;
+ m_ptClick = wxPoint(x, y);
+
+ if ( wParam & MK_CONTROL )
+ {
+ if ( HandleMouseEvent(nMsg, x, y, wParam) )
+ {
+ m_htClickedItem.Unset();
+ break;
+ }
+
+ wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING,
+ this, htItem);
+ changingEvent.m_itemOld = htOldItem;
+
+ if ( IsTreeEventAllowed(changingEvent) )
+ {
+ // toggle selected state
+ DoToggleItemSelection(wxTreeItemId(htItem));
+
+ SetFocusedItem(wxTreeItemId(htItem));
+
+ // reset on any click without Shift
+ m_htSelStart.Unset();
+
+ wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED,
+ this, htItem);
+ changedEvent.m_itemOld = htOldItem;
+ (void)HandleTreeEvent(changedEvent);
+ }
+ }
+ else if ( wParam & MK_SHIFT )
+ {
+ if ( HandleMouseEvent(nMsg, x, y, wParam) )
+ {
+ m_htClickedItem.Unset();
+ break;
+ }
+
+ int srFlags = 0;
+ bool willChange = true;
+
+ if ( !(wParam & MK_CONTROL) )
+ {
+ srFlags |= SR_UNSELECT_OTHERS;
+ }
+
+ if ( !m_htSelStart )
+ {
+ // take the focused item
+ m_htSelStart = htOldItem;
+ }
+ else
+ {
+ willChange = SelectRange(GetHwnd(), HITEM(m_htSelStart),
+ htItem, srFlags | SR_SIMULATE);
+ }
+
+ if ( willChange )
+ {
+ wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING,
+ this, htItem);
+ changingEvent.m_itemOld = htOldItem;
+
+ if ( IsTreeEventAllowed(changingEvent) )
+ {
+ // this selects all items between the starting one
+ // and the current
+ if ( m_htSelStart )
+ {
+ SelectRange(GetHwnd(), HITEM(m_htSelStart),
+ htItem, srFlags);
+ }
+ else
+ {
+ DoSelectItem(wxTreeItemId(htItem));
+ }
+
+ SetFocusedItem(wxTreeItemId(htItem));
+
+ wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED,
+ this, htItem);
+ changedEvent.m_itemOld = htOldItem;
+ (void)HandleTreeEvent(changedEvent);
+ }
+ }
+ }
+ else // normal click
+ {
+ // avoid doing anything if we click on the only
+ // currently selected item
+
+ wxArrayTreeItemIds selections;
+ size_t count = GetSelections(selections);
+
+ if ( count == 0 ||
+ count > 1 ||
+ HITEM(selections[0]) != htItem )
+ {
+ if ( HandleMouseEvent(nMsg, x, y, wParam) )
+ {
+ m_htClickedItem.Unset();
+ break;
+ }
+
+ // 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))
+ {
+ wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING,
+ this, htItem);
+ changingEvent.m_itemOld = htOldItem;
+
+ if ( IsTreeEventAllowed(changingEvent) )
+ {
+ DoUnselectAll();
+ DoSelectItem(wxTreeItemId(htItem));
+ SetFocusedItem(wxTreeItemId(htItem));
+
+ wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED,
+ this, htItem);
+ changedEvent.m_itemOld = htOldItem;
+ (void)HandleTreeEvent(changedEvent);
+ }
+ }
+ else
+ {
+ SetFocusedItem(wxTreeItemId(htItem));
+ m_mouseUpDeselect = 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();
+
+ // prevent in-place editing from starting if focus lost
+ // since previous click
+ if ( m_focusLost )
+ {
+ ClearFocusedItem();
+ DoSelectItem(wxTreeItemId(htItem));
+ SetFocusedItem(wxTreeItemId(htItem));
+ }
+ else
+ {
+ processed = false;
+ }
+ }
+
+ // reset on any click without Shift
+ m_htSelStart.Unset();
+ }
+
+ m_focusLost = false;
+
+ // we consumed the event so we need to trigger state image
+ // click if needed
+ if ( processed )
+ {
+ if ( tvht.flags & TVHT_ONITEMSTATEICON )
+ {
+ m_triggerStateImageClick = true;
+ }
+ }
+ break;
+
+ case WM_RBUTTONDOWN:
+ if ( !isMultiple )
+ break;
+
+ processed = true;
+ SetFocus();
+
+ if ( HandleMouseEvent(nMsg, x, y, wParam) || !htItem )
+ {
+ break;
+ }
+
+ // 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
+ if ( !IsItemSelected(GetHwnd(), htItem) )
+ {
+ wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING,
+ this, htItem);
+ changingEvent.m_itemOld = htOldItem;
+
+ if ( IsTreeEventAllowed(changingEvent) )
+ {
+ DoUnselectAll();
+ DoSelectItem(wxTreeItemId(htItem));
+ SetFocusedItem(wxTreeItemId(htItem));
+
+ wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED,
+ this, htItem);
+ changedEvent.m_itemOld = htOldItem;
+ (void)HandleTreeEvent(changedEvent);
+ }
+ }
+
+ break;
+
+ case WM_MOUSEMOVE:
+#ifndef __WXWINCE__
+ if ( m_htClickedItem )
{
- if ( wParam & MK_CONTROL )
+ int cx = abs(m_ptClick.x - x);
+ int cy = abs(m_ptClick.y - y);
+
+ if ( cx > ::GetSystemMetrics(SM_CXDRAG) ||
+ cy > ::GetSystemMetrics(SM_CYDRAG) )
{
- SetFocus();
+ NM_TREEVIEW tv;
+ wxZeroMemory(tv);
- // toggle selected state
- ToggleItemSelection(GetHwnd(), htItem);
+ tv.hdr.hwndFrom = GetHwnd();
+ tv.hdr.idFrom = ::GetWindowLong(GetHwnd(), GWL_ID);
+ tv.hdr.code = TVN_BEGINDRAG;
- ::SetFocus(GetHwnd(), htItem);
+ tv.itemNew.hItem = HITEM(m_htClickedItem);
- // reset on any click without Shift
- m_htSelStart = 0;
- processed = TRUE;
- }
- else if ( wParam & MK_SHIFT )
- {
- // this selects all items between the starting one and
- // the current
+ TVITEM tviAux;
+ wxZeroMemory(tviAux);
- if ( !m_htSelStart )
- {
- // take the focused item
- m_htSelStart = (WXHTREEITEM)
- TreeView_GetSelection(GetHwnd());
- }
+ tviAux.hItem = HITEM(m_htClickedItem);
+ tviAux.mask = TVIF_STATE | TVIF_PARAM;
+ tviAux.stateMask = 0xffffffff;
+ TreeView_GetItem(GetHwnd(), &tviAux);
- SelectRange(GetHwnd(), HITEM(m_htSelStart), htItem,
- !(wParam & MK_CONTROL));
+ tv.itemNew.state = tviAux.state;
+ tv.itemNew.lParam = tviAux.lParam;
- ::SetFocus(GetHwnd(), htItem);
+ tv.ptDrag.x = x;
+ tv.ptDrag.y = y;
- processed = TRUE;
- }
- else // normal click
- {
- // clear the selection and then let the default handler
- // do the job
- UnselectAll();
+ // do it before SendMessage() call below to avoid
+ // reentrancies here if there is another WM_MOUSEMOVE
+ // in the queue already
+ m_htClickedItem.Unset();
- // prevent the click from starting in-place editing
- // when there was no selection in the control
- TreeView_SelectItem(GetHwnd(), 0);
+ ::SendMessage(GetHwndOf(GetParent()), WM_NOTIFY,
+ tv.hdr.idFrom, (LPARAM)&tv );
- // reset on any click without Shift
- m_htSelStart = 0;
+ // don't pass it to the default window proc, it would
+ // start dragging again
+ processed = true;
}
}
- break;
-#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
+#endif // __WXWINCE__
- case WM_MOUSEMOVE:
+#if wxUSE_DRAGIMAGE
if ( m_dragImage )
{
m_dragImage->Move(wxPoint(x, y));
m_dragImage->Show();
}
}
+#endif // wxUSE_DRAGIMAGE
break;
case WM_LBUTTONUP:
+ if ( isMultiple )
+ {
+ // deselect other items if needed
+ if ( htItem )
+ {
+ if ( m_mouseUpDeselect )
+ {
+ m_mouseUpDeselect = false;
+
+ wxTreeEvent changingEvent(wxEVT_COMMAND_TREE_SEL_CHANGING,
+ this, htItem);
+ changingEvent.m_itemOld = htOldItem;
+
+ if ( IsTreeEventAllowed(changingEvent) )
+ {
+ DoUnselectAll();
+ DoSelectItem(wxTreeItemId(htItem));
+ SetFocusedItem(wxTreeItemId(htItem));
+
+ wxTreeEvent changedEvent(wxEVT_COMMAND_TREE_SEL_CHANGED,
+ this, htItem);
+ changedEvent.m_itemOld = htOldItem;
+ (void)HandleTreeEvent(changedEvent);
+ }
+ }
+ }
+
+ m_htClickedItem.Unset();
+
+ if ( m_triggerStateImageClick )
+ {
+ if ( tvht.flags & TVHT_ONITEMSTATEICON )
+ {
+ wxTreeEvent event(wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK,
+ this, htItem);
+ (void)HandleTreeEvent(event);
+
+ m_triggerStateImageClick = false;
+ processed = true;
+ }
+ }
+
+ if ( !m_dragStarted && MSWIsOnItem(tvht.flags) )
+ {
+ processed = true;
+ }
+ }
+
+ // fall through
+
case WM_RBUTTONUP:
+#if wxUSE_DRAGIMAGE
if ( m_dragImage )
{
m_dragImage->EndDrag();
- delete m_dragImage;
- m_dragImage = NULL;
+ wxDELETE(m_dragImage);
// 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)HandleTreeEvent(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
+
+ if ( isMultiple && nMsg == WM_RBUTTONUP )
+ {
+ // 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);
+ processed = true;
+ }
+
+ m_dragStarted = false;
+
break;
}
}
-#if !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
- else if ( (nMsg == WM_SETFOCUS || nMsg == WM_KILLFOCUS) && isMultiple )
+ else if ( (nMsg == WM_SETFOCUS || nMsg == WM_KILLFOCUS) )
{
- // the tree control greys out the selected item when it loses focus and
- // paints it as selected again when it regains it, but it won't do it
- // for the other items itself - help it
- wxArrayTreeItemIds selections;
- size_t count = GetSelections(selections);
- RECT rect;
- for ( size_t n = 0; n < count; n++ )
+ if ( isMultiple )
{
- // TreeView_GetItemRect() will return FALSE if item is not visible,
- // which may happen perfectly well
- if ( TreeView_GetItemRect(GetHwnd(), HITEM(selections[n]),
- &rect, TRUE) )
+ // the tree control greys out the selected item when it loses focus
+ // and paints it as selected again when it regains it, but it won't
+ // do it for the other items itself - help it
+ wxArrayTreeItemIds selections;
+ size_t count = GetSelections(selections);
+ TVGetItemRectParam param;
+
+ for ( size_t n = 0; n < count; n++ )
{
- ::InvalidateRect(GetHwnd(), &rect, FALSE);
+ // TreeView_GetItemRect() will return false if item is not
+ // visible, which may happen perfectly well
+ if ( wxTreeView_GetItemRect(GetHwnd(), HITEM(selections[n]),
+ param, TRUE) )
+ {
+ ::InvalidateRect(GetHwnd(), ¶m.rect, FALSE);
+ }
}
}
+
+ if ( nMsg == WM_KILLFOCUS )
+ {
+ m_focusLost = true;
+ }
}
- else if ( nMsg == WM_KEYDOWN && isMultiple )
+ else if ( (nMsg == WM_KEYDOWN || nMsg == WM_SYSKEYDOWN) && isMultiple )
{
- bool bCtrl = wxIsCtrlDown(),
- bShift = wxIsShiftDown();
+ // normally we want to generate wxEVT_KEY_DOWN events from TVN_KEYDOWN
+ // notification but for the keys which can be used to change selection
+ // we need to do it from here so as to not apply the default behaviour
+ // if the events are handled by the user code
+ switch ( wParam )
+ {
+ case VK_RETURN:
+ case VK_SPACE:
+ case VK_UP:
+ case VK_DOWN:
+ case VK_LEFT:
+ case VK_RIGHT:
+ case VK_HOME:
+ case VK_END:
+ case VK_PRIOR:
+ case VK_NEXT:
+ if ( !HandleKeyDown(wParam, lParam) &&
+ !MSWHandleTreeKeyDownEvent(wParam, lParam) )
+ {
+ // use the key to update the selection if it was left
+ // unprocessed
+ MSWHandleSelectionKey(wParam);
+ }
- // we handle.arrows and space, but not page up/down and home/end: the
- // latter should be easy, but not the former
+ // pretend that we did process it in any case as we already
+ // generated an event for it
+ processed = true;
- HTREEITEM htSel = (HTREEITEM)TreeView_GetSelection(GetHwnd());
- if ( !m_htSelStart )
- {
- m_htSelStart = (WXHTREEITEM)htSel;
+ //default: for all the other keys leave processed as false so that
+ // the tree control generates a TVN_KEYDOWN for us
}
- if ( wParam == VK_SPACE )
+ }
+ 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 ( bCtrl )
- {
- ToggleItemSelection(GetHwnd(), htSel);
- }
- else
+ if ( m_textCtrl && m_textCtrl->GetHandle() == hwnd )
{
- UnselectAll();
+ DoEndEditLabel();
- ::SelectItem(GetHwnd(), htSel);
+ processed = true;
}
-
- processed = TRUE;
}
- else if ( wParam == VK_UP || wParam == VK_DOWN )
- {
- if ( !bCtrl && !bShift )
- {
- // no modifiers, just clear selection and then let the default
- // processing to take place
- UnselectAll();
- }
- else if ( htSel )
- {
- (void)wxControl::MSWWindowProc(nMsg, wParam, lParam);
+ }
- HTREEITEM htNext = (HTREEITEM)(wParam == VK_UP
- ? TreeView_GetPrevVisible(GetHwnd(), htSel)
- : TreeView_GetNextVisible(GetHwnd(), htSel));
+ if ( !processed )
+ rc = wxControl::MSWWindowProc(nMsg, wParam, lParam);
- if ( !htNext )
- {
- // at the top/bottom
- htNext = htSel;
- }
+ return rc;
+}
- if ( bShift )
- {
- SelectRange(GetHwnd(), HITEM(m_htSelStart), htNext);
- }
- else // bCtrl
- {
- // without changing selection
- ::SetFocus(GetHwnd(), htNext);
- }
+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();
+ wxDELETE(m_dragImage);
- processed = TRUE;
+ // 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_CHECKBOXES_IN_MULTI_SEL_TREE
-
- if ( !processed )
- rc = wxControl::MSWWindowProc(nMsg, wParam, lParam);
+#endif // wxUSE_DRAGIMAGE
- return rc;
+ 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;
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
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;
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;
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;
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;
+
+ eventType = gs_expandEvents[what][how];
- event.m_item = (WXHTREEITEM) tv->itemNew.hItem;
+ event.m_item = tv->itemNew.hItem;
}
break;
case TVN_KEYDOWN:
{
- eventType = wxEVT_COMMAND_TREE_KEY_DOWN;
TV_KEYDOWN *info = (TV_KEYDOWN *)lParam;
- event.m_code = wxCharCodeMSWToWX(info->wVKey);
+ // fabricate the lParam and wParam parameters sufficiently
+ // similar to the ones from a "real" WM_KEYDOWN so that
+ // CreateKeyEvent() works correctly
+ return MSWHandleTreeKeyDownEvent(
+ info->wVKey, (wxIsAltDown() ? KF_ALTDOWN : 0) << 16);
+ }
+
+
+ // 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 behaviour. The
+ // following messages will allow only the unlocked item's selection
+ // state to change
- // a separate event for Space/Return
- if ( !wxIsCtrlDown() && !wxIsShiftDown() &&
- ((info->wVKey == VK_SPACE) || (info->wVKey == VK_RETURN)) )
+ case TVN_ITEMCHANGINGA:
+ case TVN_ITEMCHANGINGW:
+ {
+ // we only need to handles these in multi-select trees
+ if ( HasFlag(wxTR_MULTIPLE) )
{
- wxTreeEvent event2(wxEVT_COMMAND_TREE_ITEM_ACTIVATED,
- m_windowId);
- event2.SetEventObject(this);
- if ( !(GetWindowStyle() & wxTR_MULTIPLE) )
+ // get info about the item about to be changed
+ NMTVITEMCHANGE* info = (NMTVITEMCHANGE*)lParam;
+ if (TreeItemUnlocker::IsLocked(info->hItem))
{
- event2.m_item = GetSelection();
+ // item's state is locked, don't allow the change
+ // returning 1 will disallow the change
+ *result = 1;
+ return true;
}
- //else: don't know how to get it
-
- (void)GetEventHandler()->ProcessEvent(event2);
}
- }
- break;
- case TVN_SELCHANGED:
- eventType = wxEVT_COMMAND_TREE_SEL_CHANGED;
+ // 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:
+ if ( !m_changingSelection )
+ {
+ eventType = wxEVT_COMMAND_TREE_SEL_CHANGED;
+ }
// fall through
- case TVN_SELCHANGING:
+ case TVN_SELCHANGINGA:
+ case TVN_SELCHANGINGW:
+ if ( !m_changingSelection )
{
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
+ if ( !m_changingSelection && !m_isBeingDeleted )
+ 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)
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;
- case CDDS_ITEMPREPAINT:
+ // windows in TreeCtrl use one-based index for item state images,
+ // 0 indexed image is not being used, we're using zero-based index,
+ // so we have to add temp image (of zero index) to state image list
+ // before we draw any item, then after items are drawn we have to
+ // delete it (in POSTPAINT notify)
+ if (m_imageListState && m_imageListState->GetImageCount() > 0)
{
- wxTreeItemAttr *attr =
- (wxTreeItemAttr *)m_attrs.Get(nmcd.dwItemSpec);
+ typedef BOOL (wxSTDCALL *ImageList_Copy_t)
+ (HIMAGELIST, int, HIMAGELIST, int, UINT);
+ static ImageList_Copy_t s_pfnImageList_Copy = NULL;
+ static bool loaded = false;
- if ( !attr )
+ if ( !loaded )
{
- // nothing to do for this item
- return CDRF_DODEFAULT;
+ wxLoadedDLL dllComCtl32(wxT("comctl32.dll"));
+ if ( dllComCtl32.IsLoaded() )
+ {
+ wxDL_INIT_FUNC(s_pfn, ImageList_Copy, dllComCtl32);
+ loaded = true;
+ }
}
- HFONT hFont;
- wxColour colText, colBack;
- if ( attr->HasFont() )
+ if ( !s_pfnImageList_Copy )
{
- wxFont font = attr->GetFont();
- hFont = (HFONT)font.GetResourceHandle();
- }
- else
- {
- hFont = 0;
+ // this code is broken with ImageList_Copy()
+ // but I don't care enough about Win95 support
+ // to write it now -- if anybody does, please
+ // do it
+ wxFAIL_MSG("TODO: implement this for Win95");
+ break;
}
- if ( attr->HasTextColour() )
+ const HIMAGELIST
+ hImageList = GetHimagelistOf(m_imageListState);
+
+ // add temporary image
+ int width, height;
+ m_imageListState->GetSize(0, width, height);
+
+ HBITMAP hbmpTemp = ::CreateBitmap(width, height, 1, 1, NULL);
+ int index = ::ImageList_Add(hImageList, hbmpTemp, hbmpTemp);
+ ::DeleteObject(hbmpTemp);
+
+ if ( index != -1 )
{
- colText = attr->GetTextColour();
+ // move images to right
+ for ( int i = index; i > 0; i-- )
+ {
+ (*s_pfnImageList_Copy)(hImageList, i,
+ hImageList, i-1,
+ ILCF_MOVE);
+ }
+
+ // we must remove the image in POSTPAINT notify
+ *result |= CDRF_NOTIFYPOSTPAINT;
}
- else
+ }
+ break;
+
+ case CDDS_POSTPAINT:
+ // we are deleting temp image of 0 index, which was
+ // added before items were drawn (in PREPAINT notify)
+ if (m_imageListState && m_imageListState->GetImageCount() > 0)
+ m_imageListState->Remove(0);
+ break;
+
+ case CDDS_ITEMPREPAINT:
+ {
+ wxMapTreeAttr::iterator
+ it = m_attrs.find((void *)nmcd.dwItemSpec);
+
+ if ( it == m_attrs.end() )
{
- colText = GetForegroundColour();
+ // nothing to do for this item
+ *result = CDRF_DODEFAULT;
+ break;
}
- // selection colours should override ours
- if ( nmcd.uItemState & CDIS_SELECTED )
- {
- DWORD clrBk = ::GetSysColor(COLOR_HIGHLIGHT);
- lptvcd->clrTextBk = clrBk;
+ wxTreeItemAttr * const attr = it->second;
- // try to make the text visible
- lptvcd->clrText = wxColourToRGB(colText);
- lptvcd->clrText |= ~clrBk;
- lptvcd->clrText &= 0x00ffffff;
- }
- else
+ wxTreeViewItem tvItem((void *)nmcd.dwItemSpec,
+ TVIF_STATE, TVIS_DROPHILITED);
+ DoGetItem(&tvItem);
+ const UINT tvItemState = tvItem.state;
+
+ // selection colours should override ours,
+ // otherwise it is too confusing 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 htFlags = 0;
+ wxTreeItemId item = HitTest(wxPoint(point.x, point.y), htFlags);
+
+ if ( htFlags & wxTREE_HITTEST_ONITEMSTATEICON )
+ {
+ event.m_item = item;
+ eventType = wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK;
+ }
+
+ break;
+ }
case NM_DBLCLK:
case NM_RCLICK:
{
TV_HITTESTINFO tvhti;
- ::GetCursorPos(&tvhti.pt);
+ wxGetCursorPosMSW(&tvhti.pt);
::ScreenToClient(GetHwnd(), &tvhti.pt);
if ( TreeView_HitTest(GetHwnd(), &tvhti) )
{
- if ( tvhti.flags & TVHT_ONITEM )
+ if ( MSWIsOnItem(tvhti.flags) )
{
- 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;
return wxControl::MSWOnNotify(idCtrl, lParam, result);
}
- event.SetEventObject(this);
event.SetEventType(eventType);
- bool processed = GetEventHandler()->ProcessEvent(event);
+ bool processed = HandleTreeEvent(event);
// post processing
switch ( hdr->code )
{
case NM_DBLCLK:
- // we translate NM_DBLCLK into ACTIVATED event, so don't interpret
- // the return code of this event handler as the return value for
- // NM_DBLCLK - otherwise, double clicking the item to toggle its
- // expanded status would never work
- *result = FALSE;
+ // we translate NM_DBLCLK into ACTIVATED event and if the user
+ // handled the activation of the item we shouldn't proceed with
+ // also using the same double click for toggling the item expanded
+ // state -- but OTOH do let the user to expand/collapse the item by
+ // double clicking on it if the activation is not handled specially
+ *result = processed;
+ 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
// deleted once the drag operation is over
- wxASSERT_MSG( !m_dragImage, _T("starting to drag once again?") );
+ wxASSERT_MSG( !m_dragImage, wxT("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();
+
+ m_dragStarted = true;
}
+#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;
+ 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
-
- m_itemsWithIndirectData.Remove(item);
-#if 0
- int iIndex = m_itemsWithIndirectData.Index(item);
- wxASSERT( iIndex != wxNOT_FOUND) ;
- m_itemsWithIndirectData.wxBaseArray::RemoveAt((size_t)iIndex);
-#endif
- }
- 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
);
if ( info->item.mask & TVIF_SELECTEDIMAGE )
{
info->item.iSelectedImage =
- DoGetItemImageFromData
+ param->GetImage
(
- item,
IsExpanded(item) ? wxTreeItemIcon_SelectedExpanded
: wxTreeItemIcon_Selected
);
// for the other messages the return value is ignored and there is
// nothing special to do
}
-
return processed;
}
-#endif // __WIN95__
+// ----------------------------------------------------------------------------
+// State control.
+// ----------------------------------------------------------------------------
+
+// why do they define INDEXTOSTATEIMAGEMASK but not the inverse?
+#define STATEIMAGEMASKTOINDEX(state) (((state) & TVIS_STATEIMAGEMASK) >> 12)
+
+int wxTreeCtrl::DoGetItemState(const wxTreeItemId& item) const
+{
+ wxCHECK_MSG( item.IsOk(), wxTREE_ITEMSTATE_NONE, wxT("invalid tree item") );
+
+ // receive the desired information
+ wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_STATEIMAGEMASK);
+ DoGetItem(&tvItem);
+
+ // state images are one-based
+ return STATEIMAGEMASKTOINDEX(tvItem.state) - 1;
+}
+
+void wxTreeCtrl::DoSetItemState(const wxTreeItemId& item, int state)
+{
+ wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
+
+ wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_STATEIMAGEMASK);
+
+ // state images are one-based
+ // 0 if no state image display (wxTREE_ITEMSTATE_NONE = -1)
+ tvItem.state = INDEXTOSTATEIMAGEMASK(state + 1);
+
+ DoSetItem(&tvItem);
+}
+
+// ----------------------------------------------------------------------------
+// Update locking.
+// ----------------------------------------------------------------------------
+
+// Using WM_SETREDRAW with the native control is a bad idea as it's broken in
+// some Windows versions (see http://support.microsoft.com/kb/130611) and
+// doesn't seem to do anything in other ones (e.g. under Windows 7 the tree
+// control keeps updating its scrollbars while the items are added to it,
+// resulting in horrible flicker when adding even a couple of dozen items).
+// So we hide it instead of freezing -- this still flickers, but actually not
+// as badly as it would if we didn't do it.
+
+void wxTreeCtrl::DoFreeze()
+{
+ // Notice that we don't call wxWindow::Hide() here as we want the window to
+ // remain shown from wxWidgets point of view and also because
+ // wxWindowMSW::Show() calls Do{Freeze,Thaw}() itself, so we'd get into
+ // infinite recursion this way.
+ if ( IsShown() )
+ ::ShowWindow(GetHwnd(), SW_HIDE);
+}
+
+void wxTreeCtrl::DoThaw()
+{
+ if ( IsShown() )
+ ::ShowWindow(GetHwnd(), SW_SHOW);
+}
+#endif // wxUSE_TREECTRL
projects / wxWidgets.git / blobdiff