]> git.saurik.com Git - wxWidgets.git/blame - src/msw/treectrl.cpp
Compilo after wxVideoMode change, MSW part
[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
65571936 9// Licence: wxWindows licence
b823f5a1 10/////////////////////////////////////////////////////////////////////////////
2bda0e17 11
08b7c251
VZ
12// ============================================================================
13// declarations
14// ============================================================================
15
16// ----------------------------------------------------------------------------
17// headers
18// ----------------------------------------------------------------------------
1e6feb95 19
2bda0e17
KB
20// For compilers that support precompilation, includes "wx.h".
21#include "wx/wxprec.h"
22
23#ifdef __BORLANDC__
08b7c251 24 #pragma hdrstop
2bda0e17
KB
25#endif
26
1e6feb95
VZ
27#if wxUSE_TREECTRL
28
e4db172a
WS
29#include "wx/treectrl.h"
30
ad9835c9 31#ifndef WX_PRECOMP
57bd4c60
WS
32 #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
33 #include "wx/msw/missing.h"
ad9835c9 34 #include "wx/dynarray.h"
e4db172a 35 #include "wx/log.h"
670f9935 36 #include "wx/app.h"
9eddec69 37 #include "wx/settings.h"
ad9835c9
WS
38#endif
39
2f17da8b
WS
40#include "wx/msw/private.h"
41
1e6feb95
VZ
42// Set this to 1 to be _absolutely_ sure that repainting will work for all
43// comctl32.dll versions
f6bcfd97
BP
44#define wxUSE_COMCTL32_SAFELY 0
45
08b7c251 46#include "wx/imaglist.h"
23f681ec
VZ
47#include "wx/msw/dragimag.h"
48
f888d614
VZ
49// macros to hide the cast ugliness
50// --------------------------------
51
14ba002a
VZ
52// get HTREEITEM from wxTreeItemId
53#define HITEM(item) ((HTREEITEM)(((item).m_pItem)))
3f7bc32b 54
5fe302ef
BW
55
56// older SDKs are missing these
57#ifndef TVN_ITEMCHANGINGA
58
59#define TVN_ITEMCHANGINGA (TVN_FIRST-16)
60#define TVN_ITEMCHANGINGW (TVN_FIRST-17)
61
62typedef struct tagNMTVITEMCHANGE
63{
64 NMHDR hdr;
65 UINT uChanged;
66 HTREEITEM hItem;
67 UINT uStateNew;
68 UINT uStateOld;
69 LPARAM lParam;
70} NMTVITEMCHANGE;
71
72#endif
73
74
396f85ba
BW
75// this helper class is used on vista systems for preventing unwanted
76// item state changes in the vista tree control. It is only effective in
5fe302ef
BW
77// multi-select mode on vista systems.
78
396f85ba
BW
79// The vista tree control includes some new code that originally broke the
80// multi-selection tree, causing seemingly spurious item selection state changes
81// during Shift or Ctrl-click item selection. (To witness the original broken
82// behavior, simply make IsLocked() below always return false). This problem was
83// solved by using the following class to 'unlock' an item's selection state.
5fe302ef
BW
84
85class TreeItemUnlocker
86{
87public:
396f85ba
BW
88 // unlock a single item
89 TreeItemUnlocker(HTREEITEM item) { ms_unlockedItem = item; }
90
91 // unlock all items, don't use unless absolutely necessary
92 TreeItemUnlocker() { ms_unlockedItem = (HTREEITEM)-1; }
93
94 // lock everything back
95 ~TreeItemUnlocker() { ms_unlockedItem = NULL; }
96
97
98 // check if the item state is currently locked
99 static bool IsLocked(HTREEITEM item)
100 { return ms_unlockedItem != (HTREEITEM)-1 && item != ms_unlockedItem; }
101
102private:
103 static HTREEITEM ms_unlockedItem;
5fe302ef
BW
104};
105
396f85ba 106HTREEITEM TreeItemUnlocker::ms_unlockedItem = NULL;
5fe302ef 107
3f7bc32b
VZ
108// ----------------------------------------------------------------------------
109// private functions
110// ----------------------------------------------------------------------------
111
75afdc2d
VZ
112// wrappers for TreeView_GetItem/TreeView_SetItem
113static bool IsItemSelected(HWND hwndTV, HTREEITEM hItem)
114{
115
116 TV_ITEM tvi;
117 tvi.mask = TVIF_STATE | TVIF_HANDLE;
118 tvi.stateMask = TVIS_SELECTED;
119 tvi.hItem = hItem;
120
5fe302ef
BW
121 TreeItemUnlocker unlocker(hItem);
122
75afdc2d
VZ
123 if ( !TreeView_GetItem(hwndTV, &tvi) )
124 {
125 wxLogLastError(wxT("TreeView_GetItem"));
126 }
127
128 return (tvi.state & TVIS_SELECTED) != 0;
129}
130
131static bool SelectItem(HWND hwndTV, HTREEITEM hItem, bool select = true)
132{
133 TV_ITEM tvi;
134 tvi.mask = TVIF_STATE | TVIF_HANDLE;
135 tvi.stateMask = TVIS_SELECTED;
136 tvi.state = select ? TVIS_SELECTED : 0;
137 tvi.hItem = hItem;
138
5fe302ef
BW
139 TreeItemUnlocker unlocker(hItem);
140
75afdc2d
VZ
141 if ( TreeView_SetItem(hwndTV, &tvi) == -1 )
142 {
143 wxLogLastError(wxT("TreeView_SetItem"));
144 return false;
145 }
146
147 return true;
148}
149
150static inline void UnselectItem(HWND hwndTV, HTREEITEM htItem)
151{
152 SelectItem(hwndTV, htItem, false);
153}
154
75afdc2d
VZ
155// helper function which selects all items in a range and, optionally,
156// unselects all others
157static void SelectRange(HWND hwndTV,
158 HTREEITEM htFirst,
159 HTREEITEM htLast,
160 bool unselectOthers = true)
161{
162 // find the first (or last) item and select it
163 bool cont = true;
164 HTREEITEM htItem = (HTREEITEM)TreeView_GetRoot(hwndTV);
165 while ( htItem && cont )
166 {
167 if ( (htItem == htFirst) || (htItem == htLast) )
168 {
169 if ( !IsItemSelected(hwndTV, htItem) )
170 {
171 SelectItem(hwndTV, htItem);
172 }
173
174 cont = false;
175 }
176 else
177 {
178 if ( unselectOthers && IsItemSelected(hwndTV, htItem) )
179 {
180 UnselectItem(hwndTV, htItem);
181 }
182 }
183
184 htItem = (HTREEITEM)TreeView_GetNextVisible(hwndTV, htItem);
185 }
186
187 // select the items in range
188 cont = htFirst != htLast;
189 while ( htItem && cont )
190 {
191 if ( !IsItemSelected(hwndTV, htItem) )
192 {
193 SelectItem(hwndTV, htItem);
194 }
195
196 cont = (htItem != htFirst) && (htItem != htLast);
197
198 htItem = (HTREEITEM)TreeView_GetNextVisible(hwndTV, htItem);
199 }
200
201 // unselect the rest
202 if ( unselectOthers )
203 {
204 while ( htItem )
205 {
206 if ( IsItemSelected(hwndTV, htItem) )
207 {
208 UnselectItem(hwndTV, htItem);
209 }
210
211 htItem = (HTREEITEM)TreeView_GetNextVisible(hwndTV, htItem);
212 }
213 }
214
215 // seems to be necessary - otherwise the just selected items don't always
216 // appear as selected
217 UpdateWindow(hwndTV);
218}
219
220// helper function which tricks the standard control into changing the focused
221// item without changing anything else (if someone knows why Microsoft doesn't
222// allow to do it by just setting TVIS_FOCUSED flag, please tell me!)
cc87a04c
VZ
223//
224// returns true if the focus was changed, false if the given item was already
225// the focused one
226static bool SetFocus(HWND hwndTV, HTREEITEM htItem)
75afdc2d
VZ
227{
228 // the current focus
229 HTREEITEM htFocus = (HTREEITEM)TreeView_GetSelection(hwndTV);
230
cc87a04c
VZ
231 if ( htItem == htFocus )
232 return false;
233
75afdc2d
VZ
234 if ( htItem )
235 {
cc87a04c
VZ
236 // remember the selection state of the item
237 bool wasSelected = IsItemSelected(hwndTV, htItem);
75afdc2d 238
cc87a04c
VZ
239 if ( htFocus && IsItemSelected(hwndTV, htFocus) )
240 {
241 // prevent the tree from unselecting the old focus which it
242 // would do by default (TreeView_SelectItem unselects the
243 // focused item)
244 TreeView_SelectItem(hwndTV, 0);
245 SelectItem(hwndTV, htFocus);
246 }
75afdc2d 247
cc87a04c 248 TreeView_SelectItem(hwndTV, htItem);
75afdc2d 249
cc87a04c
VZ
250 if ( !wasSelected )
251 {
252 // need to clear the selection which TreeView_SelectItem() gave
253 // us
254 UnselectItem(hwndTV, htItem);
75afdc2d 255 }
cc87a04c 256 //else: was selected, still selected - ok
75afdc2d 257 }
cc87a04c 258 else // reset focus
75afdc2d 259 {
cc87a04c 260 bool wasFocusSelected = IsItemSelected(hwndTV, htFocus);
75afdc2d 261
cc87a04c
VZ
262 // just clear the focus
263 TreeView_SelectItem(hwndTV, 0);
75afdc2d 264
cc87a04c
VZ
265 if ( wasFocusSelected )
266 {
267 // restore the selection state
268 SelectItem(hwndTV, htFocus);
75afdc2d 269 }
75afdc2d 270 }
cc87a04c
VZ
271
272 return true;
75afdc2d
VZ
273}
274
08b7c251
VZ
275// ----------------------------------------------------------------------------
276// private classes
277// ----------------------------------------------------------------------------
2bda0e17 278
08b7c251 279// a convenient wrapper around TV_ITEM struct which adds a ctor
f3ef286f 280#ifdef __VISUALC__
3f7bc32b 281#pragma warning( disable : 4097 ) // inheriting from typedef
f3ef286f
JS
282#endif
283
08b7c251
VZ
284struct wxTreeViewItem : public TV_ITEM
285{
9dfbf520
VZ
286 wxTreeViewItem(const wxTreeItemId& item, // the item handle
287 UINT mask_, // fields which are valid
288 UINT stateMask_ = 0) // for TVIF_STATE only
08b7c251 289 {
a9c1265f
VZ
290 wxZeroMemory(*this);
291
9dfbf520
VZ
292 // hItem member is always valid
293 mask = mask_ | TVIF_HANDLE;
08b7c251 294 stateMask = stateMask_;
3f7bc32b 295 hItem = HITEM(item);
08b7c251
VZ
296 }
297};
f3ef286f 298
4523ebb3
VZ
299// ----------------------------------------------------------------------------
300// This class is our userdata/lParam for the TV_ITEMs stored in the treeview.
301//
302// We need this for a couple of reasons:
303//
304// 1) This class is needed for support of different images: the Win32 common
305// control natively supports only 2 images (the normal one and another for the
306// selected state). We wish to provide support for 2 more of them for folder
307// items (i.e. those which have children): for expanded state and for expanded
308// selected state. For this we use this structure to store the additional items
309// images.
310//
311// 2) This class is also needed to hold the HITEM so that we can sort
312// it correctly in the MSW sort callback.
313//
314// In addition it makes other workarounds such as this easier and helps
315// simplify the code.
316// ----------------------------------------------------------------------------
317
318class wxTreeItemParam
319{
320public:
321 wxTreeItemParam()
4523ebb3 322 {
20f4b566
VZ
323 m_data = NULL;
324
4523ebb3
VZ
325 for ( size_t n = 0; n < WXSIZEOF(m_images); n++ )
326 {
327 m_images[n] = -1;
328 }
329 }
330
331 // dtor deletes the associated data as well
332 virtual ~wxTreeItemParam() { delete m_data; }
333
334 // accessors
335 // get the real data associated with the item
336 wxTreeItemData *GetData() const { return m_data; }
337 // change it
338 void SetData(wxTreeItemData *data) { m_data = data; }
339
340 // do we have such image?
341 bool HasImage(wxTreeItemIcon which) const { return m_images[which] != -1; }
1b182562
VZ
342 // get image, falling back to the other images if this one is not
343 // specified
344 int GetImage(wxTreeItemIcon which) const
345 {
346 int image = m_images[which];
347 if ( image == -1 )
348 {
349 switch ( which )
350 {
351 case wxTreeItemIcon_SelectedExpanded:
352 image = GetImage(wxTreeItemIcon_Expanded);
353 if ( image != -1 )
354 break;
355 //else: fall through
356
357 case wxTreeItemIcon_Selected:
358 case wxTreeItemIcon_Expanded:
359 image = GetImage(wxTreeItemIcon_Normal);
360 break;
361
362 case wxTreeItemIcon_Normal:
363 // no fallback
364 break;
365
366 default:
367 wxFAIL_MSG( _T("unsupported wxTreeItemIcon value") );
368 }
369 }
370
371 return image;
372 }
373 // change the given image
4523ebb3
VZ
374 void SetImage(int image, wxTreeItemIcon which) { m_images[which] = image; }
375
376 // get item
377 const wxTreeItemId& GetItem() const { return m_item; }
378 // set item
379 void SetItem(const wxTreeItemId& item) { m_item = item; }
380
381protected:
382 // all the images associated with the item
383 int m_images[wxTreeItemIcon_Max];
384
385 // item for sort callbacks
386 wxTreeItemId m_item;
387
388 // the real client data
389 wxTreeItemData *m_data;
390
391 DECLARE_NO_COPY_CLASS(wxTreeItemParam)
392};
393
a9c1265f
VZ
394// wxVirutalNode is used in place of a single root when 'hidden' root is
395// specified.
efa38350 396class wxVirtualNode : public wxTreeViewItem
a9c1265f
VZ
397{
398public:
4523ebb3 399 wxVirtualNode(wxTreeItemParam *param)
efa38350 400 : wxTreeViewItem(TVI_ROOT, 0)
a9c1265f 401 {
4523ebb3 402 m_param = param;
a9c1265f
VZ
403 }
404
405 ~wxVirtualNode()
406 {
4523ebb3 407 delete m_param;
a9c1265f
VZ
408 }
409
4523ebb3
VZ
410 wxTreeItemParam *GetParam() const { return m_param; }
411 void SetParam(wxTreeItemParam *param) { delete m_param; m_param = param; }
a9c1265f
VZ
412
413private:
4523ebb3 414 wxTreeItemParam *m_param;
22f3361e
VZ
415
416 DECLARE_NO_COPY_CLASS(wxVirtualNode)
a9c1265f
VZ
417};
418
f3ef286f 419#ifdef __VISUALC__
197dd9af 420#pragma warning( default : 4097 )
f3ef286f 421#endif
2bda0e17 422
a9c1265f
VZ
423// a macro to get the virtual root, returns NULL if none
424#define GET_VIRTUAL_ROOT() ((wxVirtualNode *)m_pVirtualRoot)
425
04cd30de 426// returns true if the item is the virtual root
a9c1265f
VZ
427#define IS_VIRTUAL_ROOT(item) (HITEM(item) == TVI_ROOT)
428
9dfbf520 429// a class which encapsulates the tree traversal logic: it vists all (unless
04cd30de 430// OnVisit() returns false) items under the given one
9dfbf520
VZ
431class wxTreeTraversal
432{
433public:
434 wxTreeTraversal(const wxTreeCtrl *tree)
435 {
436 m_tree = tree;
437 }
438
cc11ded1
VZ
439 // give it a virtual dtor: not really needed as the class is never used
440 // polymorphically and not even allocated on heap at all, but this is safer
441 // (in case it ever is) and silences the compiler warnings for now
442 virtual ~wxTreeTraversal() { }
443
9dfbf520 444 // do traverse the tree: visit all items (recursively by default) under the
04cd30de
RL
445 // given one; return true if all items were traversed or false if the
446 // traversal was aborted because OnVisit returned false
447 bool DoTraverse(const wxTreeItemId& root, bool recursively = true);
9dfbf520
VZ
448
449 // override this function to do whatever is needed for each item, return
04cd30de 450 // false to stop traversing
9dfbf520
VZ
451 virtual bool OnVisit(const wxTreeItemId& item) = 0;
452
453protected:
454 const wxTreeCtrl *GetTree() const { return m_tree; }
455
456private:
457 bool Traverse(const wxTreeItemId& root, bool recursively);
458
459 const wxTreeCtrl *m_tree;
22f3361e
VZ
460
461 DECLARE_NO_COPY_CLASS(wxTreeTraversal)
9dfbf520
VZ
462};
463
74b31181
VZ
464// internal class for getting the selected items
465class TraverseSelections : public wxTreeTraversal
466{
467public:
468 TraverseSelections(const wxTreeCtrl *tree,
469 wxArrayTreeItemIds& selections)
470 : wxTreeTraversal(tree), m_selections(selections)
471 {
472 m_selections.Empty();
473
b9e9b40c
JS
474 if (tree->GetCount() > 0)
475 DoTraverse(tree->GetRootItem());
74b31181
VZ
476 }
477
478 virtual bool OnVisit(const wxTreeItemId& item)
479 {
0228081f
VZ
480 const wxTreeCtrl * const tree = GetTree();
481
a9c1265f 482 // can't visit a virtual node.
0228081f 483 if ( (tree->GetRootItem() == item) && tree->HasFlag(wxTR_HIDE_ROOT) )
a9c1265f 484 {
04cd30de 485 return true;
a9c1265f
VZ
486 }
487
0228081f 488 if ( ::IsItemSelected(GetHwndOf(tree), HITEM(item)) )
74b31181
VZ
489 {
490 m_selections.Add(item);
491 }
492
04cd30de 493 return true;
74b31181
VZ
494 }
495
e47c4d48
VZ
496 size_t GetCount() const { return m_selections.GetCount(); }
497
74b31181
VZ
498private:
499 wxArrayTreeItemIds& m_selections;
fc7a2a60
VZ
500
501 DECLARE_NO_COPY_CLASS(TraverseSelections)
74b31181
VZ
502};
503
504// internal class for counting tree items
505class TraverseCounter : public wxTreeTraversal
506{
507public:
508 TraverseCounter(const wxTreeCtrl *tree,
509 const wxTreeItemId& root,
510 bool recursively)
511 : wxTreeTraversal(tree)
512 {
513 m_count = 0;
514
515 DoTraverse(root, recursively);
516 }
517
33ac7e6f 518 virtual bool OnVisit(const wxTreeItemId& WXUNUSED(item))
74b31181
VZ
519 {
520 m_count++;
521
04cd30de 522 return true;
74b31181
VZ
523 }
524
525 size_t GetCount() const { return m_count; }
526
527private:
528 size_t m_count;
fc7a2a60
VZ
529
530 DECLARE_NO_COPY_CLASS(TraverseCounter)
74b31181
VZ
531};
532
23f681ec 533// ----------------------------------------------------------------------------
3f7bc32b 534// wxWin macros
08b7c251
VZ
535// ----------------------------------------------------------------------------
536
786a2425 537#if wxUSE_EXTENDED_RTTI
bc9fb572
JS
538WX_DEFINE_FLAGS( wxTreeCtrlStyle )
539
3ff066a4 540wxBEGIN_FLAGS( wxTreeCtrlStyle )
bc9fb572
JS
541 // new style border flags, we put them first to
542 // use them for streaming out
3ff066a4
SC
543 wxFLAGS_MEMBER(wxBORDER_SIMPLE)
544 wxFLAGS_MEMBER(wxBORDER_SUNKEN)
545 wxFLAGS_MEMBER(wxBORDER_DOUBLE)
546 wxFLAGS_MEMBER(wxBORDER_RAISED)
547 wxFLAGS_MEMBER(wxBORDER_STATIC)
548 wxFLAGS_MEMBER(wxBORDER_NONE)
5e7718a2 549
bc9fb572 550 // old style border flags
3ff066a4
SC
551 wxFLAGS_MEMBER(wxSIMPLE_BORDER)
552 wxFLAGS_MEMBER(wxSUNKEN_BORDER)
553 wxFLAGS_MEMBER(wxDOUBLE_BORDER)
554 wxFLAGS_MEMBER(wxRAISED_BORDER)
555 wxFLAGS_MEMBER(wxSTATIC_BORDER)
cb0afb26 556 wxFLAGS_MEMBER(wxBORDER)
bc9fb572
JS
557
558 // standard window styles
3ff066a4
SC
559 wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
560 wxFLAGS_MEMBER(wxCLIP_CHILDREN)
561 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
562 wxFLAGS_MEMBER(wxWANTS_CHARS)
cb0afb26 563 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
3ff066a4
SC
564 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
565 wxFLAGS_MEMBER(wxVSCROLL)
566 wxFLAGS_MEMBER(wxHSCROLL)
567
568 wxFLAGS_MEMBER(wxTR_EDIT_LABELS)
569 wxFLAGS_MEMBER(wxTR_NO_BUTTONS)
570 wxFLAGS_MEMBER(wxTR_HAS_BUTTONS)
571 wxFLAGS_MEMBER(wxTR_TWIST_BUTTONS)
572 wxFLAGS_MEMBER(wxTR_NO_LINES)
573 wxFLAGS_MEMBER(wxTR_FULL_ROW_HIGHLIGHT)
574 wxFLAGS_MEMBER(wxTR_LINES_AT_ROOT)
575 wxFLAGS_MEMBER(wxTR_HIDE_ROOT)
576 wxFLAGS_MEMBER(wxTR_ROW_LINES)
577 wxFLAGS_MEMBER(wxTR_HAS_VARIABLE_ROW_HEIGHT)
578 wxFLAGS_MEMBER(wxTR_SINGLE)
579 wxFLAGS_MEMBER(wxTR_MULTIPLE)
70cab5b7 580#if WXWIN_COMPATIBILITY_2_8
3ff066a4 581 wxFLAGS_MEMBER(wxTR_EXTENDED)
70cab5b7 582#endif
3ff066a4
SC
583 wxFLAGS_MEMBER(wxTR_DEFAULT_STYLE)
584
585wxEND_FLAGS( wxTreeCtrlStyle )
bc9fb572 586
786a2425
SC
587IMPLEMENT_DYNAMIC_CLASS_XTI(wxTreeCtrl, wxControl,"wx/treectrl.h")
588
3ff066a4 589wxBEGIN_PROPERTIES_TABLE(wxTreeCtrl)
5e7718a2 590 wxEVENT_PROPERTY( TextUpdated , wxEVT_COMMAND_TEXT_UPDATED , wxCommandEvent )
3ff066a4 591 wxEVENT_RANGE_PROPERTY( TreeEvent , wxEVT_COMMAND_TREE_BEGIN_DRAG , wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK , wxTreeEvent )
af498247 592 wxPROPERTY_FLAGS( WindowStyle , wxTreeCtrlStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
3ff066a4 593wxEND_PROPERTIES_TABLE()
786a2425 594
3ff066a4
SC
595wxBEGIN_HANDLERS_TABLE(wxTreeCtrl)
596wxEND_HANDLERS_TABLE()
786a2425 597
5e7718a2 598wxCONSTRUCTOR_5( wxTreeCtrl , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size , long , WindowStyle )
786a2425 599#else
23f681ec 600IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl, wxControl)
786a2425 601#endif
2bda0e17 602
08b7c251 603// ----------------------------------------------------------------------------
deb1de30 604// constants
08b7c251
VZ
605// ----------------------------------------------------------------------------
606
deb1de30
VZ
607// indices in gs_expandEvents table below
608enum
609{
610 IDX_COLLAPSE,
611 IDX_EXPAND,
612 IDX_WHAT_MAX
613};
614
615enum
616{
617 IDX_DONE,
618 IDX_DOING,
619 IDX_HOW_MAX
620};
621
622// handy table for sending events - it has to be initialized during run-time
623// now so can't be const any more
624static /* const */ wxEventType gs_expandEvents[IDX_WHAT_MAX][IDX_HOW_MAX];
625
626/*
627 but logically it's a const table with the following entries:
628=
2bda0e17 629{
08b7c251
VZ
630 { wxEVT_COMMAND_TREE_ITEM_COLLAPSED, wxEVT_COMMAND_TREE_ITEM_COLLAPSING },
631 { wxEVT_COMMAND_TREE_ITEM_EXPANDED, wxEVT_COMMAND_TREE_ITEM_EXPANDING }
632};
deb1de30 633*/
08b7c251
VZ
634
635// ============================================================================
636// implementation
637// ============================================================================
638
9dfbf520
VZ
639// ----------------------------------------------------------------------------
640// tree traversal
641// ----------------------------------------------------------------------------
642
643bool wxTreeTraversal::DoTraverse(const wxTreeItemId& root, bool recursively)
644{
645 if ( !OnVisit(root) )
04cd30de 646 return false;
9dfbf520
VZ
647
648 return Traverse(root, recursively);
649}
650
651bool wxTreeTraversal::Traverse(const wxTreeItemId& root, bool recursively)
652{
ee4b2721 653 wxTreeItemIdValue cookie;
9dfbf520
VZ
654 wxTreeItemId child = m_tree->GetFirstChild(root, cookie);
655 while ( child.IsOk() )
656 {
657 // depth first traversal
04cd30de
RL
658 if ( recursively && !Traverse(child, true) )
659 return false;
9dfbf520
VZ
660
661 if ( !OnVisit(child) )
04cd30de 662 return false;
9dfbf520
VZ
663
664 child = m_tree->GetNextChild(root, cookie);
665 }
666
04cd30de 667 return true;
9dfbf520
VZ
668}
669
08b7c251
VZ
670// ----------------------------------------------------------------------------
671// construction and destruction
672// ----------------------------------------------------------------------------
673
674void wxTreeCtrl::Init()
675{
08b7c251 676 m_textCtrl = NULL;
04cd30de 677 m_hasAnyAttr = false;
68d9be05 678#if wxUSE_DRAGIMAGE
23f681ec 679 m_dragImage = NULL;
68d9be05 680#endif
a9c1265f 681 m_pVirtualRoot = NULL;
9ab5ef13 682
deb1de30
VZ
683 // initialize the global array of events now as it can't be done statically
684 // with the wxEVT_XXX values being allocated during run-time only
685 gs_expandEvents[IDX_COLLAPSE][IDX_DONE] = wxEVT_COMMAND_TREE_ITEM_COLLAPSED;
686 gs_expandEvents[IDX_COLLAPSE][IDX_DOING] = wxEVT_COMMAND_TREE_ITEM_COLLAPSING;
687 gs_expandEvents[IDX_EXPAND][IDX_DONE] = wxEVT_COMMAND_TREE_ITEM_EXPANDED;
688 gs_expandEvents[IDX_EXPAND][IDX_DOING] = wxEVT_COMMAND_TREE_ITEM_EXPANDING;
2bda0e17
KB
689}
690
9dfbf520
VZ
691bool wxTreeCtrl::Create(wxWindow *parent,
692 wxWindowID id,
693 const wxPoint& pos,
694 const wxSize& size,
695 long style,
696 const wxValidator& validator,
08b7c251 697 const wxString& name)
2bda0e17 698{
08b7c251 699 Init();
2bda0e17 700
7699361c
JS
701 if ( (style & wxBORDER_MASK) == wxBORDER_DEFAULT )
702 style |= wxBORDER_SUNKEN;
703
9dfbf520 704 if ( !CreateControl(parent, id, pos, size, style, validator, name) )
04cd30de 705 return false;
2bda0e17 706
823b140b 707 WXDWORD exStyle = 0;
7699361c
JS
708 DWORD wstyle = MSWGetStyle(m_windowStyle, & exStyle);
709 wstyle |= WS_TABSTOP | TVS_SHOWSELALWAYS;
2bda0e17 710
63da7df7
JS
711 if ((m_windowStyle & wxTR_NO_LINES) == 0)
712 wstyle |= TVS_HASLINES;
08b7c251
VZ
713 if ( m_windowStyle & wxTR_HAS_BUTTONS )
714 wstyle |= TVS_HASBUTTONS;
2bda0e17 715
08b7c251
VZ
716 if ( m_windowStyle & wxTR_EDIT_LABELS )
717 wstyle |= TVS_EDITLABELS;
2bda0e17 718
08b7c251
VZ
719 if ( m_windowStyle & wxTR_LINES_AT_ROOT )
720 wstyle |= TVS_LINESATROOT;
deb1de30 721
c6f4913a 722 if ( m_windowStyle & wxTR_FULL_ROW_HIGHLIGHT )
deb1de30 723 {
2a1f999f 724 if ( wxApp::GetComCtl32Version() >= 471 )
c6f4913a
VS
725 wstyle |= TVS_FULLROWSELECT;
726 }
727
f3f71703 728#if !defined(__WXWINCE__) && defined(TVS_INFOTIP)
156194e1
JS
729 // Need so that TVN_GETINFOTIP messages will be sent
730 wstyle |= TVS_INFOTIP;
676d6550 731#endif
5e7718a2 732
08b7c251 733 // Create the tree control.
8779cca3 734 if ( !MSWCreateControl(WC_TREEVIEW, wstyle, pos, size) )
04cd30de 735 return false;
9dfbf520 736
f6bcfd97 737#if wxUSE_COMCTL32_SAFELY
a756f210 738 wxWindow::SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
f6bcfd97
BP
739 wxWindow::SetForegroundColour(wxWindow::GetParent()->GetForegroundColour());
740#elif 1
a756f210 741 SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
f6bcfd97 742 SetForegroundColour(wxWindow::GetParent()->GetForegroundColour());
fbdcff4a
JS
743#else
744 // This works around a bug in the Windows tree control whereby for some versions
745 // of comctrl32, setting any colour actually draws the background in black.
746 // This will initialise the background to the system colour.
f6bcfd97
BP
747 // THIS FIX NOW REVERTED since it caused problems on _other_ systems.
748 // Assume the user has an updated comctl32.dll.
fbdcff4a 749 ::SendMessage(GetHwnd(), TVM_SETBKCOLOR, 0,-1);
a756f210 750 wxWindow::SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
f6bcfd97 751 SetForegroundColour(wxWindow::GetParent()->GetForegroundColour());
fbdcff4a
JS
752#endif
753
5aeeab14 754
9dfbf520
VZ
755 // VZ: this is some experimental code which may be used to get the
756 // TVS_CHECKBOXES style functionality for comctl32.dll < 4.71.
757 // AFAIK, the standard DLL does about the same thing anyhow.
758#if 0
759 if ( m_windowStyle & wxTR_MULTIPLE )
760 {
761 wxBitmap bmp;
762
763 // create the DC compatible with the current screen
764 HDC hdcMem = CreateCompatibleDC(NULL);
765
766 // create a mono bitmap of the standard size
46697f31
WS
767 int x = ::GetSystemMetrics(SM_CXMENUCHECK);
768 int y = ::GetSystemMetrics(SM_CYMENUCHECK);
04cd30de 769 wxImageList imagelistCheckboxes(x, y, false, 2);
9dfbf520
VZ
770 HBITMAP hbmpCheck = CreateBitmap(x, y, // bitmap size
771 1, // # of color planes
772 1, // # bits needed for one pixel
773 0); // array containing colour data
774 SelectObject(hdcMem, hbmpCheck);
775
776 // then draw a check mark into it
777 RECT rect = { 0, 0, x, y };
778 if ( !::DrawFrameControl(hdcMem, &rect,
779 DFC_BUTTON,
780 DFCS_BUTTONCHECK | DFCS_CHECKED) )
781 {
223d09f6 782 wxLogLastError(wxT("DrawFrameControl(check)"));
9dfbf520
VZ
783 }
784
785 bmp.SetHBITMAP((WXHBITMAP)hbmpCheck);
786 imagelistCheckboxes.Add(bmp);
787
788 if ( !::DrawFrameControl(hdcMem, &rect,
789 DFC_BUTTON,
790 DFCS_BUTTONCHECK) )
791 {
223d09f6 792 wxLogLastError(wxT("DrawFrameControl(uncheck)"));
9dfbf520
VZ
793 }
794
795 bmp.SetHBITMAP((WXHBITMAP)hbmpCheck);
796 imagelistCheckboxes.Add(bmp);
797
798 // clean up
799 ::DeleteDC(hdcMem);
800
801 // set the imagelist
802 SetStateImageList(&imagelistCheckboxes);
803 }
804#endif // 0
805
9a63feff
VZ
806 wxSetCCUnicodeFormat(GetHwnd());
807
04cd30de 808 return true;
2bda0e17
KB
809}
810
08b7c251 811wxTreeCtrl::~wxTreeCtrl()
2bda0e17 812{
696e1ea0
VZ
813 // delete any attributes
814 if ( m_hasAnyAttr )
815 {
ee4b2721 816 WX_CLEAR_HASH_MAP(wxMapTreeAttr, m_attrs);
696e1ea0
VZ
817
818 // prevent TVN_DELETEITEM handler from deleting the attributes again!
04cd30de 819 m_hasAnyAttr = false;
696e1ea0
VZ
820 }
821
08b7c251 822 DeleteTextCtrl();
2bda0e17 823
08b7c251 824 // delete user data to prevent memory leaks
a9c1265f 825 // also deletes hidden root node storage.
08b7c251 826 DeleteAllItems();
2bda0e17
KB
827}
828
08b7c251
VZ
829// ----------------------------------------------------------------------------
830// accessors
831// ----------------------------------------------------------------------------
2bda0e17 832
39c7a53c
VZ
833/* static */ wxVisualAttributes
834wxTreeCtrl::GetClassDefaultAttributes(wxWindowVariant variant)
835{
836 wxVisualAttributes attrs = GetCompositeControlsDefaultAttributes(variant);
837
838 // common controls have their own default font
839 attrs.font = wxGetCCDefaultFont();
840
841 return attrs;
842}
843
844
08b7c251 845// simple wrappers which add error checking in debug mode
2bda0e17 846
4523ebb3 847bool wxTreeCtrl::DoGetItem(wxTreeViewItem *tvItem) const
2bda0e17 848{
04cd30de 849 wxCHECK_MSG( tvItem->hItem != TVI_ROOT, false,
a9c1265f
VZ
850 _T("can't retrieve virtual root item") );
851
d220ae32 852 if ( !TreeView_GetItem(GetHwnd(), tvItem) )
2bda0e17 853 {
f6bcfd97 854 wxLogLastError(wxT("TreeView_GetItem"));
08b7c251 855
04cd30de 856 return false;
08b7c251
VZ
857 }
858
04cd30de 859 return true;
2bda0e17
KB
860}
861
4523ebb3 862void wxTreeCtrl::DoSetItem(wxTreeViewItem *tvItem)
2bda0e17 863{
5fe302ef
BW
864 TreeItemUnlocker unlocker(tvItem->hItem);
865
d220ae32 866 if ( TreeView_SetItem(GetHwnd(), tvItem) == -1 )
2bda0e17 867 {
f6bcfd97 868 wxLogLastError(wxT("TreeView_SetItem"));
08b7c251 869 }
2bda0e17
KB
870}
871
027d45e8 872unsigned int wxTreeCtrl::GetCount() const
2bda0e17 873{
027d45e8 874 return (unsigned int)TreeView_GetCount(GetHwnd());
2bda0e17
KB
875}
876
08b7c251 877unsigned int wxTreeCtrl::GetIndent() const
2bda0e17 878{
d220ae32 879 return TreeView_GetIndent(GetHwnd());
2bda0e17
KB
880}
881
08b7c251 882void wxTreeCtrl::SetIndent(unsigned int indent)
2bda0e17 883{
d220ae32 884 TreeView_SetIndent(GetHwnd(), indent);
2bda0e17
KB
885}
886
08b7c251 887void wxTreeCtrl::SetAnyImageList(wxImageList *imageList, int which)
2bda0e17 888{
08b7c251 889 // no error return
8ecd5de2
WS
890 (void) TreeView_SetImageList(GetHwnd(),
891 imageList ? imageList->GetHIMAGELIST() : 0,
892 which);
2bda0e17
KB
893}
894
08b7c251 895void wxTreeCtrl::SetImageList(wxImageList *imageList)
2bda0e17 896{
a9c1265f
VZ
897 if (m_ownsImageListNormal)
898 delete m_imageListNormal;
899
08b7c251 900 SetAnyImageList(m_imageListNormal = imageList, TVSIL_NORMAL);
04cd30de 901 m_ownsImageListNormal = false;
2bda0e17
KB
902}
903
08b7c251 904void wxTreeCtrl::SetStateImageList(wxImageList *imageList)
2bda0e17 905{
0377efa2 906 if (m_ownsImageListState) delete m_imageListState;
08b7c251 907 SetAnyImageList(m_imageListState = imageList, TVSIL_STATE);
04cd30de 908 m_ownsImageListState = false;
0377efa2
VS
909}
910
33961d59
RR
911size_t wxTreeCtrl::GetChildrenCount(const wxTreeItemId& item,
912 bool recursively) const
913{
05b2a432 914 wxCHECK_MSG( item.IsOk(), 0u, wxT("invalid tree item") );
23fd5130 915
05b2a432 916 TraverseCounter counter(this, item, recursively);
73974df1 917 return counter.GetCount() - 1;
23fd5130
VZ
918}
919
bb448552
VZ
920// ----------------------------------------------------------------------------
921// control colours
922// ----------------------------------------------------------------------------
923
924bool wxTreeCtrl::SetBackgroundColour(const wxColour &colour)
925{
f6bcfd97 926#if !wxUSE_COMCTL32_SAFELY
bb448552 927 if ( !wxWindowBase::SetBackgroundColour(colour) )
04cd30de 928 return false;
bb448552 929
bfbb0b4c 930 ::SendMessage(GetHwnd(), TVM_SETBKCOLOR, 0, colour.GetPixel());
f6bcfd97 931#endif
bb448552 932
04cd30de 933 return true;
bb448552
VZ
934}
935
936bool wxTreeCtrl::SetForegroundColour(const wxColour &colour)
937{
f6bcfd97 938#if !wxUSE_COMCTL32_SAFELY
bb448552 939 if ( !wxWindowBase::SetForegroundColour(colour) )
04cd30de 940 return false;
bb448552 941
bfbb0b4c 942 ::SendMessage(GetHwnd(), TVM_SETTEXTCOLOR, 0, colour.GetPixel());
f6bcfd97 943#endif
bb448552 944
04cd30de 945 return true;
bb448552
VZ
946}
947
08b7c251
VZ
948// ----------------------------------------------------------------------------
949// Item access
950// ----------------------------------------------------------------------------
951
0228081f
VZ
952bool wxTreeCtrl::IsHiddenRoot(const wxTreeItemId& item) const
953{
954 return HITEM(item) == TVI_ROOT && HasFlag(wxTR_HIDE_ROOT);
955}
956
08b7c251 957wxString wxTreeCtrl::GetItemText(const wxTreeItemId& item) const
2bda0e17 958{
f31a4098 959 wxCHECK_MSG( item.IsOk(), wxEmptyString, wxT("invalid tree item") );
05b2a432 960
837e5743 961 wxChar buf[512]; // the size is arbitrary...
02ce7b72 962
08b7c251
VZ
963 wxTreeViewItem tvItem(item, TVIF_TEXT);
964 tvItem.pszText = buf;
965 tvItem.cchTextMax = WXSIZEOF(buf);
966 if ( !DoGetItem(&tvItem) )
967 {
968 // don't return some garbage which was on stack, but an empty string
223d09f6 969 buf[0] = wxT('\0');
08b7c251 970 }
2bda0e17 971
08b7c251
VZ
972 return wxString(buf);
973}
2bda0e17 974
08b7c251
VZ
975void wxTreeCtrl::SetItemText(const wxTreeItemId& item, const wxString& text)
976{
05b2a432
RD
977 wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
978
a9c1265f
VZ
979 if ( IS_VIRTUAL_ROOT(item) )
980 return;
981
08b7c251 982 wxTreeViewItem tvItem(item, TVIF_TEXT);
c9f78968 983 tvItem.pszText = (wxChar *)text.wx_str(); // conversion is ok
08b7c251 984 DoSetItem(&tvItem);
44fbc477
VZ
985
986 // when setting the text of the item being edited, the text control should
987 // be updated to reflect the new text as well, otherwise calling
988 // SetItemText() in the OnBeginLabelEdit() handler doesn't have any effect
989 //
990 // don't use GetEditControl() here because m_textCtrl is not set yet
991 HWND hwndEdit = TreeView_GetEditControl(GetHwnd());
992 if ( hwndEdit )
993 {
1a4088e1 994 if ( item == m_idEdited )
44fbc477 995 {
e0a050e3 996 ::SetWindowText(hwndEdit, text.wx_str());
44fbc477
VZ
997 }
998 }
08b7c251 999}
2bda0e17 1000
4523ebb3
VZ
1001int wxTreeCtrl::GetItemImage(const wxTreeItemId& item,
1002 wxTreeItemIcon which) const
74b31181 1003{
4523ebb3
VZ
1004 wxCHECK_MSG( item.IsOk(), -1, wxT("invalid tree item") );
1005
0228081f 1006 if ( IsHiddenRoot(item) )
74b31181 1007 {
4523ebb3 1008 // no images for hidden root item
74b31181
VZ
1009 return -1;
1010 }
1011
4523ebb3
VZ
1012 wxTreeItemParam *param = GetItemParam(item);
1013
1b182562 1014 return param && param->HasImage(which) ? param->GetImage(which) : -1;
74b31181
VZ
1015}
1016
4523ebb3
VZ
1017void wxTreeCtrl::SetItemImage(const wxTreeItemId& item, int image,
1018 wxTreeItemIcon which)
74b31181 1019{
4523ebb3
VZ
1020 wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
1021 wxCHECK_RET( which >= 0 &&
1022 which < wxTreeItemIcon_Max,
1023 wxT("invalid image index"));
1024
1025
0228081f 1026 if ( IsHiddenRoot(item) )
74b31181 1027 {
4523ebb3 1028 // no images for hidden root item
74b31181
VZ
1029 return;
1030 }
1031
4523ebb3
VZ
1032 wxTreeItemParam *data = GetItemParam(item);
1033 if ( !data )
1034 return;
74b31181
VZ
1035
1036 data->SetImage(image, which);
f5bed7a8
VS
1037
1038 RefreshItem(item);
74b31181
VZ
1039}
1040
4523ebb3 1041wxTreeItemParam *wxTreeCtrl::GetItemParam(const wxTreeItemId& item) const
2bda0e17 1042{
05b2a432
RD
1043 wxCHECK_MSG( item.IsOk(), NULL, wxT("invalid tree item") );
1044
08b7c251 1045 wxTreeViewItem tvItem(item, TVIF_PARAM);
a9c1265f 1046
4523ebb3 1047 // hidden root may still have data.
a9c1265f
VZ
1048 if ( IS_VIRTUAL_ROOT(item) )
1049 {
4523ebb3 1050 return GET_VIRTUAL_ROOT()->GetParam();
a9c1265f
VZ
1051 }
1052
4523ebb3 1053 // visible node.
08b7c251
VZ
1054 if ( !DoGetItem(&tvItem) )
1055 {
1056 return NULL;
1057 }
2bda0e17 1058
4523ebb3 1059 return (wxTreeItemParam *)tvItem.lParam;
2bda0e17
KB
1060}
1061
4523ebb3 1062wxTreeItemData *wxTreeCtrl::GetItemData(const wxTreeItemId& item) const
2bda0e17 1063{
4523ebb3 1064 wxTreeItemParam *data = GetItemParam(item);
05b2a432 1065
4523ebb3
VZ
1066 return data ? data->GetData() : NULL;
1067}
a9c1265f 1068
4523ebb3
VZ
1069void wxTreeCtrl::SetItemData(const wxTreeItemId& item, wxTreeItemData *data)
1070{
188781db
VZ
1071 // first, associate this piece of data with this item
1072 if ( data )
1073 {
1074 data->SetId(item);
1075 }
1076
4523ebb3 1077 wxTreeItemParam *param = GetItemParam(item);
74b31181 1078
4523ebb3 1079 wxCHECK_RET( param, wxT("failed to change tree items data") );
74b31181 1080
4523ebb3 1081 param->SetData(data);
08b7c251 1082}
2bda0e17 1083
3a5a2f56
VZ
1084void wxTreeCtrl::SetItemHasChildren(const wxTreeItemId& item, bool has)
1085{
05b2a432
RD
1086 wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
1087
a9c1265f
VZ
1088 if ( IS_VIRTUAL_ROOT(item) )
1089 return;
1090
3a5a2f56
VZ
1091 wxTreeViewItem tvItem(item, TVIF_CHILDREN);
1092 tvItem.cChildren = (int)has;
1093 DoSetItem(&tvItem);
1094}
1095
add28c55
VZ
1096void wxTreeCtrl::SetItemBold(const wxTreeItemId& item, bool bold)
1097{
05b2a432
RD
1098 wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
1099
a9c1265f
VZ
1100 if ( IS_VIRTUAL_ROOT(item) )
1101 return;
1102
add28c55
VZ
1103 wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_BOLD);
1104 tvItem.state = bold ? TVIS_BOLD : 0;
1105 DoSetItem(&tvItem);
1106}
1107
58a8ab88
JS
1108void wxTreeCtrl::SetItemDropHighlight(const wxTreeItemId& item, bool highlight)
1109{
a9c1265f
VZ
1110 if ( IS_VIRTUAL_ROOT(item) )
1111 return;
1112
58a8ab88
JS
1113 wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_DROPHILITED);
1114 tvItem.state = highlight ? TVIS_DROPHILITED : 0;
1115 DoSetItem(&tvItem);
1116}
1117
d00407b2
VZ
1118void wxTreeCtrl::RefreshItem(const wxTreeItemId& item)
1119{
a9c1265f
VZ
1120 if ( IS_VIRTUAL_ROOT(item) )
1121 return;
1122
d00407b2
VZ
1123 wxRect rect;
1124 if ( GetBoundingRect(item, rect) )
1125 {
1126 RefreshRect(rect);
1127 }
1128}
1129
2b5f62a0
VZ
1130wxColour wxTreeCtrl::GetItemTextColour(const wxTreeItemId& item) const
1131{
05b2a432 1132 wxCHECK_MSG( item.IsOk(), wxNullColour, wxT("invalid tree item") );
2b5f62a0 1133
05b2a432 1134 wxMapTreeAttr::const_iterator it = m_attrs.find(item.m_pItem);
ee4b2721 1135 return it == m_attrs.end() ? wxNullColour : it->second->GetTextColour();
2b5f62a0
VZ
1136}
1137
1138wxColour wxTreeCtrl::GetItemBackgroundColour(const wxTreeItemId& item) const
1139{
05b2a432 1140 wxCHECK_MSG( item.IsOk(), wxNullColour, wxT("invalid tree item") );
2b5f62a0 1141
05b2a432 1142 wxMapTreeAttr::const_iterator it = m_attrs.find(item.m_pItem);
ee4b2721 1143 return it == m_attrs.end() ? wxNullColour : it->second->GetBackgroundColour();
2b5f62a0
VZ
1144}
1145
1146wxFont wxTreeCtrl::GetItemFont(const wxTreeItemId& item) const
1147{
05b2a432 1148 wxCHECK_MSG( item.IsOk(), wxNullFont, wxT("invalid tree item") );
2b5f62a0 1149
05b2a432 1150 wxMapTreeAttr::const_iterator it = m_attrs.find(item.m_pItem);
ee4b2721 1151 return it == m_attrs.end() ? wxNullFont : it->second->GetFont();
2b5f62a0
VZ
1152}
1153
696e1ea0
VZ
1154void wxTreeCtrl::SetItemTextColour(const wxTreeItemId& item,
1155 const wxColour& col)
1156{
05b2a432
RD
1157 wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
1158
ee4b2721 1159 wxTreeItemAttr *attr;
f888d614 1160 wxMapTreeAttr::iterator it = m_attrs.find(item.m_pItem);
ee4b2721 1161 if ( it == m_attrs.end() )
696e1ea0 1162 {
ee4b2721
VZ
1163 m_hasAnyAttr = true;
1164
f888d614 1165 m_attrs[item.m_pItem] =
696e1ea0 1166 attr = new wxTreeItemAttr;
ee4b2721
VZ
1167 }
1168 else
1169 {
1170 attr = it->second;
696e1ea0
VZ
1171 }
1172
1173 attr->SetTextColour(col);
d00407b2
VZ
1174
1175 RefreshItem(item);
696e1ea0
VZ
1176}
1177
1178void wxTreeCtrl::SetItemBackgroundColour(const wxTreeItemId& item,
1179 const wxColour& col)
1180{
05b2a432
RD
1181 wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
1182
ee4b2721 1183 wxTreeItemAttr *attr;
f888d614 1184 wxMapTreeAttr::iterator it = m_attrs.find(item.m_pItem);
ee4b2721 1185 if ( it == m_attrs.end() )
696e1ea0 1186 {
ee4b2721
VZ
1187 m_hasAnyAttr = true;
1188
f888d614 1189 m_attrs[item.m_pItem] =
696e1ea0 1190 attr = new wxTreeItemAttr;
ee4b2721
VZ
1191 }
1192 else // already in the hash
1193 {
1194 attr = it->second;
696e1ea0
VZ
1195 }
1196
1197 attr->SetBackgroundColour(col);
d00407b2
VZ
1198
1199 RefreshItem(item);
696e1ea0
VZ
1200}
1201
1202void wxTreeCtrl::SetItemFont(const wxTreeItemId& item, const wxFont& font)
1203{
05b2a432
RD
1204 wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
1205
ee4b2721 1206 wxTreeItemAttr *attr;
f888d614 1207 wxMapTreeAttr::iterator it = m_attrs.find(item.m_pItem);
ee4b2721 1208 if ( it == m_attrs.end() )
696e1ea0 1209 {
ee4b2721
VZ
1210 m_hasAnyAttr = true;
1211
f888d614 1212 m_attrs[item.m_pItem] =
696e1ea0 1213 attr = new wxTreeItemAttr;
ee4b2721
VZ
1214 }
1215 else // already in the hash
1216 {
1217 attr = it->second;
696e1ea0
VZ
1218 }
1219
1220 attr->SetFont(font);
d00407b2 1221
2bd16277
RD
1222 // Reset the item's text to ensure that the bounding rect will be adjusted
1223 // for the new font.
1224 SetItemText(item, GetItemText(item));
72e61024 1225
d00407b2 1226 RefreshItem(item);
696e1ea0
VZ
1227}
1228
08b7c251
VZ
1229// ----------------------------------------------------------------------------
1230// Item status
1231// ----------------------------------------------------------------------------
2bda0e17 1232
08b7c251
VZ
1233bool wxTreeCtrl::IsVisible(const wxTreeItemId& item) const
1234{
bfbb0b4c 1235 wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") );
05b2a432 1236
2b5f62a0
VZ
1237 if ( item == wxTreeItemId(TVI_ROOT) )
1238 {
1239 // virtual (hidden) root is never visible
04cd30de 1240 return false;
2b5f62a0
VZ
1241 }
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
ee4b2721 1248 *(HTREEITEM *)&rect = HITEM(item);
955be36c 1249
caea927d
VZ
1250 // true means to get rect for just the text, not the whole line
1251 if ( !::SendMessage(GetHwnd(), TVM_GETITEMRECT, true, (LPARAM)&rect) )
1252 {
1253 // if TVM_GETITEMRECT returned false, then the item is definitely not
1254 // visible (because its parent is not expanded)
1255 return false;
1256 }
1257
1258 // however if it returned true, the item might still be outside the
1259 // currently visible part of the tree, test for it (notice that partly
1260 // visible means visible here)
1261 return rect.bottom > 0 && rect.top < GetClientSize().y;
2bda0e17
KB
1262}
1263
08b7c251 1264bool wxTreeCtrl::ItemHasChildren(const wxTreeItemId& item) const
2bda0e17 1265{
bfbb0b4c 1266 wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") );
05b2a432 1267
08b7c251
VZ
1268 wxTreeViewItem tvItem(item, TVIF_CHILDREN);
1269 DoGetItem(&tvItem);
2bda0e17 1270
08b7c251 1271 return tvItem.cChildren != 0;
2bda0e17
KB
1272}
1273
08b7c251 1274bool wxTreeCtrl::IsExpanded(const wxTreeItemId& item) const
2bda0e17 1275{
bfbb0b4c 1276 wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") );
2bda0e17 1277
08b7c251
VZ
1278 wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_EXPANDED);
1279 DoGetItem(&tvItem);
2bda0e17 1280
08b7c251 1281 return (tvItem.state & TVIS_EXPANDED) != 0;
2bda0e17
KB
1282}
1283
08b7c251 1284bool wxTreeCtrl::IsSelected(const wxTreeItemId& item) const
2bda0e17 1285{
bfbb0b4c 1286 wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") );
05b2a432 1287
08b7c251
VZ
1288 wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_SELECTED);
1289 DoGetItem(&tvItem);
2bda0e17 1290
08b7c251 1291 return (tvItem.state & TVIS_SELECTED) != 0;
2bda0e17
KB
1292}
1293
add28c55
VZ
1294bool wxTreeCtrl::IsBold(const wxTreeItemId& item) const
1295{
bfbb0b4c 1296 wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") );
05b2a432 1297
add28c55
VZ
1298 wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_BOLD);
1299 DoGetItem(&tvItem);
1300
1301 return (tvItem.state & TVIS_BOLD) != 0;
1302}
1303
08b7c251
VZ
1304// ----------------------------------------------------------------------------
1305// navigation
1306// ----------------------------------------------------------------------------
2bda0e17 1307
08b7c251
VZ
1308wxTreeItemId wxTreeCtrl::GetRootItem() const
1309{
a9c1265f
VZ
1310 // Root may be real (visible) or virtual (hidden).
1311 if ( GET_VIRTUAL_ROOT() )
1312 return TVI_ROOT;
1313
ee4b2721 1314 return wxTreeItemId(TreeView_GetRoot(GetHwnd()));
08b7c251 1315}
2bda0e17 1316
08b7c251
VZ
1317wxTreeItemId wxTreeCtrl::GetSelection() const
1318{
f888d614 1319 wxCHECK_MSG( !(m_windowStyle & wxTR_MULTIPLE), wxTreeItemId(),
223d09f6 1320 wxT("this only works with single selection controls") );
9dfbf520 1321
ee4b2721 1322 return wxTreeItemId(TreeView_GetSelection(GetHwnd()));
2bda0e17
KB
1323}
1324
99006e44 1325wxTreeItemId wxTreeCtrl::GetItemParent(const wxTreeItemId& item) const
2bda0e17 1326{
05b2a432
RD
1327 wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1328
c9b142c9
VZ
1329 HTREEITEM hItem;
1330
1331 if ( IS_VIRTUAL_ROOT(item) )
1332 {
1333 // no parent for the virtual root
1334 hItem = 0;
1335 }
1336 else // normal item
a9c1265f 1337 {
c9b142c9
VZ
1338 hItem = TreeView_GetParent(GetHwnd(), HITEM(item));
1339 if ( !hItem && HasFlag(wxTR_HIDE_ROOT) )
1340 {
1341 // the top level items should have the virtual root as their parent
1342 hItem = TVI_ROOT;
1343 }
a9c1265f
VZ
1344 }
1345
ee4b2721 1346 return wxTreeItemId(hItem);
08b7c251 1347}
2bda0e17 1348
08b7c251 1349wxTreeItemId wxTreeCtrl::GetFirstChild(const wxTreeItemId& item,
ee4b2721 1350 wxTreeItemIdValue& cookie) const
08b7c251 1351{
05b2a432
RD
1352 wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1353
08b7c251 1354 // remember the last child returned in 'cookie'
ee4b2721
VZ
1355 cookie = TreeView_GetChild(GetHwnd(), HITEM(item));
1356
1357 return wxTreeItemId(cookie);
1358}
1359
1360wxTreeItemId wxTreeCtrl::GetNextChild(const wxTreeItemId& WXUNUSED(item),
1361 wxTreeItemIdValue& cookie) const
1362{
44d60c0b
WS
1363 wxTreeItemId fromCookie(cookie);
1364
1365 HTREEITEM hitem = HITEM(fromCookie);
1366
1367 hitem = TreeView_GetNextSibling(GetHwnd(), hitem);
1368
1369 wxTreeItemId item(hitem);
1370
ee4b2721
VZ
1371 cookie = item.m_pItem;
1372
1373 return item;
1374}
2bda0e17 1375
978f38c2
VZ
1376wxTreeItemId wxTreeCtrl::GetLastChild(const wxTreeItemId& item) const
1377{
05b2a432
RD
1378 wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
1379
978f38c2 1380 // can this be done more efficiently?
ee4b2721 1381 wxTreeItemIdValue cookie;
978f38c2
VZ
1382
1383 wxTreeItemId childLast,
2165ad93 1384 child = GetFirstChild(item, cookie);
978f38c2
VZ
1385 while ( child.IsOk() )
1386 {
1387 childLast = child;
2165ad93 1388 child = GetNextChild(item, cookie);
978f38c2
VZ
1389 }
1390
1391 return childLast;
1392}
1393
08b7c251
VZ
1394wxTreeItemId wxTreeCtrl::GetNextSibling(const wxTreeItemId& item) const
1395{
05b2a432 1396 wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
ee4b2721 1397 return wxTreeItemId(TreeView_GetNextSibling(GetHwnd(), HITEM(item)));
2bda0e17
KB
1398}
1399
08b7c251 1400wxTreeItemId wxTreeCtrl::GetPrevSibling(const wxTreeItemId& item) const
2bda0e17 1401{
05b2a432 1402 wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
ee4b2721 1403 return wxTreeItemId(TreeView_GetPrevSibling(GetHwnd(), HITEM(item)));
2bda0e17
KB
1404}
1405
08b7c251 1406wxTreeItemId wxTreeCtrl::GetFirstVisibleItem() const
2bda0e17 1407{
ee4b2721 1408 return wxTreeItemId(TreeView_GetFirstVisible(GetHwnd()));
2bda0e17
KB
1409}
1410
08b7c251 1411wxTreeItemId wxTreeCtrl::GetNextVisible(const wxTreeItemId& item) const
2bda0e17 1412{
05b2a432 1413 wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
f6bcfd97 1414 wxASSERT_MSG( IsVisible(item), wxT("The item you call GetNextVisible() for must be visible itself!"));
02ce7b72 1415
f73eddd2
VZ
1416 wxTreeItemId next(TreeView_GetNextVisible(GetHwnd(), HITEM(item)));
1417 if ( next.IsOk() && !IsVisible(next) )
1418 {
1419 // Win32 considers that any non-collapsed item is visible while we want
1420 // to return only really visible items
1421 next.Unset();
1422 }
1423
1424 return next;
08b7c251 1425}
02ce7b72 1426
08b7c251
VZ
1427wxTreeItemId wxTreeCtrl::GetPrevVisible(const wxTreeItemId& item) const
1428{
05b2a432 1429 wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
f6bcfd97 1430 wxASSERT_MSG( IsVisible(item), wxT("The item you call GetPrevVisible() for must be visible itself!"));
02ce7b72 1431
f73eddd2
VZ
1432 wxTreeItemId prev(TreeView_GetPrevVisible(GetHwnd(), HITEM(item)));
1433 if ( prev.IsOk() && !IsVisible(prev) )
1434 {
1435 // just as above, Win32 function will happily return the previous item
1436 // in the tree for the first visible item too
1437 prev.Unset();
1438 }
1439
1440 return prev;
08b7c251 1441}
02ce7b72 1442
9dfbf520
VZ
1443// ----------------------------------------------------------------------------
1444// multiple selections emulation
1445// ----------------------------------------------------------------------------
1446
1447bool wxTreeCtrl::IsItemChecked(const wxTreeItemId& item) const
1448{
bfbb0b4c 1449 wxCHECK_MSG( item.IsOk(), false, wxT("invalid tree item") );
05b2a432 1450
9dfbf520
VZ
1451 // receive the desired information.
1452 wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_STATEIMAGEMASK);
1453 DoGetItem(&tvItem);
1454
1455 // state image indices are 1 based
1456 return ((tvItem.state >> 12) - 1) == 1;
1457}
1458
1459void wxTreeCtrl::SetItemCheck(const wxTreeItemId& item, bool check)
1460{
05b2a432
RD
1461 wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
1462
9dfbf520
VZ
1463 // receive the desired information.
1464 wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_STATEIMAGEMASK);
1465
a9c1265f
VZ
1466 DoGetItem(&tvItem);
1467
9dfbf520
VZ
1468 // state images are one-based
1469 tvItem.state = (check ? 2 : 1) << 12;
1470
1471 DoSetItem(&tvItem);
1472}
1473
33961d59
RR
1474size_t wxTreeCtrl::GetSelections(wxArrayTreeItemIds& selections) const
1475{
1476 TraverseSelections selector(this, selections);
9dfbf520 1477
e47c4d48 1478 return selector.GetCount();
9dfbf520
VZ
1479}
1480
08b7c251
VZ
1481// ----------------------------------------------------------------------------
1482// Usual operations
1483// ----------------------------------------------------------------------------
02ce7b72 1484
8cee4a30
VZ
1485wxTreeItemId wxTreeCtrl::DoInsertAfter(const wxTreeItemId& parent,
1486 const wxTreeItemId& hInsertAfter,
1487 const wxString& text,
1488 int image, int selectedImage,
1489 wxTreeItemData *data)
08b7c251 1490{
0e935169
VZ
1491 wxCHECK_MSG( parent.IsOk() || !TreeView_GetRoot(GetHwnd()),
1492 wxTreeItemId(),
1493 _T("can't have more than one root in the tree") );
1494
08b7c251 1495 TV_INSERTSTRUCT tvIns;
3f7bc32b
VZ
1496 tvIns.hParent = HITEM(parent);
1497 tvIns.hInsertAfter = HITEM(hInsertAfter);
58a8ab88 1498
74b31181
VZ
1499 // this is how we insert the item as the first child: supply a NULL
1500 // hInsertAfter
1501 if ( !tvIns.hInsertAfter )
58a8ab88
JS
1502 {
1503 tvIns.hInsertAfter = TVI_FIRST;
1504 }
1505
08b7c251 1506 UINT mask = 0;
44d60c0b 1507 if ( !text.empty() )
08b7c251
VZ
1508 {
1509 mask |= TVIF_TEXT;
c9f78968 1510 tvIns.item.pszText = (wxChar *)text.wx_str(); // cast is ok
08b7c251 1511 }
f6bcfd97
BP
1512 else
1513 {
1514 tvIns.item.pszText = NULL;
1515 tvIns.item.cchTextMax = 0;
1516 }
02ce7b72 1517
1b182562
VZ
1518 // create the param which will store the other item parameters
1519 wxTreeItemParam *param = new wxTreeItemParam;
1520
1521 // we return the images on demand as they depend on whether the item is
1522 // expanded or collapsed too in our case
4523ebb3
VZ
1523 mask |= TVIF_IMAGE | TVIF_SELECTEDIMAGE;
1524 tvIns.item.iImage = I_IMAGECALLBACK;
1525 tvIns.item.iSelectedImage = I_IMAGECALLBACK;
3a5a2f56 1526
4523ebb3 1527 param->SetImage(image, wxTreeItemIcon_Normal);
1b182562 1528 param->SetImage(selectedImage, wxTreeItemIcon_Selected);
02ce7b72 1529
4523ebb3
VZ
1530 mask |= TVIF_PARAM;
1531 tvIns.item.lParam = (LPARAM)param;
08b7c251 1532 tvIns.item.mask = mask;
02ce7b72 1533
7e45c159
VZ
1534 const bool firstChild = !TreeView_GetChild(GetHwnd(), HITEM(parent));
1535
1b182562 1536 HTREEITEM id = TreeView_InsertItem(GetHwnd(), &tvIns);
08b7c251
VZ
1537 if ( id == 0 )
1538 {
f6bcfd97 1539 wxLogLastError(wxT("TreeView_InsertItem"));
08b7c251 1540 }
02ce7b72 1541
7e45c159
VZ
1542 // apparently some Windows versions (2000 and XP are reported to do this)
1543 // sometimes don't refresh the tree after adding the first child and so we
1544 // need this to make the "[+]" appear
1545 if ( firstChild )
1546 {
1547 RECT rect;
1548 TreeView_GetItemRect(GetHwnd(), HITEM(parent), &rect, FALSE);
1549 ::InvalidateRect(GetHwnd(), &rect, FALSE);
1550 }
1551
4523ebb3
VZ
1552 // associate the application tree item with Win32 tree item handle
1553 param->SetItem(id);
1554
1555 // setup wxTreeItemData
fd3f686c
VZ
1556 if ( data != NULL )
1557 {
4523ebb3 1558 param->SetData(data);
ee4b2721 1559 data->SetId(id);
fd3f686c
VZ
1560 }
1561
ee4b2721 1562 return wxTreeItemId(id);
2bda0e17
KB
1563}
1564
08b7c251
VZ
1565wxTreeItemId wxTreeCtrl::AddRoot(const wxString& text,
1566 int image, int selectedImage,
1567 wxTreeItemData *data)
2bda0e17 1568{
0228081f 1569 if ( HasFlag(wxTR_HIDE_ROOT) )
a9c1265f 1570 {
2a69b4e8
VZ
1571 wxASSERT_MSG( !m_pVirtualRoot, _T("tree can have only a single root") );
1572
a9c1265f 1573 // create a virtual root item, the parent for all the others
4523ebb3
VZ
1574 wxTreeItemParam *param = new wxTreeItemParam;
1575 param->SetData(data);
1576
1577 m_pVirtualRoot = new wxVirtualNode(param);
a9c1265f
VZ
1578
1579 return TVI_ROOT;
1580 }
1581
8cee4a30
VZ
1582 return DoInsertAfter(wxTreeItemId(), wxTreeItemId(),
1583 text, image, selectedImage, data);
2bda0e17
KB
1584}
1585
8cee4a30
VZ
1586wxTreeItemId wxTreeCtrl::DoInsertItem(const wxTreeItemId& parent,
1587 size_t index,
1588 const wxString& text,
1589 int image, int selectedImage,
1590 wxTreeItemData *data)
2ef31e80 1591{
8cee4a30
VZ
1592 wxTreeItemId idPrev;
1593 if ( index == (size_t)-1 )
2ef31e80 1594 {
8cee4a30
VZ
1595 // special value: append to the end
1596 idPrev = TVI_LAST;
2ef31e80 1597 }
8cee4a30
VZ
1598 else // find the item from index
1599 {
1600 wxTreeItemIdValue cookie;
1601 wxTreeItemId idCur = GetFirstChild(parent, cookie);
1602 while ( index != 0 && idCur.IsOk() )
1603 {
1604 index--;
2ef31e80 1605
8cee4a30
VZ
1606 idPrev = idCur;
1607 idCur = GetNextChild(parent, cookie);
1608 }
2ef31e80 1609
8cee4a30
VZ
1610 // assert, not check: if the index is invalid, we will append the item
1611 // to the end
1612 wxASSERT_MSG( index == 0, _T("bad index in wxTreeCtrl::InsertItem") );
1613 }
2ef31e80 1614
8cee4a30 1615 return DoInsertAfter(parent, idPrev, text, image, selectedImage, data);
2bda0e17
KB
1616}
1617
08b7c251 1618void wxTreeCtrl::Delete(const wxTreeItemId& item)
2bda0e17 1619{
396f85ba
BW
1620 // unlock tree selections on vista, without this the
1621 // tree ctrl will eventually crash after item deletion
1622 TreeItemUnlocker unlock_all;
1623
3f7bc32b 1624 if ( !TreeView_DeleteItem(GetHwnd(), HITEM(item)) )
bbcdf8bc 1625 {
f6bcfd97 1626 wxLogLastError(wxT("TreeView_DeleteItem"));
bbcdf8bc 1627 }
bbcdf8bc
JS
1628}
1629
23fd5130
VZ
1630// delete all children (but don't delete the item itself)
1631void wxTreeCtrl::DeleteChildren(const wxTreeItemId& item)
1632{
396f85ba
BW
1633 // unlock tree selections on vista for the duration of this call
1634 TreeItemUnlocker unlock_all;
1635
ee4b2721 1636 wxTreeItemIdValue cookie;
23fd5130 1637
ee4b2721 1638 wxArrayTreeItemIds children;
23fd5130
VZ
1639 wxTreeItemId child = GetFirstChild(item, cookie);
1640 while ( child.IsOk() )
1641 {
ee4b2721 1642 children.Add(child);
23fd5130
VZ
1643
1644 child = GetNextChild(item, cookie);
1645 }
1646
1647 size_t nCount = children.Count();
1648 for ( size_t n = 0; n < nCount; n++ )
1649 {
14ba002a 1650 if ( !TreeView_DeleteItem(GetHwnd(), HITEM(children[n])) )
23fd5130 1651 {
f6bcfd97 1652 wxLogLastError(wxT("TreeView_DeleteItem"));
23fd5130
VZ
1653 }
1654 }
1655}
1656
08b7c251 1657void wxTreeCtrl::DeleteAllItems()
bbcdf8bc 1658{
396f85ba
BW
1659 // unlock tree selections on vista for the duration of this call
1660 TreeItemUnlocker unlock_all;
1661
bfedf621
VZ
1662 // delete the "virtual" root item.
1663 if ( GET_VIRTUAL_ROOT() )
1664 {
1665 delete GET_VIRTUAL_ROOT();
1666 m_pVirtualRoot = NULL;
1667 }
1668
1669 // and all the real items
a9c1265f 1670
d220ae32 1671 if ( !TreeView_DeleteAllItems(GetHwnd()) )
bbcdf8bc 1672 {
f6bcfd97 1673 wxLogLastError(wxT("TreeView_DeleteAllItems"));
bbcdf8bc 1674 }
2bda0e17
KB
1675}
1676
08b7c251 1677void wxTreeCtrl::DoExpand(const wxTreeItemId& item, int flag)
2bda0e17 1678{
dd3646fd
VZ
1679 wxASSERT_MSG( flag == TVE_COLLAPSE ||
1680 flag == (TVE_COLLAPSE | TVE_COLLAPSERESET) ||
1681 flag == TVE_EXPAND ||
1682 flag == TVE_TOGGLE,
223d09f6 1683 wxT("Unknown flag in wxTreeCtrl::DoExpand") );
08b7c251 1684
a9c1265f 1685 // A hidden root can be neither expanded nor collapsed.
0228081f 1686 wxCHECK_RET( !IsHiddenRoot(item),
637b7e4f 1687 wxT("Can't expand/collapse hidden root node!") );
a9c1265f 1688
08b7c251 1689 // TreeView_Expand doesn't send TVN_ITEMEXPAND(ING) messages, so we must
d220ae32
VZ
1690 // emulate them. This behaviour has changed slightly with comctl32.dll
1691 // v 4.70 - now it does send them but only the first time. To maintain
1692 // compatible behaviour and also in order to not have surprises with the
1693 // future versions, don't rely on this and still do everything ourselves.
1694 // To avoid that the messages be sent twice when the item is expanded for
1695 // the first time we must clear TVIS_EXPANDEDONCE style manually.
1696
1697 wxTreeViewItem tvItem(item, TVIF_STATE, TVIS_EXPANDEDONCE);
1698 tvItem.state = 0;
1699 DoSetItem(&tvItem);
1700
3f7bc32b 1701 if ( TreeView_Expand(GetHwnd(), HITEM(item), flag) != 0 )
08b7c251 1702 {
deb1de30
VZ
1703 // note that the {EXPAND|COLLAPS}ING event is sent by TreeView_Expand()
1704 // itself
09f277d6
VZ
1705 wxTreeEvent event(gs_expandEvents[IsExpanded(item) ? IDX_EXPAND
1706 : IDX_COLLAPSE]
1707 [IDX_DONE],
1708 this, item);
937013e0 1709 (void)HandleWindowEvent(event);
08b7c251 1710 }
d220ae32 1711 //else: change didn't took place, so do nothing at all
2bda0e17
KB
1712}
1713
08b7c251 1714void wxTreeCtrl::Expand(const wxTreeItemId& item)
2bda0e17 1715{
08b7c251 1716 DoExpand(item, TVE_EXPAND);
2bda0e17 1717}
2bda0e17 1718
08b7c251 1719void wxTreeCtrl::Collapse(const wxTreeItemId& item)
2bda0e17 1720{
08b7c251 1721 DoExpand(item, TVE_COLLAPSE);
2bda0e17
KB
1722}
1723
08b7c251 1724void wxTreeCtrl::CollapseAndReset(const wxTreeItemId& item)
2bda0e17 1725{
dd3646fd 1726 DoExpand(item, TVE_COLLAPSE | TVE_COLLAPSERESET);
2bda0e17
KB
1727}
1728
08b7c251 1729void wxTreeCtrl::Toggle(const wxTreeItemId& item)
2bda0e17 1730{
08b7c251 1731 DoExpand(item, TVE_TOGGLE);
2bda0e17
KB
1732}
1733
08b7c251 1734void wxTreeCtrl::Unselect()
2bda0e17 1735{
3f7bc32b
VZ
1736 wxASSERT_MSG( !(m_windowStyle & wxTR_MULTIPLE),
1737 wxT("doesn't make sense, may be you want UnselectAll()?") );
9dfbf520
VZ
1738
1739 // just remove the selection
ee4b2721 1740 SelectItem(wxTreeItemId());
08b7c251 1741}
02ce7b72 1742
9dfbf520 1743void wxTreeCtrl::UnselectAll()
08b7c251 1744{
9dfbf520 1745 if ( m_windowStyle & wxTR_MULTIPLE )
2bda0e17 1746 {
9dfbf520
VZ
1747 wxArrayTreeItemIds selections;
1748 size_t count = GetSelections(selections);
1749 for ( size_t n = 0; n < count; n++ )
d220ae32 1750 {
14ba002a 1751 ::UnselectItem(GetHwnd(), HITEM(selections[n]));
d220ae32 1752 }
ba8a1961
VZ
1753
1754 m_htSelStart.Unset();
9dfbf520 1755 }
75afdc2d 1756 else
9dfbf520
VZ
1757 {
1758 // just remove the selection
1759 Unselect();
1760 }
1761}
1762
3e9af289 1763void wxTreeCtrl::SelectItem(const wxTreeItemId& item, bool select)
9dfbf520 1764{
8a536fa3
VZ
1765 wxCHECK_RET( !IsHiddenRoot(item), _T("can't select hidden root item") );
1766
cc87a04c
VZ
1767 wxASSERT_MSG( select || HasFlag(wxTR_MULTIPLE),
1768 _T("SelectItem(false) works only for multiselect") );
9dfbf520 1769
cc87a04c 1770 wxTreeEvent event(wxEVT_COMMAND_TREE_SEL_CHANGING, this, item);
937013e0 1771 if ( !HandleWindowEvent(event) || event.IsAllowed() )
cc87a04c 1772 {
7549148b 1773 if ( HasFlag(wxTR_MULTIPLE) )
d220ae32 1774 {
7549148b
VZ
1775 if ( !::SelectItem(GetHwnd(), HITEM(item), select) )
1776 {
1777 wxLogLastError(wxT("TreeView_SelectItem"));
1778 return;
1779 }
cc87a04c 1780 }
7549148b 1781 else // single selection
cc87a04c 1782 {
7549148b
VZ
1783 // use TreeView_SelectItem() to deselect the previous selection
1784 if ( !TreeView_SelectItem(GetHwnd(), HITEM(item)) )
1785 {
1786 wxLogLastError(wxT("TreeView_SelectItem"));
1787 return;
1788 }
d220ae32 1789 }
7549148b
VZ
1790
1791 event.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED);
937013e0 1792 (void)HandleWindowEvent(event);
2bda0e17 1793 }
cc87a04c 1794 //else: program vetoed the change
08b7c251 1795}
2bda0e17 1796
08b7c251
VZ
1797void wxTreeCtrl::EnsureVisible(const wxTreeItemId& item)
1798{
0228081f
VZ
1799 wxCHECK_RET( !IsHiddenRoot(item), _T("can't show hidden root item") );
1800
08b7c251 1801 // no error return
3f7bc32b 1802 TreeView_EnsureVisible(GetHwnd(), HITEM(item));
08b7c251
VZ
1803}
1804
1805void wxTreeCtrl::ScrollTo(const wxTreeItemId& item)
1806{
3f7bc32b 1807 if ( !TreeView_SelectSetFirstVisible(GetHwnd(), HITEM(item)) )
2bda0e17 1808 {
f6bcfd97 1809 wxLogLastError(wxT("TreeView_SelectSetFirstVisible"));
2bda0e17 1810 }
08b7c251
VZ
1811}
1812
44fbc477 1813wxTextCtrl *wxTreeCtrl::GetEditControl() const
08b7c251
VZ
1814{
1815 return m_textCtrl;
1816}
1817
1818void wxTreeCtrl::DeleteTextCtrl()
1819{
1820 if ( m_textCtrl )
2bda0e17 1821 {
b6a3d6ad
VZ
1822 // the HWND corresponding to this control is deleted by the tree
1823 // control itself and we don't know when exactly this happens, so check
1824 // if the window still exists before calling UnsubclassWin()
1825 if ( !::IsWindow(GetHwndOf(m_textCtrl)) )
1826 {
1827 m_textCtrl->SetHWND(0);
1828 }
1829
08b7c251
VZ
1830 m_textCtrl->UnsubclassWin();
1831 m_textCtrl->SetHWND(0);
1832 delete m_textCtrl;
1833 m_textCtrl = NULL;
1a4088e1
VZ
1834
1835 m_idEdited.Unset();
2bda0e17 1836 }
08b7c251 1837}
2bda0e17 1838
4523ebb3
VZ
1839wxTextCtrl *wxTreeCtrl::EditLabel(const wxTreeItemId& item,
1840 wxClassInfo *textControlClass)
08b7c251
VZ
1841{
1842 wxASSERT( textControlClass->IsKindOf(CLASSINFO(wxTextCtrl)) );
1843
b94ae1ea
VZ
1844 DeleteTextCtrl();
1845
1a4088e1 1846 m_idEdited = item;
cd6bd270 1847 m_textCtrl = (wxTextCtrl *)textControlClass->CreateObject();
3f7bc32b 1848 HWND hWnd = (HWND) TreeView_EditLabel(GetHwnd(), HITEM(item));
2bda0e17 1849
5ea47806 1850 // this is not an error - the TVN_BEGINLABELEDIT handler might have
04cd30de 1851 // returned false
5ea47806
VZ
1852 if ( !hWnd )
1853 {
cd6bd270
MB
1854 delete m_textCtrl;
1855 m_textCtrl = NULL;
5ea47806
VZ
1856 return NULL;
1857 }
2bda0e17 1858
cd6bd270 1859 // textctrl is subclassed in MSWOnNotify
08b7c251 1860 return m_textCtrl;
2bda0e17
KB
1861}
1862
08b7c251 1863// End label editing, optionally cancelling the edit
d35dce3a 1864void wxTreeCtrl::DoEndEditLabel(bool discardChanges)
2bda0e17 1865{
d220ae32 1866 TreeView_EndEditLabelNow(GetHwnd(), discardChanges);
08b7c251
VZ
1867
1868 DeleteTextCtrl();
2bda0e17
KB
1869}
1870
be0e5d69 1871wxTreeItemId wxTreeCtrl::DoTreeHitTest(const wxPoint& point, int& flags) const
2bda0e17 1872{
08b7c251
VZ
1873 TV_HITTESTINFO hitTestInfo;
1874 hitTestInfo.pt.x = (int)point.x;
1875 hitTestInfo.pt.y = (int)point.y;
2bda0e17 1876
8ecd5de2 1877 (void) TreeView_HitTest(GetHwnd(), &hitTestInfo);
2bda0e17 1878
08b7c251
VZ
1879 flags = 0;
1880
1881 // avoid repetition
1882 #define TRANSLATE_FLAG(flag) if ( hitTestInfo.flags & TVHT_##flag ) \
1883 flags |= wxTREE_HITTEST_##flag
1884
1885 TRANSLATE_FLAG(ABOVE);
1886 TRANSLATE_FLAG(BELOW);
1887 TRANSLATE_FLAG(NOWHERE);
1888 TRANSLATE_FLAG(ONITEMBUTTON);
1889 TRANSLATE_FLAG(ONITEMICON);
1890 TRANSLATE_FLAG(ONITEMINDENT);
1891 TRANSLATE_FLAG(ONITEMLABEL);
1892 TRANSLATE_FLAG(ONITEMRIGHT);
1893 TRANSLATE_FLAG(ONITEMSTATEICON);
1894 TRANSLATE_FLAG(TOLEFT);
1895 TRANSLATE_FLAG(TORIGHT);
2bda0e17 1896
08b7c251
VZ
1897 #undef TRANSLATE_FLAG
1898
ee4b2721 1899 return wxTreeItemId(hitTestInfo.hItem);
08b7c251
VZ
1900}
1901
f7c832a7
VZ
1902bool wxTreeCtrl::GetBoundingRect(const wxTreeItemId& item,
1903 wxRect& rect,
1904 bool textOnly) const
1905{
1906 RECT rc;
f2c3db9d
RD
1907
1908 // Virtual root items have no bounding rectangle
1909 if ( IS_VIRTUAL_ROOT(item) )
1910 {
1911 return false;
1912 }
1913
3f7bc32b 1914 if ( TreeView_GetItemRect(GetHwnd(), HITEM(item),
f7c832a7
VZ
1915 &rc, textOnly) )
1916 {
1917 rect = wxRect(wxPoint(rc.left, rc.top), wxPoint(rc.right, rc.bottom));
1918
04cd30de 1919 return true;
f7c832a7
VZ
1920 }
1921 else
1922 {
1923 // couldn't retrieve rect: for example, item isn't visible
04cd30de 1924 return false;
f7c832a7
VZ
1925 }
1926}
1927
23fd5130
VZ
1928// ----------------------------------------------------------------------------
1929// sorting stuff
1930// ----------------------------------------------------------------------------
f7c832a7 1931
502a2b18
VZ
1932// this is just a tiny namespace which is friend to wxTreeCtrl and so can use
1933// functions such as IsDataIndirect()
1934class wxTreeSortHelper
1935{
1936public:
1937 static int CALLBACK Compare(LPARAM data1, LPARAM data2, LPARAM tree);
1938
1939private:
4523ebb3 1940 static wxTreeItemId GetIdFromData(LPARAM lParam)
502a2b18 1941 {
4523ebb3 1942 return ((wxTreeItemParam*)lParam)->GetItem();
502a2b18 1943 }
502a2b18
VZ
1944};
1945
1946int CALLBACK wxTreeSortHelper::Compare(LPARAM pItem1,
1947 LPARAM pItem2,
1948 LPARAM htree)
23fd5130 1949{
096c9f9b 1950 wxCHECK_MSG( pItem1 && pItem2, 0,
223d09f6 1951 wxT("sorting tree without data doesn't make sense") );
096c9f9b 1952
502a2b18
VZ
1953 wxTreeCtrl *tree = (wxTreeCtrl *)htree;
1954
4523ebb3
VZ
1955 return tree->OnCompareItems(GetIdFromData(pItem1),
1956 GetIdFromData(pItem2));
23fd5130
VZ
1957}
1958
95aabccc
VZ
1959void wxTreeCtrl::SortChildren(const wxTreeItemId& item)
1960{
05b2a432
RD
1961 wxCHECK_RET( item.IsOk(), wxT("invalid tree item") );
1962
95aabccc 1963 // rely on the fact that TreeView_SortChildren does the same thing as our
23fd5130
VZ
1964 // default behaviour, i.e. sorts items alphabetically and so call it
1965 // directly if we're not in derived class (much more efficient!)
4523ebb3
VZ
1966 // RN: Note that if you find you're code doesn't sort as expected this
1967 // may be why as if you don't use the DECLARE_CLASS/IMPLEMENT_CLASS
1968 // combo for your derived wxTreeCtrl if will sort without
1969 // OnCompareItems
23fd5130 1970 if ( GetClassInfo() == CLASSINFO(wxTreeCtrl) )
2bda0e17 1971 {
3f7bc32b 1972 TreeView_SortChildren(GetHwnd(), HITEM(item), 0);
2bda0e17 1973 }
08b7c251 1974 else
2bda0e17 1975 {
62448488 1976 TV_SORTCB tvSort;
3f7bc32b 1977 tvSort.hParent = HITEM(item);
502a2b18 1978 tvSort.lpfnCompare = wxTreeSortHelper::Compare;
23fd5130 1979 tvSort.lParam = (LPARAM)this;
d220ae32 1980 TreeView_SortChildrenCB(GetHwnd(), &tvSort, 0 /* reserved */);
2bda0e17 1981 }
08b7c251 1982}
2bda0e17 1983
08b7c251
VZ
1984// ----------------------------------------------------------------------------
1985// implementation
1986// ----------------------------------------------------------------------------
2bda0e17 1987
90c6edd7
VZ
1988bool wxTreeCtrl::MSWShouldPreProcessMessage(WXMSG* msg)
1989{
1990 if ( msg->message == WM_KEYDOWN )
1991 {
6719c06a
VZ
1992 // Only eat VK_RETURN if not being used by the application in
1993 // conjunction with modifiers
1994 if ( (msg->wParam == VK_RETURN) && !wxIsAnyModifierDown() )
90c6edd7
VZ
1995 {
1996 // we need VK_RETURN to generate wxEVT_COMMAND_TREE_ITEM_ACTIVATED
1997 return false;
1998 }
1999 }
2000
2001 return wxTreeCtrlBase::MSWShouldPreProcessMessage(msg);
2002}
2003
0edeeb6d 2004bool wxTreeCtrl::MSWCommand(WXUINT cmd, WXWORD id_)
08b7c251 2005{
0edeeb6d
VZ
2006 const int id = (signed short)id_;
2007
08b7c251 2008 if ( cmd == EN_UPDATE )
2bda0e17 2009 {
08b7c251
VZ
2010 wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, id);
2011 event.SetEventObject( this );
2012 ProcessCommand(event);
2bda0e17 2013 }
08b7c251 2014 else if ( cmd == EN_KILLFOCUS )
2bda0e17 2015 {
08b7c251
VZ
2016 wxCommandEvent event(wxEVT_KILL_FOCUS, id);
2017 event.SetEventObject( this );
2018 ProcessCommand(event);
2bda0e17 2019 }
08b7c251 2020 else
2bda0e17 2021 {
08b7c251 2022 // nothing done
04cd30de 2023 return false;
2bda0e17 2024 }
08b7c251
VZ
2025
2026 // command processed
04cd30de 2027 return true;
08b7c251
VZ
2028}
2029
23f681ec
VZ
2030// we hook into WndProc to process WM_MOUSEMOVE/WM_BUTTONUP messages - as we
2031// only do it during dragging, minimize wxWin overhead (this is important for
2032// WM_MOUSEMOVE as they're a lot of them) by catching Windows messages directly
2033// instead of passing by wxWin events
c140b7e7 2034WXLRESULT wxTreeCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
23f681ec 2035{
04cd30de 2036 bool processed = false;
c140b7e7 2037 WXLRESULT rc = 0;
2b9a7d4c 2038 bool isMultiple = HasFlag(wxTR_MULTIPLE);
3f7bc32b 2039
147964ca 2040 // This message is sent after a right-click, or when the "menu" key is pressed
499bbaeb 2041 if ( nMsg == WM_CONTEXTMENU )
30f5e34f 2042 {
147964ca
KH
2043 int x = GET_X_LPARAM(lParam),
2044 y = GET_Y_LPARAM(lParam);
8f6dc819
VZ
2045
2046 // the item for which the menu should be shown
2047 wxTreeItemId item;
2048
2049 // the position where the menu should be shown in client coordinates
2050 // (so that it can be passed directly to PopupMenu())
2051 wxPoint pt;
2052
2053 if ( x == -1 || y == -1 )
147964ca 2054 {
8f6dc819
VZ
2055 // this means that the event was generated from keyboard (e.g. with
2056 // Shift-F10 or special Windows menu key)
2057 //
2058 // use the Explorer standard of putting the menu at the left edge
2059 // of the text, in the vertical middle of the text
2060 item = wxTreeItemId(TreeView_GetSelection(GetHwnd()));
2061 if ( item.IsOk() )
2062 {
2063 // Use the bounding rectangle of only the text part
2064 wxRect rect;
2065 GetBoundingRect(item, rect, true);
2066 pt = wxPoint(rect.GetX(), rect.GetY() + rect.GetHeight() / 2);
2067 }
147964ca 2068 }
8f6dc819 2069 else // event from mouse, use mouse position
147964ca 2070 {
8f6dc819
VZ
2071 pt = ScreenToClient(wxPoint(x, y));
2072
2073 TV_HITTESTINFO tvhti;
2074 tvhti.pt.x = pt.x;
2075 tvhti.pt.y = pt.y;
2076 if ( TreeView_HitTest(GetHwnd(), &tvhti) )
2077 item = wxTreeItemId(tvhti.hItem);
147964ca
KH
2078 }
2079
8f6dc819
VZ
2080 // create the event
2081 wxTreeEvent event(wxEVT_COMMAND_TREE_ITEM_MENU, this, item);
2082
2083 event.m_pointDrag = pt;
2084
937013e0 2085 if ( HandleWindowEvent(event) )
2b9a7d4c 2086 processed = true;
9994e2da 2087 //else: continue with generating wxEVT_CONTEXT_MENU in base class code
30f5e34f 2088 }
2b9a7d4c 2089 else if ( (nMsg >= WM_MOUSEFIRST) && (nMsg <= WM_MOUSELAST) )
23f681ec 2090 {
7bb8798c
VZ
2091 // we only process mouse messages here and these parameters have the
2092 // same meaning for all of them
3f7bc32b
VZ
2093 int x = GET_X_LPARAM(lParam),
2094 y = GET_Y_LPARAM(lParam);
8ecd5de2 2095
e3ad5702
JS
2096 TV_HITTESTINFO tvht;
2097 tvht.pt.x = x;
2098 tvht.pt.y = y;
8ecd5de2 2099
8854a202 2100 HTREEITEM htItem = TreeView_HitTest(GetHwnd(), &tvht);
3f7bc32b 2101
23f681ec
VZ
2102 switch ( nMsg )
2103 {
3f7bc32b 2104 case WM_LBUTTONDOWN:
e3ad5702 2105 if ( htItem && isMultiple && (tvht.flags & TVHT_ONITEM) != 0 )
23f681ec 2106 {
e3ad5702
JS
2107 m_htClickedItem = (WXHTREEITEM) htItem;
2108 m_ptClick = wxPoint(x, y);
8ecd5de2 2109
3f7bc32b
VZ
2110 if ( wParam & MK_CONTROL )
2111 {
2112 SetFocus();
23f681ec 2113
3f7bc32b 2114 // toggle selected state
cc87a04c 2115 ToggleItemSelection(htItem);
3f7bc32b
VZ
2116
2117 ::SetFocus(GetHwnd(), htItem);
2118
2119 // reset on any click without Shift
f888d614 2120 m_htSelStart.Unset();
3f7bc32b 2121
04cd30de 2122 processed = true;
3f7bc32b
VZ
2123 }
2124 else if ( wParam & MK_SHIFT )
2125 {
2126 // this selects all items between the starting one and
2127 // the current
2128
2129 if ( !m_htSelStart )
2130 {
2131 // take the focused item
ee4b2721 2132 m_htSelStart = TreeView_GetSelection(GetHwnd());
3f7bc32b
VZ
2133 }
2134
e3ad5702
JS
2135 if ( m_htSelStart )
2136 SelectRange(GetHwnd(), HITEM(m_htSelStart), htItem,
3f7bc32b 2137 !(wParam & MK_CONTROL));
e3ad5702
JS
2138 else
2139 ::SelectItem(GetHwnd(), htItem);
3f7bc32b
VZ
2140
2141 ::SetFocus(GetHwnd(), htItem);
23f681ec 2142
04cd30de 2143 processed = true;
3f7bc32b
VZ
2144 }
2145 else // normal click
2146 {
df4ac4c7
VZ
2147 // avoid doing anything if we click on the only
2148 // currently selected item
8ecd5de2 2149
e3ad5702 2150 SetFocus();
5e7718a2 2151
df4ac4c7
VZ
2152 wxArrayTreeItemIds selections;
2153 size_t count = GetSelections(selections);
2154 if ( count == 0 ||
35cf1ec6 2155 count > 1 ||
14ba002a 2156 HITEM(selections[0]) != htItem )
df4ac4c7 2157 {
35cf1ec6
VZ
2158 // clear the previously selected items, if the
2159 // user clicked outside of the present selection.
2160 // otherwise, perform the deselection on mouse-up.
2161 // this allows multiple drag and drop to work.
5e7718a2 2162
e3ad5702 2163 if (!IsItemSelected(GetHwnd(), htItem))
35cf1ec6
VZ
2164 {
2165 UnselectAll();
2166
2167 // prevent the click from starting in-place editing
2168 // which should only happen if we click on the
2169 // already selected item (and nothing else is
2170 // selected)
2171
2172 TreeView_SelectItem(GetHwnd(), 0);
2173 ::SelectItem(GetHwnd(), htItem);
2174 }
e3ad5702
JS
2175 ::SetFocus(GetHwnd(), htItem);
2176 processed = true;
df4ac4c7 2177 }
b8e3f1cf
VZ
2178 else // click on a single selected item
2179 {
2180 // don't interfere with the default processing in
2181 // WM_MOUSEMOVE handler below as the default window
2182 // proc will start the drag itself if we let have
2183 // WM_LBUTTONDOWN
2184 m_htClickedItem.Unset();
2185 }
3f7bc32b
VZ
2186
2187 // reset on any click without Shift
f888d614 2188 m_htSelStart.Unset();
3f7bc32b
VZ
2189 }
2190 }
2191 break;
3f7bc32b 2192
e0bf68d6
VZ
2193 case WM_RBUTTONDOWN:
2194 // default handler removes the highlight from the currently
2195 // focused item when right mouse button is pressed on another
2196 // one but keeps the remaining items highlighted, which is
2197 // confusing, so override this default behaviour for tree with
2198 // multiple selections
2199 if ( isMultiple )
2200 {
2201 if ( !IsItemSelected(GetHwnd(), htItem) )
2202 {
2203 UnselectAll();
2204 SelectItem(htItem);
2205 ::SetFocus(GetHwnd(), htItem);
2206 }
2207
2208 // fire EVT_RIGHT_DOWN
2209 HandleMouseEvent(nMsg, x, y, wParam);
20bdddad 2210
e0bf68d6
VZ
2211 // send NM_RCLICK
2212 NMHDR nmhdr;
2213 nmhdr.hwndFrom = GetHwnd();
2214 nmhdr.idFrom = ::GetWindowLong(GetHwnd(), GWL_ID);
2215 nmhdr.code = NM_RCLICK;
2216 ::SendMessage(::GetParent(GetHwnd()), WM_NOTIFY,
2217 nmhdr.idFrom, (LPARAM)&nmhdr);
2218
2219 // prevent tree control default processing, as we've
20bdddad 2220 // already done everything
e0bf68d6
VZ
2221 processed = true;
2222 }
2223 break;
2224
3f7bc32b 2225 case WM_MOUSEMOVE:
68fc69f3 2226#ifndef __WXWINCE__
e3ad5702
JS
2227 if ( m_htClickedItem )
2228 {
2229 int cx = abs(m_ptClick.x - x);
2230 int cy = abs(m_ptClick.y - y);
2231
b8e3f1cf
VZ
2232 if ( cx > ::GetSystemMetrics(SM_CXDRAG) ||
2233 cy > ::GetSystemMetrics(SM_CYDRAG) )
e3ad5702 2234 {
b8e3f1cf
VZ
2235 NM_TREEVIEW tv;
2236 wxZeroMemory(tv);
e3ad5702 2237
b8e3f1cf
VZ
2238 tv.hdr.hwndFrom = GetHwnd();
2239 tv.hdr.idFrom = ::GetWindowLong(GetHwnd(), GWL_ID);
2240 tv.hdr.code = TVN_BEGINDRAG;
8ecd5de2 2241
b8e3f1cf 2242 tv.itemNew.hItem = HITEM(m_htClickedItem);
8ecd5de2 2243
8ecd5de2 2244
b8e3f1cf
VZ
2245 TVITEM tviAux;
2246 wxZeroMemory(tviAux);
8ecd5de2 2247
b8e3f1cf
VZ
2248 tviAux.hItem = HITEM(m_htClickedItem);
2249 tviAux.mask = TVIF_STATE | TVIF_PARAM;
2250 tviAux.stateMask = 0xffffffff;
2251 TreeView_GetItem(GetHwnd(), &tviAux);
8ecd5de2 2252
b8e3f1cf
VZ
2253 tv.itemNew.state = tviAux.state;
2254 tv.itemNew.lParam = tviAux.lParam;
2255
2256 tv.ptDrag.x = x;
2257 tv.ptDrag.y = y;
2258
2259 // do it before SendMessage() call below to avoid
2260 // reentrancies here if there is another WM_MOUSEMOVE
2261 // in the queue already
e3ad5702 2262 m_htClickedItem.Unset();
b8e3f1cf
VZ
2263
2264 ::SendMessage(GetHwndOf(GetParent()), WM_NOTIFY,
2265 tv.hdr.idFrom, (LPARAM)&tv );
2266
2267 // don't pass it to the default window proc, it would
2268 // start dragging again
2269 processed = true;
e3ad5702 2270 }
e3ad5702 2271 }
68fc69f3 2272#endif // __WXWINCE__
8ecd5de2 2273
68d9be05 2274#if wxUSE_DRAGIMAGE
3f7bc32b
VZ
2275 if ( m_dragImage )
2276 {
afff720b 2277 m_dragImage->Move(wxPoint(x, y));
3f7bc32b 2278 if ( htItem )
23f681ec
VZ
2279 {
2280 // highlight the item as target (hiding drag image is
2281 // necessary - otherwise the display will be corrupted)
68be9f09 2282 m_dragImage->Hide();
3f7bc32b 2283 TreeView_SelectDropTarget(GetHwnd(), htItem);
68be9f09 2284 m_dragImage->Show();
23f681ec
VZ
2285 }
2286 }
68d9be05 2287#endif // wxUSE_DRAGIMAGE
23f681ec
VZ
2288 break;
2289
2290 case WM_LBUTTONUP:
35cf1ec6
VZ
2291
2292 // facilitates multiple drag-and-drop
2293 if (htItem && isMultiple)
2294 {
2295 wxArrayTreeItemIds selections;
2296 size_t count = GetSelections(selections);
2297
2298 if (count > 1 &&
2299 !(wParam & MK_CONTROL) &&
2300 !(wParam & MK_SHIFT))
2301 {
2302 UnselectAll();
2303 TreeView_SelectItem(GetHwnd(), htItem);
e3ad5702
JS
2304 ::SelectItem(GetHwnd(), htItem);
2305 ::SetFocus(GetHwnd(), htItem);
35cf1ec6 2306 }
e3ad5702 2307 m_htClickedItem.Unset();
35cf1ec6
VZ
2308 }
2309
2310 // fall through
2311
23f681ec 2312 case WM_RBUTTONUP:
68d9be05 2313#if wxUSE_DRAGIMAGE
3f7bc32b 2314 if ( m_dragImage )
23f681ec 2315 {
68be9f09 2316 m_dragImage->EndDrag();
23f681ec
VZ
2317 delete m_dragImage;
2318 m_dragImage = NULL;
2319
2320 // generate the drag end event
09f277d6 2321 wxTreeEvent event(wxEVT_COMMAND_TREE_END_DRAG, this, htItem);
72e61024
JS
2322 event.m_pointDrag = wxPoint(x, y);
2323
937013e0 2324 (void)HandleWindowEvent(event);
225fe9d6
VZ
2325
2326 // if we don't do it, the tree seems to think that 2 items
2327 // are selected simultaneously which is quite weird
2328 TreeView_SelectDropTarget(GetHwnd(), 0);
23f681ec 2329 }
68d9be05 2330#endif // wxUSE_DRAGIMAGE
23f681ec
VZ
2331 break;
2332 }
2333 }
3f7bc32b
VZ
2334 else if ( (nMsg == WM_SETFOCUS || nMsg == WM_KILLFOCUS) && isMultiple )
2335 {
2336 // the tree control greys out the selected item when it loses focus and
2337 // paints it as selected again when it regains it, but it won't do it
2338 // for the other items itself - help it
2339 wxArrayTreeItemIds selections;
2340 size_t count = GetSelections(selections);
2341 RECT rect;
2342 for ( size_t n = 0; n < count; n++ )
2343 {
04cd30de 2344 // TreeView_GetItemRect() will return false if item is not visible,
3f7bc32b 2345 // which may happen perfectly well
14ba002a 2346 if ( TreeView_GetItemRect(GetHwnd(), HITEM(selections[n]),
2b9a7d4c 2347 &rect, TRUE) )
3f7bc32b 2348 {
2b9a7d4c 2349 ::InvalidateRect(GetHwnd(), &rect, FALSE);
3f7bc32b
VZ
2350 }
2351 }
2352 }
2353 else if ( nMsg == WM_KEYDOWN && isMultiple )
2354 {
2355 bool bCtrl = wxIsCtrlDown(),
2356 bShift = wxIsShiftDown();
2357
2c8e4738 2358 HTREEITEM htSel = (HTREEITEM)TreeView_GetSelection(GetHwnd());
ba8a1961 2359 switch ( wParam )
3f7bc32b 2360 {
ba8a1961
VZ
2361 case VK_SPACE:
2362 if ( bCtrl )
2363 {
cc87a04c 2364 ToggleItemSelection(htSel);
ba8a1961
VZ
2365 }
2366 else
2367 {
2368 UnselectAll();
23f681ec 2369
ba8a1961
VZ
2370 ::SelectItem(GetHwnd(), htSel);
2371 }
3f7bc32b 2372
ba8a1961
VZ
2373 processed = true;
2374 break;
3f7bc32b 2375
ba8a1961
VZ
2376 case VK_UP:
2377 case VK_DOWN:
2378 if ( !bCtrl && !bShift )
3f7bc32b 2379 {
ba8a1961
VZ
2380 // no modifiers, just clear selection and then let the default
2381 // processing to take place
2382 UnselectAll();
3f7bc32b 2383 }
ba8a1961 2384 else if ( htSel )
3f7bc32b 2385 {
ba8a1961
VZ
2386 (void)wxControl::MSWWindowProc(nMsg, wParam, lParam);
2387
2388 HTREEITEM htNext = (HTREEITEM)
2389 TreeView_GetNextItem
2390 (
2391 GetHwnd(),
2392 htSel,
2393 wParam == VK_UP ? TVGN_PREVIOUSVISIBLE
2394 : TVGN_NEXTVISIBLE
2395 );
2396
2397 if ( !htNext )
2398 {
2399 // at the top/bottom
2400 htNext = htSel;
2401 }
2402
2403 if ( bShift )
2404 {
2405 if ( !m_htSelStart )
2406 m_htSelStart = htSel;
2407
2408 SelectRange(GetHwnd(), HITEM(m_htSelStart), htNext);
2409 }
2410 else // bCtrl
2411 {
2412 // without changing selection
2413 ::SetFocus(GetHwnd(), htNext);
2414 }
2415
2416 processed = true;
3f7bc32b 2417 }
ba8a1961
VZ
2418 break;
2419
2420 case VK_HOME:
2421 case VK_END:
2422 case VK_PRIOR:
2423 case VK_NEXT:
2424 // TODO: handle Shift/Ctrl with these keys
2425 if ( !bCtrl && !bShift )
3f7bc32b 2426 {
ba8a1961 2427 UnselectAll();
3f7bc32b 2428
ba8a1961
VZ
2429 m_htSelStart.Unset();
2430 }
3f7bc32b
VZ
2431 }
2432 }
d35dce3a
VZ
2433 else if ( nMsg == WM_COMMAND )
2434 {
2435 // if we receive a EN_KILLFOCUS command from the in-place edit control
2436 // used for label editing, make sure to end editing
2437 WORD id, cmd;
2438 WXHWND hwnd;
2439 UnpackCommand(wParam, lParam, &id, &hwnd, &cmd);
2440
2441 if ( cmd == EN_KILLFOCUS )
2442 {
2443 if ( m_textCtrl && m_textCtrl->GetHandle() == hwnd )
2444 {
2445 DoEndEditLabel();
2446
2447 processed = true;
2448 }
2449 }
2450 }
7bb8798c 2451
3f7bc32b
VZ
2452 if ( !processed )
2453 rc = wxControl::MSWWindowProc(nMsg, wParam, lParam);
2454
2455 return rc;
23f681ec
VZ
2456}
2457
fbd8ac52
VZ
2458WXLRESULT
2459wxTreeCtrl::MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
2460{
068b764a
VZ
2461 if ( nMsg == WM_CHAR )
2462 {
df63b2a4 2463 // don't let the control process Space and Return keys because it
068b764a
VZ
2464 // doesn't do anything useful with them anyhow but always beeps
2465 // annoyingly when it receives them and there is no way to turn it off
2466 // simply if you just process TREEITEM_ACTIVATED event to which Space
2467 // and Enter presses are mapped in your code
2468 if ( wParam == VK_SPACE || wParam == VK_RETURN )
2469 return 0;
2470 }
c4cd8712
VZ
2471#if wxUSE_DRAGIMAGE
2472 else if ( nMsg == WM_KEYDOWN )
2473 {
2474 if ( wParam == VK_ESCAPE )
2475 {
2476 if ( m_dragImage )
2477 {
2478 m_dragImage->EndDrag();
2479 delete m_dragImage;
2480 m_dragImage = NULL;
2481
2482 // if we don't do it, the tree seems to think that 2 items
2483 // are selected simultaneously which is quite weird
2484 TreeView_SelectDropTarget(GetHwnd(), 0);
2485 }
2486 }
2487 }
2488#endif // wxUSE_DRAGIMAGE
068b764a 2489
fbd8ac52
VZ
2490 return wxControl::MSWDefWindowProc(nMsg, wParam, lParam);
2491}
2492
08b7c251 2493// process WM_NOTIFY Windows message
a23fd0e1 2494bool wxTreeCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
08b7c251 2495{
09f277d6 2496 wxTreeEvent event(wxEVT_NULL, this);
08b7c251
VZ
2497 wxEventType eventType = wxEVT_NULL;
2498 NMHDR *hdr = (NMHDR *)lParam;
2499
2500 switch ( hdr->code )
2bda0e17 2501 {
08b7c251
VZ
2502 case TVN_BEGINDRAG:
2503 eventType = wxEVT_COMMAND_TREE_BEGIN_DRAG;
2504 // fall through
2505
2506 case TVN_BEGINRDRAG:
2507 {
2508 if ( eventType == wxEVT_NULL )
2509 eventType = wxEVT_COMMAND_TREE_BEGIN_RDRAG;
2510 //else: left drag, already set above
2511
2512 NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam;
2513
ee4b2721 2514 event.m_item = tv->itemNew.hItem;
08b7c251 2515 event.m_pointDrag = wxPoint(tv->ptDrag.x, tv->ptDrag.y);
23f681ec
VZ
2516
2517 // don't allow dragging by default: the user code must
2518 // explicitly say that it wants to allow it to avoid breaking
2519 // the old apps
2520 event.Veto();
08b7c251 2521 }
696e1ea0 2522 break;
08b7c251
VZ
2523
2524 case TVN_BEGINLABELEDIT:
2525 {
2526 eventType = wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT;
2527 TV_DISPINFO *info = (TV_DISPINFO *)lParam;
2528
646a8a4d
VZ
2529 // although the user event handler may still veto it, it is
2530 // important to set it now so that calls to SetItemText() from
2531 // the event handler would change the text controls contents
2532 m_idEdited =
ee4b2721 2533 event.m_item = info->item.hItem;
5ea47806 2534 event.m_label = info->item.pszText;
04cd30de 2535 event.m_editCancelled = false;
08b7c251 2536 }
696e1ea0 2537 break;
08b7c251
VZ
2538
2539 case TVN_DELETEITEM:
2540 {
2541 eventType = wxEVT_COMMAND_TREE_DELETE_ITEM;
2542 NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam;
2543
ee4b2721 2544 event.m_item = tv->itemOld.hItem;
696e1ea0
VZ
2545
2546 if ( m_hasAnyAttr )
2547 {
ee4b2721
VZ
2548 wxMapTreeAttr::iterator it = m_attrs.find(tv->itemOld.hItem);
2549 if ( it != m_attrs.end() )
2550 {
2551 delete it->second;
2552 m_attrs.erase(it);
2553 }
696e1ea0 2554 }
08b7c251 2555 }
696e1ea0 2556 break;
08b7c251
VZ
2557
2558 case TVN_ENDLABELEDIT:
2559 {
2560 eventType = wxEVT_COMMAND_TREE_END_LABEL_EDIT;
2561 TV_DISPINFO *info = (TV_DISPINFO *)lParam;
2562
ee4b2721 2563 event.m_item = info->item.hItem;
5ea47806 2564 event.m_label = info->item.pszText;
06110b00 2565 event.m_editCancelled = info->item.pszText == NULL;
08b7c251
VZ
2566 break;
2567 }
2568
676d6550 2569#ifndef __WXWINCE__
156194e1
JS
2570 // These *must* not be removed or TVN_GETINFOTIP will
2571 // not be processed each time the mouse is moved
2572 // and the tooltip will only ever update once.
2573 case TTN_NEEDTEXTA:
2574 case TTN_NEEDTEXTW:
2575 {
2576 *result = 0;
2577
2578 break;
2579 }
2580
f3f71703 2581#ifdef TVN_GETINFOTIP
156194e1
JS
2582 case TVN_GETINFOTIP:
2583 {
2584 eventType = wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP;
2585 NMTVGETINFOTIP *info = (NMTVGETINFOTIP*)lParam;
2586
2587 // Which item are we trying to get a tooltip for?
bc0aebab 2588 event.m_item = info->hItem;
156194e1
JS
2589
2590 break;
2591 }
df63b2a4
VZ
2592#endif // TVN_GETINFOTIP
2593#endif // !__WXWINCE__
5e7718a2 2594
08b7c251
VZ
2595 case TVN_GETDISPINFO:
2596 eventType = wxEVT_COMMAND_TREE_GET_INFO;
2597 // fall through
2598
2599 case TVN_SETDISPINFO:
2600 {
2601 if ( eventType == wxEVT_NULL )
2602 eventType = wxEVT_COMMAND_TREE_SET_INFO;
2603 //else: get, already set above
2604
2605 TV_DISPINFO *info = (TV_DISPINFO *)lParam;
2606
ee4b2721 2607 event.m_item = info->item.hItem;
08b7c251
VZ
2608 break;
2609 }
2610
2611 case TVN_ITEMEXPANDING:
08b7c251
VZ
2612 case TVN_ITEMEXPANDED:
2613 {
4523ebb3 2614 NM_TREEVIEW *tv = (NM_TREEVIEW*)lParam;
08b7c251 2615
deb1de30 2616 int what;
08b7c251
VZ
2617 switch ( tv->action )
2618 {
deb1de30
VZ
2619 default:
2620 wxLogDebug(wxT("unexpected code %d in TVN_ITEMEXPAND message"), tv->action);
2621 // fall through
2622
08b7c251 2623 case TVE_EXPAND:
deb1de30 2624 what = IDX_EXPAND;
08b7c251
VZ
2625 break;
2626
2627 case TVE_COLLAPSE:
deb1de30 2628 what = IDX_COLLAPSE;
08b7c251 2629 break;
08b7c251
VZ
2630 }
2631
2b5f62a0
VZ
2632 int how = hdr->code == TVN_ITEMEXPANDING ? IDX_DOING
2633 : IDX_DONE;
deb1de30
VZ
2634
2635 eventType = gs_expandEvents[what][how];
08b7c251 2636
ee4b2721 2637 event.m_item = tv->itemNew.hItem;
08b7c251 2638 }
696e1ea0 2639 break;
08b7c251
VZ
2640
2641 case TVN_KEYDOWN:
2642 {
2643 eventType = wxEVT_COMMAND_TREE_KEY_DOWN;
2644 TV_KEYDOWN *info = (TV_KEYDOWN *)lParam;
2645
1944ad76
VZ
2646 // fabricate the lParam and wParam parameters sufficiently
2647 // similar to the ones from a "real" WM_KEYDOWN so that
2648 // CreateKeyEvent() works correctly
6719c06a 2649 WXLPARAM lParam = (wxIsAltDown() ? KF_ALTDOWN : 0) << 16;
1944ad76
VZ
2650
2651 WXWPARAM wParam = info->wVKey;
2652
637b7e4f 2653 int keyCode = wxCharCodeMSWToWX(wParam);
1944ad76
VZ
2654 if ( !keyCode )
2655 {
2656 // wxCharCodeMSWToWX() returns 0 to indicate that this is a
2657 // simple ASCII key
2658 keyCode = wParam;
2659 }
2660
8191741f 2661 event.m_evtKey = CreateKeyEvent(wxEVT_KEY_DOWN,
1944ad76
VZ
2662 keyCode,
2663 lParam,
2664 wParam);
23fd5130 2665
3f7bc32b 2666 // a separate event for Space/Return
6719c06a 2667 if ( !wxIsAnyModifierDown() &&
3f7bc32b 2668 ((info->wVKey == VK_SPACE) || (info->wVKey == VK_RETURN)) )
23fd5130 2669 {
09f277d6
VZ
2670 wxTreeItemId item;
2671 if ( !HasFlag(wxTR_MULTIPLE) )
2672 item = GetSelection();
23fd5130 2673
09f277d6
VZ
2674 wxTreeEvent event2(wxEVT_COMMAND_TREE_ITEM_ACTIVATED,
2675 this, item);
937013e0 2676 (void)HandleWindowEvent(event2);
23fd5130 2677 }
08b7c251 2678 }
696e1ea0 2679 break;
08b7c251 2680
5fe302ef
BW
2681
2682 // Vista's tree control has introduced some problems with our
2683 // multi-selection tree. When TreeView_SelectItem() is called,
2684 // the wrong items are deselected.
20bdddad 2685
5fe302ef
BW
2686 // Fortunately, Vista provides a new notification, TVN_ITEMCHANGING
2687 // that can be used to regulate this incorrect behavior. The
2688 // following messages will allow only the unlocked item's selection
2689 // state to change
396f85ba 2690
5fe302ef
BW
2691 case TVN_ITEMCHANGINGA:
2692 case TVN_ITEMCHANGINGW:
2693 {
2694 // we only need to handles these in multi-select trees
2695 if ( HasFlag(wxTR_MULTIPLE) )
2696 {
2697 // get info about the item about to be changed
2698 NMTVITEMCHANGE* info = (NMTVITEMCHANGE*)lParam;
396f85ba 2699 if (TreeItemUnlocker::IsLocked(info->hItem))
5fe302ef
BW
2700 {
2701 // item's state is locked, don't allow the change
2702 // returning 1 will disallow the change
20bdddad 2703 *result = 1;
5fe302ef
BW
2704 return true;
2705 }
2706 }
2707
2708 // allow the state change
2709 }
2710 return false;
2711
5e7718a2 2712 // NB: MSLU is broken and sends TVN_SELCHANGEDA instead of
69a8b5b4
VS
2713 // TVN_SELCHANGEDW in Unicode mode under Win98. Therefore
2714 // we have to handle both messages:
2715 case TVN_SELCHANGEDA:
2716 case TVN_SELCHANGEDW:
08b7c251
VZ
2717 eventType = wxEVT_COMMAND_TREE_SEL_CHANGED;
2718 // fall through
2719
69a8b5b4
VS
2720 case TVN_SELCHANGINGA:
2721 case TVN_SELCHANGINGW:
08b7c251
VZ
2722 {
2723 if ( eventType == wxEVT_NULL )
2724 eventType = wxEVT_COMMAND_TREE_SEL_CHANGING;
2725 //else: already set above
2726
5e7718a2 2727 if (hdr->code == TVN_SELCHANGINGW ||
69a8b5b4
VS
2728 hdr->code == TVN_SELCHANGEDW)
2729 {
4523ebb3 2730 NM_TREEVIEWW *tv = (NM_TREEVIEWW *)lParam;
ee4b2721
VZ
2731 event.m_item = tv->itemNew.hItem;
2732 event.m_itemOld = tv->itemOld.hItem;
69a8b5b4
VS
2733 }
2734 else
2735 {
4523ebb3 2736 NM_TREEVIEWA *tv = (NM_TREEVIEWA *)lParam;
ee4b2721
VZ
2737 event.m_item = tv->itemNew.hItem;
2738 event.m_itemOld = tv->itemOld.hItem;
69a8b5b4 2739 }
08b7c251 2740 }
cb776b66
VZ
2741
2742 // we receive this message from WM_LBUTTONDOWN handler inside
2743 // comctl32.dll and so before the click is passed to
2744 // DefWindowProc() which sets the focus to the window which was
2745 // clicked and this can lead to unexpected event sequences: for
2746 // example, we may get a "selection change" event from the tree
2747 // before getting a "kill focus" event for the text control which
2748 // had the focus previously, thus breaking user code doing input
2749 // validation
2750 //
2751 // to avoid such surprises, we force the generation of focus events
2752 // now, before we generate the selection change ones
2753 SetFocus();
696e1ea0
VZ
2754 break;
2755
5b59df83
VZ
2756 // instead of explicitly checking for _WIN32_IE, check if the
2757 // required symbols are available in the headers
2758#if defined(CDDS_PREPAINT) && !wxUSE_COMCTL32_SAFELY
696e1ea0
VZ
2759 case NM_CUSTOMDRAW:
2760 {
2761 LPNMTVCUSTOMDRAW lptvcd = (LPNMTVCUSTOMDRAW)lParam;
2762 NMCUSTOMDRAW& nmcd = lptvcd->nmcd;
d7926e0b 2763 switch ( nmcd.dwDrawStage )
696e1ea0
VZ
2764 {
2765 case CDDS_PREPAINT:
2766 // if we've got any items with non standard attributes,
2767 // notify us before painting each item
2768 *result = m_hasAnyAttr ? CDRF_NOTIFYITEMDRAW
2769 : CDRF_DODEFAULT;
d7926e0b 2770 break;
696e1ea0
VZ
2771
2772 case CDDS_ITEMPREPAINT:
2773 {
ee4b2721
VZ
2774 wxMapTreeAttr::iterator
2775 it = m_attrs.find((void *)nmcd.dwItemSpec);
696e1ea0 2776
ee4b2721 2777 if ( it == m_attrs.end() )
696e1ea0
VZ
2778 {
2779 // nothing to do for this item
d7926e0b
VZ
2780 *result = CDRF_DODEFAULT;
2781 break;
696e1ea0
VZ
2782 }
2783
ee4b2721
VZ
2784 wxTreeItemAttr * const attr = it->second;
2785
8b713759
VZ
2786 wxTreeViewItem tvItem((void *)nmcd.dwItemSpec,
2787 TVIF_STATE, TVIS_DROPHILITED);
2788 DoGetItem(&tvItem);
2789 const UINT tvItemState = tvItem.state;
2790
19da49fc 2791 // selection colours should override ours,
8b713759
VZ
2792 // otherwise it is too confusing to the user
2793 if ( !(nmcd.uItemState & CDIS_SELECTED) &&
2794 !(tvItemState & TVIS_DROPHILITED) )
696e1ea0 2795 {
2076893b 2796 wxColour colBack;
696e1ea0
VZ
2797 if ( attr->HasBackgroundColour() )
2798 {
2799 colBack = attr->GetBackgroundColour();
19da49fc 2800 lptvcd->clrTextBk = wxColourToRGB(colBack);
696e1ea0 2801 }
19da49fc
VZ
2802 }
2803
2804 // but we still want to keep the special foreground
2805 // colour when we don't have focus (we can't keep
2806 // it when we do, it would usually be unreadable on
2807 // the almost inverted bg colour...)
8b713759
VZ
2808 if ( ( !(nmcd.uItemState & CDIS_SELECTED) ||
2809 FindFocus() != this ) &&
2810 !(tvItemState & TVIS_DROPHILITED) )
19da49fc
VZ
2811 {
2812 wxColour colText;
2813 if ( attr->HasTextColour() )
696e1ea0 2814 {
19da49fc
VZ
2815 colText = attr->GetTextColour();
2816 lptvcd->clrText = wxColourToRGB(colText);
696e1ea0 2817 }
696e1ea0
VZ
2818 }
2819
19da49fc 2820 if ( attr->HasFont() )
696e1ea0 2821 {
19da49fc
VZ
2822 HFONT hFont = GetHfontOf(attr->GetFont());
2823
696e1ea0
VZ
2824 ::SelectObject(nmcd.hdc, hFont);
2825
2826 *result = CDRF_NEWFONT;
2827 }
19da49fc 2828 else // no specific font
696e1ea0
VZ
2829 {
2830 *result = CDRF_DODEFAULT;
2831 }
696e1ea0 2832 }
d7926e0b 2833 break;
696e1ea0
VZ
2834
2835 default:
2836 *result = CDRF_DODEFAULT;
696e1ea0
VZ
2837 }
2838 }
d7926e0b
VZ
2839
2840 // we always process it
04cd30de 2841 return true;
5b59df83 2842#endif // have owner drawn support in headers
08b7c251 2843
8a000b6b
VZ
2844 case NM_CLICK:
2845 {
2846 DWORD pos = GetMessagePos();
2847 POINT point;
2848 point.x = LOWORD(pos);
2849 point.y = HIWORD(pos);
2850 ::MapWindowPoints(HWND_DESKTOP, GetHwnd(), &point, 1);
2851 int flags = 0;
2852 wxTreeItemId item = HitTest(wxPoint(point.x, point.y), flags);
2853 if (flags & wxTREE_HITTEST_ONITEMSTATEICON)
2854 {
2855 event.m_item = item;
2856 eventType = wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK;
2857 }
2858 break;
2859 }
2860
f6bcfd97
BP
2861 case NM_DBLCLK:
2862 case NM_RCLICK:
2863 {
2864 TV_HITTESTINFO tvhti;
2865 ::GetCursorPos(&tvhti.pt);
2866 ::ScreenToClient(GetHwnd(), &tvhti.pt);
2867 if ( TreeView_HitTest(GetHwnd(), &tvhti) )
2868 {
2869 if ( tvhti.flags & TVHT_ONITEM )
2870 {
ee4b2721 2871 event.m_item = tvhti.hItem;
f6bcfd97
BP
2872 eventType = (int)hdr->code == NM_DBLCLK
2873 ? wxEVT_COMMAND_TREE_ITEM_ACTIVATED
2874 : wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK;
8591268f
VZ
2875
2876 event.m_pointDrag.x = tvhti.pt.x;
2877 event.m_pointDrag.y = tvhti.pt.y;
f6bcfd97
BP
2878 }
2879
2880 break;
2881 }
2882 }
2883 // fall through
2884
08b7c251 2885 default:
a23fd0e1 2886 return wxControl::MSWOnNotify(idCtrl, lParam, result);
2bda0e17 2887 }
08b7c251 2888
08b7c251
VZ
2889 event.SetEventType(eventType);
2890
09f277d6
VZ
2891 if ( event.m_item.IsOk() )
2892 event.SetClientObject(GetItemData(event.m_item));
2893
937013e0 2894 bool processed = HandleWindowEvent(event);
08b7c251
VZ
2895
2896 // post processing
5ea47806 2897 switch ( hdr->code )
2bda0e17 2898 {
f6bcfd97
BP
2899 case NM_DBLCLK:
2900 // we translate NM_DBLCLK into ACTIVATED event, so don't interpret
2901 // the return code of this event handler as the return value for
2902 // NM_DBLCLK - otherwise, double clicking the item to toggle its
2903 // expanded status would never work
04cd30de 2904 *result = false;
f6bcfd97
BP
2905 break;
2906
df63b2a4
VZ
2907 case NM_RCLICK:
2908 // prevent tree control from sending WM_CONTEXTMENU to our parent
2909 // (which it does if NM_RCLICK is not handled) because we want to
2910 // send it to the control itself
2911 *result =
2912 processed = true;
2913
2914 ::SendMessage(GetHwnd(), WM_CONTEXTMENU,
2915 (WPARAM)GetHwnd(), ::GetMessagePos());
2916 break;
2917
23f681ec
VZ
2918 case TVN_BEGINDRAG:
2919 case TVN_BEGINRDRAG:
68d9be05 2920#if wxUSE_DRAGIMAGE
23f681ec
VZ
2921 if ( event.IsAllowed() )
2922 {
2923 // normally this is impossible because the m_dragImage is
2924 // deleted once the drag operation is over
2925 wxASSERT_MSG( !m_dragImage, _T("starting to drag once again?") );
2926
2927 m_dragImage = new wxDragImage(*this, event.m_item);
c47addef 2928 m_dragImage->BeginDrag(wxPoint(0,0), this);
68be9f09 2929 m_dragImage->Show();
23f681ec 2930 }
68d9be05 2931#endif // wxUSE_DRAGIMAGE
23f681ec
VZ
2932 break;
2933
5ea47806
VZ
2934 case TVN_DELETEITEM:
2935 {
77ffb593 2936 // NB: we might process this message using wxWidgets event
5ea47806
VZ
2937 // tables, but due to overhead of wxWin event system we
2938 // prefer to do it here ourself (otherwise deleting a tree
2939 // with many items is just too slow)
4523ebb3 2940 NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam;
4523ebb3
VZ
2941
2942 wxTreeItemParam *param =
2943 (wxTreeItemParam *)tv->itemOld.lParam;
2944 delete param;
08b7c251 2945
04cd30de 2946 processed = true; // Make sure we don't get called twice
5ea47806
VZ
2947 }
2948 break;
2949
2950 case TVN_BEGINLABELEDIT:
04cd30de 2951 // return true to cancel label editing
5ea47806 2952 *result = !event.IsAllowed();
646a8a4d 2953
cd6bd270 2954 // set ES_WANTRETURN ( like we do in BeginLabelEdit )
646a8a4d 2955 if ( event.IsAllowed() )
cd6bd270
MB
2956 {
2957 HWND hText = TreeView_GetEditControl(GetHwnd());
4523ebb3 2958 if ( hText )
cd6bd270 2959 {
5e7718a2 2960 // MBN: if m_textCtrl already has an HWND, it is a stale
cd6bd270
MB
2961 // pointer from a previous edit (because the user
2962 // didn't modify the label before dismissing the control,
2963 // and TVN_ENDLABELEDIT was not sent), so delete it
4523ebb3 2964 if ( m_textCtrl && m_textCtrl->GetHWND() )
cd6bd270 2965 DeleteTextCtrl();
4523ebb3 2966 if ( !m_textCtrl )
cd6bd270
MB
2967 m_textCtrl = new wxTextCtrl();
2968 m_textCtrl->SetParent(this);
2969 m_textCtrl->SetHWND((WXHWND)hText);
2970 m_textCtrl->SubclassWin((WXHWND)hText);
2971
2972 // set wxTE_PROCESS_ENTER style for the text control to
2973 // force it to process the Enter presses itself, otherwise
2974 // they could be stolen from it by the dialog
2975 // navigation code
2976 m_textCtrl->SetWindowStyle(m_textCtrl->GetWindowStyle()
2977 | wxTE_PROCESS_ENTER);
2978 }
2979 }
646a8a4d
VZ
2980 else // we had set m_idEdited before
2981 {
2982 m_idEdited.Unset();
2983 }
5ea47806
VZ
2984 break;
2985
2986 case TVN_ENDLABELEDIT:
04cd30de 2987 // return true to set the label to the new string: note that we
188781db 2988 // also must pretend that we did process the message or it is going
04cd30de 2989 // to be passed to DefWindowProc() which will happily return false
188781db 2990 // cancelling the label change
5ea47806 2991 *result = event.IsAllowed();
04cd30de 2992 processed = true;
5ea47806
VZ
2993
2994 // ensure that we don't have the text ctrl which is going to be
2995 // deleted any more
2996 DeleteTextCtrl();
2997 break;
2998
676d6550 2999#ifndef __WXWINCE__
f3f71703 3000#ifdef TVN_GETINFOTIP
156194e1
JS
3001 case TVN_GETINFOTIP:
3002 {
3003 // If the user permitted a tooltip change, change it
3004 if (event.IsAllowed())
3005 {
3006 SetToolTip(event.m_label);
3007 }
3008 }
3009 break;
f3f71703 3010#endif
676d6550 3011#endif
5e7718a2 3012
5ea47806
VZ
3013 case TVN_SELCHANGING:
3014 case TVN_ITEMEXPANDING:
04cd30de 3015 // return true to prevent the action from happening
5ea47806
VZ
3016 *result = !event.IsAllowed();
3017 break;
3018
deb1de30 3019 case TVN_ITEMEXPANDED:
deb1de30 3020 {
4523ebb3 3021 NM_TREEVIEW *tv = (NM_TREEVIEW *)lParam;
5188000b 3022 const wxTreeItemId id(tv->itemNew.hItem);
deb1de30 3023
5188000b 3024 if ( tv->action == TVE_COLLAPSE )
bf43d750 3025 {
5188000b
VZ
3026 if ( wxApp::GetComCtl32Version() >= 600 )
3027 {
3028 // for some reason the item selection rectangle depends
3029 // on whether it is expanded or collapsed (at least
3030 // with comctl32.dll v6): it is wider (by 3 pixels) in
3031 // the expanded state, so when the item collapses and
3032 // then is deselected the rightmost 3 pixels of the
3033 // previously drawn selection are left on the screen
3034 //
3035 // it's not clear if it's a bug in comctl32.dll or in
3036 // our code (because it does not happen in Explorer but
3037 // OTOH we don't do anything which could result in this
3038 // AFAICS) but we do need to work around it to avoid
3039 // ugly artifacts
3040 RefreshItem(id);
3041 }
3042 }
3043 else // expand
3044 {
3045 // the item is also not refreshed properly after expansion when
3046 // it has an image depending on the expanded/collapsed state:
3047 // again, it's not clear if the bug is in comctl32.dll or our
3048 // code...
3049 int image = GetItemImage(id, wxTreeItemIcon_Expanded);
3050 if ( image != -1 )
3051 {
3052 RefreshItem(id);
3053 }
deb1de30
VZ
3054 }
3055 }
3056 break;
3057
74b31181
VZ
3058 case TVN_GETDISPINFO:
3059 // NB: so far the user can't set the image himself anyhow, so do it
3060 // anyway - but this may change later
4523ebb3 3061 //if ( /* !processed && */ )
74b31181
VZ
3062 {
3063 wxTreeItemId item = event.m_item;
3064 TV_DISPINFO *info = (TV_DISPINFO *)lParam;
4523ebb3 3065
1b182562 3066 const wxTreeItemParam * const param = GetItemParam(item);
4523ebb3
VZ
3067 if ( !param )
3068 break;
3069
74b31181
VZ
3070 if ( info->item.mask & TVIF_IMAGE )
3071 {
3072 info->item.iImage =
4523ebb3 3073 param->GetImage
74b31181 3074 (
74b31181
VZ
3075 IsExpanded(item) ? wxTreeItemIcon_Expanded
3076 : wxTreeItemIcon_Normal
3077 );
3078 }
3079 if ( info->item.mask & TVIF_SELECTEDIMAGE )
3080 {
3081 info->item.iSelectedImage =
4523ebb3 3082 param->GetImage
74b31181 3083 (
74b31181
VZ
3084 IsExpanded(item) ? wxTreeItemIcon_SelectedExpanded
3085 : wxTreeItemIcon_Selected
3086 );
3087 }
deb1de30 3088 }
74b31181
VZ
3089 break;
3090
5ea47806
VZ
3091 //default:
3092 // for the other messages the return value is ignored and there is
3093 // nothing special to do
3094 }
fd3f686c 3095 return processed;
2bda0e17
KB
3096}
3097
8a000b6b
VZ
3098// ----------------------------------------------------------------------------
3099// State control.
3100// ----------------------------------------------------------------------------
3101
3102// why do they define INDEXTOSTATEIMAGEMASK but not the inverse?
3103#define STATEIMAGEMASKTOINDEX(state) (((state) & TVIS_STATEIMAGEMASK) >> 12)
3104
3105void wxTreeCtrl::SetState(const wxTreeItemId& node, int state)
3106{
3107 TV_ITEM tvi;
3108 tvi.hItem = (HTREEITEM)node.m_pItem;
3109 tvi.mask = TVIF_STATE;
3110 tvi.stateMask = TVIS_STATEIMAGEMASK;
3111
3112 // Select the specified state, or -1 == cycle to the next one.
3113 if ( state == -1 )
3114 {
5e7718a2 3115 TreeView_GetItem(GetHwnd(), &tvi);
8a000b6b
VZ
3116
3117 state = STATEIMAGEMASKTOINDEX(tvi.state) + 1;
3118 if ( state == m_imageListState->GetImageCount() )
3119 state = 1;
3120 }
3121
3122 wxCHECK_RET( state < m_imageListState->GetImageCount(),
3123 _T("wxTreeCtrl::SetState(): item index out of bounds") );
3124
5e7718a2 3125 tvi.state = INDEXTOSTATEIMAGEMASK(state);
8a000b6b
VZ
3126
3127 TreeView_SetItem(GetHwnd(), &tvi);
3128}
3129
3130int wxTreeCtrl::GetState(const wxTreeItemId& node)
3131{
3132 TV_ITEM tvi;
3133 tvi.hItem = (HTREEITEM)node.m_pItem;
3134 tvi.mask = TVIF_STATE;
3135 tvi.stateMask = TVIS_STATEIMAGEMASK;
5e7718a2 3136 TreeView_GetItem(GetHwnd(), &tvi);
8a000b6b
VZ
3137
3138 return STATEIMAGEMASKTOINDEX(tvi.state);
3139}
3140
1e6feb95 3141#endif // wxUSE_TREECTRL