]> git.saurik.com Git - wxWidgets.git/blob - src/msw/listctrl.cpp
removed wxFunction
[wxWidgets.git] / src / msw / listctrl.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/listctrl.cpp
3 // Purpose: wxListCtrl
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 04/01/98
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 // ============================================================================
13 // declarations
14 // ============================================================================
15
16 // ----------------------------------------------------------------------------
17 // headers
18 // ----------------------------------------------------------------------------
19
20 #ifdef __GNUG__
21 #pragma implementation "listctrl.h"
22 #pragma implementation "listctrlbase.h"
23 #endif
24
25 // For compilers that support precompilation, includes "wx.h".
26 #include "wx/wxprec.h"
27
28 #ifdef __BORLANDC__
29 #pragma hdrstop
30 #endif
31
32 #if wxUSE_LISTCTRL && defined(__WIN95__)
33
34 #ifndef WX_PRECOMP
35 #include "wx/app.h"
36 #include "wx/intl.h"
37 #include "wx/log.h"
38 #include "wx/settings.h"
39 #endif
40
41 #include "wx/textctrl.h"
42 #include "wx/imaglist.h"
43 #include "wx/listctrl.h"
44 #include "wx/dcclient.h"
45
46 #include "wx/msw/private.h"
47
48 #if defined(__GNUWIN32_OLD__) && !defined(__CYGWIN10__)
49 #include "wx/msw/gnuwin32/extra.h"
50 #else
51 #include <commctrl.h>
52 #endif
53
54 #include "wx/msw/missing.h"
55
56 // ----------------------------------------------------------------------------
57 // private functions
58 // ----------------------------------------------------------------------------
59
60 // convert our state and mask flags to LV_ITEM constants
61 static void wxConvertToMSWFlags(long state, long mask, LV_ITEM& lvItem);
62
63 // convert wxListItem to LV_ITEM
64 static void wxConvertToMSWListItem(const wxListCtrl *ctrl,
65 const wxListItem& info, LV_ITEM& lvItem);
66
67 // convert LV_ITEM to wxListItem
68 static void wxConvertFromMSWListItem(HWND hwndListCtrl,
69 wxListItem& info,
70 /* const */ LV_ITEM& lvItem);
71
72 // convert our wxListItem to LV_COLUMN
73 static void wxConvertToMSWListCol(int col, const wxListItem& item,
74 LV_COLUMN& lvCol);
75
76 // ----------------------------------------------------------------------------
77 // private helper classes
78 // ----------------------------------------------------------------------------
79
80 // We have to handle both fooW and fooA notifications in several cases
81 // because of broken commctl.dll and/or unicows.dll. This class is used to
82 // convert LV_ITEMA and LV_ITEMW to LV_ITEM (which is either LV_ITEMA or
83 // LV_ITEMW depending on wxUSE_UNICODE setting), so that it can be processed
84 // by wxConvertToMSWListItem().
85 class wxLV_ITEM
86 {
87 public:
88 ~wxLV_ITEM() { delete m_buf; }
89 operator LV_ITEM&() const { return *m_item; }
90
91 #if wxUSE_UNICODE
92 wxLV_ITEM(LV_ITEMW &item) : m_buf(NULL), m_item(&item) {}
93 wxLV_ITEM(LV_ITEMA &item)
94 {
95 m_item = new LV_ITEM((LV_ITEM&)item);
96 if ( (item.mask & LVIF_TEXT) && item.pszText )
97 {
98 m_buf = new wxMB2WXbuf(wxConvLocal.cMB2WX(item.pszText));
99 m_item->pszText = (wxChar*)m_buf->data();
100 }
101 else
102 m_buf = NULL;
103 }
104 private:
105 wxMB2WXbuf *m_buf;
106
107 #else // !wxUSE_UNICODE
108 wxLV_ITEM(LV_ITEMW &item)
109 {
110 m_item = new LV_ITEM((LV_ITEM&)item);
111
112 // the code below doesn't compile without wxUSE_WCHAR_T and as I don't
113 // know if it's useful to have it at all (do we ever get Unicode
114 // notifications in ANSI mode? I don't think so...) I'm not going to
115 // write alternative implementation right now
116 //
117 // but if it is indeed used, we should simply directly use
118 // ::WideCharToMultiByte() here
119 #if wxUSE_WCHAR_T
120 if ( (item.mask & LVIF_TEXT) && item.pszText )
121 {
122 m_buf = new wxWC2WXbuf(wxConvLocal.cWC2WX(item.pszText));
123 m_item->pszText = (wxChar*)m_buf->data();
124 }
125 else
126 #endif // wxUSE_WCHAR_T
127 m_buf = NULL;
128 }
129 wxLV_ITEM(LV_ITEMA &item) : m_buf(NULL), m_item(&item) {}
130 private:
131 wxWC2WXbuf *m_buf;
132 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
133
134 LV_ITEM *m_item;
135
136 DECLARE_NO_COPY_CLASS(wxLV_ITEM)
137 };
138
139 ///////////////////////////////////////////////////////
140 // Problem:
141 // The MSW version had problems with SetTextColour() et
142 // al as the wxListItemAttr's were stored keyed on the
143 // item index. If a item was inserted anywhere but the end
144 // of the list the the text attributes (colour etc) for
145 // the following items were out of sync.
146 //
147 // Solution:
148 // Under MSW the only way to associate data with a List
149 // item independant of its position in the list is to
150 // store a pointer to it in its lParam attribute. However
151 // user programs are already using this (via the
152 // SetItemData() GetItemData() calls).
153 //
154 // However what we can do is store a pointer to a
155 // structure which contains the attributes we want *and*
156 // a lParam for the users data, e.g.
157 //
158 // class wxListItemInternalData
159 // {
160 // public:
161 // wxListItemAttr *attr;
162 // long lParam; // user data
163 // };
164 //
165 // To conserve memory, a wxListItemInternalData is
166 // only allocated for a LV_ITEM if text attributes or
167 // user data(lparam) are being set.
168
169
170 // class wxListItemInternalData
171 class wxListItemInternalData
172 {
173 public:
174 wxListItemAttr *attr;
175 LPARAM lParam; // user data
176
177 wxListItemInternalData() : attr(NULL), lParam(0) {}
178 ~wxListItemInternalData()
179 {
180 if (attr)
181 delete attr;
182 };
183
184 DECLARE_NO_COPY_CLASS(wxListItemInternalData)
185 };
186
187 // Get the internal data structure
188 static wxListItemInternalData *wxGetInternalData(HWND hwnd, long itemId);
189 static wxListItemInternalData *wxGetInternalData(wxListCtrl *ctl, long itemId);
190 static wxListItemAttr *wxGetInternalDataAttr(wxListCtrl *ctl, long itemId);
191 static void wxDeleteInternalData(wxListCtrl* ctl, long itemId);
192
193
194 // ----------------------------------------------------------------------------
195 // events
196 // ----------------------------------------------------------------------------
197
198 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_DRAG)
199 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_RDRAG)
200 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT)
201 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_END_LABEL_EDIT)
202 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ITEM)
203 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS)
204 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_GET_INFO)
205 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_SET_INFO)
206 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_SELECTED)
207 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_DESELECTED)
208 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_KEY_DOWN)
209 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_INSERT_ITEM)
210 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_CLICK)
211 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_RIGHT_CLICK)
212 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_BEGIN_DRAG)
213 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_DRAGGING)
214 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_END_DRAG)
215 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK)
216 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK)
217 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_ACTIVATED)
218 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_FOCUSED)
219 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_CACHE_HINT)
220
221 IMPLEMENT_DYNAMIC_CLASS(wxListCtrl, wxControl)
222 IMPLEMENT_DYNAMIC_CLASS(wxListView, wxListCtrl)
223 IMPLEMENT_DYNAMIC_CLASS(wxListItem, wxObject)
224
225 IMPLEMENT_DYNAMIC_CLASS(wxListEvent, wxNotifyEvent)
226
227 BEGIN_EVENT_TABLE(wxListCtrl, wxControl)
228 EVT_PAINT(wxListCtrl::OnPaint)
229 END_EVENT_TABLE()
230
231 // ============================================================================
232 // implementation
233 // ============================================================================
234
235 // ----------------------------------------------------------------------------
236 // wxListCtrl construction
237 // ----------------------------------------------------------------------------
238
239 void wxListCtrl::Init()
240 {
241 m_imageListNormal = NULL;
242 m_imageListSmall = NULL;
243 m_imageListState = NULL;
244 m_ownsImageListNormal = m_ownsImageListSmall = m_ownsImageListState = FALSE;
245 m_baseStyle = 0;
246 m_colCount = 0;
247 m_count = 0;
248 m_ignoreChangeMessages = FALSE;
249 m_textCtrl = NULL;
250 m_AnyInternalData = FALSE;
251 m_hasAnyAttr = FALSE;
252 }
253
254 bool wxListCtrl::Create(wxWindow *parent,
255 wxWindowID id,
256 const wxPoint& pos,
257 const wxSize& size,
258 long style,
259 const wxValidator& validator,
260 const wxString& name)
261 {
262 #if wxUSE_VALIDATORS
263 SetValidator(validator);
264 #endif // wxUSE_VALIDATORS
265
266 SetName(name);
267
268 int x = pos.x;
269 int y = pos.y;
270 int width = size.x;
271 int height = size.y;
272
273 m_windowStyle = style;
274
275 SetParent(parent);
276
277 if (width <= 0)
278 width = 100;
279 if (height <= 0)
280 height = 30;
281 if (x < 0)
282 x = 0;
283 if (y < 0)
284 y = 0;
285
286 m_windowId = (id == -1) ? NewControlId() : id;
287
288 DWORD wstyle = WS_VISIBLE | WS_CHILD | WS_TABSTOP |
289 LVS_SHAREIMAGELISTS | LVS_SHOWSELALWAYS;
290
291 m_baseStyle = wstyle;
292
293 if ( !DoCreateControl(x, y, width, height) )
294 return FALSE;
295
296 if (parent)
297 parent->AddChild(this);
298
299 return TRUE;
300 }
301
302 bool wxListCtrl::DoCreateControl(int x, int y, int w, int h)
303 {
304 DWORD wstyle = m_baseStyle;
305
306 WXDWORD exStyle = 0;
307 WXDWORD standardStyle = MSWGetStyle(GetWindowStyle(), & exStyle) ;
308
309 long oldStyle = 0; // Dummy
310 wstyle |= ConvertToMSWStyle(oldStyle, m_windowStyle);
311 wstyle |= standardStyle;
312
313 // Create the ListView control.
314 m_hWnd = (WXHWND)CreateWindowEx(exStyle,
315 WC_LISTVIEW,
316 wxT(""),
317 wstyle,
318 x, y, w, h,
319 GetWinHwnd(GetParent()),
320 (HMENU)m_windowId,
321 wxGetInstance(),
322 NULL);
323
324 if ( !m_hWnd )
325 {
326 wxLogError(_("Can't create list control window, check that comctl32.dll is installed."));
327
328 return FALSE;
329 }
330
331 // for comctl32.dll v 4.70+ we want to have this attribute because it's
332 // prettier (and also because wxGTK does it like this)
333 if ( (wstyle & LVS_REPORT) && wxTheApp->GetComCtl32Version() >= 470 )
334 {
335 ::SendMessage(GetHwnd(), LVM_SETEXTENDEDLISTVIEWSTYLE,
336 0, LVS_EX_FULLROWSELECT);
337 }
338
339 SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
340 SetForegroundColour(GetParent()->GetForegroundColour());
341
342 SubclassWin(m_hWnd);
343
344 return TRUE;
345 }
346
347 void wxListCtrl::UpdateStyle()
348 {
349 if ( GetHWND() )
350 {
351 // The new window view style
352 long dummy;
353 DWORD dwStyleNew = ConvertToMSWStyle(dummy, m_windowStyle);
354 dwStyleNew |= m_baseStyle;
355
356 // Get the current window style.
357 DWORD dwStyleOld = ::GetWindowLong(GetHwnd(), GWL_STYLE);
358
359 // Only set the window style if the view bits have changed.
360 if ( dwStyleOld != dwStyleNew )
361 {
362 ::SetWindowLong(GetHwnd(), GWL_STYLE, dwStyleNew);
363 }
364 }
365 }
366
367 void wxListCtrl::FreeAllInternalData()
368 {
369 if (m_AnyInternalData)
370 {
371 int n = GetItemCount();
372 int i = 0;
373
374 m_ignoreChangeMessages = TRUE;
375 for (i = 0; i < n; i++)
376 wxDeleteInternalData(this, i);
377 m_ignoreChangeMessages = FALSE;
378
379 m_AnyInternalData = FALSE;
380 }
381 }
382
383 wxListCtrl::~wxListCtrl()
384 {
385 FreeAllInternalData();
386
387 if ( m_textCtrl )
388 {
389 m_textCtrl->UnsubclassWin();
390 m_textCtrl->SetHWND(0);
391 delete m_textCtrl;
392 m_textCtrl = NULL;
393 }
394
395 if (m_ownsImageListNormal) delete m_imageListNormal;
396 if (m_ownsImageListSmall) delete m_imageListSmall;
397 if (m_ownsImageListState) delete m_imageListState;
398 }
399
400 // ----------------------------------------------------------------------------
401 // set/get/change style
402 // ----------------------------------------------------------------------------
403
404 // Add or remove a single window style
405 void wxListCtrl::SetSingleStyle(long style, bool add)
406 {
407 long flag = GetWindowStyleFlag();
408
409 // Get rid of conflicting styles
410 if ( add )
411 {
412 if ( style & wxLC_MASK_TYPE)
413 flag = flag & ~wxLC_MASK_TYPE;
414 if ( style & wxLC_MASK_ALIGN )
415 flag = flag & ~wxLC_MASK_ALIGN;
416 if ( style & wxLC_MASK_SORT )
417 flag = flag & ~wxLC_MASK_SORT;
418 }
419
420 if ( flag & style )
421 {
422 if ( !add )
423 flag -= style;
424 }
425 else
426 {
427 if ( add )
428 {
429 flag |= style;
430 }
431 }
432
433 m_windowStyle = flag;
434
435 UpdateStyle();
436 }
437
438 // Set the whole window style
439 void wxListCtrl::SetWindowStyleFlag(long flag)
440 {
441 m_windowStyle = flag;
442
443 UpdateStyle();
444 }
445
446 // Can be just a single style, or a bitlist
447 long wxListCtrl::ConvertToMSWStyle(long& oldStyle, long style) const
448 {
449 long wstyle = 0;
450 if ( style & wxLC_ICON )
451 {
452 if ( (oldStyle & LVS_TYPEMASK) == LVS_SMALLICON )
453 oldStyle -= LVS_SMALLICON;
454 if ( (oldStyle & LVS_TYPEMASK) == LVS_REPORT )
455 oldStyle -= LVS_REPORT;
456 if ( (oldStyle & LVS_TYPEMASK) == LVS_LIST )
457 oldStyle -= LVS_LIST;
458 wstyle |= LVS_ICON;
459 }
460
461 if ( style & wxLC_SMALL_ICON )
462 {
463 if ( (oldStyle & LVS_TYPEMASK) == LVS_ICON )
464 oldStyle -= LVS_ICON;
465 if ( (oldStyle & LVS_TYPEMASK) == LVS_REPORT )
466 oldStyle -= LVS_REPORT;
467 if ( (oldStyle & LVS_TYPEMASK) == LVS_LIST )
468 oldStyle -= LVS_LIST;
469 wstyle |= LVS_SMALLICON;
470 }
471
472 if ( style & wxLC_LIST )
473 {
474 if ( (oldStyle & LVS_TYPEMASK) == LVS_ICON )
475 oldStyle -= LVS_ICON;
476 if ( (oldStyle & LVS_TYPEMASK) == LVS_REPORT )
477 oldStyle -= LVS_REPORT;
478 if ( (oldStyle & LVS_TYPEMASK) == LVS_SMALLICON )
479 oldStyle -= LVS_SMALLICON;
480 wstyle |= LVS_LIST;
481 }
482
483 if ( style & wxLC_REPORT )
484 {
485 if ( (oldStyle & LVS_TYPEMASK) == LVS_ICON )
486 oldStyle -= LVS_ICON;
487 if ( (oldStyle & LVS_TYPEMASK) == LVS_LIST )
488 oldStyle -= LVS_LIST;
489 if ( (oldStyle & LVS_TYPEMASK) == LVS_SMALLICON )
490 oldStyle -= LVS_SMALLICON;
491
492 wstyle |= LVS_REPORT;
493 }
494
495 if ( style & wxLC_ALIGN_LEFT )
496 {
497 if ( oldStyle & LVS_ALIGNTOP )
498 oldStyle -= LVS_ALIGNTOP;
499 wstyle |= LVS_ALIGNLEFT;
500 }
501
502 if ( style & wxLC_ALIGN_TOP )
503 {
504 if ( oldStyle & LVS_ALIGNLEFT )
505 oldStyle -= LVS_ALIGNLEFT;
506 wstyle |= LVS_ALIGNTOP;
507 }
508
509 if ( style & wxLC_AUTOARRANGE )
510 wstyle |= LVS_AUTOARRANGE;
511
512 if ( style & wxLC_NO_SORT_HEADER )
513 wstyle |= LVS_NOSORTHEADER;
514
515 if ( style & wxLC_NO_HEADER )
516 wstyle |= LVS_NOCOLUMNHEADER;
517
518 if ( style & wxLC_EDIT_LABELS )
519 wstyle |= LVS_EDITLABELS;
520
521 if ( style & wxLC_SINGLE_SEL )
522 wstyle |= LVS_SINGLESEL;
523
524 if ( style & wxLC_SORT_ASCENDING )
525 {
526 if ( oldStyle & LVS_SORTDESCENDING )
527 oldStyle -= LVS_SORTDESCENDING;
528 wstyle |= LVS_SORTASCENDING;
529 }
530
531 if ( style & wxLC_SORT_DESCENDING )
532 {
533 if ( oldStyle & LVS_SORTASCENDING )
534 oldStyle -= LVS_SORTASCENDING;
535 wstyle |= LVS_SORTDESCENDING;
536 }
537
538 #if !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 0 ) )
539 if ( style & wxLC_VIRTUAL )
540 {
541 int ver = wxTheApp->GetComCtl32Version();
542 if ( ver < 470 )
543 {
544 wxLogWarning(_("Please install a newer version of comctl32.dll\n(at least version 4.70 is required but you have %d.%02d)\nor this program won't operate correctly."),
545 ver / 100, ver % 100);
546 }
547
548 wstyle |= LVS_OWNERDATA;
549 }
550 #endif
551
552 return wstyle;
553 }
554
555 // ----------------------------------------------------------------------------
556 // accessors
557 // ----------------------------------------------------------------------------
558
559 // Sets the foreground, i.e. text, colour
560 bool wxListCtrl::SetForegroundColour(const wxColour& col)
561 {
562 if ( !wxWindow::SetForegroundColour(col) )
563 return FALSE;
564
565 ListView_SetTextColor(GetHwnd(), wxColourToRGB(col));
566
567 return TRUE;
568 }
569
570 // Sets the background colour
571 bool wxListCtrl::SetBackgroundColour(const wxColour& col)
572 {
573 if ( !wxWindow::SetBackgroundColour(col) )
574 return FALSE;
575
576 // we set the same colour for both the "empty" background and the items
577 // background
578 COLORREF color = wxColourToRGB(col);
579 ListView_SetBkColor(GetHwnd(), color);
580 ListView_SetTextBkColor(GetHwnd(), color);
581
582 return TRUE;
583 }
584
585 // Gets information about this column
586 bool wxListCtrl::GetColumn(int col, wxListItem& item) const
587 {
588 LV_COLUMN lvCol;
589 wxZeroMemory(lvCol);
590
591 lvCol.mask = LVCF_WIDTH;
592
593 if ( item.m_mask & wxLIST_MASK_TEXT )
594 {
595 lvCol.mask |= LVCF_TEXT;
596 lvCol.pszText = new wxChar[513];
597 lvCol.cchTextMax = 512;
598 }
599
600 if ( item.m_mask & wxLIST_MASK_FORMAT )
601 {
602 lvCol.mask |= LVCF_FMT;
603 }
604
605 if ( item.m_mask & wxLIST_MASK_IMAGE )
606 {
607 lvCol.mask |= LVCF_IMAGE;
608 }
609
610 bool success = ListView_GetColumn(GetHwnd(), col, &lvCol) != 0;
611
612 // item.m_subItem = lvCol.iSubItem;
613 item.m_width = lvCol.cx;
614
615 if ( (item.m_mask & wxLIST_MASK_TEXT) && lvCol.pszText )
616 {
617 item.m_text = lvCol.pszText;
618 delete[] lvCol.pszText;
619 }
620
621 if ( item.m_mask & wxLIST_MASK_FORMAT )
622 {
623 switch (lvCol.fmt & LVCFMT_JUSTIFYMASK) {
624 case LVCFMT_LEFT:
625 item.m_format = wxLIST_FORMAT_LEFT;
626 break;
627 case LVCFMT_RIGHT:
628 item.m_format = wxLIST_FORMAT_RIGHT;
629 break;
630 case LVCFMT_CENTER:
631 item.m_format = wxLIST_FORMAT_CENTRE;
632 break;
633 default:
634 item.m_format = -1; // Unknown?
635 break;
636 }
637 }
638
639 #if _WIN32_IE >= 0x0300
640 if ( item.m_mask & wxLIST_MASK_IMAGE )
641 {
642 item.m_image = lvCol.iImage;
643 }
644 #endif
645
646 return success;
647 }
648
649 // Sets information about this column
650 bool wxListCtrl::SetColumn(int col, wxListItem& item)
651 {
652 LV_COLUMN lvCol;
653 wxConvertToMSWListCol(col, item, lvCol);
654
655 return ListView_SetColumn(GetHwnd(), col, &lvCol) != 0;
656 }
657
658 // Gets the column width
659 int wxListCtrl::GetColumnWidth(int col) const
660 {
661 return ListView_GetColumnWidth(GetHwnd(), col);
662 }
663
664 // Sets the column width
665 bool wxListCtrl::SetColumnWidth(int col, int width)
666 {
667 int col2 = col;
668 if ( m_windowStyle & wxLC_LIST )
669 col2 = -1;
670
671 int width2 = width;
672 if ( width2 == wxLIST_AUTOSIZE)
673 width2 = LVSCW_AUTOSIZE;
674 else if ( width2 == wxLIST_AUTOSIZE_USEHEADER)
675 width2 = LVSCW_AUTOSIZE_USEHEADER;
676
677 return ListView_SetColumnWidth(GetHwnd(), col2, width2) != 0;
678 }
679
680 // Gets the number of items that can fit vertically in the
681 // visible area of the list control (list or report view)
682 // or the total number of items in the list control (icon
683 // or small icon view)
684 int wxListCtrl::GetCountPerPage() const
685 {
686 return ListView_GetCountPerPage(GetHwnd());
687 }
688
689 // Gets the edit control for editing labels.
690 wxTextCtrl* wxListCtrl::GetEditControl() const
691 {
692 return m_textCtrl;
693 }
694
695 // Gets information about the item
696 bool wxListCtrl::GetItem(wxListItem& info) const
697 {
698 LV_ITEM lvItem;
699 wxZeroMemory(lvItem);
700
701 lvItem.iItem = info.m_itemId;
702 lvItem.iSubItem = info.m_col;
703
704 if ( info.m_mask & wxLIST_MASK_TEXT )
705 {
706 lvItem.mask |= LVIF_TEXT;
707 lvItem.pszText = new wxChar[513];
708 lvItem.cchTextMax = 512;
709 }
710 else
711 {
712 lvItem.pszText = NULL;
713 }
714
715 if (info.m_mask & wxLIST_MASK_DATA)
716 lvItem.mask |= LVIF_PARAM;
717
718 if (info.m_mask & wxLIST_MASK_IMAGE)
719 lvItem.mask |= LVIF_IMAGE;
720
721 if ( info.m_mask & wxLIST_MASK_STATE )
722 {
723 lvItem.mask |= LVIF_STATE;
724 // the other bits are hardly interesting anyhow
725 lvItem.stateMask = LVIS_SELECTED | LVIS_FOCUSED;
726 }
727
728 bool success = ListView_GetItem((HWND)GetHWND(), &lvItem) != 0;
729 if ( !success )
730 {
731 wxLogError(_("Couldn't retrieve information about list control item %d."),
732 lvItem.iItem);
733 }
734 else
735 {
736 // give NULL as hwnd as we already have everything we need
737 wxConvertFromMSWListItem(NULL, info, lvItem);
738 }
739
740 if (lvItem.pszText)
741 delete[] lvItem.pszText;
742
743 return success;
744 }
745
746 // Sets information about the item
747 bool wxListCtrl::SetItem(wxListItem& info)
748 {
749 LV_ITEM item;
750 wxConvertToMSWListItem(this, info, item);
751
752 // we never update the lParam if it contains our pointer
753 // to the wxListItemInternalData structure
754 item.mask &= ~LVIF_PARAM;
755
756 // check if setting attributes or lParam
757 if (info.HasAttributes() || (info.m_mask & wxLIST_MASK_DATA))
758 {
759 // get internal item data
760 // perhaps a cache here ?
761 wxListItemInternalData *data = wxGetInternalData(this, info.m_itemId);
762
763 if (! data)
764 {
765 // need to set it
766 m_AnyInternalData = TRUE;
767 data = new wxListItemInternalData();
768 item.lParam = (LPARAM) data;
769 item.mask |= LVIF_PARAM;
770 };
771
772
773 // user data
774 if (info.m_mask & wxLIST_MASK_DATA)
775 data->lParam = info.m_data;
776
777 // attributes
778 if (info.HasAttributes())
779 {
780 if (data->attr)
781 *data->attr = *info.GetAttributes();
782 else
783 data->attr = new wxListItemAttr(*info.GetAttributes());
784 };
785 };
786
787
788 // we could be changing only the attribute in which case we don't need to
789 // call ListView_SetItem() at all
790 if ( item.mask )
791 {
792 item.cchTextMax = 0;
793 if ( !ListView_SetItem(GetHwnd(), &item) )
794 {
795 wxLogDebug(_T("ListView_SetItem() failed"));
796
797 return FALSE;
798 }
799 }
800
801 // we need to update the item immediately to show the new image
802 bool updateNow = (info.m_mask & wxLIST_MASK_IMAGE) != 0;
803
804 // check whether it has any custom attributes
805 if ( info.HasAttributes() )
806 {
807 m_hasAnyAttr = TRUE;
808
809 // if the colour has changed, we must redraw the item
810 updateNow = TRUE;
811 }
812
813 if ( updateNow )
814 {
815 // we need this to make the change visible right now
816 RefreshItem(item.iItem);
817 }
818
819 return TRUE;
820 }
821
822 long wxListCtrl::SetItem(long index, int col, const wxString& label, int imageId)
823 {
824 wxListItem info;
825 info.m_text = label;
826 info.m_mask = wxLIST_MASK_TEXT;
827 info.m_itemId = index;
828 info.m_col = col;
829 if ( imageId > -1 )
830 {
831 info.m_image = imageId;
832 info.m_mask |= wxLIST_MASK_IMAGE;
833 }
834 return SetItem(info);
835 }
836
837
838 // Gets the item state
839 int wxListCtrl::GetItemState(long item, long stateMask) const
840 {
841 wxListItem info;
842
843 info.m_mask = wxLIST_MASK_STATE;
844 info.m_stateMask = stateMask;
845 info.m_itemId = item;
846
847 if (!GetItem(info))
848 return 0;
849
850 return info.m_state;
851 }
852
853 // Sets the item state
854 bool wxListCtrl::SetItemState(long item, long state, long stateMask)
855 {
856 // NB: don't use SetItem() here as it doesn't work with the virtual list
857 // controls
858 LV_ITEM lvItem;
859 wxZeroMemory(lvItem);
860
861 wxConvertToMSWFlags(state, stateMask, lvItem);
862
863 // for the virtual list controls we need to refresh the previously focused
864 // item manually when changing focus without changing selection
865 // programmatically because otherwise it keeps its focus rectangle until
866 // next repaint (yet another comctl32 bug)
867 long focusOld;
868 if ( IsVirtual() &&
869 (stateMask & wxLIST_STATE_FOCUSED) &&
870 (state & wxLIST_STATE_FOCUSED) )
871 {
872 focusOld = GetNextItem(-1, wxLIST_NEXT_ALL, wxLIST_STATE_FOCUSED);
873 }
874 else
875 {
876 focusOld = -1;
877 }
878
879 if ( !::SendMessage(GetHwnd(), LVM_SETITEMSTATE,
880 (WPARAM)item, (LPARAM)&lvItem) )
881 {
882 wxLogLastError(_T("ListView_SetItemState"));
883
884 return FALSE;
885 }
886
887 if ( focusOld != -1 )
888 {
889 // no need to refresh the item if it was previously selected, it would
890 // only result in annoying flicker
891 if ( !(GetItemState(focusOld,
892 wxLIST_STATE_SELECTED) & wxLIST_STATE_SELECTED) )
893 {
894 RefreshItem(focusOld);
895 }
896 }
897
898 return TRUE;
899 }
900
901 // Sets the item image
902 bool wxListCtrl::SetItemImage(long item, int image, int WXUNUSED(selImage))
903 {
904 wxListItem info;
905
906 info.m_mask = wxLIST_MASK_IMAGE;
907 info.m_image = image;
908 info.m_itemId = item;
909
910 return SetItem(info);
911 }
912
913 // Gets the item text
914 wxString wxListCtrl::GetItemText(long item) const
915 {
916 wxListItem info;
917
918 info.m_mask = wxLIST_MASK_TEXT;
919 info.m_itemId = item;
920
921 if (!GetItem(info))
922 return wxEmptyString;
923 return info.m_text;
924 }
925
926 // Sets the item text
927 void wxListCtrl::SetItemText(long item, const wxString& str)
928 {
929 wxListItem info;
930
931 info.m_mask = wxLIST_MASK_TEXT;
932 info.m_itemId = item;
933 info.m_text = str;
934
935 SetItem(info);
936 }
937
938 // Gets the item data
939 long wxListCtrl::GetItemData(long item) const
940 {
941 wxListItem info;
942
943 info.m_mask = wxLIST_MASK_DATA;
944 info.m_itemId = item;
945
946 if (!GetItem(info))
947 return 0;
948 return info.m_data;
949 }
950
951 // Sets the item data
952 bool wxListCtrl::SetItemData(long item, long data)
953 {
954 wxListItem info;
955
956 info.m_mask = wxLIST_MASK_DATA;
957 info.m_itemId = item;
958 info.m_data = data;
959
960 return SetItem(info);
961 }
962
963 // Gets the item rectangle
964 bool wxListCtrl::GetItemRect(long item, wxRect& rect, int code) const
965 {
966 RECT rectWin;
967
968 int codeWin;
969 if ( code == wxLIST_RECT_BOUNDS )
970 codeWin = LVIR_BOUNDS;
971 else if ( code == wxLIST_RECT_ICON )
972 codeWin = LVIR_ICON;
973 else if ( code == wxLIST_RECT_LABEL )
974 codeWin = LVIR_LABEL;
975 else
976 {
977 wxFAIL_MSG( _T("incorrect code in GetItemRect()") );
978
979 codeWin = LVIR_BOUNDS;
980 }
981
982 bool success = ListView_GetItemRect(GetHwnd(), (int) item, &rectWin, codeWin) != 0;
983
984 rect.x = rectWin.left;
985 rect.y = rectWin.top;
986 rect.width = rectWin.right - rectWin.left;
987 rect.height = rectWin.bottom - rectWin.top;
988
989 return success;
990 }
991
992 // Gets the item position
993 bool wxListCtrl::GetItemPosition(long item, wxPoint& pos) const
994 {
995 POINT pt;
996
997 bool success = (ListView_GetItemPosition(GetHwnd(), (int) item, &pt) != 0);
998
999 pos.x = pt.x; pos.y = pt.y;
1000 return success;
1001 }
1002
1003 // Sets the item position.
1004 bool wxListCtrl::SetItemPosition(long item, const wxPoint& pos)
1005 {
1006 return (ListView_SetItemPosition(GetHwnd(), (int) item, pos.x, pos.y) != 0);
1007 }
1008
1009 // Gets the number of items in the list control
1010 int wxListCtrl::GetItemCount() const
1011 {
1012 return m_count;
1013 }
1014
1015 // Retrieves the spacing between icons in pixels.
1016 // If small is TRUE, gets the spacing for the small icon
1017 // view, otherwise the large icon view.
1018 int wxListCtrl::GetItemSpacing(bool isSmall) const
1019 {
1020 return ListView_GetItemSpacing(GetHwnd(), (BOOL) isSmall);
1021 }
1022
1023 void wxListCtrl::SetItemTextColour( long item, const wxColour &col )
1024 {
1025 wxListItem info;
1026 info.m_itemId = item;
1027 info.SetTextColour( col );
1028 SetItem( info );
1029 }
1030
1031 wxColour wxListCtrl::GetItemTextColour( long item ) const
1032 {
1033 wxListItem info;
1034 info.m_itemId = item;
1035 GetItem( info );
1036 return info.GetTextColour();
1037 }
1038
1039 void wxListCtrl::SetItemBackgroundColour( long item, const wxColour &col )
1040 {
1041 wxListItem info;
1042 info.m_itemId = item;
1043 info.SetBackgroundColour( col );
1044 SetItem( info );
1045 }
1046
1047 wxColour wxListCtrl::GetItemBackgroundColour( long item ) const
1048 {
1049 wxListItem info;
1050 info.m_itemId = item;
1051 GetItem( info );
1052 return info.GetBackgroundColour();
1053 }
1054
1055 // Gets the number of selected items in the list control
1056 int wxListCtrl::GetSelectedItemCount() const
1057 {
1058 return ListView_GetSelectedCount(GetHwnd());
1059 }
1060
1061 // Gets the text colour of the listview
1062 wxColour wxListCtrl::GetTextColour() const
1063 {
1064 COLORREF ref = ListView_GetTextColor(GetHwnd());
1065 wxColour col(GetRValue(ref), GetGValue(ref), GetBValue(ref));
1066 return col;
1067 }
1068
1069 // Sets the text colour of the listview
1070 void wxListCtrl::SetTextColour(const wxColour& col)
1071 {
1072 ListView_SetTextColor(GetHwnd(), PALETTERGB(col.Red(), col.Green(), col.Blue()));
1073 }
1074
1075 // Gets the index of the topmost visible item when in
1076 // list or report view
1077 long wxListCtrl::GetTopItem() const
1078 {
1079 return (long) ListView_GetTopIndex(GetHwnd());
1080 }
1081
1082 // Searches for an item, starting from 'item'.
1083 // 'geometry' is one of
1084 // wxLIST_NEXT_ABOVE/ALL/BELOW/LEFT/RIGHT.
1085 // 'state' is a state bit flag, one or more of
1086 // wxLIST_STATE_DROPHILITED/FOCUSED/SELECTED/CUT.
1087 // item can be -1 to find the first item that matches the
1088 // specified flags.
1089 // Returns the item or -1 if unsuccessful.
1090 long wxListCtrl::GetNextItem(long item, int geom, int state) const
1091 {
1092 long flags = 0;
1093
1094 if ( geom == wxLIST_NEXT_ABOVE )
1095 flags |= LVNI_ABOVE;
1096 if ( geom == wxLIST_NEXT_ALL )
1097 flags |= LVNI_ALL;
1098 if ( geom == wxLIST_NEXT_BELOW )
1099 flags |= LVNI_BELOW;
1100 if ( geom == wxLIST_NEXT_LEFT )
1101 flags |= LVNI_TOLEFT;
1102 if ( geom == wxLIST_NEXT_RIGHT )
1103 flags |= LVNI_TORIGHT;
1104
1105 if ( state & wxLIST_STATE_CUT )
1106 flags |= LVNI_CUT;
1107 if ( state & wxLIST_STATE_DROPHILITED )
1108 flags |= LVNI_DROPHILITED;
1109 if ( state & wxLIST_STATE_FOCUSED )
1110 flags |= LVNI_FOCUSED;
1111 if ( state & wxLIST_STATE_SELECTED )
1112 flags |= LVNI_SELECTED;
1113
1114 return (long) ListView_GetNextItem(GetHwnd(), item, flags);
1115 }
1116
1117
1118 wxImageList *wxListCtrl::GetImageList(int which) const
1119 {
1120 if ( which == wxIMAGE_LIST_NORMAL )
1121 {
1122 return m_imageListNormal;
1123 }
1124 else if ( which == wxIMAGE_LIST_SMALL )
1125 {
1126 return m_imageListSmall;
1127 }
1128 else if ( which == wxIMAGE_LIST_STATE )
1129 {
1130 return m_imageListState;
1131 }
1132 return NULL;
1133 }
1134
1135 void wxListCtrl::SetImageList(wxImageList *imageList, int which)
1136 {
1137 int flags = 0;
1138 if ( which == wxIMAGE_LIST_NORMAL )
1139 {
1140 flags = LVSIL_NORMAL;
1141 if (m_ownsImageListNormal) delete m_imageListNormal;
1142 m_imageListNormal = imageList;
1143 m_ownsImageListNormal = FALSE;
1144 }
1145 else if ( which == wxIMAGE_LIST_SMALL )
1146 {
1147 flags = LVSIL_SMALL;
1148 if (m_ownsImageListSmall) delete m_imageListSmall;
1149 m_imageListSmall = imageList;
1150 m_ownsImageListSmall = FALSE;
1151 }
1152 else if ( which == wxIMAGE_LIST_STATE )
1153 {
1154 flags = LVSIL_STATE;
1155 if (m_ownsImageListState) delete m_imageListState;
1156 m_imageListState = imageList;
1157 m_ownsImageListState = FALSE;
1158 }
1159 ListView_SetImageList(GetHwnd(), (HIMAGELIST) imageList ? imageList->GetHIMAGELIST() : 0, flags);
1160 }
1161
1162 void wxListCtrl::AssignImageList(wxImageList *imageList, int which)
1163 {
1164 SetImageList(imageList, which);
1165 if ( which == wxIMAGE_LIST_NORMAL )
1166 m_ownsImageListNormal = TRUE;
1167 else if ( which == wxIMAGE_LIST_SMALL )
1168 m_ownsImageListSmall = TRUE;
1169 else if ( which == wxIMAGE_LIST_STATE )
1170 m_ownsImageListState = TRUE;
1171 }
1172
1173 // ----------------------------------------------------------------------------
1174 // Operations
1175 // ----------------------------------------------------------------------------
1176
1177 // Arranges the items
1178 bool wxListCtrl::Arrange(int flag)
1179 {
1180 UINT code = 0;
1181 if ( flag == wxLIST_ALIGN_LEFT )
1182 code = LVA_ALIGNLEFT;
1183 else if ( flag == wxLIST_ALIGN_TOP )
1184 code = LVA_ALIGNTOP;
1185 else if ( flag == wxLIST_ALIGN_DEFAULT )
1186 code = LVA_DEFAULT;
1187 else if ( flag == wxLIST_ALIGN_SNAP_TO_GRID )
1188 code = LVA_SNAPTOGRID;
1189
1190 return (ListView_Arrange(GetHwnd(), code) != 0);
1191 }
1192
1193 // Deletes an item
1194 bool wxListCtrl::DeleteItem(long item)
1195 {
1196 if ( !ListView_DeleteItem(GetHwnd(), (int) item) )
1197 {
1198 wxLogLastError(_T("ListView_DeleteItem"));
1199 return FALSE;
1200 }
1201
1202 m_count -= 1;
1203 wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()),
1204 wxT("m_count should match ListView_GetItemCount"));
1205
1206 // the virtual list control doesn't refresh itself correctly, help it
1207 if ( IsVirtual() )
1208 {
1209 // we need to refresh all the lines below the one which was deleted
1210 wxRect rectItem;
1211 if ( item > 0 && GetItemCount() )
1212 {
1213 GetItemRect(item - 1, rectItem);
1214 }
1215 else
1216 {
1217 rectItem.y =
1218 rectItem.height = 0;
1219 }
1220
1221 wxRect rectWin = GetRect();
1222 rectWin.height = rectWin.GetBottom() - rectItem.GetBottom();
1223 rectWin.y = rectItem.GetBottom();
1224
1225 RefreshRect(rectWin);
1226 }
1227
1228 return TRUE;
1229 }
1230
1231 // Deletes all items
1232 bool wxListCtrl::DeleteAllItems()
1233 {
1234 FreeAllInternalData();
1235 return ListView_DeleteAllItems(GetHwnd()) != 0;
1236 }
1237
1238 // Deletes all items
1239 bool wxListCtrl::DeleteAllColumns()
1240 {
1241 while ( m_colCount > 0 )
1242 {
1243 if ( ListView_DeleteColumn(GetHwnd(), 0) == 0 )
1244 {
1245 wxLogLastError(wxT("ListView_DeleteColumn"));
1246
1247 return FALSE;
1248 }
1249
1250 m_colCount--;
1251 }
1252
1253 wxASSERT_MSG( m_colCount == 0, wxT("no columns should be left") );
1254
1255 return TRUE;
1256 }
1257
1258 // Deletes a column
1259 bool wxListCtrl::DeleteColumn(int col)
1260 {
1261 bool success = (ListView_DeleteColumn(GetHwnd(), col) != 0);
1262
1263 if ( success && (m_colCount > 0) )
1264 m_colCount --;
1265 return success;
1266 }
1267
1268 // Clears items, and columns if there are any.
1269 void wxListCtrl::ClearAll()
1270 {
1271 DeleteAllItems();
1272 if ( m_colCount > 0 )
1273 DeleteAllColumns();
1274 }
1275
1276 wxTextCtrl* wxListCtrl::EditLabel(long item, wxClassInfo* textControlClass)
1277 {
1278 wxASSERT( (textControlClass->IsKindOf(CLASSINFO(wxTextCtrl))) );
1279
1280 // ListView_EditLabel requires that the list has focus.
1281 SetFocus();
1282
1283 WXHWND hWnd = (WXHWND) ListView_EditLabel(GetHwnd(), item);
1284 if ( !hWnd )
1285 {
1286 // failed to start editing
1287 return NULL;
1288 }
1289
1290 // [re]create the text control wrapping the HWND we got
1291 if ( m_textCtrl )
1292 {
1293 m_textCtrl->UnsubclassWin();
1294 m_textCtrl->SetHWND(0);
1295 delete m_textCtrl;
1296 }
1297
1298 m_textCtrl = (wxTextCtrl *)textControlClass->CreateObject();
1299 m_textCtrl->SetHWND(hWnd);
1300 m_textCtrl->SubclassWin(hWnd);
1301 m_textCtrl->SetParent(this);
1302
1303 // we must disallow TABbing away from the control while the edit contol is
1304 // shown because this leaves it in some strange state (just try removing
1305 // this line and then pressing TAB while editing an item in listctrl
1306 // inside a panel)
1307 m_textCtrl->SetWindowStyle(m_textCtrl->GetWindowStyle() | wxTE_PROCESS_TAB);
1308
1309 return m_textCtrl;
1310 }
1311
1312 // End label editing, optionally cancelling the edit
1313 bool wxListCtrl::EndEditLabel(bool WXUNUSED(cancel))
1314 {
1315 wxFAIL_MSG( _T("not implemented") );
1316
1317 return FALSE;
1318 }
1319
1320 // Ensures this item is visible
1321 bool wxListCtrl::EnsureVisible(long item)
1322 {
1323 return ListView_EnsureVisible(GetHwnd(), (int) item, FALSE) != 0;
1324 }
1325
1326 // Find an item whose label matches this string, starting from the item after 'start'
1327 // or the beginning if 'start' is -1.
1328 long wxListCtrl::FindItem(long start, const wxString& str, bool partial)
1329 {
1330 LV_FINDINFO findInfo;
1331
1332 findInfo.flags = LVFI_STRING;
1333 if ( partial )
1334 findInfo.flags |= LVFI_PARTIAL;
1335 findInfo.psz = str;
1336
1337 // ListView_FindItem() excludes the first item from search and to look
1338 // through all the items you need to start from -1 which is unnatural and
1339 // inconsistent with the generic version - so we adjust the index
1340 if (start != -1)
1341 start --;
1342 return ListView_FindItem(GetHwnd(), (int) start, &findInfo);
1343 }
1344
1345 // Find an item whose data matches this data, starting from the item after 'start'
1346 // or the beginning if 'start' is -1.
1347 // NOTE : Lindsay Mathieson - 14-July-2002
1348 // No longer use ListView_FindItem as the data attribute is now stored
1349 // in a wxListItemInternalData structure refernced by the actual lParam
1350 long wxListCtrl::FindItem(long start, long data)
1351 {
1352 long idx = start + 1;
1353 long count = GetItemCount();
1354
1355 while (idx < count)
1356 {
1357 if (GetItemData(idx) == data)
1358 return idx;
1359 idx++;
1360 };
1361
1362 return -1;
1363 }
1364
1365 // Find an item nearest this position in the specified direction, starting from
1366 // the item after 'start' or the beginning if 'start' is -1.
1367 long wxListCtrl::FindItem(long start, const wxPoint& pt, int direction)
1368 {
1369 LV_FINDINFO findInfo;
1370
1371 findInfo.flags = LVFI_NEARESTXY;
1372 findInfo.pt.x = pt.x;
1373 findInfo.pt.y = pt.y;
1374 findInfo.vkDirection = VK_RIGHT;
1375
1376 if ( direction == wxLIST_FIND_UP )
1377 findInfo.vkDirection = VK_UP;
1378 else if ( direction == wxLIST_FIND_DOWN )
1379 findInfo.vkDirection = VK_DOWN;
1380 else if ( direction == wxLIST_FIND_LEFT )
1381 findInfo.vkDirection = VK_LEFT;
1382 else if ( direction == wxLIST_FIND_RIGHT )
1383 findInfo.vkDirection = VK_RIGHT;
1384
1385 return ListView_FindItem(GetHwnd(), (int) start, & findInfo);
1386 }
1387
1388 // Determines which item (if any) is at the specified point,
1389 // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
1390 long wxListCtrl::HitTest(const wxPoint& point, int& flags)
1391 {
1392 LV_HITTESTINFO hitTestInfo;
1393 hitTestInfo.pt.x = (int) point.x;
1394 hitTestInfo.pt.y = (int) point.y;
1395
1396 ListView_HitTest(GetHwnd(), & hitTestInfo);
1397
1398 flags = 0;
1399 if ( hitTestInfo.flags & LVHT_ABOVE )
1400 flags |= wxLIST_HITTEST_ABOVE;
1401 if ( hitTestInfo.flags & LVHT_BELOW )
1402 flags |= wxLIST_HITTEST_BELOW;
1403 if ( hitTestInfo.flags & LVHT_NOWHERE )
1404 flags |= wxLIST_HITTEST_NOWHERE;
1405 if ( hitTestInfo.flags & LVHT_ONITEMICON )
1406 flags |= wxLIST_HITTEST_ONITEMICON;
1407 if ( hitTestInfo.flags & LVHT_ONITEMLABEL )
1408 flags |= wxLIST_HITTEST_ONITEMLABEL;
1409 if ( hitTestInfo.flags & LVHT_ONITEMSTATEICON )
1410 flags |= wxLIST_HITTEST_ONITEMSTATEICON;
1411 if ( hitTestInfo.flags & LVHT_TOLEFT )
1412 flags |= wxLIST_HITTEST_TOLEFT;
1413 if ( hitTestInfo.flags & LVHT_TORIGHT )
1414 flags |= wxLIST_HITTEST_TORIGHT;
1415
1416 return (long) hitTestInfo.iItem;
1417 }
1418
1419 // Inserts an item, returning the index of the new item if successful,
1420 // -1 otherwise.
1421 long wxListCtrl::InsertItem(wxListItem& info)
1422 {
1423 wxASSERT_MSG( !IsVirtual(), _T("can't be used with virtual controls") );
1424
1425 LV_ITEM item;
1426 wxConvertToMSWListItem(this, info, item);
1427 item.mask &= ~LVIF_PARAM;
1428
1429 // check wether we need to allocate our internal data
1430 bool needInternalData = ((info.m_mask & wxLIST_MASK_DATA) || info.HasAttributes());
1431 if (needInternalData)
1432 {
1433 m_AnyInternalData = TRUE;
1434 item.mask |= LVIF_PARAM;
1435
1436 // internal stucture that manages data
1437 wxListItemInternalData *data = new wxListItemInternalData();
1438 item.lParam = (LPARAM) data;
1439
1440 if (info.m_mask & wxLIST_MASK_DATA)
1441 data->lParam = info.m_data;
1442
1443 // check whether it has any custom attributes
1444 if ( info.HasAttributes() )
1445 {
1446 // take copy of attributes
1447 data->attr = new wxListItemAttr(*info.GetAttributes());
1448 }
1449 };
1450
1451 long rv = ListView_InsertItem(GetHwnd(), & item);
1452 m_count += 1;
1453 wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()),
1454 wxT("m_count should match ListView_GetItemCount"));
1455
1456 return rv;
1457 }
1458
1459 long wxListCtrl::InsertItem(long index, const wxString& label)
1460 {
1461 wxListItem info;
1462 info.m_text = label;
1463 info.m_mask = wxLIST_MASK_TEXT;
1464 info.m_itemId = index;
1465 return InsertItem(info);
1466 }
1467
1468 // Inserts an image item
1469 long wxListCtrl::InsertItem(long index, int imageIndex)
1470 {
1471 wxListItem info;
1472 info.m_image = imageIndex;
1473 info.m_mask = wxLIST_MASK_IMAGE;
1474 info.m_itemId = index;
1475 return InsertItem(info);
1476 }
1477
1478 // Inserts an image/string item
1479 long wxListCtrl::InsertItem(long index, const wxString& label, int imageIndex)
1480 {
1481 wxListItem info;
1482 info.m_image = imageIndex;
1483 info.m_text = label;
1484 info.m_mask = wxLIST_MASK_IMAGE | wxLIST_MASK_TEXT;
1485 info.m_itemId = index;
1486 return InsertItem(info);
1487 }
1488
1489 // For list view mode (only), inserts a column.
1490 long wxListCtrl::InsertColumn(long col, wxListItem& item)
1491 {
1492 LV_COLUMN lvCol;
1493 wxConvertToMSWListCol(col, item, lvCol);
1494
1495 if ( !(lvCol.mask & LVCF_WIDTH) )
1496 {
1497 // always give some width to the new column: this one is compatible
1498 // with the generic version
1499 lvCol.mask |= LVCF_WIDTH;
1500 lvCol.cx = 80;
1501 }
1502
1503 // when we insert a column which can contain an image, we must specify this
1504 // flag right now as doing it later in SetColumn() has no effect
1505 //
1506 // we use LVCFMT_BITMAP_ON_RIGHT by default because without it there is no
1507 // way to dynamically set/clear the bitmap as the column without a bitmap
1508 // on the left looks ugly (there is a hole)
1509 //
1510 // unfortunately with my version of comctl32.dll (5.80), the left column
1511 // image is always on the left and it seems that it's a "feature" - I
1512 // didn't find any way to work around it in any case
1513 if ( lvCol.mask & LVCF_IMAGE )
1514 {
1515 lvCol.mask |= LVCF_FMT;
1516 lvCol.fmt |= LVCFMT_BITMAP_ON_RIGHT;
1517 }
1518
1519 bool success = ListView_InsertColumn(GetHwnd(), col, &lvCol) != -1;
1520 if ( success )
1521 {
1522 m_colCount++;
1523 }
1524 else
1525 {
1526 wxLogDebug(wxT("Failed to insert the column '%s' into listview!"),
1527 lvCol.pszText);
1528 }
1529
1530 return success;
1531 }
1532
1533 long wxListCtrl::InsertColumn(long col,
1534 const wxString& heading,
1535 int format,
1536 int width)
1537 {
1538 wxListItem item;
1539 item.m_mask = wxLIST_MASK_TEXT | wxLIST_MASK_FORMAT;
1540 item.m_text = heading;
1541 if ( width > -1 )
1542 {
1543 item.m_mask |= wxLIST_MASK_WIDTH;
1544 item.m_width = width;
1545 }
1546 item.m_format = format;
1547
1548 return InsertColumn(col, item);
1549 }
1550
1551 // scroll the control by the given number of pixels (exception: in list view,
1552 // dx is interpreted as number of columns)
1553 bool wxListCtrl::ScrollList(int dx, int dy)
1554 {
1555 if ( !ListView_Scroll(GetHwnd(), dx, dy) )
1556 {
1557 wxLogDebug(_T("ListView_Scroll(%d, %d) failed"), dx, dy);
1558
1559 return FALSE;
1560 }
1561
1562 return TRUE;
1563 }
1564
1565 // Sort items.
1566
1567 // fn is a function which takes 3 long arguments: item1, item2, data.
1568 // item1 is the long data associated with a first item (NOT the index).
1569 // item2 is the long data associated with a second item (NOT the index).
1570 // data is the same value as passed to SortItems.
1571 // The return value is a negative number if the first item should precede the second
1572 // item, a positive number of the second item should precede the first,
1573 // or zero if the two items are equivalent.
1574
1575 // data is arbitrary data to be passed to the sort function.
1576
1577 // Internal structures for proxying the user compare function
1578 // so that we can pass it the *real* user data
1579
1580 // translate lParam data and call user func
1581 struct wxInternalDataSort
1582 {
1583 wxListCtrlCompare user_fn;
1584 long data;
1585 };
1586
1587 int CALLBACK wxInternalDataCompareFunc(LPARAM lParam1, LPARAM lParam2, LPARAM lParamSort)
1588 {
1589 struct wxInternalDataSort *internalData = (struct wxInternalDataSort *) lParamSort;
1590
1591 wxListItemInternalData *data1 = (wxListItemInternalData *) lParam1;
1592 wxListItemInternalData *data2 = (wxListItemInternalData *) lParam2;
1593
1594 long d1 = (data1 == NULL ? 0 : data1->lParam);
1595 long d2 = (data2 == NULL ? 0 : data2->lParam);
1596
1597 return internalData->user_fn(d1, d2, internalData->data);
1598
1599 };
1600
1601 bool wxListCtrl::SortItems(wxListCtrlCompare fn, long data)
1602 {
1603 struct wxInternalDataSort internalData;
1604 internalData.user_fn = fn;
1605 internalData.data = data;
1606
1607 // WPARAM cast is needed for mingw/cygwin
1608 if ( !ListView_SortItems(GetHwnd(),
1609 wxInternalDataCompareFunc,
1610 (WPARAM) &internalData) )
1611 {
1612 wxLogDebug(_T("ListView_SortItems() failed"));
1613
1614 return FALSE;
1615 }
1616
1617 return TRUE;
1618 }
1619
1620
1621
1622 // ----------------------------------------------------------------------------
1623 // message processing
1624 // ----------------------------------------------------------------------------
1625
1626 bool wxListCtrl::MSWCommand(WXUINT cmd, WXWORD id)
1627 {
1628 if (cmd == EN_UPDATE)
1629 {
1630 wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, id);
1631 event.SetEventObject( this );
1632 ProcessCommand(event);
1633 return TRUE;
1634 }
1635 else if (cmd == EN_KILLFOCUS)
1636 {
1637 wxCommandEvent event(wxEVT_KILL_FOCUS, id);
1638 event.SetEventObject( this );
1639 ProcessCommand(event);
1640 return TRUE;
1641 }
1642 else
1643 return FALSE;
1644 }
1645
1646 bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
1647 {
1648
1649 // prepare the event
1650 // -----------------
1651
1652 wxListEvent event(wxEVT_NULL, m_windowId);
1653 event.SetEventObject(this);
1654
1655 wxEventType eventType = wxEVT_NULL;
1656
1657 NMHDR *nmhdr = (NMHDR *)lParam;
1658
1659 // if your compiler is as broken as this, you should really change it: this
1660 // code is needed for normal operation! #ifdef below is only useful for
1661 // automatic rebuilds which are done with a very old compiler version
1662 #ifdef HDN_BEGINTRACKA
1663
1664 // check for messages from the header (in report view)
1665 HWND hwndHdr = ListView_GetHeader(GetHwnd());
1666
1667 // is it a message from the header?
1668 if ( nmhdr->hwndFrom == hwndHdr )
1669 {
1670 HD_NOTIFY *nmHDR = (HD_NOTIFY *)nmhdr;
1671
1672 event.m_itemIndex = -1;
1673
1674 switch ( nmhdr->code )
1675 {
1676 // yet another comctl32.dll bug: under NT/W2K it sends Unicode
1677 // TRACK messages even to ANSI programs: on my system I get
1678 // HDN_BEGINTRACKW and HDN_ENDTRACKA and no HDN_TRACK at all!
1679 //
1680 // work around is to simply catch both versions and hope that it
1681 // works (why should this message exist in ANSI and Unicode is
1682 // beyond me as it doesn't deal with strings at all...)
1683 //
1684 // note that fr HDN_TRACK another possibility could be to use
1685 // HDN_ITEMCHANGING but it is sent even after HDN_ENDTRACK and when
1686 // something other than the item width changes so we'd have to
1687 // filter out the unwanted events then
1688 case HDN_BEGINTRACKA:
1689 case HDN_BEGINTRACKW:
1690 eventType = wxEVT_COMMAND_LIST_COL_BEGIN_DRAG;
1691 // fall through
1692
1693 case HDN_TRACKA:
1694 case HDN_TRACKW:
1695 if ( eventType == wxEVT_NULL )
1696 eventType = wxEVT_COMMAND_LIST_COL_DRAGGING;
1697 // fall through
1698
1699 case HDN_ENDTRACKA:
1700 case HDN_ENDTRACKW:
1701 if ( eventType == wxEVT_NULL )
1702 eventType = wxEVT_COMMAND_LIST_COL_END_DRAG;
1703
1704 event.m_item.m_width = nmHDR->pitem->cxy;
1705 event.m_col = nmHDR->iItem;
1706 break;
1707
1708 case NM_RCLICK:
1709 {
1710 eventType = wxEVT_COMMAND_LIST_COL_RIGHT_CLICK;
1711 event.m_col = -1;
1712
1713 // find the column clicked: we have to search for it
1714 // ourselves as the notification message doesn't provide
1715 // this info
1716
1717 // where did the click occur?
1718 POINT ptClick;
1719 if ( !::GetCursorPos(&ptClick) )
1720 {
1721 wxLogLastError(_T("GetCursorPos"));
1722 }
1723
1724 if ( !::ScreenToClient(hwndHdr, &ptClick) )
1725 {
1726 wxLogLastError(_T("ScreenToClient(listctrl header)"));
1727 }
1728
1729 event.m_pointDrag.x = ptClick.x;
1730 event.m_pointDrag.y = ptClick.y;
1731
1732 int colCount = Header_GetItemCount(hwndHdr);
1733
1734 RECT rect;
1735 for ( int col = 0; col < colCount; col++ )
1736 {
1737 if ( Header_GetItemRect(hwndHdr, col, &rect) )
1738 {
1739 if ( ::PtInRect(&rect, ptClick) )
1740 {
1741 event.m_col = col;
1742 break;
1743 }
1744 }
1745 }
1746 }
1747 break;
1748
1749 case HDN_GETDISPINFOW:
1750 {
1751 LPNMHDDISPINFOW info = (LPNMHDDISPINFOW) lParam;
1752 // This is a fix for a strange bug under XP.
1753 // Normally, info->iItem is a valid index, but
1754 // sometimes this is a silly (large) number
1755 // and when we return FALSE via wxControl::MSWOnNotify
1756 // to indicate that it hasn't yet been processed,
1757 // there's a GPF in Windows.
1758 // By returning TRUE here, we avoid further processing
1759 // of this strange message.
1760 if ( info->iItem >= GetColumnCount() )
1761 return TRUE;
1762 }
1763 // fall through
1764
1765 default:
1766 return wxControl::MSWOnNotify(idCtrl, lParam, result);
1767 }
1768 }
1769 else
1770 #endif // defined(HDN_BEGINTRACKA)
1771 if ( nmhdr->hwndFrom == GetHwnd() )
1772 {
1773 // almost all messages use NM_LISTVIEW
1774 NM_LISTVIEW *nmLV = (NM_LISTVIEW *)nmhdr;
1775
1776 const int iItem = nmLV->iItem;
1777
1778
1779 // FreeAllInternalData will cause LVN_ITEMCHANG* messages, which can be
1780 // ignored for efficiency. It is done here because the internal data is in the
1781 // process of being deleted so we don't want to try and access it below.
1782 if ( m_ignoreChangeMessages &&
1783 ( (nmLV->hdr.code == LVN_ITEMCHANGED) || (nmLV->hdr.code == LVN_ITEMCHANGING)))
1784 {
1785 return TRUE;
1786 }
1787
1788
1789 // If we have a valid item then check if there is a data value
1790 // associated with it and put it in the event.
1791 if ( iItem >= 0 && iItem < GetItemCount() )
1792 {
1793 wxListItemInternalData *internaldata =
1794 wxGetInternalData(GetHwnd(), iItem);
1795
1796 if ( internaldata )
1797 event.m_item.m_data = internaldata->lParam;
1798 }
1799
1800
1801 switch ( nmhdr->code )
1802 {
1803 case LVN_BEGINRDRAG:
1804 eventType = wxEVT_COMMAND_LIST_BEGIN_RDRAG;
1805 // fall through
1806
1807 case LVN_BEGINDRAG:
1808 if ( eventType == wxEVT_NULL )
1809 {
1810 eventType = wxEVT_COMMAND_LIST_BEGIN_DRAG;
1811 }
1812
1813 event.m_itemIndex = iItem;
1814 event.m_pointDrag.x = nmLV->ptAction.x;
1815 event.m_pointDrag.y = nmLV->ptAction.y;
1816 break;
1817
1818 // NB: we have to handle both *A and *W versions here because some
1819 // versions of comctl32.dll send ANSI message to an Unicode app
1820 case LVN_BEGINLABELEDITA:
1821 {
1822 eventType = wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT;
1823 wxLV_ITEM item(((LV_DISPINFOA *)lParam)->item);
1824 wxConvertFromMSWListItem(GetHwnd(), event.m_item, item);
1825 event.m_itemIndex = event.m_item.m_itemId;
1826 }
1827 break;
1828 case LVN_BEGINLABELEDITW:
1829 {
1830 eventType = wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT;
1831 wxLV_ITEM item(((LV_DISPINFOW *)lParam)->item);
1832 wxConvertFromMSWListItem(GetHwnd(), event.m_item, item);
1833 event.m_itemIndex = event.m_item.m_itemId;
1834 }
1835 break;
1836
1837 case LVN_ENDLABELEDITA:
1838 {
1839 eventType = wxEVT_COMMAND_LIST_END_LABEL_EDIT;
1840 wxLV_ITEM item(((LV_DISPINFOA *)lParam)->item);
1841 wxConvertFromMSWListItem(NULL, event.m_item, item);
1842 if ( ((LV_ITEM)item).pszText == NULL ||
1843 ((LV_ITEM)item).iItem == -1 )
1844 {
1845 // don't keep a stale wxTextCtrl around
1846 if ( m_textCtrl )
1847 {
1848 // EDIT control will be deleted by the list control itself so
1849 // prevent us from deleting it as well
1850 m_textCtrl->UnsubclassWin();
1851 m_textCtrl->SetHWND(0);
1852 delete m_textCtrl;
1853 m_textCtrl = NULL;
1854 }
1855 return FALSE;
1856 }
1857
1858 event.m_itemIndex = event.m_item.m_itemId;
1859 }
1860 break;
1861 case LVN_ENDLABELEDITW:
1862 {
1863 eventType = wxEVT_COMMAND_LIST_END_LABEL_EDIT;
1864 wxLV_ITEM item(((LV_DISPINFOW *)lParam)->item);
1865 wxConvertFromMSWListItem(NULL, event.m_item, item);
1866 if ( ((LV_ITEM)item).pszText == NULL ||
1867 ((LV_ITEM)item).iItem == -1 )
1868 {
1869 // don't keep a stale wxTextCtrl around
1870 if ( m_textCtrl )
1871 {
1872 // EDIT control will be deleted by the list control itself so
1873 // prevent us from deleting it as well
1874 m_textCtrl->UnsubclassWin();
1875 m_textCtrl->SetHWND(0);
1876 delete m_textCtrl;
1877 m_textCtrl = NULL;
1878 }
1879 return FALSE;
1880 }
1881
1882 event.m_itemIndex = event.m_item.m_itemId;
1883 }
1884 break;
1885
1886 case LVN_COLUMNCLICK:
1887 eventType = wxEVT_COMMAND_LIST_COL_CLICK;
1888 event.m_itemIndex = -1;
1889 event.m_col = nmLV->iSubItem;
1890 break;
1891
1892 case LVN_DELETEALLITEMS:
1893 m_count = 0;
1894 eventType = wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS;
1895 event.m_itemIndex = -1;
1896 break;
1897
1898 case LVN_DELETEITEM:
1899 if (m_count == 0)
1900 // this should be prevented by the post-processing code below,
1901 // but "just in case"
1902 return FALSE;
1903
1904 eventType = wxEVT_COMMAND_LIST_DELETE_ITEM;
1905 event.m_itemIndex = iItem;
1906 // delete the assoicated internal data
1907 wxDeleteInternalData(this, iItem);
1908 break;
1909
1910 case LVN_SETDISPINFO:
1911 {
1912 eventType = wxEVT_COMMAND_LIST_SET_INFO;
1913 LV_DISPINFO *info = (LV_DISPINFO *)lParam;
1914 wxConvertFromMSWListItem(GetHwnd(), event.m_item, info->item);
1915 }
1916 break;
1917
1918 case LVN_INSERTITEM:
1919 eventType = wxEVT_COMMAND_LIST_INSERT_ITEM;
1920 event.m_itemIndex = iItem;
1921 break;
1922
1923 case LVN_ITEMCHANGED:
1924 // we translate this catch all message into more interesting
1925 // (and more easy to process) wxWindows events
1926
1927 // first of all, we deal with the state change events only and
1928 // only for valid items (item == -1 for the virtual list
1929 // control)
1930 if ( nmLV->uChanged & LVIF_STATE && iItem != -1 )
1931 {
1932 // temp vars for readability
1933 const UINT stOld = nmLV->uOldState;
1934 const UINT stNew = nmLV->uNewState;
1935
1936 event.m_item.SetId(iItem);
1937 event.m_item.SetMask(wxLIST_MASK_TEXT |
1938 wxLIST_MASK_IMAGE |
1939 wxLIST_MASK_DATA);
1940 GetItem(event.m_item);
1941
1942 // has the focus changed?
1943 if ( !(stOld & LVIS_FOCUSED) && (stNew & LVIS_FOCUSED) )
1944 {
1945 eventType = wxEVT_COMMAND_LIST_ITEM_FOCUSED;
1946 event.m_itemIndex = iItem;
1947 }
1948
1949 if ( (stNew & LVIS_SELECTED) != (stOld & LVIS_SELECTED) )
1950 {
1951 if ( eventType != wxEVT_NULL )
1952 {
1953 // focus and selection have both changed: send the
1954 // focus event from here and the selection one
1955 // below
1956 event.SetEventType(eventType);
1957 (void)GetEventHandler()->ProcessEvent(event);
1958 }
1959 else // no focus event to send
1960 {
1961 // then need to set m_itemIndex as it wasn't done
1962 // above
1963 event.m_itemIndex = iItem;
1964 }
1965
1966 eventType = stNew & LVIS_SELECTED
1967 ? wxEVT_COMMAND_LIST_ITEM_SELECTED
1968 : wxEVT_COMMAND_LIST_ITEM_DESELECTED;
1969 }
1970 }
1971
1972 if ( eventType == wxEVT_NULL )
1973 {
1974 // not an interesting event for us
1975 return FALSE;
1976 }
1977
1978 break;
1979
1980 case LVN_KEYDOWN:
1981 {
1982 LV_KEYDOWN *info = (LV_KEYDOWN *)lParam;
1983 WORD wVKey = info->wVKey;
1984
1985 // get the current selection
1986 long lItem = GetNextItem(-1,
1987 wxLIST_NEXT_ALL,
1988 wxLIST_STATE_SELECTED);
1989
1990 // <Enter> or <Space> activate the selected item if any (but
1991 // not with Shift and/or Ctrl as then they have a predefined
1992 // meaning for the list view)
1993 if ( lItem != -1 &&
1994 (wVKey == VK_RETURN || wVKey == VK_SPACE) &&
1995 !(wxIsShiftDown() || wxIsCtrlDown()) )
1996 {
1997 eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED;
1998 }
1999 else
2000 {
2001 eventType = wxEVT_COMMAND_LIST_KEY_DOWN;
2002
2003 // wxCharCodeMSWToWX() returns 0 if the key is an ASCII
2004 // value which should be used as is
2005 int code = wxCharCodeMSWToWX(wVKey);
2006 event.m_code = code ? code : wVKey;
2007 }
2008
2009 event.m_itemIndex =
2010 event.m_item.m_itemId = lItem;
2011
2012 if ( lItem != -1 )
2013 {
2014 // fill the other fields too
2015 event.m_item.m_text = GetItemText(lItem);
2016 event.m_item.m_data = GetItemData(lItem);
2017 }
2018 }
2019 break;
2020
2021 case NM_DBLCLK:
2022 // if the user processes it in wxEVT_COMMAND_LEFT_CLICK(), don't do
2023 // anything else
2024 if ( wxControl::MSWOnNotify(idCtrl, lParam, result) )
2025 {
2026 return TRUE;
2027 }
2028
2029 // else translate it into wxEVT_COMMAND_LIST_ITEM_ACTIVATED event
2030 // if it happened on an item (and not on empty place)
2031 if ( iItem == -1 )
2032 {
2033 // not on item
2034 return FALSE;
2035 }
2036
2037 eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED;
2038 event.m_itemIndex = iItem;
2039 event.m_item.m_text = GetItemText(iItem);
2040 event.m_item.m_data = GetItemData(iItem);
2041 break;
2042
2043 case NM_RCLICK:
2044 // if the user processes it in wxEVT_COMMAND_RIGHT_CLICK(),
2045 // don't do anything else
2046 if ( wxControl::MSWOnNotify(idCtrl, lParam, result) )
2047 {
2048 return TRUE;
2049 }
2050
2051 // else translate it into wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK event
2052 LV_HITTESTINFO lvhti;
2053 wxZeroMemory(lvhti);
2054
2055 ::GetCursorPos(&(lvhti.pt));
2056 ::ScreenToClient(GetHwnd(),&(lvhti.pt));
2057 if ( ListView_HitTest(GetHwnd(),&lvhti) != -1 )
2058 {
2059 if ( lvhti.flags & LVHT_ONITEM )
2060 {
2061 eventType = wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK;
2062 event.m_itemIndex = lvhti.iItem;
2063 event.m_pointDrag.x = lvhti.pt.x;
2064 event.m_pointDrag.y = lvhti.pt.y;
2065 }
2066 }
2067 break;
2068
2069 #if defined(_WIN32_IE) && _WIN32_IE >= 0x300 \
2070 && !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 0 ) )
2071 case NM_CUSTOMDRAW:
2072 *result = OnCustomDraw(lParam);
2073
2074 return TRUE;
2075 #endif // _WIN32_IE >= 0x300
2076
2077 case LVN_ODCACHEHINT:
2078 {
2079 const NM_CACHEHINT *cacheHint = (NM_CACHEHINT *)lParam;
2080
2081 eventType = wxEVT_COMMAND_LIST_CACHE_HINT;
2082
2083 // we get some really stupid cache hints like ones for
2084 // items in range 0..0 for an empty control or, after
2085 // deleting an item, for items in invalid range -- filter
2086 // this garbage out
2087 if ( cacheHint->iFrom > cacheHint->iTo )
2088 return FALSE;
2089
2090 event.m_oldItemIndex = cacheHint->iFrom;
2091
2092 const long iMax = GetItemCount();
2093 event.m_itemIndex = cacheHint->iTo < iMax ? cacheHint->iTo
2094 : iMax - 1;
2095 }
2096 break;
2097
2098 case LVN_GETDISPINFO:
2099 if ( IsVirtual() )
2100 {
2101 LV_DISPINFO *info = (LV_DISPINFO *)lParam;
2102
2103 LV_ITEM& lvi = info->item;
2104 long item = lvi.iItem;
2105
2106 if ( lvi.mask & LVIF_TEXT )
2107 {
2108 wxString text = OnGetItemText(item, lvi.iSubItem);
2109 wxStrncpy(lvi.pszText, text, lvi.cchTextMax);
2110 }
2111
2112 #if defined(_WIN32_IE) && _WIN32_IE >= 0x300 \
2113 && !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 1 ) )
2114 if ( lvi.mask & LVIF_IMAGE )
2115 {
2116 lvi.iImage = OnGetItemImage(item);
2117 }
2118 #endif
2119
2120 // a little dose of healthy paranoia: as we never use
2121 // LVM_SETCALLBACKMASK we're not supposed to get these ones
2122 wxASSERT_MSG( !(lvi.mask & LVIF_STATE),
2123 _T("we don't support state callbacks yet!") );
2124
2125 return TRUE;
2126 }
2127 // fall through
2128
2129 default:
2130 return wxControl::MSWOnNotify(idCtrl, lParam, result);
2131 }
2132 }
2133 else
2134 {
2135 // where did this one come from?
2136 return FALSE;
2137 }
2138
2139 // process the event
2140 // -----------------
2141
2142 event.SetEventType(eventType);
2143
2144 bool processed = GetEventHandler()->ProcessEvent(event);
2145
2146 // post processing
2147 // ---------------
2148 switch ( nmhdr->code )
2149 {
2150 case LVN_DELETEALLITEMS:
2151 // always return TRUE to suppress all additional LVN_DELETEITEM
2152 // notifications - this makes deleting all items from a list ctrl
2153 // much faster
2154 *result = TRUE;
2155 return TRUE;
2156
2157 case LVN_ENDLABELEDITA:
2158 case LVN_ENDLABELEDITW:
2159 // logic here is inversed compared to all the other messages
2160 *result = event.IsAllowed();
2161
2162 // don't keep a stale wxTextCtrl around
2163 if ( m_textCtrl )
2164 {
2165 // EDIT control will be deleted by the list control itself so
2166 // prevent us from deleting it as well
2167 m_textCtrl->UnsubclassWin();
2168 m_textCtrl->SetHWND(0);
2169 delete m_textCtrl;
2170 m_textCtrl = NULL;
2171 }
2172
2173 return TRUE;
2174 }
2175
2176 if ( processed )
2177 *result = !event.IsAllowed();
2178
2179 return processed;
2180 }
2181
2182 #if defined(_WIN32_IE) && _WIN32_IE >= 0x300
2183
2184 WXLPARAM wxListCtrl::OnCustomDraw(WXLPARAM lParam)
2185 {
2186 LPNMLVCUSTOMDRAW lplvcd = (LPNMLVCUSTOMDRAW)lParam;
2187 NMCUSTOMDRAW& nmcd = lplvcd->nmcd;
2188 switch ( nmcd.dwDrawStage )
2189 {
2190 case CDDS_PREPAINT:
2191 // if we've got any items with non standard attributes,
2192 // notify us before painting each item
2193 //
2194 // for virtual controls, always suppose that we have attributes as
2195 // there is no way to check for this
2196 return IsVirtual() || m_hasAnyAttr ? CDRF_NOTIFYITEMDRAW
2197 : CDRF_DODEFAULT;
2198
2199 case CDDS_ITEMPREPAINT:
2200 {
2201 size_t item = (size_t)nmcd.dwItemSpec;
2202 if ( item >= (size_t)GetItemCount() )
2203 {
2204 // we get this message with item == 0 for an empty control,
2205 // we must ignore it as calling OnGetItemAttr() would be
2206 // wrong
2207 return CDRF_DODEFAULT;
2208 }
2209
2210 wxListItemAttr *attr =
2211 IsVirtual() ? OnGetItemAttr(item)
2212 : wxGetInternalDataAttr(this, item);
2213
2214 if ( !attr )
2215 {
2216 // nothing to do for this item
2217 return CDRF_DODEFAULT;
2218 }
2219
2220 HFONT hFont;
2221 wxColour colText, colBack;
2222 if ( attr->HasFont() )
2223 {
2224 wxFont font = attr->GetFont();
2225 hFont = (HFONT)font.GetResourceHandle();
2226 }
2227 else
2228 {
2229 hFont = 0;
2230 }
2231
2232 if ( attr->HasTextColour() )
2233 {
2234 colText = attr->GetTextColour();
2235 }
2236 else
2237 {
2238 colText = GetTextColour();
2239 }
2240
2241 if ( attr->HasBackgroundColour() )
2242 {
2243 colBack = attr->GetBackgroundColour();
2244 }
2245 else
2246 {
2247 colBack = GetBackgroundColour();
2248 }
2249
2250 lplvcd->clrText = wxColourToRGB(colText);
2251 lplvcd->clrTextBk = wxColourToRGB(colBack);
2252
2253 // note that if we wanted to set colours for
2254 // individual columns (subitems), we would have
2255 // returned CDRF_NOTIFYSUBITEMREDRAW from here
2256 if ( hFont )
2257 {
2258 ::SelectObject(nmcd.hdc, hFont);
2259
2260 return CDRF_NEWFONT;
2261 }
2262 }
2263 // fall through to return CDRF_DODEFAULT
2264
2265 default:
2266 return CDRF_DODEFAULT;
2267 }
2268 }
2269
2270 #endif // NM_CUSTOMDRAW supported
2271
2272 // Necessary for drawing hrules and vrules, if specified
2273 void wxListCtrl::OnPaint(wxPaintEvent& event)
2274 {
2275 wxPaintDC dc(this);
2276
2277 wxControl::OnPaint(event);
2278
2279 // Reset the device origin since it may have been set
2280 dc.SetDeviceOrigin(0, 0);
2281
2282 bool drawHRules = ((GetWindowStyle() & wxLC_HRULES) != 0);
2283 bool drawVRules = ((GetWindowStyle() & wxLC_VRULES) != 0);
2284
2285 if (!drawHRules && !drawVRules)
2286 return;
2287 if ((GetWindowStyle() & wxLC_REPORT) == 0)
2288 return;
2289
2290 wxPen pen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT), 1, wxSOLID);
2291 dc.SetPen(pen);
2292 dc.SetBrush(* wxTRANSPARENT_BRUSH);
2293
2294 wxSize clientSize = GetClientSize();
2295 wxRect itemRect;
2296 int cy=0;
2297
2298 int itemCount = GetItemCount();
2299 int i;
2300 if (drawHRules)
2301 {
2302 long top = GetTopItem();
2303 for (i = top; i < top + GetCountPerPage() + 1; i++)
2304 {
2305 if (GetItemRect(i, itemRect))
2306 {
2307 cy = itemRect.GetTop();
2308 if (i != 0) // Don't draw the first one
2309 {
2310 dc.DrawLine(0, cy, clientSize.x, cy);
2311 }
2312 // Draw last line
2313 if (i == itemCount - 1)
2314 {
2315 cy = itemRect.GetBottom();
2316 dc.DrawLine(0, cy, clientSize.x, cy);
2317 }
2318 }
2319 }
2320 }
2321 i = itemCount - 1;
2322 if (drawVRules && (i > -1))
2323 {
2324 wxRect firstItemRect;
2325 GetItemRect(0, firstItemRect);
2326
2327 if (GetItemRect(i, itemRect))
2328 {
2329 int col;
2330 int x = itemRect.GetX();
2331 for (col = 0; col < GetColumnCount(); col++)
2332 {
2333 int colWidth = GetColumnWidth(col);
2334 x += colWidth ;
2335 dc.DrawLine(x-1, firstItemRect.GetY() - 2, x-1, itemRect.GetBottom());
2336 }
2337 }
2338 }
2339 }
2340
2341 // ----------------------------------------------------------------------------
2342 // virtual list controls
2343 // ----------------------------------------------------------------------------
2344
2345 wxString wxListCtrl::OnGetItemText(long WXUNUSED(item), long WXUNUSED(col)) const
2346 {
2347 // this is a pure virtual function, in fact - which is not really pure
2348 // because the controls which are not virtual don't need to implement it
2349 wxFAIL_MSG( _T("wxListCtrl::OnGetItemText not supposed to be called") );
2350
2351 return wxEmptyString;
2352 }
2353
2354 int wxListCtrl::OnGetItemImage(long WXUNUSED(item)) const
2355 {
2356 // same as above
2357 wxFAIL_MSG( _T("wxListCtrl::OnGetItemImage not supposed to be called") );
2358
2359 return -1;
2360 }
2361
2362 wxListItemAttr *wxListCtrl::OnGetItemAttr(long WXUNUSED_UNLESS_DEBUG(item)) const
2363 {
2364 wxASSERT_MSG( item >= 0 && item < GetItemCount(),
2365 _T("invalid item index in OnGetItemAttr()") );
2366
2367 // no attributes by default
2368 return NULL;
2369 }
2370
2371 void wxListCtrl::SetItemCount(long count)
2372 {
2373 wxASSERT_MSG( IsVirtual(), _T("this is for virtual controls only") );
2374
2375 if ( !::SendMessage(GetHwnd(), LVM_SETITEMCOUNT, (WPARAM)count, LVSICF_NOSCROLL) )
2376 {
2377 wxLogLastError(_T("ListView_SetItemCount"));
2378 }
2379 m_count = count;
2380 wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()),
2381 wxT("m_count should match ListView_GetItemCount"));
2382 }
2383
2384 void wxListCtrl::RefreshItem(long item)
2385 {
2386 // strangely enough, ListView_Update() results in much more flicker here
2387 // than a dumb Refresh() -- why?
2388 #if 0
2389 if ( !ListView_Update(GetHwnd(), item) )
2390 {
2391 wxLogLastError(_T("ListView_Update"));
2392 }
2393 #else // 1
2394 wxRect rect;
2395 GetItemRect(item, rect);
2396 RefreshRect(rect);
2397 #endif // 0/1
2398 }
2399
2400 void wxListCtrl::RefreshItems(long itemFrom, long itemTo)
2401 {
2402 wxRect rect1, rect2;
2403 GetItemRect(itemFrom, rect1);
2404 GetItemRect(itemTo, rect2);
2405
2406 wxRect rect = rect1;
2407 rect.height = rect2.GetBottom() - rect1.GetTop();
2408
2409 RefreshRect(rect);
2410 }
2411
2412 static wxListItemInternalData *wxGetInternalData(HWND hwnd, long itemId)
2413 {
2414 LV_ITEM it;
2415 it.mask = LVIF_PARAM;
2416 it.iItem = itemId;
2417
2418 bool success = ListView_GetItem(hwnd, &it) != 0;
2419 if (success)
2420 return (wxListItemInternalData *) it.lParam;
2421 else
2422 return NULL;
2423 };
2424
2425 static wxListItemInternalData *wxGetInternalData(wxListCtrl *ctl, long itemId)
2426 {
2427 return wxGetInternalData((HWND) ctl->GetHWND(), itemId);
2428 };
2429
2430 static wxListItemAttr *wxGetInternalDataAttr(wxListCtrl *ctl, long itemId)
2431 {
2432 wxListItemInternalData *data = wxGetInternalData(ctl, itemId);
2433 if (data)
2434 return data->attr;
2435 else
2436 return NULL;
2437 };
2438
2439 static void wxDeleteInternalData(wxListCtrl* ctl, long itemId)
2440 {
2441 wxListItemInternalData *data = wxGetInternalData(ctl, itemId);
2442 if (data)
2443 {
2444 LV_ITEM item;
2445 memset(&item, 0, sizeof(item));
2446 item.iItem = itemId;
2447 item.mask = LVIF_PARAM;
2448 item.lParam = (LPARAM) 0;
2449 ListView_SetItem((HWND)ctl->GetHWND(), &item);
2450 delete data;
2451 }
2452 }
2453
2454 static void wxConvertFromMSWListItem(HWND hwndListCtrl,
2455 wxListItem& info,
2456 LV_ITEM& lvItem)
2457 {
2458 wxListItemInternalData *internaldata =
2459 (wxListItemInternalData *) lvItem.lParam;
2460
2461 if (internaldata)
2462 info.m_data = internaldata->lParam;
2463
2464 info.m_mask = 0;
2465 info.m_state = 0;
2466 info.m_stateMask = 0;
2467 info.m_itemId = lvItem.iItem;
2468
2469 long oldMask = lvItem.mask;
2470
2471 bool needText = FALSE;
2472 if (hwndListCtrl != 0)
2473 {
2474 if ( lvItem.mask & LVIF_TEXT )
2475 needText = FALSE;
2476 else
2477 needText = TRUE;
2478
2479 if ( needText )
2480 {
2481 lvItem.pszText = new wxChar[513];
2482 lvItem.cchTextMax = 512;
2483 }
2484 lvItem.mask |= LVIF_TEXT | LVIF_IMAGE | LVIF_PARAM;
2485 ::SendMessage(hwndListCtrl, LVM_GETITEM, 0, (LPARAM)& lvItem);
2486 }
2487
2488 if ( lvItem.mask & LVIF_STATE )
2489 {
2490 info.m_mask |= wxLIST_MASK_STATE;
2491
2492 if ( lvItem.stateMask & LVIS_CUT)
2493 {
2494 info.m_stateMask |= wxLIST_STATE_CUT;
2495 if ( lvItem.state & LVIS_CUT )
2496 info.m_state |= wxLIST_STATE_CUT;
2497 }
2498 if ( lvItem.stateMask & LVIS_DROPHILITED)
2499 {
2500 info.m_stateMask |= wxLIST_STATE_DROPHILITED;
2501 if ( lvItem.state & LVIS_DROPHILITED )
2502 info.m_state |= wxLIST_STATE_DROPHILITED;
2503 }
2504 if ( lvItem.stateMask & LVIS_FOCUSED)
2505 {
2506 info.m_stateMask |= wxLIST_STATE_FOCUSED;
2507 if ( lvItem.state & LVIS_FOCUSED )
2508 info.m_state |= wxLIST_STATE_FOCUSED;
2509 }
2510 if ( lvItem.stateMask & LVIS_SELECTED)
2511 {
2512 info.m_stateMask |= wxLIST_STATE_SELECTED;
2513 if ( lvItem.state & LVIS_SELECTED )
2514 info.m_state |= wxLIST_STATE_SELECTED;
2515 }
2516 }
2517
2518 if ( lvItem.mask & LVIF_TEXT )
2519 {
2520 info.m_mask |= wxLIST_MASK_TEXT;
2521 info.m_text = lvItem.pszText;
2522 }
2523 if ( lvItem.mask & LVIF_IMAGE )
2524 {
2525 info.m_mask |= wxLIST_MASK_IMAGE;
2526 info.m_image = lvItem.iImage;
2527 }
2528 if ( lvItem.mask & LVIF_PARAM )
2529 info.m_mask |= wxLIST_MASK_DATA;
2530 if ( lvItem.mask & LVIF_DI_SETITEM )
2531 info.m_mask |= wxLIST_SET_ITEM;
2532 info.m_col = lvItem.iSubItem;
2533
2534 if (needText)
2535 {
2536 if (lvItem.pszText)
2537 delete[] lvItem.pszText;
2538 }
2539 lvItem.mask = oldMask;
2540 }
2541
2542 static void wxConvertToMSWFlags(long state, long stateMask, LV_ITEM& lvItem)
2543 {
2544 if (stateMask & wxLIST_STATE_CUT)
2545 {
2546 lvItem.stateMask |= LVIS_CUT;
2547 if (state & wxLIST_STATE_CUT)
2548 lvItem.state |= LVIS_CUT;
2549 }
2550 if (stateMask & wxLIST_STATE_DROPHILITED)
2551 {
2552 lvItem.stateMask |= LVIS_DROPHILITED;
2553 if (state & wxLIST_STATE_DROPHILITED)
2554 lvItem.state |= LVIS_DROPHILITED;
2555 }
2556 if (stateMask & wxLIST_STATE_FOCUSED)
2557 {
2558 lvItem.stateMask |= LVIS_FOCUSED;
2559 if (state & wxLIST_STATE_FOCUSED)
2560 lvItem.state |= LVIS_FOCUSED;
2561 }
2562 if (stateMask & wxLIST_STATE_SELECTED)
2563 {
2564 lvItem.stateMask |= LVIS_SELECTED;
2565 if (state & wxLIST_STATE_SELECTED)
2566 lvItem.state |= LVIS_SELECTED;
2567 }
2568 }
2569
2570 static void wxConvertToMSWListItem(const wxListCtrl *ctrl,
2571 const wxListItem& info,
2572 LV_ITEM& lvItem)
2573 {
2574 lvItem.iItem = (int) info.m_itemId;
2575
2576 lvItem.iImage = info.m_image;
2577 lvItem.stateMask = 0;
2578 lvItem.state = 0;
2579 lvItem.mask = 0;
2580 lvItem.iSubItem = info.m_col;
2581
2582 if (info.m_mask & wxLIST_MASK_STATE)
2583 {
2584 lvItem.mask |= LVIF_STATE;
2585
2586 wxConvertToMSWFlags(info.m_state, info.m_stateMask, lvItem);
2587 }
2588
2589 if (info.m_mask & wxLIST_MASK_TEXT)
2590 {
2591 lvItem.mask |= LVIF_TEXT;
2592 if ( ctrl->GetWindowStyleFlag() & wxLC_USER_TEXT )
2593 {
2594 lvItem.pszText = LPSTR_TEXTCALLBACK;
2595 }
2596 else
2597 {
2598 // pszText is not const, hence the cast
2599 lvItem.pszText = (wxChar *)info.m_text.c_str();
2600 if ( lvItem.pszText )
2601 lvItem.cchTextMax = info.m_text.Length();
2602 else
2603 lvItem.cchTextMax = 0;
2604 }
2605 }
2606 if (info.m_mask & wxLIST_MASK_IMAGE)
2607 lvItem.mask |= LVIF_IMAGE;
2608 }
2609
2610 static void wxConvertToMSWListCol(int WXUNUSED(col), const wxListItem& item,
2611 LV_COLUMN& lvCol)
2612 {
2613 wxZeroMemory(lvCol);
2614
2615 if ( item.m_mask & wxLIST_MASK_TEXT )
2616 {
2617 lvCol.mask |= LVCF_TEXT;
2618 lvCol.pszText = (wxChar *)item.m_text.c_str(); // cast is safe
2619 }
2620
2621 if ( item.m_mask & wxLIST_MASK_FORMAT )
2622 {
2623 lvCol.mask |= LVCF_FMT;
2624
2625 if ( item.m_format == wxLIST_FORMAT_LEFT )
2626 lvCol.fmt = LVCFMT_LEFT;
2627 else if ( item.m_format == wxLIST_FORMAT_RIGHT )
2628 lvCol.fmt = LVCFMT_RIGHT;
2629 else if ( item.m_format == wxLIST_FORMAT_CENTRE )
2630 lvCol.fmt = LVCFMT_CENTER;
2631 }
2632
2633 if ( item.m_mask & wxLIST_MASK_WIDTH )
2634 {
2635 lvCol.mask |= LVCF_WIDTH;
2636 if ( item.m_width == wxLIST_AUTOSIZE)
2637 lvCol.cx = LVSCW_AUTOSIZE;
2638 else if ( item.m_width == wxLIST_AUTOSIZE_USEHEADER)
2639 lvCol.cx = LVSCW_AUTOSIZE_USEHEADER;
2640 else
2641 lvCol.cx = item.m_width;
2642 }
2643
2644 #if defined(_WIN32_IE) && _WIN32_IE >= 0x300 \
2645 && !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 1 ) )
2646 if ( item.m_mask & wxLIST_MASK_IMAGE )
2647 {
2648 if ( wxTheApp->GetComCtl32Version() >= 470 )
2649 {
2650 lvCol.mask |= LVCF_IMAGE;
2651 lvCol.iImage = item.m_image;
2652 }
2653 //else: it doesn't support item images anyhow
2654 }
2655 #endif
2656 }
2657
2658 #endif // wxUSE_LISTCTRL