#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)
// looks quite ugly.
#define wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE 0
-
// ----------------------------------------------------------------------------
// private functions
// ----------------------------------------------------------------------------
// wrappers for TreeView_GetItem/TreeView_SetItem
static bool IsItemSelected(HWND hwndTV, HTREEITEM hItem)
{
+
TV_ITEM tvi;
tvi.mask = TVIF_STATE | TVIF_HANDLE;
tvi.stateMask = TVIS_SELECTED;
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;
+};
+
#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
class wxTreeTraversal
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
//
// 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;
};
IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl, wxControl)
// ----------------------------------------------------------------------------
-// variables
+// constants
// ----------------------------------------------------------------------------
-// handy table for sending events
-static 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
m_hasAnyAttr = FALSE;
m_dragImage = NULL;
m_htSelStart = 0;
+ m_pVirtualRoot = NULL;
- // Initialize static array of events, because with the new event system,
- // they may not be initialized yet.
-
- g_events[0][0] = wxEVT_COMMAND_TREE_ITEM_COLLAPSED;
- g_events[0][1] = wxEVT_COMMAND_TREE_ITEM_COLLAPSING;
- g_events[1][0] = wxEVT_COMMAND_TREE_ITEM_EXPANDED;
- g_events[1][1] = wxEVT_COMMAND_TREE_ITEM_EXPANDING;
+ // 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,
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 && \
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
DeleteTextCtrl();
// delete user data to prevent memory leaks
+ // also deletes hidden root node storage.
DeleteAllItems();
if (m_ownsImageListNormal) delete m_imageListNormal;
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"));
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;
}
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);
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) )
{
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()));
}
wxTreeItemId wxTreeCtrl::GetParent(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 stored root item.
+ delete GET_VIRTUAL_ROOT();
+
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.
+ if ( (HITEM(item) == TVI_ROOT) && (m_windowStyle & wxTR_HIDE_ROOT) )
+ {
+ // No action will be taken.
+ return;
+ }
+
// 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
}
// 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 */);
}
{
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 = (int)hdr->code == TVN_ITEMEXPANDING ? IDX_DOING
+ : IDX_DONE;
+
+ eventType = gs_expandEvents[what][how];
event.m_item = (WXHTREEITEM) tv->itemNew.hItem;
}
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
{
*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;
+ if ( tv->action == TVE_EXPAND )
+ {
+ 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
: wxTreeItemIcon_Selected
);
}
- }
+ }
break;
//default:
projects / wxWidgets.git / blobdiff