]> git.saurik.com Git - wxWidgets.git/blame - src/msw/treectrl.cpp
Added space under label since it was too close to first radio button.
[wxWidgets.git] / src / msw / treectrl.cpp
CommitLineData
b823f5a1 1/////////////////////////////////////////////////////////////////////////////
1e6feb95 2// Name: src/msw/treectrl.cpp
b823f5a1
JS
3// Purpose: wxTreeCtrl
4// Author: Julian Smart
08b7c251 5// Modified by: Vadim Zeitlin to be less MSW-specific on 10.10.98
b823f5a1
JS
6// Created: 1997
7// RCS-ID: $Id$
8// Copyright: (c) Julian Smart
08b7c251 9// Licence: wxWindows licence
b823f5a1 10/////////////////////////////////////////////////////////////////////////////
2bda0e17 11
08b7c251
VZ
12// ============================================================================
13// declarations
14// ============================================================================
15
16// ----------------------------------------------------------------------------
17// headers
18// ----------------------------------------------------------------------------
1e6feb95 19
2bda0e17 20#ifdef __GNUG__
08b7c251 21 #pragma implementation "treectrl.h"
2bda0e17
KB
22#endif
23
24// For compilers that support precompilation, includes "wx.h".
25#include "wx/wxprec.h"
26
27#ifdef __BORLANDC__
08b7c251 28 #pragma hdrstop
2bda0e17
KB
29#endif
30
1e6feb95
VZ
31#if wxUSE_TREECTRL
32
0c589ad0
BM
33#include "wx/msw/private.h"
34
1e6feb95
VZ
35// Set this to 1 to be _absolutely_ sure that repainting will work for all
36// comctl32.dll versions
f6bcfd97
BP
37#define wxUSE_COMCTL32_SAFELY 0
38
0c589ad0
BM
39// Mingw32 is a bit mental even though this is done in winundef
40#ifdef GetFirstChild
d220ae32 41 #undef GetFirstChild
0c589ad0 42#endif
d220ae32 43
0c589ad0 44#ifdef GetNextSibling
d220ae32 45 #undef GetNextSibling
2bda0e17
KB
46#endif
47
2bda0e17
KB
48#if defined(__WIN95__)
49
c6f4913a 50#include "wx/app.h"
08b7c251 51#include "wx/log.h"
ce3ed50d 52#include "wx/dynarray.h"
08b7c251 53#include "wx/imaglist.h"
77cff606 54#include "wx/settings.h"
484523cf 55#include "wx/msw/treectrl.h"
23f681ec
VZ
56#include "wx/msw/dragimag.h"
57
c42404a5
VZ
58#ifdef __GNUWIN32_OLD__
59 #include "wx/msw/gnuwin32/extra.h"
65fd5cb0 60#endif
9a05fd8d 61
ae090fdb 62#if defined(__WIN95__) && !((defined(__GNUWIN32_OLD__) || defined(__TWIN32__)) && !defined(__CYGWIN10__))
08b7c251 63 #include <commctrl.h>
2bda0e17
KB
64#endif
65
66// Bug in headers, sometimes
67#ifndef TVIS_FOCUSED
08b7c251 68 #define TVIS_FOCUSED 0x0001
2bda0e17
KB
69#endif
70
bb448552
VZ
71#ifndef TV_FIRST
72 #define TV_FIRST 0x1100
73#endif
74
b94ae1ea
VZ
75#ifndef TVS_CHECKBOXES
76 #define TVS_CHECKBOXES 0x0100
77#endif
78
5ece068d
VZ
79#ifndef TVS_FULLROWSELECT
80 #define TVS_FULLROWSELECT 0x1000
81#endif
82
bb448552
VZ
83// old headers might miss these messages (comctl32.dll 4.71+ only)
84#ifndef TVM_SETBKCOLOR
85 #define TVM_SETBKCOLOR (TV_FIRST + 29)
86 #define TVM_SETTEXTCOLOR (TV_FIRST + 30)
87#endif
88
3f7bc32b
VZ
89// a macro to hide the ugliness of nested casts
90#define HITEM(item) (HTREEITEM)(WXHTREEITEM)(item)
91
92// the native control doesn't support multiple selections under MSW and we
93// have 2 ways to emulate them: either using TVS_CHECKBOXES style and let
94// checkboxes be the selection status (checked == selected) or by really
95// emulating everything, i.e. intercepting mouse and key events &c. The first
96// approach is much easier but doesn't work with comctl32.dll < 4.71 and also
97// looks quite ugly.
98#define wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE 0
99
3f7bc32b
VZ
100// ----------------------------------------------------------------------------
101// private functions
102// ----------------------------------------------------------------------------
103
104// wrapper for TreeView_HitTest
105static HTREEITEM GetItemFromPoint(HWND hwndTV, int x, int y)
106{
107 TV_HITTESTINFO tvht;
108 tvht.pt.x = x;
109 tvht.pt.y = y;
110
3f7bc32b
VZ
111 return (HTREEITEM)TreeView_HitTest(hwndTV, &tvht);
112}
113
114#if !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
115
116// wrappers for TreeView_GetItem/TreeView_SetItem
117static bool IsItemSelected(HWND hwndTV, HTREEITEM hItem)
118{
a9c1265f 119
3f7bc32b
VZ
120 TV_ITEM tvi;
121 tvi.mask = TVIF_STATE | TVIF_HANDLE;
122 tvi.stateMask = TVIS_SELECTED;
123 tvi.hItem = hItem;
124
125 if ( !TreeView_GetItem(hwndTV, &tvi) )
126 {
f6bcfd97 127 wxLogLastError(wxT("TreeView_GetItem"));
3f7bc32b
VZ
128 }
129
130 return (tvi.state & TVIS_SELECTED) != 0;
131}
132
133static void SelectItem(HWND hwndTV, HTREEITEM hItem, bool select = TRUE)
134{
135 TV_ITEM tvi;
136 tvi.mask = TVIF_STATE | TVIF_HANDLE;
137 tvi.stateMask = TVIS_SELECTED;
138 tvi.state = select ? TVIS_SELECTED : 0;
139 tvi.hItem = hItem;
140
141 if ( TreeView_SetItem(hwndTV, &tvi) == -1 )
142 {
f6bcfd97 143 wxLogLastError(wxT("TreeView_SetItem"));
3f7bc32b
VZ
144 }
145}
146
147static inline void UnselectItem(HWND hwndTV, HTREEITEM htItem)
148{
149 SelectItem(hwndTV, htItem, FALSE);
150}
151
152static inline void ToggleItemSelection(HWND hwndTV, HTREEITEM htItem)
153{
154 SelectItem(hwndTV, htItem, !IsItemSelected(hwndTV, htItem));
155}
156
157// helper function which selects all items in a range and, optionally,
158// unselects all others
159static void SelectRange(HWND hwndTV,
160 HTREEITEM htFirst,
161 HTREEITEM htLast,
162 bool unselectOthers = TRUE)
163{
164 // find the first (or last) item and select it
165 bool cont = TRUE;
2c8e4738 166 HTREEITEM htItem = (HTREEITEM)TreeView_GetRoot(hwndTV);
3f7bc32b
VZ
167 while ( htItem && cont )
168 {
169 if ( (htItem == htFirst) || (htItem == htLast) )
170 {
171 if ( !IsItemSelected(hwndTV, htItem) )
172 {
173 SelectItem(hwndTV, htItem);
174 }
175
176 cont = FALSE;
177 }
178 else
179 {
180 if ( unselectOthers && IsItemSelected(hwndTV, htItem) )
181 {
182 UnselectItem(hwndTV, htItem);
183 }
184 }
185
2c8e4738 186 htItem = (HTREEITEM)TreeView_GetNextVisible(hwndTV, htItem);
3f7bc32b
VZ
187 }
188
189 // select the items in range
190 cont = htFirst != htLast;
191 while ( htItem && cont )
192 {
193 if ( !IsItemSelected(hwndTV, htItem) )
194 {
195 SelectItem(hwndTV, htItem);
196 }
197
198 cont = (htItem != htFirst) && (htItem != htLast);
199
2c8e4738 200 htItem = (HTREEITEM)TreeView_GetNextVisible(hwndTV, htItem);
3f7bc32b
VZ
201 }
202
203 // unselect the rest
204 if ( unselectOthers )
205 {
206 while ( htItem )
207 {
208 if ( IsItemSelected(hwndTV, htItem) )
209 {
210 UnselectItem(hwndTV, htItem);
211 }
212
2c8e4738 213 htItem = (HTREEITEM)TreeView_GetNextVisible(hwndTV, htItem);
3f7bc32b
VZ
214 }
215 }
216
217 // seems to be necessary - otherwise the just selected items don't always
218 // appear as selected
219 UpdateWindow(hwndTV);
220}
221
222// helper function which tricks the standard control into changing the focused
223// item without changing anything else (if someone knows why Microsoft doesn't
224// allow to do it by just setting TVIS_FOCUSED flag, please tell me!)
225static void SetFocus(HWND hwndTV, HTREEITEM htItem)
226{
227 // the current focus
2c8e4738 228 HTREEITEM htFocus = (HTREEITEM)TreeView_GetSelection(hwndTV);
3f7bc32b
VZ
229
230 if ( htItem )
231 {
232 // set the focus
233 if ( htItem != htFocus )
234 {
235 // remember the selection state of the item
236 bool wasSelected = IsItemSelected(hwndTV, htItem);
237
238 if ( htFocus && IsItemSelected(hwndTV, htFocus) )
239 {
240 // prevent the tree from unselecting the old focus which it
241 // would do by default (TreeView_SelectItem unselects the
242 // focused item)
243 TreeView_SelectItem(hwndTV, 0);
244 SelectItem(hwndTV, htFocus);
245 }
246
247 TreeView_SelectItem(hwndTV, htItem);
248
249 if ( !wasSelected )
250 {
251 // need to clear the selection which TreeView_SelectItem() gave
252 // us
253 UnselectItem(hwndTV, htItem);
254 }
255 //else: was selected, still selected - ok
256 }
257 //else: nothing to do, focus already there
258 }
259 else
260 {
261 if ( htFocus )
262 {
263 bool wasFocusSelected = IsItemSelected(hwndTV, htFocus);
264
265 // just clear the focus
266 TreeView_SelectItem(hwndTV, 0);
267
268 if ( wasFocusSelected )
269 {
270 // restore the selection state
271 SelectItem(hwndTV, htFocus);
272 }
273 }
274 //else: nothing to do, no focus already
275 }
276}
277
278#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
279
08b7c251
VZ
280// ----------------------------------------------------------------------------
281// private classes
282// ----------------------------------------------------------------------------
2bda0e17 283
08b7c251 284// a convenient wrapper around TV_ITEM struct which adds a ctor
f3ef286f 285#ifdef __VISUALC__
3f7bc32b 286#pragma warning( disable : 4097 ) // inheriting from typedef
f3ef286f
JS
287#endif
288
08b7c251
VZ
289struct wxTreeViewItem : public TV_ITEM
290{
9dfbf520
VZ
291 wxTreeViewItem(const wxTreeItemId& item, // the item handle
292 UINT mask_, // fields which are valid
293 UINT stateMask_ = 0) // for TVIF_STATE only
08b7c251 294 {
a9c1265f
VZ
295 wxZeroMemory(*this);
296
9dfbf520
VZ
297 // hItem member is always valid
298 mask = mask_ | TVIF_HANDLE;
08b7c251 299 stateMask = stateMask_;
3f7bc32b 300 hItem = HITEM(item);
08b7c251
VZ
301 }
302};
f3ef286f 303
a9c1265f
VZ
304// wxVirutalNode is used in place of a single root when 'hidden' root is
305// specified.
efa38350 306class wxVirtualNode : public wxTreeViewItem
a9c1265f
VZ
307{
308public:
309 wxVirtualNode(wxTreeItemData *data)
efa38350 310 : wxTreeViewItem(TVI_ROOT, 0)
a9c1265f
VZ
311 {
312 m_data = data;
a9c1265f
VZ
313 }
314
315 ~wxVirtualNode()
316 {
317 delete m_data;
a9c1265f
VZ
318 }
319
320 wxTreeItemData *GetData() const { return m_data; }
321 void SetData(wxTreeItemData *data) { delete m_data; m_data = data; }
322
323private:
a9c1265f
VZ
324 wxTreeItemData *m_data;
325};
326
f3ef286f 327#ifdef __VISUALC__
197dd9af 328#pragma warning( default : 4097 )
f3ef286f 329#endif
2bda0e17 330
a9c1265f
VZ
331// a macro to get the virtual root, returns NULL if none
332#define GET_VIRTUAL_ROOT() ((wxVirtualNode *)m_pVirtualRoot)
333
334// returns TRUE if the item is the virtual root
335#define IS_VIRTUAL_ROOT(item) (HITEM(item) == TVI_ROOT)
336
9dfbf520
VZ
337// a class which encapsulates the tree traversal logic: it vists all (unless
338// OnVisit() returns FALSE) items under the given one
339class wxTreeTraversal
340{
341public:
342 wxTreeTraversal(const wxTreeCtrl *tree)
343 {
344 m_tree = tree;
345 }
346
347 // do traverse the tree: visit all items (recursively by default) under the
348 // given one; return TRUE if all items were traversed or FALSE if the
349 // traversal was aborted because OnVisit returned FALSE
350 bool DoTraverse(const wxTreeItemId& root, bool recursively = TRUE);
351
352 // override this function to do whatever is needed for each item, return
353 // FALSE to stop traversing
354 virtual bool OnVisit(const wxTreeItemId& item) = 0;
355
356protected:
357 const wxTreeCtrl *GetTree() const { return m_tree; }
358
359private:
360 bool Traverse(const wxTreeItemId& root, bool recursively);
361
362 const wxTreeCtrl *m_tree;
363};
364
74b31181
VZ
365// internal class for getting the selected items
366class TraverseSelections : public wxTreeTraversal
367{
368public:
369 TraverseSelections(const wxTreeCtrl *tree,
370 wxArrayTreeItemIds& selections)
371 : wxTreeTraversal(tree), m_selections(selections)
372 {
373 m_selections.Empty();
374
375 DoTraverse(tree->GetRootItem());
376 }
377
378 virtual bool OnVisit(const wxTreeItemId& item)
379 {
a9c1265f
VZ
380 // can't visit a virtual node.
381 if ( (GetTree()->GetRootItem() == item) && (GetTree()->GetWindowStyle() & wxTR_HIDE_ROOT))
382 {
383 return TRUE;
384 }
385
3f7bc32b 386#if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
74b31181 387 if ( GetTree()->IsItemChecked(item) )
3f7bc32b
VZ
388#else
389 if ( ::IsItemSelected(GetHwndOf(GetTree()), HITEM(item)) )
390#endif
74b31181
VZ
391 {
392 m_selections.Add(item);
393 }
394
395 return TRUE;
396 }
397
e47c4d48
VZ
398 size_t GetCount() const { return m_selections.GetCount(); }
399
74b31181
VZ
400private:
401 wxArrayTreeItemIds& m_selections;
402};
403
404// internal class for counting tree items
405class TraverseCounter : public wxTreeTraversal
406{
407public:
408 TraverseCounter(const wxTreeCtrl *tree,
409 const wxTreeItemId& root,
410 bool recursively)
411 : wxTreeTraversal(tree)
412 {
413 m_count = 0;
414
415 DoTraverse(root, recursively);
416 }
417
33ac7e6f 418 virtual bool OnVisit(const wxTreeItemId& WXUNUSED(item))
74b31181
VZ
419 {
420 m_count++;
421
422 return TRUE;
423 }
424
425 size_t GetCount() const { return m_count; }
426
427private:
428 size_t m_count;
429};
430
431// ----------------------------------------------------------------------------
432// This class is needed for support of different images: the Win32 common
433// control natively supports only 2 images (the normal one and another for the
434// selected state). We wish to provide support for 2 more of them for folder
435// items (i.e. those which have children): for expanded state and for expanded
436// selected state. For this we use this structure to store the additional items
437// images.
438//
439// There is only one problem with this: when we retrieve the item's data, we
440// don't know whether we get a pointer to wxTreeItemData or
502a2b18
VZ
441// wxTreeItemIndirectData. So we always set the item id to an invalid value
442// in this class and the code using the client data checks for it and retrieves
443// the real client data in this case.
74b31181 444// ----------------------------------------------------------------------------
696e1ea0 445
502a2b18 446class wxTreeItemIndirectData : public wxTreeItemData
74b31181
VZ
447{
448public:
449 // ctor associates this data with the item and the real item data becomes
450 // available through our GetData() method
451 wxTreeItemIndirectData(wxTreeCtrl *tree, const wxTreeItemId& item)
452 {
453 for ( size_t n = 0; n < WXSIZEOF(m_images); n++ )
454 {
455 m_images[n] = -1;
456 }
457
458 // save the old data
459 m_data = tree->GetItemData(item);
460
461 // and set ourselves as the new one
462 tree->SetIndirectItemData(item, this);
cf48ccc0
VZ
463
464 // we must have the invalid value for the item
465 m_pItem = 0l;
74b31181
VZ
466 }
467
468 // dtor deletes the associated data as well
502a2b18 469 virtual ~wxTreeItemIndirectData() { delete m_data; }
74b31181
VZ
470
471 // accessors
472 // get the real data associated with the item
473 wxTreeItemData *GetData() const { return m_data; }
474 // change it
475 void SetData(wxTreeItemData *data) { m_data = data; }
476
477 // do we have such image?
478 bool HasImage(wxTreeItemIcon which) const { return m_images[which] != -1; }
479 // get image
480 int GetImage(wxTreeItemIcon which) const { return m_images[which]; }
481 // change it
482 void SetImage(int image, wxTreeItemIcon which) { m_images[which] = image; }
483
484private:
485 // all the images associated with the item
486 int m_images[wxTreeItemIcon_Max];
487
502a2b18 488 // the real client data
74b31181
VZ
489 wxTreeItemData *m_data;
490};
491
23f681ec 492// ----------------------------------------------------------------------------
3f7bc32b 493// wxWin macros
08b7c251
VZ
494// ----------------------------------------------------------------------------
495
23f681ec 496IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl, wxControl)
2bda0e17 497
08b7c251 498// ----------------------------------------------------------------------------
deb1de30 499// constants
08b7c251
VZ
500// ----------------------------------------------------------------------------
501
deb1de30
VZ
502// indices in gs_expandEvents table below
503enum
504{
505 IDX_COLLAPSE,
506 IDX_EXPAND,
507 IDX_WHAT_MAX
508};
509
510enum
511{
512 IDX_DONE,
513 IDX_DOING,
514 IDX_HOW_MAX
515};
516
517// handy table for sending events - it has to be initialized during run-time
518// now so can't be const any more
519static /* const */ wxEventType gs_expandEvents[IDX_WHAT_MAX][IDX_HOW_MAX];
520
521/*
522 but logically it's a const table with the following entries:
523=
2bda0e17 524{
08b7c251
VZ
525 { wxEVT_COMMAND_TREE_ITEM_COLLAPSED, wxEVT_COMMAND_TREE_ITEM_COLLAPSING },
526 { wxEVT_COMMAND_TREE_ITEM_EXPANDED, wxEVT_COMMAND_TREE_ITEM_EXPANDING }
527};
deb1de30 528*/
08b7c251
VZ
529
530// ============================================================================
531// implementation
532// ============================================================================
533
9dfbf520
VZ
534// ----------------------------------------------------------------------------
535// tree traversal
536// ----------------------------------------------------------------------------
537
538bool wxTreeTraversal::DoTraverse(const wxTreeItemId& root, bool recursively)
539{
540 if ( !OnVisit(root) )
541 return FALSE;
542
543 return Traverse(root, recursively);
544}
545
546bool wxTreeTraversal::Traverse(const wxTreeItemId& root, bool recursively)
547{
548 long cookie;
549 wxTreeItemId child = m_tree->GetFirstChild(root, cookie);
550 while ( child.IsOk() )
551 {
552 // depth first traversal
553 if ( recursively && !Traverse(child, TRUE) )
554 return FALSE;
555
556 if ( !OnVisit(child) )
557 return FALSE;
558
559 child = m_tree->GetNextChild(root, cookie);
560 }
561
562 return TRUE;
563}
564
08b7c251
VZ
565// ----------------------------------------------------------------------------
566// construction and destruction
567// ----------------------------------------------------------------------------
568
569void wxTreeCtrl::Init()
570{
571 m_imageListNormal = NULL;
572 m_imageListState = NULL;
0377efa2 573 m_ownsImageListNormal = m_ownsImageListState = FALSE;
08b7c251 574 m_textCtrl = NULL;
696e1ea0 575 m_hasAnyAttr = FALSE;
23f681ec 576 m_dragImage = NULL;
3f7bc32b 577 m_htSelStart = 0;
a9c1265f 578 m_pVirtualRoot = NULL;
9ab5ef13 579
deb1de30
VZ
580 // initialize the global array of events now as it can't be done statically
581 // with the wxEVT_XXX values being allocated during run-time only
582 gs_expandEvents[IDX_COLLAPSE][IDX_DONE] = wxEVT_COMMAND_TREE_ITEM_COLLAPSED;
583 gs_expandEvents[IDX_COLLAPSE][IDX_DOING] = wxEVT_COMMAND_TREE_ITEM_COLLAPSING;
584 gs_expandEvents[IDX_EXPAND][IDX_DONE] = wxEVT_COMMAND_TREE_ITEM_EXPANDED;
585 gs_expandEvents[IDX_EXPAND][IDX_DOING] = wxEVT_COMMAND_TREE_ITEM_EXPANDING;
2bda0e17
KB
586}
587
9dfbf520
VZ
588bool wxTreeCtrl::Create(wxWindow *parent,
589 wxWindowID id,
590 const wxPoint& pos,
591 const wxSize& size,
592 long style,
593 const wxValidator& validator,
08b7c251 594 const wxString& name)
2bda0e17 595{
08b7c251 596 Init();
2bda0e17 597
9dfbf520
VZ
598 if ( !CreateControl(parent, id, pos, size, style, validator, name) )
599 return FALSE;
2bda0e17 600
5ea47806 601 DWORD wstyle = WS_VISIBLE | WS_CHILD | WS_TABSTOP |
b0766406
JS
602 TVS_SHOWSELALWAYS;
603
604 if ( m_windowStyle & wxCLIP_SIBLINGS )
605 wstyle |= WS_CLIPSIBLINGS;
2bda0e17 606
63da7df7
JS
607 if ((m_windowStyle & wxTR_NO_LINES) == 0)
608 wstyle |= TVS_HASLINES;
08b7c251
VZ
609 if ( m_windowStyle & wxTR_HAS_BUTTONS )
610 wstyle |= TVS_HASBUTTONS;
2bda0e17 611
08b7c251
VZ
612 if ( m_windowStyle & wxTR_EDIT_LABELS )
613 wstyle |= TVS_EDITLABELS;
2bda0e17 614
08b7c251
VZ
615 if ( m_windowStyle & wxTR_LINES_AT_ROOT )
616 wstyle |= TVS_LINESATROOT;
deb1de30 617
c6f4913a 618 if ( m_windowStyle & wxTR_FULL_ROW_HIGHLIGHT )
deb1de30 619 {
c6f4913a
VS
620 if ( wxTheApp->GetComCtl32Version() >= 471 )
621 wstyle |= TVS_FULLROWSELECT;
622 }
623
3f7bc32b
VZ
624 // using TVS_CHECKBOXES for emulation of a multiselection tree control
625 // doesn't work without the new enough headers
626#if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE && \
627 !defined( __GNUWIN32_OLD__ ) && \
c42404a5
VZ
628 !defined( __BORLANDC__ ) && \
629 !defined( __WATCOMC__ ) && \
630 (!defined(__VISUALC__) || (__VISUALC__ > 1010))
a20a10fe 631
9dfbf520
VZ
632 // we emulate the multiple selection tree controls by using checkboxes: set
633 // up the image list we need for this if we do have multiple selections
634 if ( m_windowStyle & wxTR_MULTIPLE )
10fcf31a 635 wstyle |= TVS_CHECKBOXES;
3f7bc32b 636#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
9dfbf520 637
08b7c251 638 // Create the tree control.
9dfbf520
VZ
639 if ( !MSWCreateControl(WC_TREEVIEW, wstyle) )
640 return FALSE;
641
f6bcfd97 642#if wxUSE_COMCTL32_SAFELY
a756f210 643 wxWindow::SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
f6bcfd97
BP
644 wxWindow::SetForegroundColour(wxWindow::GetParent()->GetForegroundColour());
645#elif 1
a756f210 646 SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
f6bcfd97 647 SetForegroundColour(wxWindow::GetParent()->GetForegroundColour());
fbdcff4a
JS
648#else
649 // This works around a bug in the Windows tree control whereby for some versions
650 // of comctrl32, setting any colour actually draws the background in black.
651 // This will initialise the background to the system colour.
f6bcfd97
BP
652 // THIS FIX NOW REVERTED since it caused problems on _other_ systems.
653 // Assume the user has an updated comctl32.dll.
fbdcff4a 654 ::SendMessage(GetHwnd(), TVM_SETBKCOLOR, 0,-1);
a756f210 655 wxWindow::SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
f6bcfd97 656 SetForegroundColour(wxWindow::GetParent()->GetForegroundColour());
fbdcff4a
JS
657#endif
658
5aeeab14 659
9dfbf520
VZ
660 // VZ: this is some experimental code which may be used to get the
661 // TVS_CHECKBOXES style functionality for comctl32.dll < 4.71.
662 // AFAIK, the standard DLL does about the same thing anyhow.
663#if 0
664 if ( m_windowStyle & wxTR_MULTIPLE )
665 {
666 wxBitmap bmp;
667
668 // create the DC compatible with the current screen
669 HDC hdcMem = CreateCompatibleDC(NULL);
670
671 // create a mono bitmap of the standard size
672 int x = GetSystemMetrics(SM_CXMENUCHECK);
673 int y = GetSystemMetrics(SM_CYMENUCHECK);
674 wxImageList imagelistCheckboxes(x, y, FALSE, 2);
675 HBITMAP hbmpCheck = CreateBitmap(x, y, // bitmap size
676 1, // # of color planes
677 1, // # bits needed for one pixel
678 0); // array containing colour data
679 SelectObject(hdcMem, hbmpCheck);
680
681 // then draw a check mark into it
682 RECT rect = { 0, 0, x, y };
683 if ( !::DrawFrameControl(hdcMem, &rect,
684 DFC_BUTTON,
685 DFCS_BUTTONCHECK | DFCS_CHECKED) )
686 {
223d09f6 687 wxLogLastError(wxT("DrawFrameControl(check)"));
9dfbf520
VZ
688 }
689
690 bmp.SetHBITMAP((WXHBITMAP)hbmpCheck);
691 imagelistCheckboxes.Add(bmp);
692
693 if ( !::DrawFrameControl(hdcMem, &rect,
694 DFC_BUTTON,
695 DFCS_BUTTONCHECK) )
696 {
223d09f6 697 wxLogLastError(wxT("DrawFrameControl(uncheck)"));
9dfbf520
VZ
698 }
699
700 bmp.SetHBITMAP((WXHBITMAP)hbmpCheck);
701 imagelistCheckboxes.Add(bmp);
702
703 // clean up
704 ::DeleteDC(hdcMem);
705
706 // set the imagelist
707 SetStateImageList(&imagelistCheckboxes);
708 }
709#endif // 0
710
711 SetSize(pos.x, pos.y, size.x, size.y);
2bda0e17 712
08b7c251 713 return TRUE;
2bda0e17
KB
714}
715
08b7c251 716wxTreeCtrl::~wxTreeCtrl()
2bda0e17 717{
696e1ea0
VZ
718 // delete any attributes
719 if ( m_hasAnyAttr )
720 {
721 for ( wxNode *node = m_attrs.Next(); node; node = m_attrs.Next() )
722 {
723 delete (wxTreeItemAttr *)node->Data();
724 }
725
726 // prevent TVN_DELETEITEM handler from deleting the attributes again!
727 m_hasAnyAttr = FALSE;
728 }
729
08b7c251 730 DeleteTextCtrl();
2bda0e17 731
08b7c251 732 // delete user data to prevent memory leaks
a9c1265f 733 // also deletes hidden root node storage.
08b7c251 734 DeleteAllItems();
33ac7e6f 735
0377efa2
VS
736 if (m_ownsImageListNormal) delete m_imageListNormal;
737 if (m_ownsImageListState) delete m_imageListState;
2bda0e17
KB
738}
739
08b7c251
VZ
740// ----------------------------------------------------------------------------
741// accessors
742// ----------------------------------------------------------------------------
2bda0e17 743
08b7c251 744// simple wrappers which add error checking in debug mode
2bda0e17 745
08b7c251 746bool wxTreeCtrl::DoGetItem(wxTreeViewItem* tvItem) const
2bda0e17 747{
a9c1265f
VZ
748 wxCHECK_MSG( tvItem->hItem != TVI_ROOT, FALSE,
749 _T("can't retrieve virtual root item") );
750
d220ae32 751 if ( !TreeView_GetItem(GetHwnd(), tvItem) )
2bda0e17 752 {
f6bcfd97 753 wxLogLastError(wxT("TreeView_GetItem"));
08b7c251
VZ
754
755 return FALSE;
756 }
757
758 return TRUE;
2bda0e17
KB
759}
760
08b7c251 761void wxTreeCtrl::DoSetItem(wxTreeViewItem* tvItem)
2bda0e17 762{
d220ae32 763 if ( TreeView_SetItem(GetHwnd(), tvItem) == -1 )
2bda0e17 764 {
f6bcfd97 765 wxLogLastError(wxT("TreeView_SetItem"));
08b7c251 766 }
2bda0e17
KB
767}
768
08b7c251 769size_t wxTreeCtrl::GetCount() const
2bda0e17 770{
d220ae32 771 return (size_t)TreeView_GetCount(GetHwnd());
2bda0e17
KB
772}
773
08b7c251 774unsigned int wxTreeCtrl::GetIndent() const
2bda0e17 775{
d220ae32 776 return TreeView_GetIndent(GetHwnd());
2bda0e17
KB
777}
778
08b7c251 779void wxTreeCtrl::SetIndent(unsigned int indent)
2bda0e17 780{
d220ae32 781 TreeView_SetIndent(GetHwnd(), indent);
2bda0e17
KB
782}
783
08b7c251 784wxImageList *wxTreeCtrl::GetImageList() const
2bda0e17 785{
08b7c251 786 return m_imageListNormal;
2bda0e17
KB
787}
788
08b7c251 789wxImageList *wxTreeCtrl::GetStateImageList() const
2bda0e17 790{
08b7c251 791 return m_imageListNormal;
2bda0e17
KB
792}
793
08b7c251 794void wxTreeCtrl::SetAnyImageList(wxImageList *imageList, int which)
2bda0e17 795{
08b7c251 796 // no error return
d220ae32 797 TreeView_SetImageList(GetHwnd(),
08b7c251
VZ
798 imageList ? imageList->GetHIMAGELIST() : 0,
799 which);
2bda0e17
KB
800}
801
08b7c251 802void wxTreeCtrl::SetImageList(wxImageList *imageList)
2bda0e17 803{
a9c1265f
VZ
804 if (m_ownsImageListNormal)
805 delete m_imageListNormal;
806
08b7c251 807 SetAnyImageList(m_imageListNormal = imageList, TVSIL_NORMAL);
0377efa2 808 m_ownsImageListNormal = FALSE;
2bda0e17
KB
809}
810
08b7c251 811void wxTreeCtrl::SetStateImageList(wxImageList *imageList)
2bda0e17 812{
0377efa2 813 if (m_ownsImageListState) delete m_imageListState;
08b7c251 814 SetAnyImageList(m_imageListState = imageList, TVSIL_STATE);
0377efa2
VS
815 m_ownsImageListState = FALSE;
816}
817
818void wxTreeCtrl::AssignImageList(wxImageList *imageList)
819{
820 SetImageList(imageList);
821 m_ownsImageListNormal = TRUE;
822}
823
824void wxTreeCtrl::AssignStateImageList(wxImageList *imageList)
825{
826 SetStateImageList(imageList);
827 m_ownsImageListState = TRUE;
2bda0e17
KB
828}
829
33961d59
RR
830size_t wxTreeCtrl::GetChildrenCount(const wxTreeItemId& item,
831 bool recursively) const
832{
833 TraverseCounter counter(this, item, recursively);
23fd5130 834
73974df1 835 return counter.GetCount() - 1;
23fd5130
VZ
836}
837
bb448552
VZ
838// ----------------------------------------------------------------------------
839// control colours
840// ----------------------------------------------------------------------------
841
842bool wxTreeCtrl::SetBackgroundColour(const wxColour &colour)
843{
f6bcfd97 844#if !wxUSE_COMCTL32_SAFELY
bb448552
VZ
845 if ( !wxWindowBase::SetBackgroundColour(colour) )
846 return FALSE;
847
848 SendMessage(GetHwnd(), TVM_SETBKCOLOR, 0, colour.GetPixel());
f6bcfd97 849#endif
bb448552
VZ
850
851 return TRUE;
852}
853
854bool wxTreeCtrl::SetForegroundColour(const wxColour &colour)
855{
f6bcfd97 856#if !wxUSE_COMCTL32_SAFELY
bb448552
VZ
857 if ( !wxWindowBase::SetForegroundColour(colour) )
858 return FALSE;
859
860 SendMessage(GetHwnd(), TVM_SETTEXTCOLOR, 0, colour.GetPixel());
f6bcfd97 861#endif
bb448552
VZ
862
863 return TRUE;
864}
865
08b7c251
VZ
866// ----------------------------------------------------------------------------
867// Item access
868// ----------------------------------------------------------------------------
869
870wxString wxTreeCtrl::GetItemText(const wxTreeItemId& item) const
2bda0e17 871{
837e5743 872 wxChar buf[512]; // the size is arbitrary...
02ce7b72 873
08b7c251
VZ
874 wxTreeViewItem tvItem(item, TVIF_TEXT);
875 tvItem.pszText = buf;
876 tvItem.cchTextMax = WXSIZEOF(buf);
877 if ( !DoGetItem(&tvItem) )
878 {
879 // don't return some garbage which was on stack, but an empty string
223d09f6 880 buf[0] = wxT('\0');
08b7c251 881 }
2bda0e17 882
08b7c251
VZ
883 return wxString(buf);
884}
2bda0e17 885
08b7c251
VZ
886void wxTreeCtrl::SetItemText(const wxTreeItemId& item, const wxString& text)
887{
a9c1265f
VZ
888 if ( IS_VIRTUAL_ROOT(item) )
889 return;
890
08b7c251 891 wxTreeViewItem tvItem(item, TVIF_TEXT);
837e5743 892 tvItem.pszText = (wxChar *)text.c_str(); // conversion is ok
08b7c251 893 DoSetItem(&tvItem);
44fbc477
VZ
894
895 // when setting the text of the item being edited, the text control should
896 // be updated to reflect the new text as well, otherwise calling
897 // SetItemText() in the OnBeginLabelEdit() handler doesn't have any effect
898 //
899 // don't use GetEditControl() here because m_textCtrl is not set yet
900 HWND hwndEdit = TreeView_GetEditControl(GetHwnd());
901 if ( hwndEdit )
902 {
903 if ( item == GetSelection() )
904 {
905 ::SetWindowText(hwndEdit, text);
906 }
907 }
08b7c251 908}
2bda0e17 909
74b31181
VZ
910int wxTreeCtrl::DoGetItemImageFromData(const wxTreeItemId& item,
911 wxTreeItemIcon which) const
912{
913 wxTreeViewItem tvItem(item, TVIF_PARAM);
914 if ( !DoGetItem(&tvItem) )
915 {
916 return -1;
917 }
918
919 return ((wxTreeItemIndirectData *)tvItem.lParam)->GetImage(which);
920}
921
922void wxTreeCtrl::DoSetItemImageFromData(const wxTreeItemId& item,
923 int image,
924 wxTreeItemIcon which) const
925{
926 wxTreeViewItem tvItem(item, TVIF_PARAM);
927 if ( !DoGetItem(&tvItem) )
928 {
929 return;
930 }
931
932 wxTreeItemIndirectData *data = ((wxTreeItemIndirectData *)tvItem.lParam);
933
934 data->SetImage(image, which);
935
936 // make sure that we have selected images as well
937 if ( which == wxTreeItemIcon_Normal &&
938 !data->HasImage(wxTreeItemIcon_Selected) )
939 {
940 data->SetImage(image, wxTreeItemIcon_Selected);
941 }
942
943 if ( which == wxTreeItemIcon_Expanded &&
944 !data->HasImage(wxTreeItemIcon_SelectedExpanded) )
945 {
946 data->SetImage(image, wxTreeItemIcon_SelectedExpanded);
947 }
948}
949
9dfbf520
VZ
950void wxTreeCtrl::DoSetItemImages(const wxTreeItemId& item,
951 int image,
952 int imageSel)
953{
954 wxTreeViewItem tvItem(item, TVIF_IMAGE | TVIF_SELECTEDIMAGE);
955 tvItem.iSelectedImage = imageSel;
956 tvItem.iImage = image;
957 DoSetItem(&tvItem);
958}
959
74b31181
VZ
960int wxTreeCtrl::GetItemImage(const wxTreeItemId& item,
961 wxTreeItemIcon which) const
08b7c251 962{
a9c1265f
VZ
963 if ( (HITEM(item) == TVI_ROOT) && (m_windowStyle & wxTR_HIDE_ROOT) )
964 {
965 // TODO: Maybe a hidden root can still provide images?
966 return -1;
967 }
968
74b31181
VZ
969 if ( HasIndirectData(item) )
970 {
971 return DoGetItemImageFromData(item, which);
972 }
2bda0e17 973
74b31181
VZ
974 UINT mask;
975 switch ( which )
976 {
977 default:
223d09f6 978 wxFAIL_MSG( wxT("unknown tree item image type") );
2bda0e17 979
74b31181
VZ
980 case wxTreeItemIcon_Normal:
981 mask = TVIF_IMAGE;
982 break;
2bda0e17 983
74b31181
VZ
984 case wxTreeItemIcon_Selected:
985 mask = TVIF_SELECTEDIMAGE;
986 break;
987
988 case wxTreeItemIcon_Expanded:
989 case wxTreeItemIcon_SelectedExpanded:
990 return -1;
991 }
992
993 wxTreeViewItem tvItem(item, mask);
08b7c251 994 DoGetItem(&tvItem);
2bda0e17 995
74b31181 996 return mask == TVIF_IMAGE ? tvItem.iImage : tvItem.iSelectedImage;
2bda0e17
KB
997}
998
74b31181
VZ
999void wxTreeCtrl::SetItemImage(const wxTreeItemId& item, int image,
1000 wxTreeItemIcon which)
2bda0e17 1001{
a9c1265f
VZ
1002 if ( IS_VIRTUAL_ROOT(item) )
1003 {
1004 // TODO: Maybe a hidden root can still store images?
1005 return;
1006 }
1007
74b31181
VZ
1008 int imageNormal, imageSel;
1009 switch ( which )
1010 {
1011 default:
223d09f6 1012 wxFAIL_MSG( wxT("unknown tree item image type") );
74b31181
VZ
1013
1014 case wxTreeItemIcon_Normal:
1015 imageNormal = image;
1016 imageSel = GetItemSelectedImage(item);
1017 break;
1018
1019 case wxTreeItemIcon_Selected:
1020 imageNormal = GetItemImage(item);
1021 imageSel = image;
1022 break;
1023
1024 case wxTreeItemIcon_Expanded:
1025 case wxTreeItemIcon_SelectedExpanded:
1026 if ( !HasIndirectData(item) )
1027 {
1028 // we need to get the old images first, because after we create
1029 // the wxTreeItemIndirectData GetItemXXXImage() will use it to
1030 // get the images
1031 imageNormal = GetItemImage(item);
1032 imageSel = GetItemSelectedImage(item);
1033
1034 // if it doesn't have it yet, add it
1035 wxTreeItemIndirectData *data = new
1036 wxTreeItemIndirectData(this, item);
1037
1038 // copy the data to the new location
1039 data->SetImage(imageNormal, wxTreeItemIcon_Normal);
1040 data->SetImage(imageSel, wxTreeItemIcon_Selected);
1041 }
1042
1043 DoSetItemImageFromData(item, image, which);
1044
1045 // reset the normal/selected images because we won't use them any
1046 // more - now they're stored inside the indirect data
1047 imageNormal =
1048 imageSel = I_IMAGECALLBACK;
1049 break;
1050 }
1051
9dfbf520
VZ
1052 // NB: at least in version 5.00.0518.9 of comctl32.dll we need to always
1053 // change both normal and selected image - otherwise the change simply
1054 // doesn't take place!
74b31181 1055 DoSetItemImages(item, imageNormal, imageSel);
2bda0e17
KB
1056}
1057
08b7c251 1058wxTreeItemData *wxTreeCtrl::GetItemData(const wxTreeItemId& item) const
2bda0e17 1059{
08b7c251 1060 wxTreeViewItem tvItem(item, TVIF_PARAM);
a9c1265f
VZ
1061
1062 // Hidden root may have data.
1063 if ( IS_VIRTUAL_ROOT(item) )
1064 {
1065 return GET_VIRTUAL_ROOT()->GetData();
1066 }
1067
1068 // Visible node.
08b7c251
VZ
1069 if ( !DoGetItem(&tvItem) )
1070 {
1071 return NULL;
1072 }
2bda0e17 1073
502a2b18
VZ
1074 wxTreeItemData *data = (wxTreeItemData *)tvItem.lParam;
1075 if ( IsDataIndirect(data) )
74b31181 1076 {
502a2b18 1077 data = ((wxTreeItemIndirectData *)data)->GetData();
74b31181 1078 }
502a2b18
VZ
1079
1080 return data;
2bda0e17
KB
1081}
1082
08b7c251 1083void wxTreeCtrl::SetItemData(const wxTreeItemId& item, wxTreeItemData *data)
2bda0e17 1084{
a9c1265f
VZ
1085 if ( IS_VIRTUAL_ROOT(item) )
1086 {
1087 GET_VIRTUAL_ROOT()->SetData(data);
1088 }
1089
188781db
VZ
1090 // first, associate this piece of data with this item
1091 if ( data )
1092 {
1093 data->SetId(item);
1094 }
1095
08b7c251 1096 wxTreeViewItem tvItem(item, TVIF_PARAM);
74b31181
VZ
1097
1098 if ( HasIndirectData(item) )
1099 {
1100 if ( DoGetItem(&tvItem) )
1101 {
1102 ((wxTreeItemIndirectData *)tvItem.lParam)->SetData(data);
1103 }
1104 else
1105 {
223d09f6 1106 wxFAIL_MSG( wxT("failed to change tree items data") );
74b31181
VZ
1107 }
1108 }
1109 else
1110 {
1111 tvItem.lParam = (LPARAM)data;
1112 DoSetItem(&tvItem);
1113 }
1114}
1115
1116void wxTreeCtrl::SetIndirectItemData(const wxTreeItemId& item,
1117 wxTreeItemIndirectData *data)
1118{
1119 // this should never happen because it's unnecessary and will probably lead
1120 // to crash too because the code elsewhere supposes that the pointer the
1121 // wxTreeItemIndirectData has is a real wxItemData and not
1122 // wxTreeItemIndirectData as well
223d09f6 1123 wxASSERT_MSG( !HasIndirectData(item), wxT("setting indirect data twice?") );
74b31181 1124
502a2b18 1125 SetItemData(item, data);
74b31181
VZ
1126}
1127
1128bool wxTreeCtrl::HasIndirectData(const wxTreeItemId& item) const
1129{
502a2b18
VZ
1130 // query the item itself
1131 wxTreeViewItem tvItem(item, TVIF_PARAM);
1132 if ( !DoGetItem(&tvItem) )
1133 {
1134 return FALSE;
1135 }
1136
1137 wxTreeItemData *data = (wxTreeItemData *)tvItem.lParam;
1138
1139 return data && IsDataIndirect(data);
08b7c251 1140}
2bda0e17 1141
3a5a2f56
VZ
1142void wxTreeCtrl::SetItemHasChildren(const wxTreeItemId& item, bool has)
1143{
a9c1265f
VZ
1144 if ( IS_VIRTUAL_ROOT(item) )
1145 return;
1146
3a5a2f56
VZ
1147 wxTreeViewItem tvItem(item, TVIF_CHILDREN);
1148 tvItem.cChildren = (int)has;
1149 DoSetItem(&tvItem);
1150}
1151
add28c55
VZ
1152void wxTreeCtrl::SetItemBold(const wxTreeItemId& item, bool bold)
1153{
a9c1265f
VZ
1154 if ( IS_VIRTUAL_ROOT(item) )
1155 return;
1156
add28c55
VZ
1157 wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_BOLD);
1158 tvItem.state = bold ? TVIS_BOLD : 0;
1159 DoSetItem(&tvItem);
1160}
1161
58a8ab88
JS
1162void wxTreeCtrl::SetItemDropHighlight(const wxTreeItemId& item, bool highlight)
1163{
a9c1265f
VZ
1164 if ( IS_VIRTUAL_ROOT(item) )
1165 return;
1166
58a8ab88
JS
1167 wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_DROPHILITED);
1168 tvItem.state = highlight ? TVIS_DROPHILITED : 0;
1169 DoSetItem(&tvItem);
1170}
1171
d00407b2
VZ
1172void wxTreeCtrl::RefreshItem(const wxTreeItemId& item)
1173{
a9c1265f
VZ
1174 if ( IS_VIRTUAL_ROOT(item) )
1175 return;
1176
d00407b2
VZ
1177 wxRect rect;
1178 if ( GetBoundingRect(item, rect) )
1179 {
1180 RefreshRect(rect);
1181 }
1182}
1183
696e1ea0
VZ
1184void wxTreeCtrl::SetItemTextColour(const wxTreeItemId& item,
1185 const wxColour& col)
1186{
1187 m_hasAnyAttr = TRUE;
1188
1189 long id = (long)(WXHTREEITEM)item;
1190 wxTreeItemAttr *attr = (wxTreeItemAttr *)m_attrs.Get(id);
1191 if ( !attr )
1192 {
1193 attr = new wxTreeItemAttr;
1194 m_attrs.Put(id, (wxObject *)attr);
1195 }
1196
1197 attr->SetTextColour(col);
d00407b2
VZ
1198
1199 RefreshItem(item);
696e1ea0
VZ
1200}
1201
1202void wxTreeCtrl::SetItemBackgroundColour(const wxTreeItemId& item,
1203 const wxColour& col)
1204{
1205 m_hasAnyAttr = TRUE;
1206
1207 long id = (long)(WXHTREEITEM)item;
1208 wxTreeItemAttr *attr = (wxTreeItemAttr *)m_attrs.Get(id);
1209 if ( !attr )
1210 {
1211 attr = new wxTreeItemAttr;
1212 m_attrs.Put(id, (wxObject *)attr);
1213 }
1214
1215 attr->SetBackgroundColour(col);
d00407b2
VZ
1216
1217 RefreshItem(item);
696e1ea0
VZ
1218}
1219
1220void wxTreeCtrl::SetItemFont(const wxTreeItemId& item, const wxFont& font)
1221{
1222 m_hasAnyAttr = TRUE;
1223
1224 long id = (long)(WXHTREEITEM)item;
1225 wxTreeItemAttr *attr = (wxTreeItemAttr *)m_attrs.Get(id);
1226 if ( !attr )
1227 {
1228 attr = new wxTreeItemAttr;
1229 m_attrs.Put(id, (wxObject *)attr);
1230 }
1231
1232 attr->SetFont(font);
d00407b2
VZ
1233
1234 RefreshItem(item);
696e1ea0
VZ
1235}
1236
08b7c251
VZ
1237// ----------------------------------------------------------------------------
1238// Item status
1239// ----------------------------------------------------------------------------
2bda0e17 1240
08b7c251
VZ
1241bool wxTreeCtrl::IsVisible(const wxTreeItemId& item) const
1242{
add28c55 1243 // Bug in Gnu-Win32 headers, so don't use the macro TreeView_GetItemRect
08b7c251 1244 RECT rect;
955be36c
VZ
1245
1246 // this ugliness comes directly from MSDN - it *is* the correct way to pass
1247 // the HTREEITEM with TVM_GETITEMRECT
1248 *(WXHTREEITEM *)&rect = (WXHTREEITEM)item;
1249
1250 // FALSE means get item rect for the whole item, not only text
1c74a900 1251 return SendMessage(GetHwnd(), TVM_GETITEMRECT, FALSE, (LPARAM)&rect) != 0;
2bda0e17
KB
1252}
1253
08b7c251 1254bool wxTreeCtrl::ItemHasChildren(const wxTreeItemId& item) const
2bda0e17 1255{
08b7c251
VZ
1256 wxTreeViewItem tvItem(item, TVIF_CHILDREN);
1257 DoGetItem(&tvItem);
2bda0e17 1258
08b7c251 1259 return tvItem.cChildren != 0;
2bda0e17
KB
1260}
1261
08b7c251 1262bool wxTreeCtrl::IsExpanded(const wxTreeItemId& item) const
2bda0e17 1263{
08b7c251
VZ
1264 // probably not a good idea to put it here
1265 //wxASSERT( ItemHasChildren(item) );
2bda0e17 1266
08b7c251
VZ
1267 wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_EXPANDED);
1268 DoGetItem(&tvItem);
2bda0e17 1269
08b7c251 1270 return (tvItem.state & TVIS_EXPANDED) != 0;
2bda0e17
KB
1271}
1272
08b7c251 1273bool wxTreeCtrl::IsSelected(const wxTreeItemId& item) const
2bda0e17 1274{
08b7c251
VZ
1275 wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_SELECTED);
1276 DoGetItem(&tvItem);
2bda0e17 1277
08b7c251 1278 return (tvItem.state & TVIS_SELECTED) != 0;
2bda0e17
KB
1279}
1280
add28c55
VZ
1281bool wxTreeCtrl::IsBold(const wxTreeItemId& item) const
1282{
1283 wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_BOLD);
1284 DoGetItem(&tvItem);
1285
1286 return (tvItem.state & TVIS_BOLD) != 0;
1287}
1288
08b7c251
VZ
1289// ----------------------------------------------------------------------------
1290// navigation
1291// ----------------------------------------------------------------------------
2bda0e17 1292
08b7c251
VZ
1293wxTreeItemId wxTreeCtrl::GetRootItem() const
1294{
a9c1265f
VZ
1295 // Root may be real (visible) or virtual (hidden).
1296 if ( GET_VIRTUAL_ROOT() )
1297 return TVI_ROOT;
1298
d220ae32 1299 return wxTreeItemId((WXHTREEITEM) TreeView_GetRoot(GetHwnd()));
08b7c251 1300}
2bda0e17 1301
08b7c251
VZ
1302wxTreeItemId wxTreeCtrl::GetSelection() const
1303{
ad90972f 1304 wxCHECK_MSG( !(m_windowStyle & wxTR_MULTIPLE), (long)(WXHTREEITEM)0,
223d09f6 1305 wxT("this only works with single selection controls") );
9dfbf520 1306
d220ae32 1307 return wxTreeItemId((WXHTREEITEM) TreeView_GetSelection(GetHwnd()));
2bda0e17
KB
1308}
1309
08b7c251 1310wxTreeItemId wxTreeCtrl::GetParent(const wxTreeItemId& item) const
2bda0e17 1311{
c9b142c9
VZ
1312 HTREEITEM hItem;
1313
1314 if ( IS_VIRTUAL_ROOT(item) )
1315 {
1316 // no parent for the virtual root
1317 hItem = 0;
1318 }
1319 else // normal item
a9c1265f 1320 {
c9b142c9
VZ
1321 hItem = TreeView_GetParent(GetHwnd(), HITEM(item));
1322 if ( !hItem && HasFlag(wxTR_HIDE_ROOT) )
1323 {
1324 // the top level items should have the virtual root as their parent
1325 hItem = TVI_ROOT;
1326 }
a9c1265f
VZ
1327 }
1328
1329 return wxTreeItemId((WXHTREEITEM)hItem);
08b7c251 1330}
2bda0e17 1331
08b7c251 1332wxTreeItemId wxTreeCtrl::GetFirstChild(const wxTreeItemId& item,
06e38c8e 1333 long& _cookie) const
08b7c251
VZ
1334{
1335 // remember the last child returned in 'cookie'
3f7bc32b 1336 _cookie = (long)TreeView_GetChild(GetHwnd(), HITEM(item));
2bda0e17 1337
06e38c8e 1338 return wxTreeItemId((WXHTREEITEM)_cookie);
2bda0e17
KB
1339}
1340
08b7c251 1341wxTreeItemId wxTreeCtrl::GetNextChild(const wxTreeItemId& WXUNUSED(item),
06e38c8e 1342 long& _cookie) const
2bda0e17 1343{
d220ae32 1344 wxTreeItemId l = wxTreeItemId((WXHTREEITEM)TreeView_GetNextSibling(GetHwnd(),
3f7bc32b 1345 HITEM(_cookie)));
23fd5130
VZ
1346 _cookie = (long)l;
1347
2e5dddb0 1348 return l;
08b7c251 1349}
2bda0e17 1350
978f38c2
VZ
1351wxTreeItemId wxTreeCtrl::GetLastChild(const wxTreeItemId& item) const
1352{
1353 // can this be done more efficiently?
1354 long cookie;
1355
1356 wxTreeItemId childLast,
2165ad93 1357 child = GetFirstChild(item, cookie);
978f38c2
VZ
1358 while ( child.IsOk() )
1359 {
1360 childLast = child;
2165ad93 1361 child = GetNextChild(item, cookie);
978f38c2
VZ
1362 }
1363
1364 return childLast;
1365}
1366
08b7c251
VZ
1367wxTreeItemId wxTreeCtrl::GetNextSibling(const wxTreeItemId& item) const
1368{
3f7bc32b 1369 return wxTreeItemId((WXHTREEITEM) TreeView_GetNextSibling(GetHwnd(), HITEM(item)));
2bda0e17
KB
1370}
1371
08b7c251 1372wxTreeItemId wxTreeCtrl::GetPrevSibling(const wxTreeItemId& item) const
2bda0e17 1373{
3f7bc32b 1374 return wxTreeItemId((WXHTREEITEM) TreeView_GetPrevSibling(GetHwnd(), HITEM(item)));
2bda0e17
KB
1375}
1376
08b7c251 1377wxTreeItemId wxTreeCtrl::GetFirstVisibleItem() const
2bda0e17 1378{
d220ae32 1379 return wxTreeItemId((WXHTREEITEM) TreeView_GetFirstVisible(GetHwnd()));
2bda0e17
KB
1380}
1381
08b7c251 1382wxTreeItemId wxTreeCtrl::GetNextVisible(const wxTreeItemId& item) const
2bda0e17 1383{
f6bcfd97 1384 wxASSERT_MSG( IsVisible(item), wxT("The item you call GetNextVisible() for must be visible itself!"));
02ce7b72 1385
3f7bc32b 1386 return wxTreeItemId((WXHTREEITEM) TreeView_GetNextVisible(GetHwnd(), HITEM(item)));
08b7c251 1387}
02ce7b72 1388
08b7c251
VZ
1389wxTreeItemId wxTreeCtrl::GetPrevVisible(const wxTreeItemId& item) const
1390{
f6bcfd97 1391 wxASSERT_MSG( IsVisible(item), wxT("The item you call GetPrevVisible() for must be visible itself!"));
02ce7b72 1392
3f7bc32b 1393 return wxTreeItemId((WXHTREEITEM) TreeView_GetPrevVisible(GetHwnd(), HITEM(item)));
08b7c251 1394}
02ce7b72 1395
9dfbf520
VZ
1396// ----------------------------------------------------------------------------
1397// multiple selections emulation
1398// ----------------------------------------------------------------------------
1399
1400bool wxTreeCtrl::IsItemChecked(const wxTreeItemId& item) const
1401{
1402 // receive the desired information.
1403 wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_STATEIMAGEMASK);
1404 DoGetItem(&tvItem);
1405
1406 // state image indices are 1 based
1407 return ((tvItem.state >> 12) - 1) == 1;
1408}
1409
1410void wxTreeCtrl::SetItemCheck(const wxTreeItemId& item, bool check)
1411{
1412 // receive the desired information.
1413 wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_STATEIMAGEMASK);
1414
a9c1265f
VZ
1415 DoGetItem(&tvItem);
1416
9dfbf520
VZ
1417 // state images are one-based
1418 tvItem.state = (check ? 2 : 1) << 12;
1419
1420 DoSetItem(&tvItem);
1421}
1422
33961d59
RR
1423size_t wxTreeCtrl::GetSelections(wxArrayTreeItemIds& selections) const
1424{
1425 TraverseSelections selector(this, selections);
9dfbf520 1426
e47c4d48 1427 return selector.GetCount();
9dfbf520
VZ
1428}
1429
08b7c251
VZ
1430// ----------------------------------------------------------------------------
1431// Usual operations
1432// ----------------------------------------------------------------------------
02ce7b72 1433
08b7c251
VZ
1434wxTreeItemId wxTreeCtrl::DoInsertItem(const wxTreeItemId& parent,
1435 wxTreeItemId hInsertAfter,
1436 const wxString& text,
1437 int image, int selectedImage,
1438 wxTreeItemData *data)
1439{
0e935169
VZ
1440 wxCHECK_MSG( parent.IsOk() || !TreeView_GetRoot(GetHwnd()),
1441 wxTreeItemId(),
1442 _T("can't have more than one root in the tree") );
1443
08b7c251 1444 TV_INSERTSTRUCT tvIns;
3f7bc32b
VZ
1445 tvIns.hParent = HITEM(parent);
1446 tvIns.hInsertAfter = HITEM(hInsertAfter);
58a8ab88 1447
74b31181
VZ
1448 // this is how we insert the item as the first child: supply a NULL
1449 // hInsertAfter
1450 if ( !tvIns.hInsertAfter )
58a8ab88
JS
1451 {
1452 tvIns.hInsertAfter = TVI_FIRST;
1453 }
1454
08b7c251
VZ
1455 UINT mask = 0;
1456 if ( !text.IsEmpty() )
1457 {
1458 mask |= TVIF_TEXT;
837e5743 1459 tvIns.item.pszText = (wxChar *)text.c_str(); // cast is ok
08b7c251 1460 }
f6bcfd97
BP
1461 else
1462 {
1463 tvIns.item.pszText = NULL;
1464 tvIns.item.cchTextMax = 0;
1465 }
02ce7b72 1466
08b7c251
VZ
1467 if ( image != -1 )
1468 {
1469 mask |= TVIF_IMAGE;
1470 tvIns.item.iImage = image;
3a5a2f56 1471
6b037754 1472 if ( selectedImage == -1 )
3a5a2f56
VZ
1473 {
1474 // take the same image for selected icon if not specified
1475 selectedImage = image;
1476 }
08b7c251 1477 }
02ce7b72 1478
08b7c251
VZ
1479 if ( selectedImage != -1 )
1480 {
1481 mask |= TVIF_SELECTEDIMAGE;
1482 tvIns.item.iSelectedImage = selectedImage;
1483 }
02ce7b72 1484
08b7c251
VZ
1485 if ( data != NULL )
1486 {
1487 mask |= TVIF_PARAM;
1488 tvIns.item.lParam = (LPARAM)data;
1489 }
02ce7b72 1490
08b7c251 1491 tvIns.item.mask = mask;
02ce7b72 1492
d220ae32 1493 HTREEITEM id = (HTREEITEM) TreeView_InsertItem(GetHwnd(), &tvIns);
08b7c251
VZ
1494 if ( id == 0 )
1495 {
f6bcfd97 1496 wxLogLastError(wxT("TreeView_InsertItem"));
08b7c251 1497 }
02ce7b72 1498
fd3f686c
VZ
1499 if ( data != NULL )
1500 {
1501 // associate the application tree item with Win32 tree item handle
1502 data->SetId((WXHTREEITEM)id);
1503 }
1504
06e38c8e 1505 return wxTreeItemId((WXHTREEITEM)id);
2bda0e17
KB
1506}
1507
08b7c251
VZ
1508// for compatibility only
1509wxTreeItemId wxTreeCtrl::InsertItem(const wxTreeItemId& parent,
1510 const wxString& text,
1511 int image, int selImage,
1512 long insertAfter)
2bda0e17 1513{
06e38c8e 1514 return DoInsertItem(parent, (WXHTREEITEM)insertAfter, text,
08b7c251 1515 image, selImage, NULL);
2bda0e17
KB
1516}
1517
08b7c251
VZ
1518wxTreeItemId wxTreeCtrl::AddRoot(const wxString& text,
1519 int image, int selectedImage,
1520 wxTreeItemData *data)
2bda0e17 1521{
a9c1265f
VZ
1522
1523 if ( m_windowStyle & wxTR_HIDE_ROOT )
1524 {
1525 // create a virtual root item, the parent for all the others
1526 m_pVirtualRoot = new wxVirtualNode(data);
1527
1528 return TVI_ROOT;
1529 }
1530
22fb32d5 1531 return DoInsertItem(wxTreeItemId((long)(WXHTREEITEM) 0), (long)(WXHTREEITEM) 0,
08b7c251 1532 text, image, selectedImage, data);
2bda0e17
KB
1533}
1534
08b7c251
VZ
1535wxTreeItemId wxTreeCtrl::PrependItem(const wxTreeItemId& parent,
1536 const wxString& text,
1537 int image, int selectedImage,
1538 wxTreeItemData *data)
2bda0e17 1539{
06e38c8e 1540 return DoInsertItem(parent, (WXHTREEITEM) TVI_FIRST,
08b7c251 1541 text, image, selectedImage, data);
2bda0e17
KB
1542}
1543
08b7c251
VZ
1544wxTreeItemId wxTreeCtrl::InsertItem(const wxTreeItemId& parent,
1545 const wxTreeItemId& idPrevious,
1546 const wxString& text,
1547 int image, int selectedImage,
1548 wxTreeItemData *data)
2bda0e17 1549{
08b7c251 1550 return DoInsertItem(parent, idPrevious, text, image, selectedImage, data);
2bda0e17
KB
1551}
1552
2ef31e80
VZ
1553wxTreeItemId wxTreeCtrl::InsertItem(const wxTreeItemId& parent,
1554 size_t index,
1555 const wxString& text,
1556 int image, int selectedImage,
1557 wxTreeItemData *data)
1558{
1559 // find the item from index
1560 long cookie;
1561 wxTreeItemId idPrev, idCur = GetFirstChild(parent, cookie);
1562 while ( index != 0 && idCur.IsOk() )
1563 {
1564 index--;
1565
1566 idPrev = idCur;
1567 idCur = GetNextChild(parent, cookie);
1568 }
1569
1570 // assert, not check: if the index is invalid, we will append the item
1571 // to the end
1572 wxASSERT_MSG( index == 0, _T("bad index in wxTreeCtrl::InsertItem") );
1573
1574 return DoInsertItem(parent, idPrev, text, image, selectedImage, data);
1575}
1576
08b7c251
VZ
1577wxTreeItemId wxTreeCtrl::AppendItem(const wxTreeItemId& parent,
1578 const wxString& text,
1579 int image, int selectedImage,
1580 wxTreeItemData *data)
2bda0e17 1581{
06e38c8e 1582 return DoInsertItem(parent, (WXHTREEITEM) TVI_LAST,
08b7c251 1583 text, image, selectedImage, data);
2bda0e17
KB
1584}
1585
08b7c251 1586void wxTreeCtrl::Delete(const wxTreeItemId& item)
2bda0e17 1587{
3f7bc32b 1588 if ( !TreeView_DeleteItem(GetHwnd(), HITEM(item)) )
bbcdf8bc 1589 {
f6bcfd97 1590 wxLogLastError(wxT("TreeView_DeleteItem"));
bbcdf8bc 1591 }
bbcdf8bc
JS
1592}
1593
23fd5130
VZ
1594// delete all children (but don't delete the item itself)
1595void wxTreeCtrl::DeleteChildren(const wxTreeItemId& item)
1596{
1597 long cookie;
1598
1599 wxArrayLong children;
1600 wxTreeItemId child = GetFirstChild(item, cookie);
1601 while ( child.IsOk() )
1602 {
1603 children.Add((long)(WXHTREEITEM)child);
1604
1605 child = GetNextChild(item, cookie);
1606 }
1607
1608 size_t nCount = children.Count();
1609 for ( size_t n = 0; n < nCount; n++ )
1610 {
d220ae32 1611 if ( !TreeView_DeleteItem(GetHwnd(), (HTREEITEM)children[n]) )
23fd5130 1612 {
f6bcfd97 1613 wxLogLastError(wxT("TreeView_DeleteItem"));
23fd5130
VZ
1614 }
1615 }
1616}
1617
08b7c251 1618void wxTreeCtrl::DeleteAllItems()
bbcdf8bc 1619{
a9c1265f
VZ
1620 // delete stored root item.
1621 delete GET_VIRTUAL_ROOT();
1622
d220ae32 1623 if ( !TreeView_DeleteAllItems(GetHwnd()) )
bbcdf8bc 1624 {
f6bcfd97 1625 wxLogLastError(wxT("TreeView_DeleteAllItems"));
bbcdf8bc 1626 }
2bda0e17
KB
1627}
1628
08b7c251 1629void wxTreeCtrl::DoExpand(const wxTreeItemId& item, int flag)
2bda0e17 1630{
dd3646fd
VZ
1631 wxASSERT_MSG( flag == TVE_COLLAPSE ||
1632 flag == (TVE_COLLAPSE | TVE_COLLAPSERESET) ||
1633 flag == TVE_EXPAND ||
1634 flag == TVE_TOGGLE,
223d09f6 1635 wxT("Unknown flag in wxTreeCtrl::DoExpand") );
08b7c251 1636
a9c1265f 1637 // A hidden root can be neither expanded nor collapsed.
e9616381 1638 wxCHECK_RET( !(m_windowStyle & wxTR_HIDE_ROOT) || (HITEM(item) != TVI_ROOT),
0d6a0101 1639 wxT("Can't expand/collapse hidden root node!") )
a9c1265f 1640
08b7c251 1641 // TreeView_Expand doesn't send TVN_ITEMEXPAND(ING) messages, so we must
d220ae32
VZ
1642 // emulate them. This behaviour has changed slightly with comctl32.dll
1643 // v 4.70 - now it does send them but only the first time. To maintain
1644 // compatible behaviour and also in order to not have surprises with the
1645 // future versions, don't rely on this and still do everything ourselves.
1646 // To avoid that the messages be sent twice when the item is expanded for
1647 // the first time we must clear TVIS_EXPANDEDONCE style manually.
1648
1649 wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_EXPANDEDONCE);
1650 tvItem.state = 0;
1651 DoSetItem(&tvItem);
1652
3f7bc32b 1653 if ( TreeView_Expand(GetHwnd(), HITEM(item), flag) != 0 )
08b7c251
VZ
1654 {
1655 wxTreeEvent event(wxEVT_NULL, m_windowId);
1656 event.m_item = item;
08b7c251 1657 event.SetEventObject(this);
2bda0e17 1658
deb1de30
VZ
1659 // note that the {EXPAND|COLLAPS}ING event is sent by TreeView_Expand()
1660 // itself
1661 event.SetEventType(gs_expandEvents[IsExpanded(item) ? IDX_EXPAND
1662 : IDX_COLLAPSE]
1663 [IDX_DONE]);
2bda0e17 1664
deb1de30 1665 (void)GetEventHandler()->ProcessEvent(event);
08b7c251 1666 }
d220ae32 1667 //else: change didn't took place, so do nothing at all
2bda0e17
KB
1668}
1669
08b7c251 1670void wxTreeCtrl::Expand(const wxTreeItemId& item)
2bda0e17 1671{
08b7c251 1672 DoExpand(item, TVE_EXPAND);
2bda0e17 1673}
2bda0e17 1674
08b7c251 1675void wxTreeCtrl::Collapse(const wxTreeItemId& item)
2bda0e17 1676{
08b7c251 1677 DoExpand(item, TVE_COLLAPSE);
2bda0e17
KB
1678}
1679
08b7c251 1680void wxTreeCtrl::CollapseAndReset(const wxTreeItemId& item)
2bda0e17 1681{
dd3646fd 1682 DoExpand(item, TVE_COLLAPSE | TVE_COLLAPSERESET);
2bda0e17
KB
1683}
1684
08b7c251 1685void wxTreeCtrl::Toggle(const wxTreeItemId& item)
2bda0e17 1686{
08b7c251 1687 DoExpand(item, TVE_TOGGLE);
2bda0e17
KB
1688}
1689
42c5812d
UU
1690void wxTreeCtrl::ExpandItem(const wxTreeItemId& item, int action)
1691{
9dfbf520 1692 DoExpand(item, action);
42c5812d
UU
1693}
1694
08b7c251 1695void wxTreeCtrl::Unselect()
2bda0e17 1696{
3f7bc32b
VZ
1697 wxASSERT_MSG( !(m_windowStyle & wxTR_MULTIPLE),
1698 wxT("doesn't make sense, may be you want UnselectAll()?") );
9dfbf520
VZ
1699
1700 // just remove the selection
ad90972f 1701 SelectItem(wxTreeItemId((long) (WXHTREEITEM) 0));
08b7c251 1702}
02ce7b72 1703
9dfbf520 1704void wxTreeCtrl::UnselectAll()
08b7c251 1705{
9dfbf520 1706 if ( m_windowStyle & wxTR_MULTIPLE )
2bda0e17 1707 {
9dfbf520
VZ
1708 wxArrayTreeItemIds selections;
1709 size_t count = GetSelections(selections);
1710 for ( size_t n = 0; n < count; n++ )
d220ae32 1711 {
3f7bc32b 1712#if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
9dfbf520 1713 SetItemCheck(selections[n], FALSE);
3f7bc32b
VZ
1714#else // !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
1715 ::UnselectItem(GetHwnd(), HITEM(selections[n]));
1716#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE/!wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
d220ae32 1717 }
9dfbf520
VZ
1718 }
1719 else
1720 {
1721 // just remove the selection
1722 Unselect();
1723 }
1724}
1725
1726void wxTreeCtrl::SelectItem(const wxTreeItemId& item)
1727{
1728 if ( m_windowStyle & wxTR_MULTIPLE )
1729 {
3f7bc32b 1730#if wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
9dfbf520
VZ
1731 // selecting the item means checking it
1732 SetItemCheck(item);
3f7bc32b
VZ
1733#else // !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
1734 ::SelectItem(GetHwnd(), HITEM(item));
1735#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE/!wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
9dfbf520
VZ
1736 }
1737 else
1738 {
1739 // inspite of the docs (MSDN Jan 99 edition), we don't seem to receive
1740 // the notification from the control (i.e. TVN_SELCHANG{ED|ING}), so
1741 // send them ourselves
1742
1743 wxTreeEvent event(wxEVT_NULL, m_windowId);
1744 event.m_item = item;
1745 event.SetEventObject(this);
1746
1747 event.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGING);
1748 if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
d220ae32 1749 {
3f7bc32b 1750 if ( !TreeView_SelectItem(GetHwnd(), HITEM(item)) )
9dfbf520 1751 {
f6bcfd97 1752 wxLogLastError(wxT("TreeView_SelectItem"));
9dfbf520
VZ
1753 }
1754 else
1755 {
1756 event.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED);
1757 (void)GetEventHandler()->ProcessEvent(event);
1758 }
d220ae32 1759 }
9dfbf520 1760 //else: program vetoed the change
2bda0e17 1761 }
08b7c251 1762}
2bda0e17 1763
08b7c251
VZ
1764void wxTreeCtrl::EnsureVisible(const wxTreeItemId& item)
1765{
1766 // no error return
3f7bc32b 1767 TreeView_EnsureVisible(GetHwnd(), HITEM(item));
08b7c251
VZ
1768}
1769
1770void wxTreeCtrl::ScrollTo(const wxTreeItemId& item)
1771{
3f7bc32b 1772 if ( !TreeView_SelectSetFirstVisible(GetHwnd(), HITEM(item)) )
2bda0e17 1773 {
f6bcfd97 1774 wxLogLastError(wxT("TreeView_SelectSetFirstVisible"));
2bda0e17 1775 }
08b7c251
VZ
1776}
1777
44fbc477 1778wxTextCtrl *wxTreeCtrl::GetEditControl() const
08b7c251
VZ
1779{
1780 return m_textCtrl;
1781}
1782
1783void wxTreeCtrl::DeleteTextCtrl()
1784{
1785 if ( m_textCtrl )
2bda0e17 1786 {
b6a3d6ad
VZ
1787 // the HWND corresponding to this control is deleted by the tree
1788 // control itself and we don't know when exactly this happens, so check
1789 // if the window still exists before calling UnsubclassWin()
1790 if ( !::IsWindow(GetHwndOf(m_textCtrl)) )
1791 {
1792 m_textCtrl->SetHWND(0);
1793 }
1794
08b7c251
VZ
1795 m_textCtrl->UnsubclassWin();
1796 m_textCtrl->SetHWND(0);
1797 delete m_textCtrl;
1798 m_textCtrl = NULL;
2bda0e17 1799 }
08b7c251 1800}
2bda0e17 1801
08b7c251
VZ
1802wxTextCtrl* wxTreeCtrl::EditLabel(const wxTreeItemId& item,
1803 wxClassInfo* textControlClass)
1804{
1805 wxASSERT( textControlClass->IsKindOf(CLASSINFO(wxTextCtrl)) );
1806
b94ae1ea
VZ
1807 DeleteTextCtrl();
1808
cd6bd270 1809 m_textCtrl = (wxTextCtrl *)textControlClass->CreateObject();
3f7bc32b 1810 HWND hWnd = (HWND) TreeView_EditLabel(GetHwnd(), HITEM(item));
2bda0e17 1811
5ea47806
VZ
1812 // this is not an error - the TVN_BEGINLABELEDIT handler might have
1813 // returned FALSE
1814 if ( !hWnd )
1815 {
cd6bd270
MB
1816 delete m_textCtrl;
1817 m_textCtrl = NULL;
5ea47806
VZ
1818 return NULL;
1819 }
2bda0e17 1820
cd6bd270 1821 // textctrl is subclassed in MSWOnNotify
08b7c251 1822 return m_textCtrl;
2bda0e17
KB
1823}
1824
08b7c251 1825// End label editing, optionally cancelling the edit
33ac7e6f 1826void wxTreeCtrl::EndEditLabel(const wxTreeItemId& WXUNUSED(item), bool discardChanges)
2bda0e17 1827{
d220ae32 1828 TreeView_EndEditLabelNow(GetHwnd(), discardChanges);
08b7c251
VZ
1829
1830 DeleteTextCtrl();
2bda0e17
KB
1831}
1832
08b7c251 1833wxTreeItemId wxTreeCtrl::HitTest(const wxPoint& point, int& flags)
2bda0e17 1834{
08b7c251
VZ
1835 TV_HITTESTINFO hitTestInfo;
1836 hitTestInfo.pt.x = (int)point.x;
1837 hitTestInfo.pt.y = (int)point.y;
2bda0e17 1838
d220ae32 1839 TreeView_HitTest(GetHwnd(), &hitTestInfo);
2bda0e17 1840
08b7c251
VZ
1841 flags = 0;
1842
1843 // avoid repetition
1844 #define TRANSLATE_FLAG(flag) if ( hitTestInfo.flags & TVHT_##flag ) \
1845 flags |= wxTREE_HITTEST_##flag
1846
1847 TRANSLATE_FLAG(ABOVE);
1848 TRANSLATE_FLAG(BELOW);
1849 TRANSLATE_FLAG(NOWHERE);
1850 TRANSLATE_FLAG(ONITEMBUTTON);
1851 TRANSLATE_FLAG(ONITEMICON);
1852 TRANSLATE_FLAG(ONITEMINDENT);
1853 TRANSLATE_FLAG(ONITEMLABEL);
1854 TRANSLATE_FLAG(ONITEMRIGHT);
1855 TRANSLATE_FLAG(ONITEMSTATEICON);
1856 TRANSLATE_FLAG(TOLEFT);
1857 TRANSLATE_FLAG(TORIGHT);
2bda0e17 1858
08b7c251
VZ
1859 #undef TRANSLATE_FLAG
1860
06e38c8e 1861 return wxTreeItemId((WXHTREEITEM) hitTestInfo.hItem);
08b7c251
VZ
1862}
1863
f7c832a7
VZ
1864bool wxTreeCtrl::GetBoundingRect(const wxTreeItemId& item,
1865 wxRect& rect,
1866 bool textOnly) const
1867{
1868 RECT rc;
3f7bc32b 1869 if ( TreeView_GetItemRect(GetHwnd(), HITEM(item),
f7c832a7
VZ
1870 &rc, textOnly) )
1871 {
1872 rect = wxRect(wxPoint(rc.left, rc.top), wxPoint(rc.right, rc.bottom));
1873
1874 return TRUE;
1875 }
1876 else
1877 {
1878 // couldn't retrieve rect: for example, item isn't visible
1879 return FALSE;
1880 }
1881}
1882
23fd5130
VZ
1883// ----------------------------------------------------------------------------
1884// sorting stuff
1885// ----------------------------------------------------------------------------
f7c832a7 1886
502a2b18
VZ
1887// this is just a tiny namespace which is friend to wxTreeCtrl and so can use
1888// functions such as IsDataIndirect()
1889class wxTreeSortHelper
1890{
1891public:
1892 static int CALLBACK Compare(LPARAM data1, LPARAM data2, LPARAM tree);
1893
1894private:
1895 static wxTreeItemId GetIdFromData(wxTreeCtrl *tree, LPARAM item)
1896 {
1897 wxTreeItemData *data = (wxTreeItemData *)item;
1898 if ( tree->IsDataIndirect(data) )
1899 {
1900 data = ((wxTreeItemIndirectData *)data)->GetData();
1901 }
1902
1903 return data->GetId();
1904 }
1905};
1906
1907int CALLBACK wxTreeSortHelper::Compare(LPARAM pItem1,
1908 LPARAM pItem2,
1909 LPARAM htree)
23fd5130 1910{
096c9f9b 1911 wxCHECK_MSG( pItem1 && pItem2, 0,
223d09f6 1912 wxT("sorting tree without data doesn't make sense") );
096c9f9b 1913
502a2b18
VZ
1914 wxTreeCtrl *tree = (wxTreeCtrl *)htree;
1915
1916 return tree->OnCompareItems(GetIdFromData(tree, pItem1),
1917 GetIdFromData(tree, pItem2));
23fd5130
VZ
1918}
1919
95aabccc
VZ
1920int wxTreeCtrl::OnCompareItems(const wxTreeItemId& item1,
1921 const wxTreeItemId& item2)
08b7c251 1922{
837e5743 1923 return wxStrcmp(GetItemText(item1), GetItemText(item2));
95aabccc
VZ
1924}
1925
1926void wxTreeCtrl::SortChildren(const wxTreeItemId& item)
1927{
1928 // rely on the fact that TreeView_SortChildren does the same thing as our
23fd5130
VZ
1929 // default behaviour, i.e. sorts items alphabetically and so call it
1930 // directly if we're not in derived class (much more efficient!)
1931 if ( GetClassInfo() == CLASSINFO(wxTreeCtrl) )
2bda0e17 1932 {
3f7bc32b 1933 TreeView_SortChildren(GetHwnd(), HITEM(item), 0);
2bda0e17 1934 }
08b7c251 1935 else
2bda0e17 1936 {
62448488 1937 TV_SORTCB tvSort;
3f7bc32b 1938 tvSort.hParent = HITEM(item);
502a2b18 1939 tvSort.lpfnCompare = wxTreeSortHelper::Compare;
23fd5130 1940 tvSort.lParam = (LPARAM)this;
d220ae32 1941 TreeView_SortChildrenCB(GetHwnd(), &tvSort, 0 /* reserved */);
2bda0e17 1942 }
08b7c251 1943}
2bda0e17 1944
08b7c251
VZ
1945// ----------------------------------------------------------------------------
1946// implementation
1947// ----------------------------------------------------------------------------
2bda0e17 1948
08b7c251
VZ
1949bool wxTreeCtrl::MSWCommand(WXUINT cmd, WXWORD id)
1950{
1951 if ( cmd == EN_UPDATE )
2bda0e17 1952 {
08b7c251
VZ
1953 wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, id);
1954 event.SetEventObject( this );
1955 ProcessCommand(event);
2bda0e17 1956 }
08b7c251 1957 else if ( cmd == EN_KILLFOCUS )
2bda0e17 1958 {
08b7c251
VZ
1959 wxCommandEvent event(wxEVT_KILL_FOCUS, id);
1960 event.SetEventObject( this );
1961 ProcessCommand(event);
2bda0e17 1962 }
08b7c251 1963 else
2bda0e17 1964 {
08b7c251
VZ
1965 // nothing done
1966 return FALSE;
2bda0e17 1967 }
08b7c251
VZ
1968
1969 // command processed
1970 return TRUE;
1971}
1972
23f681ec
VZ
1973// we hook into WndProc to process WM_MOUSEMOVE/WM_BUTTONUP messages - as we
1974// only do it during dragging, minimize wxWin overhead (this is important for
1975// WM_MOUSEMOVE as they're a lot of them) by catching Windows messages directly
1976// instead of passing by wxWin events
1977long wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
1978{
3f7bc32b
VZ
1979 bool processed = FALSE;
1980 long rc = 0;
3f7bc32b
VZ
1981 bool isMultiple = (GetWindowStyle() & wxTR_MULTIPLE) != 0;
1982
1983 if ( (nMsg >= WM_MOUSEFIRST) && (nMsg <= WM_MOUSELAST) )
23f681ec 1984 {
3f7bc32b
VZ
1985 // we only process mouse messages here and these parameters have the same
1986 // meaning for all of them
1987 int x = GET_X_LPARAM(lParam),
1988 y = GET_Y_LPARAM(lParam);
1989 HTREEITEM htItem = GetItemFromPoint(GetHwnd(), x, y);
1990
23f681ec
VZ
1991 switch ( nMsg )
1992 {
3f7bc32b
VZ
1993#if !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
1994 case WM_LBUTTONDOWN:
1995 if ( htItem && isMultiple )
23f681ec 1996 {
3f7bc32b
VZ
1997 if ( wParam & MK_CONTROL )
1998 {
1999 SetFocus();
23f681ec 2000
3f7bc32b
VZ
2001 // toggle selected state
2002 ToggleItemSelection(GetHwnd(), htItem);
2003
2004 ::SetFocus(GetHwnd(), htItem);
2005
2006 // reset on any click without Shift
2007 m_htSelStart = 0;
2008
2009 processed = TRUE;
2010 }
2011 else if ( wParam & MK_SHIFT )
2012 {
2013 // this selects all items between the starting one and
2014 // the current
2015
2016 if ( !m_htSelStart )
2017 {
2018 // take the focused item
2019 m_htSelStart = (WXHTREEITEM)
2020 TreeView_GetSelection(GetHwnd());
2021 }
2022
2023 SelectRange(GetHwnd(), HITEM(m_htSelStart), htItem,
2024 !(wParam & MK_CONTROL));
2025
2026 ::SetFocus(GetHwnd(), htItem);
23f681ec 2027
3f7bc32b
VZ
2028 processed = TRUE;
2029 }
2030 else // normal click
2031 {
2032 // clear the selection and then let the default handler
2033 // do the job
2034 UnselectAll();
2035
2036 // prevent the click from starting in-place editing
2037 // when there was no selection in the control
2038 TreeView_SelectItem(GetHwnd(), 0);
2039
2040 // reset on any click without Shift
2041 m_htSelStart = 0;
2042 }
2043 }
2044 break;
2045#endif // wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
2046
2047 case WM_MOUSEMOVE:
2048 if ( m_dragImage )
2049 {
afff720b 2050 m_dragImage->Move(wxPoint(x, y));
3f7bc32b 2051 if ( htItem )
23f681ec
VZ
2052 {
2053 // highlight the item as target (hiding drag image is
2054 // necessary - otherwise the display will be corrupted)
68be9f09 2055 m_dragImage->Hide();
3f7bc32b 2056 TreeView_SelectDropTarget(GetHwnd(), htItem);
68be9f09 2057 m_dragImage->Show();
23f681ec
VZ
2058 }
2059 }
2060 break;
2061
2062 case WM_LBUTTONUP:
2063 case WM_RBUTTONUP:
3f7bc32b 2064 if ( m_dragImage )
23f681ec 2065 {
68be9f09 2066 m_dragImage->EndDrag();
23f681ec
VZ
2067 delete m_dragImage;
2068 m_dragImage = NULL;
2069
2070 // generate the drag end event
2071 wxTreeEvent event(wxEVT_COMMAND_TREE_END_DRAG, m_windowId);
2072
3f7bc32b 2073 event.m_item = (WXHTREEITEM)htItem;
23f681ec
VZ
2074 event.m_pointDrag = wxPoint(x, y);
2075 event.SetEventObject(this);
2076
2077 (void)GetEventHandler()->ProcessEvent(event);
225fe9d6
VZ
2078
2079 // if we don't do it, the tree seems to think that 2 items
2080 // are selected simultaneously which is quite weird
2081 TreeView_SelectDropTarget(GetHwnd(), 0);
23f681ec
VZ
2082 }
2083 break;
2084 }
2085 }
3f7bc32b
VZ
2086#if !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
2087 else if ( (nMsg == WM_SETFOCUS || nMsg == WM_KILLFOCUS) && isMultiple )
2088 {
2089 // the tree control greys out the selected item when it loses focus and
2090 // paints it as selected again when it regains it, but it won't do it
2091 // for the other items itself - help it
2092 wxArrayTreeItemIds selections;
2093 size_t count = GetSelections(selections);
2094 RECT rect;
2095 for ( size_t n = 0; n < count; n++ )
2096 {
2097 // TreeView_GetItemRect() will return FALSE if item is not visible,
2098 // which may happen perfectly well
2099 if ( TreeView_GetItemRect(GetHwnd(), HITEM(selections[n]),
2100 &rect, TRUE) )
2101 {
2102 ::InvalidateRect(GetHwnd(), &rect, FALSE);
2103 }
2104 }
2105 }
2106 else if ( nMsg == WM_KEYDOWN && isMultiple )
2107 {
2108 bool bCtrl = wxIsCtrlDown(),
2109 bShift = wxIsShiftDown();
2110
2111 // we handle.arrows and space, but not page up/down and home/end: the
2112 // latter should be easy, but not the former
2113
2c8e4738 2114 HTREEITEM htSel = (HTREEITEM)TreeView_GetSelection(GetHwnd());
3f7bc32b
VZ
2115 if ( !m_htSelStart )
2116 {
2117 m_htSelStart = (WXHTREEITEM)htSel;
2118 }
2119
2120 if ( wParam == VK_SPACE )
2121 {
2122 if ( bCtrl )
2123 {
2124 ToggleItemSelection(GetHwnd(), htSel);
2125 }
2126 else
2127 {
2128 UnselectAll();
2129
2130 ::SelectItem(GetHwnd(), htSel);
2131 }
23f681ec 2132
3f7bc32b
VZ
2133 processed = TRUE;
2134 }
2135 else if ( wParam == VK_UP || wParam == VK_DOWN )
2136 {
2137 if ( !bCtrl && !bShift )
2138 {
2139 // no modifiers, just clear selection and then let the default
2140 // processing to take place
2141 UnselectAll();
2142 }
2143 else if ( htSel )
2144 {
2145 (void)wxControl::MSWWindowProc(nMsg, wParam, lParam);
2146
2c8e4738
VZ
2147 HTREEITEM htNext = (HTREEITEM)(wParam == VK_UP
2148 ? TreeView_GetPrevVisible(GetHwnd(), htSel)
2149 : TreeView_GetNextVisible(GetHwnd(), htSel));
3f7bc32b
VZ
2150
2151 if ( !htNext )
2152 {
2153 // at the top/bottom
2154 htNext = htSel;
2155 }
2156
2157 if ( bShift )
2158 {
2159 SelectRange(GetHwnd(), HITEM(m_htSelStart), htNext);
2160 }
2161 else // bCtrl
2162 {
2163 // without changing selection
2164 ::SetFocus(GetHwnd(), htNext);
2165 }
2166
2167 processed = TRUE;
2168 }
2169 }
2170 }
2171#endif // !wxUSE_CHECKBOXES_IN_MULTI_SEL_TREE
3f7bc32b
VZ
2172 if ( !processed )
2173 rc = wxControl::MSWWindowProc(nMsg, wParam, lParam);
2174
2175 return rc;
23f681ec
VZ
2176}
2177
08b7c251 2178// process WM_NOTIFY Windows message
a23fd0e1 2179bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
08b7c251
VZ
2180{
2181 wxTreeEvent event(wxEVT_NULL, m_windowId);
2182 wxEventType eventType = wxEVT_NULL;
2183 NMHDR *hdr = (NMHDR *)lParam;
2184
2185 switch ( hdr->code )
2bda0e17 2186 {
08b7c251
VZ
2187 case TVN_BEGINDRAG:
2188 eventType = wxEVT_COMMAND_TREE_BEGIN_DRAG;
2189 // fall through
2190
2191 case TVN_BEGINRDRAG:
2192 {
2193 if ( eventType == wxEVT_NULL )
2194 eventType = wxEVT_COMMAND_TREE_BEGIN_RDRAG;
2195 //else: left drag, already set above
2196
2197 NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam;
2198
06e38c8e 2199 event.m_item = (WXHTREEITEM) tv->itemNew.hItem;
08b7c251 2200 event.m_pointDrag = wxPoint(tv->ptDrag.x, tv->ptDrag.y);
23f681ec
VZ
2201
2202 // don't allow dragging by default: the user code must
2203 // explicitly say that it wants to allow it to avoid breaking
2204 // the old apps
2205 event.Veto();
08b7c251 2206 }
696e1ea0 2207 break;
08b7c251
VZ
2208
2209 case TVN_BEGINLABELEDIT:
2210 {
2211 eventType = wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT;
2212 TV_DISPINFO *info = (TV_DISPINFO *)lParam;
2213
06e38c8e 2214 event.m_item = (WXHTREEITEM) info->item.hItem;
5ea47806 2215 event.m_label = info->item.pszText;
08b7c251 2216 }
696e1ea0 2217 break;
08b7c251
VZ
2218
2219 case TVN_DELETEITEM:
2220 {
2221 eventType = wxEVT_COMMAND_TREE_DELETE_ITEM;
2222 NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam;
2223
696e1ea0
VZ
2224 event.m_item = (WXHTREEITEM)tv->itemOld.hItem;
2225
2226 if ( m_hasAnyAttr )
2227 {
2228 delete (wxTreeItemAttr *)m_attrs.
2229 Delete((long)tv->itemOld.hItem);
2230 }
08b7c251 2231 }
696e1ea0 2232 break;
08b7c251
VZ
2233
2234 case TVN_ENDLABELEDIT:
2235 {
2236 eventType = wxEVT_COMMAND_TREE_END_LABEL_EDIT;
2237 TV_DISPINFO *info = (TV_DISPINFO *)lParam;
2238
5ea47806
VZ
2239 event.m_item = (WXHTREEITEM)info->item.hItem;
2240 event.m_label = info->item.pszText;
1ee4ead5
VZ
2241 if (info->item.pszText == NULL)
2242 return FALSE;
08b7c251
VZ
2243 break;
2244 }
2245
2246 case TVN_GETDISPINFO:
2247 eventType = wxEVT_COMMAND_TREE_GET_INFO;
2248 // fall through
2249
2250 case TVN_SETDISPINFO:
2251 {
2252 if ( eventType == wxEVT_NULL )
2253 eventType = wxEVT_COMMAND_TREE_SET_INFO;
2254 //else: get, already set above
2255
2256 TV_DISPINFO *info = (TV_DISPINFO *)lParam;
2257
06e38c8e 2258 event.m_item = (WXHTREEITEM) info->item.hItem;
08b7c251
VZ
2259 break;
2260 }
2261
2262 case TVN_ITEMEXPANDING:
08b7c251
VZ
2263 case TVN_ITEMEXPANDED:
2264 {
2265 NM_TREEVIEW* tv = (NM_TREEVIEW*)lParam;
2266
deb1de30 2267 int what;
08b7c251
VZ
2268 switch ( tv->action )
2269 {
deb1de30
VZ
2270 default:
2271 wxLogDebug(wxT("unexpected code %d in TVN_ITEMEXPAND message"), tv->action);
2272 // fall through
2273
08b7c251 2274 case TVE_EXPAND:
deb1de30 2275 what = IDX_EXPAND;
08b7c251
VZ
2276 break;
2277
2278 case TVE_COLLAPSE:
deb1de30 2279 what = IDX_COLLAPSE;
08b7c251 2280 break;
08b7c251
VZ
2281 }
2282
deb1de30
VZ
2283 int how = (int)hdr->code == TVN_ITEMEXPANDING ? IDX_DOING
2284 : IDX_DONE;
2285
2286 eventType = gs_expandEvents[what][how];
08b7c251 2287
06e38c8e 2288 event.m_item = (WXHTREEITEM) tv->itemNew.hItem;
08b7c251 2289 }
696e1ea0 2290 break;
08b7c251
VZ
2291
2292 case TVN_KEYDOWN:
2293 {
2294 eventType = wxEVT_COMMAND_TREE_KEY_DOWN;
2295 TV_KEYDOWN *info = (TV_KEYDOWN *)lParam;
2296
9c7df356 2297 // we pass 0 as 2 last CreateKeyEvent() parameters because we
b09bda68
VZ
2298 // don't have access to the real key press flags here - but as
2299 // it is only used to determin wxKeyEvent::m_altDown flag it's
2300 // not too bad
8191741f 2301 event.m_evtKey = CreateKeyEvent(wxEVT_KEY_DOWN,
9c7df356 2302 wxCharCodeMSWToWX(info->wVKey));
23fd5130 2303
3f7bc32b
VZ
2304 // a separate event for Space/Return
2305 if ( !wxIsCtrlDown() && !wxIsShiftDown() &&
2306 ((info->wVKey == VK_SPACE) || (info->wVKey == VK_RETURN)) )
23fd5130
VZ
2307 {
2308 wxTreeEvent event2(wxEVT_COMMAND_TREE_ITEM_ACTIVATED,
2309 m_windowId);
2310 event2.SetEventObject(this);
3f7bc32b
VZ
2311 if ( !(GetWindowStyle() & wxTR_MULTIPLE) )
2312 {
2313 event2.m_item = GetSelection();
2314 }
2315 //else: don't know how to get it
23fd5130 2316
3f7bc32b 2317 (void)GetEventHandler()->ProcessEvent(event2);
23fd5130 2318 }
08b7c251 2319 }
696e1ea0 2320 break;
08b7c251
VZ
2321
2322 case TVN_SELCHANGED:
2323 eventType = wxEVT_COMMAND_TREE_SEL_CHANGED;
2324 // fall through
2325
2326 case TVN_SELCHANGING:
2327 {
2328 if ( eventType == wxEVT_NULL )
2329 eventType = wxEVT_COMMAND_TREE_SEL_CHANGING;
2330 //else: already set above
2331
2332 NM_TREEVIEW* tv = (NM_TREEVIEW *)lParam;
2333
06e38c8e
JS
2334 event.m_item = (WXHTREEITEM) tv->itemNew.hItem;
2335 event.m_itemOld = (WXHTREEITEM) tv->itemOld.hItem;
08b7c251 2336 }
696e1ea0
VZ
2337 break;
2338
bf9b6266 2339#if defined(_WIN32_IE) && _WIN32_IE >= 0x300 && !wxUSE_COMCTL32_SAFELY && !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 0 ) )
696e1ea0
VZ
2340 case NM_CUSTOMDRAW:
2341 {
2342 LPNMTVCUSTOMDRAW lptvcd = (LPNMTVCUSTOMDRAW)lParam;
2343 NMCUSTOMDRAW& nmcd = lptvcd->nmcd;
d7926e0b 2344 switch ( nmcd.dwDrawStage )
696e1ea0
VZ
2345 {
2346 case CDDS_PREPAINT:
2347 // if we've got any items with non standard attributes,
2348 // notify us before painting each item
2349 *result = m_hasAnyAttr ? CDRF_NOTIFYITEMDRAW
2350 : CDRF_DODEFAULT;
d7926e0b 2351 break;
696e1ea0
VZ
2352
2353 case CDDS_ITEMPREPAINT:
2354 {
2355 wxTreeItemAttr *attr =
2356 (wxTreeItemAttr *)m_attrs.Get(nmcd.dwItemSpec);
2357
2358 if ( !attr )
2359 {
2360 // nothing to do for this item
d7926e0b
VZ
2361 *result = CDRF_DODEFAULT;
2362 break;
696e1ea0
VZ
2363 }
2364
2365 HFONT hFont;
2366 wxColour colText, colBack;
2367 if ( attr->HasFont() )
2368 {
2369 wxFont font = attr->GetFont();
2370 hFont = (HFONT)font.GetResourceHandle();
2371 }
2372 else
2373 {
2374 hFont = 0;
2375 }
2376
2377 if ( attr->HasTextColour() )
2378 {
2379 colText = attr->GetTextColour();
2380 }
2381 else
2382 {
2383 colText = GetForegroundColour();
2384 }
2385
2386 // selection colours should override ours
2387 if ( nmcd.uItemState & CDIS_SELECTED )
2388 {
2389 DWORD clrBk = ::GetSysColor(COLOR_HIGHLIGHT);
2390 lptvcd->clrTextBk = clrBk;
2391
2392 // try to make the text visible
2393 lptvcd->clrText = wxColourToRGB(colText);
2394 lptvcd->clrText |= ~clrBk;
2395 lptvcd->clrText &= 0x00ffffff;
2396 }
2397 else
2398 {
2399 if ( attr->HasBackgroundColour() )
2400 {
2401 colBack = attr->GetBackgroundColour();
2402 }
2403 else
2404 {
2405 colBack = GetBackgroundColour();
2406 }
2407
2408 lptvcd->clrText = wxColourToRGB(colText);
2409 lptvcd->clrTextBk = wxColourToRGB(colBack);
2410 }
2411
2412 // note that if we wanted to set colours for
2413 // individual columns (subitems), we would have
2414 // returned CDRF_NOTIFYSUBITEMREDRAW from here
2415 if ( hFont )
2416 {
2417 ::SelectObject(nmcd.hdc, hFont);
2418
2419 *result = CDRF_NEWFONT;
2420 }
2421 else
2422 {
2423 *result = CDRF_DODEFAULT;
2424 }
696e1ea0 2425 }
d7926e0b 2426 break;
696e1ea0
VZ
2427
2428 default:
2429 *result = CDRF_DODEFAULT;
696e1ea0
VZ
2430 }
2431 }
d7926e0b
VZ
2432
2433 // we always process it
2434 return TRUE;
6ecfe2ac 2435#endif // _WIN32_IE >= 0x300
08b7c251 2436
f6bcfd97
BP
2437 case NM_DBLCLK:
2438 case NM_RCLICK:
2439 {
2440 TV_HITTESTINFO tvhti;
2441 ::GetCursorPos(&tvhti.pt);
2442 ::ScreenToClient(GetHwnd(), &tvhti.pt);
2443 if ( TreeView_HitTest(GetHwnd(), &tvhti) )
2444 {
2445 if ( tvhti.flags & TVHT_ONITEM )
2446 {
2447 event.m_item = (WXHTREEITEM) tvhti.hItem;
2448 eventType = (int)hdr->code == NM_DBLCLK
2449 ? wxEVT_COMMAND_TREE_ITEM_ACTIVATED
2450 : wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK;
8591268f
VZ
2451
2452 event.m_pointDrag.x = tvhti.pt.x;
2453 event.m_pointDrag.y = tvhti.pt.y;
f6bcfd97
BP
2454 }
2455
2456 break;
2457 }
2458 }
2459 // fall through
2460
08b7c251 2461 default:
a23fd0e1 2462 return wxControl::MSWOnNotify(idCtrl, lParam, result);
2bda0e17 2463 }
08b7c251
VZ
2464
2465 event.SetEventObject(this);
2466 event.SetEventType(eventType);
2467
fd3f686c 2468 bool processed = GetEventHandler()->ProcessEvent(event);
08b7c251
VZ
2469
2470 // post processing
5ea47806 2471 switch ( hdr->code )
2bda0e17 2472 {
f6bcfd97
BP
2473 case NM_DBLCLK:
2474 // we translate NM_DBLCLK into ACTIVATED event, so don't interpret
2475 // the return code of this event handler as the return value for
2476 // NM_DBLCLK - otherwise, double clicking the item to toggle its
2477 // expanded status would never work
2478 *result = FALSE;
2479 break;
2480
23f681ec
VZ
2481 case TVN_BEGINDRAG:
2482 case TVN_BEGINRDRAG:
2483 if ( event.IsAllowed() )
2484 {
2485 // normally this is impossible because the m_dragImage is
2486 // deleted once the drag operation is over
2487 wxASSERT_MSG( !m_dragImage, _T("starting to drag once again?") );
2488
2489 m_dragImage = new wxDragImage(*this, event.m_item);
2490 m_dragImage->BeginDrag(wxPoint(0, 0), this);
68be9f09 2491 m_dragImage->Show();
23f681ec
VZ
2492 }
2493 break;
2494
5ea47806
VZ
2495 case TVN_DELETEITEM:
2496 {
2497 // NB: we might process this message using wxWindows event
2498 // tables, but due to overhead of wxWin event system we
2499 // prefer to do it here ourself (otherwise deleting a tree
2500 // with many items is just too slow)
2501 NM_TREEVIEW* tv = (NM_TREEVIEW *)lParam;
74b31181
VZ
2502
2503 wxTreeItemId item = event.m_item;
2504 if ( HasIndirectData(item) )
2505 {
2506 wxTreeItemIndirectData *data = (wxTreeItemIndirectData *)
2507 tv->itemOld.lParam;
2508 delete data; // can't be NULL here
74b31181
VZ
2509 }
2510 else
2511 {
2512 wxTreeItemData *data = (wxTreeItemData *)tv->itemOld.lParam;
2513 delete data; // may be NULL, ok
2514 }
08b7c251 2515
5ea47806
VZ
2516 processed = TRUE; // Make sure we don't get called twice
2517 }
2518 break;
2519
2520 case TVN_BEGINLABELEDIT:
2521 // return TRUE to cancel label editing
2522 *result = !event.IsAllowed();
cd6bd270
MB
2523 // set ES_WANTRETURN ( like we do in BeginLabelEdit )
2524 if(event.IsAllowed())
2525 {
2526 HWND hText = TreeView_GetEditControl(GetHwnd());
2527 if(hText != NULL)
2528 {
2529 // MBN: if m_textCtrl already has an HWND, it is a stale
2530 // pointer from a previous edit (because the user
2531 // didn't modify the label before dismissing the control,
2532 // and TVN_ENDLABELEDIT was not sent), so delete it
2533 if(m_textCtrl && m_textCtrl->GetHWND() != 0)
2534 DeleteTextCtrl();
2535 if(!m_textCtrl)
2536 m_textCtrl = new wxTextCtrl();
2537 m_textCtrl->SetParent(this);
2538 m_textCtrl->SetHWND((WXHWND)hText);
2539 m_textCtrl->SubclassWin((WXHWND)hText);
2540
2541 // set wxTE_PROCESS_ENTER style for the text control to
2542 // force it to process the Enter presses itself, otherwise
2543 // they could be stolen from it by the dialog
2544 // navigation code
2545 m_textCtrl->SetWindowStyle(m_textCtrl->GetWindowStyle()
2546 | wxTE_PROCESS_ENTER);
2547 }
2548 }
5ea47806
VZ
2549 break;
2550
2551 case TVN_ENDLABELEDIT:
188781db
VZ
2552 // return TRUE to set the label to the new string: note that we
2553 // also must pretend that we did process the message or it is going
2554 // to be passed to DefWindowProc() which will happily return FALSE
2555 // cancelling the label change
5ea47806 2556 *result = event.IsAllowed();
188781db 2557 processed = TRUE;
5ea47806
VZ
2558
2559 // ensure that we don't have the text ctrl which is going to be
2560 // deleted any more
2561 DeleteTextCtrl();
2562 break;
2563
2564 case TVN_SELCHANGING:
2565 case TVN_ITEMEXPANDING:
2566 // return TRUE to prevent the action from happening
2567 *result = !event.IsAllowed();
2568 break;
2569
deb1de30
VZ
2570 case TVN_ITEMEXPANDED:
2571 // the item is not refreshed properly after expansion when it has
2572 // an image depending on the expanded/collapsed state - bug in
2573 // comctl32.dll or our code?
2574 {
bf43d750
VZ
2575 NM_TREEVIEW* tv = (NM_TREEVIEW *)lParam;
2576 wxTreeItemId id = (WXHTREEITEM)tv->itemNew.hItem;
deb1de30 2577
bf43d750
VZ
2578 int image = GetItemImage(id, wxTreeItemIcon_Expanded);
2579 if ( image != -1 )
2580 {
2581 RefreshItem(id);
deb1de30
VZ
2582 }
2583 }
2584 break;
2585
74b31181
VZ
2586 case TVN_GETDISPINFO:
2587 // NB: so far the user can't set the image himself anyhow, so do it
2588 // anyway - but this may change later
bf43d750 2589 //if ( /* !processed && */ 1 )
74b31181
VZ
2590 {
2591 wxTreeItemId item = event.m_item;
2592 TV_DISPINFO *info = (TV_DISPINFO *)lParam;
2593 if ( info->item.mask & TVIF_IMAGE )
2594 {
2595 info->item.iImage =
2596 DoGetItemImageFromData
2597 (
2598 item,
2599 IsExpanded(item) ? wxTreeItemIcon_Expanded
2600 : wxTreeItemIcon_Normal
2601 );
2602 }
2603 if ( info->item.mask & TVIF_SELECTEDIMAGE )
2604 {
2605 info->item.iSelectedImage =
2606 DoGetItemImageFromData
2607 (
2608 item,
2609 IsExpanded(item) ? wxTreeItemIcon_SelectedExpanded
2610 : wxTreeItemIcon_Selected
2611 );
2612 }
deb1de30 2613 }
74b31181
VZ
2614 break;
2615
5ea47806
VZ
2616 //default:
2617 // for the other messages the return value is ignored and there is
2618 // nothing special to do
2619 }
fd3f686c 2620 return processed;
2bda0e17
KB
2621}
2622
08b7c251 2623#endif // __WIN95__
2bda0e17 2624
1e6feb95 2625#endif // wxUSE_TREECTRL