/////////////////////////////////////////////////////////////////////////////
-// 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
#pragma hdrstop
#endif
+#if wxUSE_TREECTRL
+
#include "wx/msw/private.h"
-// Set this to 1 to be _absolutely_ sure that repainting will work for all comctl32.dll versions
+// Set this to 1 to be _absolutely_ sure that repainting will work for all
+// comctl32.dll versions
#define wxUSE_COMCTL32_SAFELY 0
// Mingw32 is a bit mental even though this is done in winundef
#if defined(__WIN95__)
+#include "wx/app.h"
#include "wx/log.h"
#include "wx/dynarray.h"
#include "wx/imaglist.h"
#include "wx/msw/gnuwin32/extra.h"
#endif
-#if defined(__WIN95__) && !(defined(__GNUWIN32_OLD__) || defined(__TWIN32__))
+#if defined(__WIN95__) && !((defined(__GNUWIN32_OLD__) || defined(__TWIN32__)) && !defined(__CYGWIN10__))
#include <commctrl.h>
#endif
#define TVS_CHECKBOXES 0x0100
#endif
+#ifndef TVS_FULLROWSELECT
+ #define TVS_FULLROWSELECT 0x1000
+#endif
+
// old headers might miss these messages (comctl32.dll 4.71+ only)
#ifndef TVM_SETBKCOLOR
#define TVM_SETBKCOLOR (TV_FIRST + 29)
// wrappers for TreeView_GetItem/TreeView_SetItem
static bool IsItemSelected(HWND hwndTV, HTREEITEM hItem)
{
+
TV_ITEM tvi;
tvi.mask = TVIF_STATE | TVIF_HANDLE;
tvi.stateMask = TVIS_SELECTED;
return (tvi.state & TVIS_SELECTED) != 0;
}
-static void SelectItem(HWND hwndTV, HTREEITEM hItem, bool select = TRUE)
+static void SelectItem(HWND hwndTV, HTREEITEM hItem, bool select = true)
{
TV_ITEM tvi;
tvi.mask = TVIF_STATE | TVIF_HANDLE;
static inline void UnselectItem(HWND hwndTV, HTREEITEM htItem)
{
- SelectItem(hwndTV, htItem, FALSE);
+ SelectItem(hwndTV, htItem, false);
}
static inline void ToggleItemSelection(HWND hwndTV, HTREEITEM htItem)
static void SelectRange(HWND hwndTV,
HTREEITEM htFirst,
HTREEITEM htLast,
- bool unselectOthers = TRUE)
+ bool unselectOthers = true)
{
// find the first (or last) item and select it
- bool cont = TRUE;
+ bool cont = true;
HTREEITEM htItem = (HTREEITEM)TreeView_GetRoot(hwndTV);
while ( htItem && cont )
{
SelectItem(hwndTV, htItem);
}
- cont = FALSE;
+ cont = false;
}
else
{
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_;
}
};
+// wxVirutalNode is used in place of a single root when 'hidden' root is
+// specified.
+class wxVirtualNode : public wxTreeViewItem
+{
+public:
+ wxVirtualNode(wxTreeItemData *data)
+ : wxTreeViewItem(TVI_ROOT, 0)
+ {
+ m_data = data;
+ }
+
+ ~wxVirtualNode()
+ {
+ delete m_data;
+ }
+
+ wxTreeItemData *GetData() const { return m_data; }
+ void SetData(wxTreeItemData *data) { delete m_data; m_data = data; }
+
+private:
+ wxTreeItemData *m_data;
+
+ DECLARE_NO_COPY_CLASS(wxVirtualNode)
+};
+
#ifdef __VISUALC__
#pragma warning( default : 4097 )
#endif
+// a macro to get the virtual root, returns NULL if none
+#define GET_VIRTUAL_ROOT() ((wxVirtualNode *)m_pVirtualRoot)
+
+// returns true if the item is the virtual root
+#define IS_VIRTUAL_ROOT(item) (HITEM(item) == TVI_ROOT)
+
// a class which encapsulates the tree traversal logic: it vists all (unless
-// OnVisit() returns FALSE) items under the given one
+// OnVisit() returns false) items under the given one
class wxTreeTraversal
{
public:
}
// 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;
+
+ DECLARE_NO_COPY_CLASS(wxTreeTraversal)
};
// internal class for getting the selected items
virtual bool OnVisit(const wxTreeItemId& item)
{
+ // can't visit a virtual node.
+ if ( (GetTree()->GetRootItem() == item) && (GetTree()->GetWindowStyle() & wxTR_HIDE_ROOT))
+ {
+ return true;
+ }
+
#if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
if ( GetTree()->IsItemChecked(item) )
#else
m_selections.Add(item);
}
- return TRUE;
+ return true;
}
size_t GetCount() const { return m_selections.GetCount(); }
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; }
//
// There is only one problem with this: when we retrieve the item's data, we
// don't know whether we get a pointer to wxTreeItemData or
-// wxTreeItemIndirectData. So we have to maintain a list of all items which
-// have indirect data inside the listctrl itself.
+// wxTreeItemIndirectData. So we always set the item id to an invalid value
+// in this class and the code using the client data checks for it and retrieves
+// the real client data in this case.
// ----------------------------------------------------------------------------
-class wxTreeItemIndirectData
+class wxTreeItemIndirectData : public wxTreeItemData
{
public:
// ctor associates this data with the item and the real item data becomes
// and set ourselves as the new one
tree->SetIndirectItemData(item, this);
+
+ // we must have the invalid value for the item
+ m_pItem = 0l;
}
// dtor deletes the associated data as well
- ~wxTreeItemIndirectData() { delete m_data; }
+ virtual ~wxTreeItemIndirectData() { delete m_data; }
// accessors
// get the real data associated with the item
// all the images associated with the item
int m_images[wxTreeItemIcon_Max];
+ // the real client data
wxTreeItemData *m_data;
+
+ DECLARE_NO_COPY_CLASS(wxTreeItemIndirectData)
};
// ----------------------------------------------------------------------------
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);
}
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;
}
// ----------------------------------------------------------------------------
{
m_imageListNormal = NULL;
m_imageListState = NULL;
- m_ownsImageListNormal = m_ownsImageListState = FALSE;
+ m_ownsImageListNormal = m_ownsImageListState = false;
m_textCtrl = NULL;
- m_hasAnyAttr = FALSE;
+ m_hasAnyAttr = false;
m_dragImage = NULL;
-
m_htSelStart = 0;
+ m_pVirtualRoot = NULL;
+
+ // initialize the global array of events now as it can't be done statically
+ // with the wxEVT_XXX values being allocated during run-time only
+ gs_expandEvents[IDX_COLLAPSE][IDX_DONE] = wxEVT_COMMAND_TREE_ITEM_COLLAPSED;
+ gs_expandEvents[IDX_COLLAPSE][IDX_DOING] = wxEVT_COMMAND_TREE_ITEM_COLLAPSING;
+ gs_expandEvents[IDX_EXPAND][IDX_DONE] = wxEVT_COMMAND_TREE_ITEM_EXPANDED;
+ gs_expandEvents[IDX_EXPAND][IDX_DOING] = wxEVT_COMMAND_TREE_ITEM_EXPANDING;
}
bool wxTreeCtrl::Create(wxWindow *parent,
Init();
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 */;
+ TVS_SHOWSELALWAYS;
+
+ if ( m_windowStyle & wxCLIP_SIBLINGS )
+ wstyle |= WS_CLIPSIBLINGS;
if ((m_windowStyle & wxTR_NO_LINES) == 0)
wstyle |= TVS_HASLINES;
if ( m_windowStyle & wxTR_LINES_AT_ROOT )
wstyle |= TVS_LINESATROOT;
+ if ( m_windowStyle & wxTR_FULL_ROW_HIGHLIGHT )
+ {
+ if ( wxTheApp->GetComCtl32Version() >= 471 )
+ wstyle |= TVS_FULLROWSELECT;
+ }
+
// using TVS_CHECKBOXES for emulation of a multiselection tree control
// doesn't work without the new enough headers
#if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE && \
// Create the tree control.
if ( !MSWCreateControl(WC_TREEVIEW, wstyle) )
- return FALSE;
+ return false;
#if wxUSE_COMCTL32_SAFELY
- wxWindow::SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_WINDOW));
+ wxWindow::SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
wxWindow::SetForegroundColour(wxWindow::GetParent()->GetForegroundColour());
#elif 1
- SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_WINDOW));
+ SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
SetForegroundColour(wxWindow::GetParent()->GetForegroundColour());
#else
// This works around a bug in the Windows tree control whereby for some versions
// THIS FIX NOW REVERTED since it caused problems on _other_ systems.
// Assume the user has an updated comctl32.dll.
::SendMessage(GetHwnd(), TVM_SETBKCOLOR, 0,-1);
- wxWindow::SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_WINDOW));
+ wxWindow::SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
SetForegroundColour(wxWindow::GetParent()->GetForegroundColour());
#endif
// create a mono bitmap of the standard size
int x = GetSystemMetrics(SM_CXMENUCHECK);
int y = GetSystemMetrics(SM_CYMENUCHECK);
- wxImageList imagelistCheckboxes(x, y, FALSE, 2);
+ wxImageList imagelistCheckboxes(x, y, false, 2);
HBITMAP hbmpCheck = CreateBitmap(x, y, // bitmap size
1, // # of color planes
1, // # bits needed for one pixel
SetSize(pos.x, pos.y, size.x, size.y);
- return TRUE;
+ return true;
}
wxTreeCtrl::~wxTreeCtrl()
{
for ( wxNode *node = m_attrs.Next(); node; node = m_attrs.Next() )
{
- delete (wxTreeItemAttr *)node->Data();
+ delete (wxTreeItemAttr *)node->GetData();
}
// prevent TVN_DELETEITEM handler from deleting the attributes again!
- m_hasAnyAttr = FALSE;
+ m_hasAnyAttr = false;
}
DeleteTextCtrl();
// delete user data to prevent memory leaks
+ // also deletes hidden root node storage.
DeleteAllItems();
-
+
if (m_ownsImageListNormal) delete m_imageListNormal;
if (m_ownsImageListState) delete m_imageListState;
}
bool wxTreeCtrl::DoGetItem(wxTreeViewItem* tvItem) const
{
+ wxCHECK_MSG( tvItem->hItem != TVI_ROOT, false,
+ _T("can't retrieve virtual root item") );
+
if ( !TreeView_GetItem(GetHwnd(), tvItem) )
{
wxLogLastError(wxT("TreeView_GetItem"));
- return FALSE;
+ return false;
}
- return TRUE;
+ return true;
}
void wxTreeCtrl::DoSetItem(wxTreeViewItem* tvItem)
void wxTreeCtrl::SetImageList(wxImageList *imageList)
{
- if (m_ownsImageListNormal) delete m_imageListNormal;
+ if (m_ownsImageListNormal)
+ delete m_imageListNormal;
+
SetAnyImageList(m_imageListNormal = imageList, TVSIL_NORMAL);
- m_ownsImageListNormal = FALSE;
+ m_ownsImageListNormal = false;
}
void wxTreeCtrl::SetStateImageList(wxImageList *imageList)
{
if (m_ownsImageListState) delete m_imageListState;
SetAnyImageList(m_imageListState = imageList, TVSIL_STATE);
- m_ownsImageListState = FALSE;
+ m_ownsImageListState = false;
}
void wxTreeCtrl::AssignImageList(wxImageList *imageList)
{
SetImageList(imageList);
- m_ownsImageListNormal = TRUE;
+ m_ownsImageListNormal = true;
}
void wxTreeCtrl::AssignStateImageList(wxImageList *imageList)
{
SetStateImageList(imageList);
- m_ownsImageListState = TRUE;
+ m_ownsImageListState = true;
}
size_t wxTreeCtrl::GetChildrenCount(const wxTreeItemId& item,
{
#if !wxUSE_COMCTL32_SAFELY
if ( !wxWindowBase::SetBackgroundColour(colour) )
- return FALSE;
+ return false;
SendMessage(GetHwnd(), TVM_SETBKCOLOR, 0, colour.GetPixel());
#endif
- return TRUE;
+ return true;
}
bool wxTreeCtrl::SetForegroundColour(const wxColour &colour)
{
#if !wxUSE_COMCTL32_SAFELY
if ( !wxWindowBase::SetForegroundColour(colour) )
- return FALSE;
+ return false;
SendMessage(GetHwnd(), TVM_SETTEXTCOLOR, 0, colour.GetPixel());
#endif
- return TRUE;
+ return true;
}
// ----------------------------------------------------------------------------
void wxTreeCtrl::SetItemText(const wxTreeItemId& item, const wxString& text)
{
+ if ( IS_VIRTUAL_ROOT(item) )
+ return;
+
wxTreeViewItem tvItem(item, TVIF_TEXT);
tvItem.pszText = (wxChar *)text.c_str(); // conversion is ok
DoSetItem(&tvItem);
+
+ // when setting the text of the item being edited, the text control should
+ // be updated to reflect the new text as well, otherwise calling
+ // SetItemText() in the OnBeginLabelEdit() handler doesn't have any effect
+ //
+ // don't use GetEditControl() here because m_textCtrl is not set yet
+ HWND hwndEdit = TreeView_GetEditControl(GetHwnd());
+ if ( hwndEdit )
+ {
+ if ( item == GetSelection() )
+ {
+ ::SetWindowText(hwndEdit, text);
+ }
+ }
}
int wxTreeCtrl::DoGetItemImageFromData(const wxTreeItemId& item,
int wxTreeCtrl::GetItemImage(const wxTreeItemId& item,
wxTreeItemIcon which) const
{
+ if ( (HITEM(item) == TVI_ROOT) && (m_windowStyle & wxTR_HIDE_ROOT) )
+ {
+ // TODO: Maybe a hidden root can still provide images?
+ return -1;
+ }
+
if ( HasIndirectData(item) )
{
return DoGetItemImageFromData(item, which);
void wxTreeCtrl::SetItemImage(const wxTreeItemId& item, int image,
wxTreeItemIcon which)
{
+ if ( IS_VIRTUAL_ROOT(item) )
+ {
+ // TODO: Maybe a hidden root can still store images?
+ return;
+ }
+
int imageNormal, imageSel;
switch ( which )
{
wxTreeItemData *wxTreeCtrl::GetItemData(const wxTreeItemId& item) const
{
wxTreeViewItem tvItem(item, TVIF_PARAM);
- if ( !DoGetItem(&tvItem) )
+
+ // Hidden root may have data.
+ if ( IS_VIRTUAL_ROOT(item) )
{
- return NULL;
+ return GET_VIRTUAL_ROOT()->GetData();
}
- if ( HasIndirectData(item) )
+ // Visible node.
+ if ( !DoGetItem(&tvItem) )
{
- return ((wxTreeItemIndirectData *)tvItem.lParam)->GetData();
+ return NULL;
}
- else
+
+ wxTreeItemData *data = (wxTreeItemData *)tvItem.lParam;
+ if ( IsDataIndirect(data) )
{
- return (wxTreeItemData *)tvItem.lParam;
+ data = ((wxTreeItemIndirectData *)data)->GetData();
}
+
+ return data;
}
void wxTreeCtrl::SetItemData(const wxTreeItemId& item, wxTreeItemData *data)
{
+ if ( IS_VIRTUAL_ROOT(item) )
+ {
+ GET_VIRTUAL_ROOT()->SetData(data);
+ }
+
// first, associate this piece of data with this item
if ( data )
{
// wxTreeItemIndirectData as well
wxASSERT_MSG( !HasIndirectData(item), wxT("setting indirect data twice?") );
- SetItemData(item, (wxTreeItemData *)data);
-
- m_itemsWithIndirectData.Add(item);
+ SetItemData(item, data);
}
bool wxTreeCtrl::HasIndirectData(const wxTreeItemId& item) const
{
- return m_itemsWithIndirectData.Index(item) != wxNOT_FOUND;
+ // query the item itself
+ wxTreeViewItem tvItem(item, TVIF_PARAM);
+ if ( !DoGetItem(&tvItem) )
+ {
+ return false;
+ }
+
+ wxTreeItemData *data = (wxTreeItemData *)tvItem.lParam;
+
+ return data && IsDataIndirect(data);
}
void wxTreeCtrl::SetItemHasChildren(const wxTreeItemId& item, bool has)
{
+ if ( IS_VIRTUAL_ROOT(item) )
+ return;
+
wxTreeViewItem tvItem(item, TVIF_CHILDREN);
tvItem.cChildren = (int)has;
DoSetItem(&tvItem);
void wxTreeCtrl::SetItemBold(const wxTreeItemId& item, bool bold)
{
+ if ( IS_VIRTUAL_ROOT(item) )
+ return;
+
wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_BOLD);
tvItem.state = bold ? TVIS_BOLD : 0;
DoSetItem(&tvItem);
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
+{
+ long id = (long)(WXHTREEITEM)item;
+ wxTreeItemAttr *attr = (wxTreeItemAttr *)m_attrs.Get(id);
+ if ( !attr )
+ {
+ return wxNullColour;
+ }
+
+ return attr->GetTextColour();
+}
+
+wxColour wxTreeCtrl::GetItemBackgroundColour(const wxTreeItemId& item) const
+{
+ long id = (long)(WXHTREEITEM)item;
+ wxTreeItemAttr *attr = (wxTreeItemAttr *)m_attrs.Get(id);
+ if ( !attr )
+ {
+ return wxNullColour;
+ }
+
+ return attr->GetBackgroundColour();
+}
+
+wxFont wxTreeCtrl::GetItemFont(const wxTreeItemId& item) const
+{
+ long id = (long)(WXHTREEITEM)item;
+ wxTreeItemAttr *attr = (wxTreeItemAttr *)m_attrs.Get(id);
+ if ( !attr )
+ {
+ return wxNullFont;
+ }
+
+ return attr->GetFont();
+}
+
void wxTreeCtrl::SetItemTextColour(const wxTreeItemId& item,
const wxColour& col)
{
- m_hasAnyAttr = TRUE;
+ m_hasAnyAttr = true;
long id = (long)(WXHTREEITEM)item;
wxTreeItemAttr *attr = (wxTreeItemAttr *)m_attrs.Get(id);
}
attr->SetTextColour(col);
+
+ RefreshItem(item);
}
void wxTreeCtrl::SetItemBackgroundColour(const wxTreeItemId& item,
const wxColour& col)
{
- m_hasAnyAttr = TRUE;
+ m_hasAnyAttr = true;
long id = (long)(WXHTREEITEM)item;
wxTreeItemAttr *attr = (wxTreeItemAttr *)m_attrs.Get(id);
}
attr->SetBackgroundColour(col);
+
+ RefreshItem(item);
}
void wxTreeCtrl::SetItemFont(const wxTreeItemId& item, const wxFont& font)
{
- m_hasAnyAttr = TRUE;
+ m_hasAnyAttr = true;
long id = (long)(WXHTREEITEM)item;
wxTreeItemAttr *attr = (wxTreeItemAttr *)m_attrs.Get(id);
}
attr->SetFont(font);
+
+ RefreshItem(item);
}
// ----------------------------------------------------------------------------
bool wxTreeCtrl::IsVisible(const wxTreeItemId& item) const
{
+ if ( item == wxTreeItemId(TVI_ROOT) )
+ {
+ // virtual (hidden) root is never visible
+ return false;
+ }
+
// Bug in Gnu-Win32 headers, so don't use the macro TreeView_GetItemRect
RECT rect;
// the HTREEITEM with TVM_GETITEMRECT
*(WXHTREEITEM *)&rect = (WXHTREEITEM)item;
- // FALSE means get item rect for the whole item, not only text
- return SendMessage(GetHwnd(), TVM_GETITEMRECT, FALSE, (LPARAM)&rect) != 0;
-
+ // false means get item rect for the whole item, not only text
+ return SendMessage(GetHwnd(), TVM_GETITEMRECT, false, (LPARAM)&rect) != 0;
}
bool wxTreeCtrl::ItemHasChildren(const wxTreeItemId& item) const
wxTreeItemId wxTreeCtrl::GetRootItem() const
{
+ // Root may be real (visible) or virtual (hidden).
+ if ( GET_VIRTUAL_ROOT() )
+ return TVI_ROOT;
+
return wxTreeItemId((WXHTREEITEM) TreeView_GetRoot(GetHwnd()));
}
return wxTreeItemId((WXHTREEITEM) 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)));
+ HTREEITEM hItem;
+
+ if ( IS_VIRTUAL_ROOT(item) )
+ {
+ // no parent for the virtual root
+ hItem = 0;
+ }
+ else // normal item
+ {
+ hItem = TreeView_GetParent(GetHwnd(), HITEM(item));
+ if ( !hItem && HasFlag(wxTR_HIDE_ROOT) )
+ {
+ // the top level items should have the virtual root as their parent
+ hItem = TVI_ROOT;
+ }
+ }
+
+ return wxTreeItemId((WXHTREEITEM)hItem);
}
wxTreeItemId wxTreeCtrl::GetFirstChild(const wxTreeItemId& item,
// receive the desired information.
wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_STATEIMAGEMASK);
+ DoGetItem(&tvItem);
+
// state images are one-based
tvItem.state = (check ? 2 : 1) << 12;
int image, int selectedImage,
wxTreeItemData *data)
{
- return DoInsertItem(wxTreeItemId((long) (WXHTREEITEM) 0), (long)(WXHTREEITEM) 0,
+
+ if ( m_windowStyle & wxTR_HIDE_ROOT )
+ {
+ // create a virtual root item, the parent for all the others
+ m_pVirtualRoot = new wxVirtualNode(data);
+
+ return TVI_ROOT;
+ }
+
+ return DoInsertItem(wxTreeItemId((long)(WXHTREEITEM) 0), (long)(WXHTREEITEM) 0,
text, image, selectedImage, data);
}
void wxTreeCtrl::DeleteAllItems()
{
+ // delete the "virtual" root item.
+ if ( GET_VIRTUAL_ROOT() )
+ {
+ delete GET_VIRTUAL_ROOT();
+ m_pVirtualRoot = NULL;
+ }
+
+ // and all the real items
+
if ( !TreeView_DeleteAllItems(GetHwnd()) )
{
wxLogLastError(wxT("TreeView_DeleteAllItems"));
flag == TVE_TOGGLE,
wxT("Unknown flag in wxTreeCtrl::DoExpand") );
+ // A hidden root can be neither expanded nor collapsed.
+ wxCHECK_RET( !(m_windowStyle & wxTR_HIDE_ROOT) || (HITEM(item) != TVI_ROOT),
+ wxT("Can't expand/collapse hidden root node!") )
+
// TreeView_Expand doesn't send TVN_ITEMEXPAND(ING) messages, so we must
// emulate them. This behaviour has changed slightly with comctl32.dll
// v 4.70 - now it does send them but only the first time. To maintain
{
wxTreeEvent event(wxEVT_NULL, m_windowId);
event.m_item = item;
-
- bool isExpanded = IsExpanded(item);
-
event.SetEventObject(this);
- // FIXME return value of {EXPAND|COLLAPS}ING event handler is discarded
- event.SetEventType(g_events[isExpanded][TRUE]);
- GetEventHandler()->ProcessEvent(event);
+ // note that the {EXPAND|COLLAPS}ING event is sent by TreeView_Expand()
+ // itself
+ event.SetEventType(gs_expandEvents[IsExpanded(item) ? IDX_EXPAND
+ : IDX_COLLAPSE]
+ [IDX_DONE]);
- event.SetEventType(g_events[isExpanded][FALSE]);
- GetEventHandler()->ProcessEvent(event);
+ (void)GetEventHandler()->ProcessEvent(event);
}
//else: change didn't took place, so do nothing at all
}
for ( size_t n = 0; n < count; n++ )
{
#if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
- SetItemCheck(selections[n], FALSE);
+ 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
}
}
-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;
DeleteTextCtrl();
+ m_textCtrl = (wxTextCtrl *)textControlClass->CreateObject();
HWND hWnd = (HWND) TreeView_EditLabel(GetHwnd(), HITEM(item));
// this is not an error - the TVN_BEGINLABELEDIT handler might have
- // returned FALSE
+ // returned false
if ( !hWnd )
{
+ delete m_textCtrl;
+ m_textCtrl = NULL;
return NULL;
}
- m_textCtrl = (wxTextCtrl *)textControlClass->CreateObject();
- m_textCtrl->SetHWND((WXHWND)hWnd);
- m_textCtrl->SubclassWin((WXHWND)hWnd);
-
+ // textctrl is subclassed in MSWOnNotify
return m_textCtrl;
}
// End label editing, optionally cancelling the edit
-void wxTreeCtrl::EndEditLabel(const wxTreeItemId& item, bool discardChanges)
+void wxTreeCtrl::EndEditLabel(const wxTreeItemId& WXUNUSED(item), bool discardChanges)
{
TreeView_EndEditLabelNow(GetHwnd(), discardChanges);
{
rect = wxRect(wxPoint(rc.left, rc.top), wxPoint(rc.right, rc.bottom));
- return TRUE;
+ return true;
}
else
{
// couldn't retrieve rect: for example, item isn't visible
- return FALSE;
+ return false;
}
}
// sorting stuff
// ----------------------------------------------------------------------------
-static int CALLBACK TreeView_CompareCallback(wxTreeItemData *pItem1,
- wxTreeItemData *pItem2,
- wxTreeCtrl *tree)
+// this is just a tiny namespace which is friend to wxTreeCtrl and so can use
+// functions such as IsDataIndirect()
+class wxTreeSortHelper
+{
+public:
+ static int CALLBACK Compare(LPARAM data1, LPARAM data2, LPARAM tree);
+
+private:
+ static wxTreeItemId GetIdFromData(wxTreeCtrl *tree, LPARAM item)
+ {
+ wxTreeItemData *data = (wxTreeItemData *)item;
+ if ( tree->IsDataIndirect(data) )
+ {
+ data = ((wxTreeItemIndirectData *)data)->GetData();
+ }
+
+ return data->GetId();
+ }
+};
+
+int CALLBACK wxTreeSortHelper::Compare(LPARAM pItem1,
+ LPARAM pItem2,
+ LPARAM htree)
{
wxCHECK_MSG( pItem1 && pItem2, 0,
wxT("sorting tree without data doesn't make sense") );
- return tree->OnCompareItems(pItem1->GetId(), pItem2->GetId());
+ wxTreeCtrl *tree = (wxTreeCtrl *)htree;
+
+ return tree->OnCompareItems(GetIdFromData(tree, pItem1),
+ GetIdFromData(tree, pItem2));
}
int wxTreeCtrl::OnCompareItems(const wxTreeItemId& item1,
{
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 */);
}
else
{
// nothing done
- return FALSE;
+ return false;
}
// command processed
- return TRUE;
+ return true;
}
// we hook into WndProc to process WM_MOUSEMOVE/WM_BUTTONUP messages - as we
// instead of passing by wxWin events
long wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
{
- bool processed = FALSE;
+ bool processed = false;
long rc = 0;
-
bool isMultiple = (GetWindowStyle() & wxTR_MULTIPLE) != 0;
if ( (nMsg >= WM_MOUSEFIRST) && (nMsg <= WM_MOUSELAST) )
{
- // we only process mouse messages here and these parameters have the same
- // meaning for all of them
+ // we only process mouse messages here and these parameters have the
+ // same meaning for all of them
int x = GET_X_LPARAM(lParam),
y = GET_Y_LPARAM(lParam);
HTREEITEM htItem = GetItemFromPoint(GetHwnd(), x, y);
switch ( nMsg )
{
+ case WM_RBUTTONDOWN:
+ // if the item we are about to right click on
+ // is not already select, remove the entire
+ // previous selection
+ if (!::IsItemSelected(GetHwnd(), htItem))
+ {
+ UnselectAll();
+ }
+
+ // select item and set the focus to the
+ // newly selected item
+ ::SelectItem(GetHwnd(), htItem);
+ ::SetFocus(GetHwnd(), htItem);
+ break;
+
#if !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
case WM_LBUTTONDOWN:
if ( htItem && isMultiple )
// reset on any click without Shift
m_htSelStart = 0;
- processed = TRUE;
+ processed = true;
}
else if ( wParam & MK_SHIFT )
{
::SetFocus(GetHwnd(), htItem);
- processed = TRUE;
+ processed = true;
}
else // normal click
{
- // clear the selection and then let the default handler
- // do the job
- UnselectAll();
-
- // prevent the click from starting in-place editing
- // when there was no selection in the control
- TreeView_SelectItem(GetHwnd(), 0);
+ // 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 )
+ {
+ // clear the previously selected items
+ UnselectAll();
+
+ // prevent the click from starting in-place editing
+ // which should only happen if we click on the
+ // already selected item (and nothing else is
+ // selected)
+ TreeView_SelectItem(GetHwnd(), 0);
+ }
// reset on any click without Shift
m_htSelStart = 0;
RECT rect;
for ( size_t n = 0; n < count; n++ )
{
- // TreeView_GetItemRect() will return FALSE if item is not visible,
+ // TreeView_GetItemRect() will return false if item is not visible,
// which may happen perfectly well
if ( TreeView_GetItemRect(GetHwnd(), HITEM(selections[n]),
- &rect, TRUE) )
+ &rect, true) )
{
- ::InvalidateRect(GetHwnd(), &rect, FALSE);
+ ::InvalidateRect(GetHwnd(), &rect, false);
}
}
}
::SelectItem(GetHwnd(), htSel);
}
- processed = TRUE;
+ processed = true;
}
else if ( wParam == VK_UP || wParam == VK_DOWN )
{
::SetFocus(GetHwnd(), htNext);
}
- processed = TRUE;
+ processed = true;
}
}
}
#endif // !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
+ else if ( nMsg == WM_CHAR )
+ {
+ // don't let the control process Space and Return keys because it
+ // doesn't do anything useful with them anyhow but always beeps
+ // annoyingly when it receives them and there is no way to turn it off
+ // simply if you just process TREEITEM_ACTIVATED event to which Space
+ // and Enter presses are mapped in your code
+ if ( wParam == VK_SPACE || wParam == VK_RETURN )
+ {
+ processed = true;
+ }
+ }
if ( !processed )
rc = wxControl::MSWWindowProc(nMsg, wParam, lParam);
event.m_item = (WXHTREEITEM) info->item.hItem;
event.m_label = info->item.pszText;
+ event.m_editCancelled = false;
}
break;
event.m_item = (WXHTREEITEM)info->item.hItem;
event.m_label = info->item.pszText;
if (info->item.pszText == NULL)
- return FALSE;
+ {
+ event.m_editCancelled = true;
+ }
+ else
+ {
+ event.m_editCancelled = false;
+ }
break;
}
}
case TVN_ITEMEXPANDING:
- event.m_code = FALSE;
- // fall through
-
case TVN_ITEMEXPANDED:
{
NM_TREEVIEW* tv = (NM_TREEVIEW*)lParam;
- bool expand = FALSE;
+ int what;
switch ( tv->action )
{
+ default:
+ wxLogDebug(wxT("unexpected code %d in TVN_ITEMEXPAND message"), tv->action);
+ // fall through
+
case TVE_EXPAND:
- expand = TRUE;
+ what = IDX_EXPAND;
break;
case TVE_COLLAPSE:
- expand = FALSE;
+ what = IDX_COLLAPSE;
break;
-
- default:
- wxLogDebug(wxT("unexpected code %d in TVN_ITEMEXPAND message"), tv->action);
}
- bool ing = ((int)hdr->code == TVN_ITEMEXPANDING);
- eventType = g_events[expand][ing];
+ int how = hdr->code == TVN_ITEMEXPANDING ? IDX_DOING
+ : IDX_DONE;
+
+ eventType = gs_expandEvents[what][how];
event.m_item = (WXHTREEITEM) tv->itemNew.hItem;
}
eventType = wxEVT_COMMAND_TREE_KEY_DOWN;
TV_KEYDOWN *info = (TV_KEYDOWN *)lParam;
- event.m_code = wxCharCodeMSWToWX(info->wVKey);
+ // fabricate the lParam and wParam parameters sufficiently
+ // similar to the ones from a "real" WM_KEYDOWN so that
+ // CreateKeyEvent() works correctly
+ WXLPARAM lParam =
+ (::GetKeyState(VK_MENU) & 0x100 ? KF_ALTDOWN : 0) << 16;
+
+ WXWPARAM wParam = info->wVKey;
+
+ int keyCode = wxCharCodeMSWToWX(info->wVKey);
+ if ( !keyCode )
+ {
+ // wxCharCodeMSWToWX() returns 0 to indicate that this is a
+ // simple ASCII key
+ keyCode = wParam;
+ }
+
+ event.m_evtKey = CreateKeyEvent(wxEVT_KEY_DOWN,
+ keyCode,
+ lParam,
+ wParam);
// a separate event for Space/Return
if ( !wxIsCtrlDown() && !wxIsShiftDown() &&
}
break;
- case TVN_SELCHANGED:
+ // NB: MSLU is broken and sends TVN_SELCHANGEDA instead of
+ // TVN_SELCHANGEDW in Unicode mode under Win98. Therefore
+ // we have to handle both messages:
+ case TVN_SELCHANGEDA:
+ case TVN_SELCHANGEDW:
eventType = wxEVT_COMMAND_TREE_SEL_CHANGED;
// fall through
- case TVN_SELCHANGING:
+ case TVN_SELCHANGINGA:
+ case TVN_SELCHANGINGW:
{
if ( eventType == wxEVT_NULL )
eventType = wxEVT_COMMAND_TREE_SEL_CHANGING;
//else: already set above
- NM_TREEVIEW* tv = (NM_TREEVIEW *)lParam;
-
- event.m_item = (WXHTREEITEM) tv->itemNew.hItem;
- event.m_itemOld = (WXHTREEITEM) tv->itemOld.hItem;
+ if (hdr->code == TVN_SELCHANGINGW ||
+ hdr->code == TVN_SELCHANGEDW)
+ {
+ NM_TREEVIEWW* tv = (NM_TREEVIEWW *)lParam;
+ event.m_item = (WXHTREEITEM) tv->itemNew.hItem;
+ event.m_itemOld = (WXHTREEITEM) tv->itemOld.hItem;
+ }
+ else
+ {
+ NM_TREEVIEWA* tv = (NM_TREEVIEWA *)lParam;
+ event.m_item = (WXHTREEITEM) tv->itemNew.hItem;
+ event.m_itemOld = (WXHTREEITEM) tv->itemOld.hItem;
+ }
}
break;
-#if defined(_WIN32_IE) && _WIN32_IE >= 0x300 && !wxUSE_COMCTL32_SAFELY
+#if defined(_WIN32_IE) && _WIN32_IE >= 0x300 && !wxUSE_COMCTL32_SAFELY && !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 0 ) )
case NM_CUSTOMDRAW:
{
LPNMTVCUSTOMDRAW lptvcd = (LPNMTVCUSTOMDRAW)lParam;
NMCUSTOMDRAW& nmcd = lptvcd->nmcd;
- switch( nmcd.dwDrawStage )
+ switch ( nmcd.dwDrawStage )
{
case CDDS_PREPAINT:
// if we've got any items with non standard attributes,
// notify us before painting each item
*result = m_hasAnyAttr ? CDRF_NOTIFYITEMDRAW
: CDRF_DODEFAULT;
- return TRUE;
+ break;
case CDDS_ITEMPREPAINT:
{
if ( !attr )
{
// nothing to do for this item
- return CDRF_DODEFAULT;
+ *result = CDRF_DODEFAULT;
+ break;
}
HFONT hFont;
- wxColour colText, colBack;
if ( attr->HasFont() )
{
- wxFont font = attr->GetFont();
- hFont = (HFONT)font.GetResourceHandle();
+ hFont = GetHfontOf(attr->GetFont());
}
else
{
hFont = 0;
}
+ wxColour colText;
if ( attr->HasTextColour() )
{
colText = attr->GetTextColour();
// selection colours should override ours
if ( nmcd.uItemState & CDIS_SELECTED )
{
- DWORD clrBk = ::GetSysColor(COLOR_HIGHLIGHT);
- lptvcd->clrTextBk = clrBk;
-
- // try to make the text visible
- lptvcd->clrText = wxColourToRGB(colText);
- lptvcd->clrText |= ~clrBk;
- lptvcd->clrText &= 0x00ffffff;
+ lptvcd->clrTextBk =
+ ::GetSysColor(COLOR_HIGHLIGHT);
+ lptvcd->clrText =
+ ::GetSysColor(COLOR_HIGHLIGHTTEXT);
}
- else
+ else // !selected
{
+ wxColour colBack;
if ( attr->HasBackgroundColour() )
{
colBack = attr->GetBackgroundColour();
{
*result = CDRF_DODEFAULT;
}
-
- return TRUE;
}
+ break;
default:
*result = CDRF_DODEFAULT;
- return TRUE;
}
}
- break;
+
+ // we always process it
+ return true;
#endif // _WIN32_IE >= 0x300
case NM_DBLCLK:
// the return code of this event handler as the return value for
// NM_DBLCLK - otherwise, double clicking the item to toggle its
// expanded status would never work
- *result = FALSE;
+ *result = false;
break;
case TVN_BEGINDRAG:
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
{
delete data; // may be NULL, ok
}
- processed = TRUE; // Make sure we don't get called twice
+ processed = true; // Make sure we don't get called twice
}
break;
case TVN_BEGINLABELEDIT:
- // return TRUE to cancel label editing
+ // return true to cancel label editing
*result = !event.IsAllowed();
+ // set ES_WANTRETURN ( like we do in BeginLabelEdit )
+ if(event.IsAllowed())
+ {
+ HWND hText = TreeView_GetEditControl(GetHwnd());
+ if(hText != NULL)
+ {
+ // MBN: if m_textCtrl already has an HWND, it is a stale
+ // pointer from a previous edit (because the user
+ // didn't modify the label before dismissing the control,
+ // and TVN_ENDLABELEDIT was not sent), so delete it
+ if(m_textCtrl && m_textCtrl->GetHWND() != 0)
+ DeleteTextCtrl();
+ if(!m_textCtrl)
+ m_textCtrl = new wxTextCtrl();
+ m_textCtrl->SetParent(this);
+ m_textCtrl->SetHWND((WXHWND)hText);
+ m_textCtrl->SubclassWin((WXHWND)hText);
+
+ // set wxTE_PROCESS_ENTER style for the text control to
+ // force it to process the Enter presses itself, otherwise
+ // they could be stolen from it by the dialog
+ // navigation code
+ m_textCtrl->SetWindowStyle(m_textCtrl->GetWindowStyle()
+ | wxTE_PROCESS_ENTER);
+ }
+ }
break;
case TVN_ENDLABELEDIT:
- // return TRUE to set the label to the new string: note that we
+ // 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
+ // to be passed to DefWindowProc() which will happily return false
// cancelling the label change
*result = event.IsAllowed();
- processed = TRUE;
+ processed = true;
// ensure that we don't have the text ctrl which is going to be
// deleted any more
case TVN_SELCHANGING:
case TVN_ITEMEXPANDING:
- // return TRUE to prevent the action from happening
+ // return true to prevent the action from happening
*result = !event.IsAllowed();
break;
+ case TVN_ITEMEXPANDED:
+ // the item is not refreshed properly after expansion when it has
+ // an image depending on the expanded/collapsed state - bug in
+ // comctl32.dll or our code?
+ {
+ NM_TREEVIEW* tv = (NM_TREEVIEW *)lParam;
+ wxTreeItemId id = (WXHTREEITEM)tv->itemNew.hItem;
+
+ int image = GetItemImage(id, wxTreeItemIcon_Expanded);
+ if ( image != -1 )
+ {
+ RefreshItem(id);
+ }
+ }
+ break;
+
case TVN_GETDISPINFO:
// NB: so far the user can't set the image himself anyhow, so do it
// anyway - but this may change later
- if ( /* !processed && */ 1 )
+ //if ( /* !processed && */ 1 )
{
wxTreeItemId item = event.m_item;
TV_DISPINFO *info = (TV_DISPINFO *)lParam;
// for the other messages the return value is ignored and there is
// nothing special to do
}
-
return processed;
}
#endif // __WIN95__
+#endif // wxUSE_TREECTRL
projects / wxWidgets.git / blobdiff