Fix wrong in wxListCtrl::SetItemColumnImage() in r74716.
[wxWidgets.git] / src / msw / listctrl.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/listctrl.cpp
3 // Purpose: wxListCtrl
4 // Author: Julian Smart
5 // Modified by: Agron Selimaj
6 // Created: 04/01/98
7 // Copyright: (c) Julian Smart
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
10
11 // ============================================================================
12 // declarations
13 // ============================================================================
14
15 // ----------------------------------------------------------------------------
16 // headers
17 // ----------------------------------------------------------------------------
18
19 // For compilers that support precompilation, includes "wx.h".
20 #include "wx/wxprec.h"
21
22 #ifdef __BORLANDC__
23 #pragma hdrstop
24 #endif
25
26 #if wxUSE_LISTCTRL
27
28 #include "wx/listctrl.h"
29
30 #ifndef WX_PRECOMP
31 #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
32 #include "wx/app.h"
33 #include "wx/intl.h"
34 #include "wx/log.h"
35 #include "wx/settings.h"
36 #include "wx/stopwatch.h"
37 #include "wx/dcclient.h"
38 #include "wx/textctrl.h"
39 #endif
40
41 #include "wx/imaglist.h"
42 #include "wx/vector.h"
43
44 #include "wx/msw/private.h"
45 #include "wx/msw/private/keyboard.h"
46
47 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__)
48 #include <ole2.h>
49 #include <shellapi.h>
50 #if _WIN32_WCE < 400
51 #include <aygshell.h>
52 #endif
53 #endif
54
55 // Currently gcc and watcom don't define NMLVFINDITEM, and DMC only defines
56 // it by its old name NM_FINDTIEM.
57 //
58 #if defined(__VISUALC__) || defined(__BORLANDC__) || defined(NMLVFINDITEM)
59 #define HAVE_NMLVFINDITEM 1
60 #elif defined(__DMC__) || defined(NM_FINDITEM)
61 #define HAVE_NMLVFINDITEM 1
62 #define NMLVFINDITEM NM_FINDITEM
63 #endif
64
65 // ----------------------------------------------------------------------------
66 // private functions
67 // ----------------------------------------------------------------------------
68
69 // convert our state and mask flags to LV_ITEM constants
70 static void wxConvertToMSWFlags(long state, long mask, LV_ITEM& lvItem);
71
72 // convert wxListItem to LV_ITEM
73 static void wxConvertToMSWListItem(const wxListCtrl *ctrl,
74 const wxListItem& info, LV_ITEM& lvItem);
75
76 // convert LV_ITEM to wxListItem
77 static void wxConvertFromMSWListItem(HWND hwndListCtrl,
78 wxListItem& info,
79 /* const */ LV_ITEM& lvItem);
80
81 // convert our wxListItem to LV_COLUMN
82 static void wxConvertToMSWListCol(HWND hwndList,
83 int col,
84 const wxListItem& item,
85 LV_COLUMN& lvCol);
86
87 namespace
88 {
89
90 // replacement for ListView_GetSubItemRect() which provokes warnings like
91 // "the address of 'rc' will always evaluate as 'true'" when used with mingw32
92 // 4.3+
93 //
94 // this function does no error checking on item and subitem parameters, notice
95 // that subitem 0 means the whole item so there is no way to retrieve the
96 // rectangle of the first subitem using this function, in particular notice
97 // that the index is *not* 1-based, in spite of what MSDN says
98 inline bool
99 wxGetListCtrlSubItemRect(HWND hwnd, int item, int subitem, int flags, RECT& rect)
100 {
101 rect.top = subitem;
102 rect.left = flags;
103 return ::SendMessage(hwnd, LVM_GETSUBITEMRECT, item, (LPARAM)&rect) != 0;
104 }
105
106 inline bool
107 wxGetListCtrlItemRect(HWND hwnd, int item, int flags, RECT& rect)
108 {
109 return wxGetListCtrlSubItemRect(hwnd, item, 0, flags, rect);
110 }
111
112 } // anonymous namespace
113
114 // ----------------------------------------------------------------------------
115 // private helper classes
116 // ----------------------------------------------------------------------------
117
118 // We have to handle both fooW and fooA notifications in several cases
119 // because of broken comctl32.dll and/or unicows.dll. This class is used to
120 // convert LV_ITEMA and LV_ITEMW to LV_ITEM (which is either LV_ITEMA or
121 // LV_ITEMW depending on wxUSE_UNICODE setting), so that it can be processed
122 // by wxConvertToMSWListItem().
123 #if wxUSE_UNICODE
124 #define LV_ITEM_NATIVE LV_ITEMW
125 #define LV_ITEM_OTHER LV_ITEMA
126
127 #define LV_CONV_TO_WX cMB2WX
128 #define LV_CONV_BUF wxMB2WXbuf
129 #else // ANSI
130 #define LV_ITEM_NATIVE LV_ITEMA
131 #define LV_ITEM_OTHER LV_ITEMW
132
133 #define LV_CONV_TO_WX cWC2WX
134 #define LV_CONV_BUF wxWC2WXbuf
135 #endif // Unicode/ANSI
136
137 class wxLV_ITEM
138 {
139 public:
140 // default ctor, use Init() later
141 wxLV_ITEM() { m_buf = NULL; m_pItem = NULL; }
142
143 // init without conversion
144 void Init(LV_ITEM_NATIVE& item)
145 {
146 wxASSERT_MSG( !m_pItem, wxT("Init() called twice?") );
147
148 m_pItem = &item;
149 }
150
151 // init with conversion
152 void Init(const LV_ITEM_OTHER& item)
153 {
154 // avoid unnecessary dynamic memory allocation, jjust make m_pItem
155 // point to our own m_item
156
157 // memcpy() can't work if the struct sizes are different
158 wxCOMPILE_TIME_ASSERT( sizeof(LV_ITEM_OTHER) == sizeof(LV_ITEM_NATIVE),
159 CodeCantWorkIfDiffSizes);
160
161 memcpy(&m_item, &item, sizeof(LV_ITEM_NATIVE));
162
163 // convert text from ANSI to Unicod if necessary
164 if ( (item.mask & LVIF_TEXT) && item.pszText )
165 {
166 m_buf = new LV_CONV_BUF(wxConvLocal.LV_CONV_TO_WX(item.pszText));
167 m_item.pszText = (wxChar *)m_buf->data();
168 }
169 }
170
171 // ctor without conversion
172 wxLV_ITEM(LV_ITEM_NATIVE& item) : m_buf(NULL), m_pItem(&item) { }
173
174 // ctor with conversion
175 wxLV_ITEM(LV_ITEM_OTHER& item) : m_buf(NULL)
176 {
177 Init(item);
178 }
179
180 ~wxLV_ITEM() { delete m_buf; }
181
182 // conversion to the real LV_ITEM
183 operator LV_ITEM_NATIVE&() const { return *m_pItem; }
184
185 private:
186 LV_CONV_BUF *m_buf;
187
188 LV_ITEM_NATIVE *m_pItem;
189 LV_ITEM_NATIVE m_item;
190
191 wxDECLARE_NO_COPY_CLASS(wxLV_ITEM);
192 };
193
194 ///////////////////////////////////////////////////////
195 // Problem:
196 // The MSW version had problems with SetTextColour() et
197 // al as the wxListItemAttr's were stored keyed on the
198 // item index. If a item was inserted anywhere but the end
199 // of the list the text attributes (colour etc) for
200 // the following items were out of sync.
201 //
202 // Solution:
203 // Under MSW the only way to associate data with a List
204 // item independent of its position in the list is to
205 // store a pointer to it in its lParam attribute. However
206 // user programs are already using this (via the
207 // SetItemData() GetItemData() calls).
208 //
209 // However what we can do is store a pointer to a
210 // structure which contains the attributes we want *and*
211 // a lParam -- and this is what wxMSWListItemData does.
212 //
213 // To conserve memory, a wxMSWListItemData is
214 // only allocated for a LV_ITEM if text attributes or
215 // user data(lparam) are being set.
216 class wxMSWListItemData
217 {
218 public:
219 wxMSWListItemData() : attr(NULL), lParam(0) {}
220 ~wxMSWListItemData() { delete attr; }
221
222 wxListItemAttr *attr;
223 LPARAM lParam; // real user data
224
225 wxDECLARE_NO_COPY_CLASS(wxMSWListItemData);
226 };
227
228 BEGIN_EVENT_TABLE(wxListCtrl, wxListCtrlBase)
229 EVT_PAINT(wxListCtrl::OnPaint)
230 EVT_CHAR_HOOK(wxListCtrl::OnCharHook)
231 END_EVENT_TABLE()
232
233 // ============================================================================
234 // implementation
235 // ============================================================================
236
237 // ----------------------------------------------------------------------------
238 // wxListCtrl construction
239 // ----------------------------------------------------------------------------
240
241 void wxListCtrl::Init()
242 {
243 m_imageListNormal =
244 m_imageListSmall =
245 m_imageListState = NULL;
246 m_ownsImageListNormal =
247 m_ownsImageListSmall =
248 m_ownsImageListState = false;
249
250 m_colCount = 0;
251 m_count = 0;
252 m_textCtrl = NULL;
253
254 m_hasAnyAttr = false;
255 }
256
257 bool wxListCtrl::Create(wxWindow *parent,
258 wxWindowID id,
259 const wxPoint& pos,
260 const wxSize& size,
261 long style,
262 const wxValidator& validator,
263 const wxString& name)
264 {
265 if ( !CreateControl(parent, id, pos, size, style, validator, name) )
266 return false;
267
268 if ( !MSWCreateControl(WC_LISTVIEW, wxEmptyString, pos, size) )
269 return false;
270
271 // explicitly say that we want to use Unicode because otherwise we get ANSI
272 // versions of _some_ messages (notably LVN_GETDISPINFOA) in MSLU build
273 wxSetCCUnicodeFormat(GetHwnd());
274
275 // We must set the default text colour to the system/theme color, otherwise
276 // GetTextColour will always return black
277 SetTextColour(GetDefaultAttributes().colFg);
278
279 if ( InReportView() )
280 MSWSetExListStyles();
281
282 return true;
283 }
284
285 void wxListCtrl::MSWSetExListStyles()
286 {
287 // for comctl32.dll v 4.70+ we want to have some non default extended
288 // styles because it's prettier (and also because wxGTK does it like this)
289 if ( wxApp::GetComCtl32Version() >= 470 )
290 {
291 ::SendMessage
292 (
293 GetHwnd(), LVM_SETEXTENDEDLISTVIEWSTYLE, 0,
294 // LVS_EX_LABELTIP shouldn't be used under Windows CE where it's
295 // not defined in the SDK headers
296 #ifdef LVS_EX_LABELTIP
297 LVS_EX_LABELTIP |
298 #endif
299 LVS_EX_FULLROWSELECT |
300 LVS_EX_SUBITEMIMAGES |
301 // normally this should be governed by a style as it's probably not
302 // always appropriate, but we don't have any free styles left and
303 // it seems better to enable it by default than disable
304 LVS_EX_HEADERDRAGDROP
305 );
306 }
307 }
308
309 WXDWORD wxListCtrl::MSWGetStyle(long style, WXDWORD *exstyle) const
310 {
311 WXDWORD wstyle = wxListCtrlBase::MSWGetStyle(style, exstyle);
312
313 wstyle |= LVS_SHAREIMAGELISTS | LVS_SHOWSELALWAYS;
314
315 #if wxDEBUG_LEVEL
316 size_t nModes = 0;
317
318 #define MAP_MODE_STYLE(wx, ms) \
319 if ( style & (wx) ) { wstyle |= (ms); nModes++; }
320 #else // !wxDEBUG_LEVEL
321 #define MAP_MODE_STYLE(wx, ms) \
322 if ( style & (wx) ) wstyle |= (ms);
323 #endif // wxDEBUG_LEVEL/!wxDEBUG_LEVEL
324
325 MAP_MODE_STYLE(wxLC_ICON, LVS_ICON)
326 MAP_MODE_STYLE(wxLC_SMALL_ICON, LVS_SMALLICON)
327 MAP_MODE_STYLE(wxLC_LIST, LVS_LIST)
328 MAP_MODE_STYLE(wxLC_REPORT, LVS_REPORT)
329
330 wxASSERT_MSG( nModes == 1,
331 wxT("wxListCtrl style should have exactly one mode bit set") );
332
333 #undef MAP_MODE_STYLE
334
335 if ( style & wxLC_ALIGN_LEFT )
336 wstyle |= LVS_ALIGNLEFT;
337
338 if ( style & wxLC_ALIGN_TOP )
339 wstyle |= LVS_ALIGNTOP;
340
341 if ( style & wxLC_AUTOARRANGE )
342 wstyle |= LVS_AUTOARRANGE;
343
344 if ( style & wxLC_NO_SORT_HEADER )
345 wstyle |= LVS_NOSORTHEADER;
346
347 if ( style & wxLC_NO_HEADER )
348 wstyle |= LVS_NOCOLUMNHEADER;
349
350 if ( style & wxLC_EDIT_LABELS )
351 wstyle |= LVS_EDITLABELS;
352
353 if ( style & wxLC_SINGLE_SEL )
354 wstyle |= LVS_SINGLESEL;
355
356 if ( style & wxLC_SORT_ASCENDING )
357 {
358 wstyle |= LVS_SORTASCENDING;
359
360 wxASSERT_MSG( !(style & wxLC_SORT_DESCENDING),
361 wxT("can't sort in ascending and descending orders at once") );
362 }
363 else if ( style & wxLC_SORT_DESCENDING )
364 wstyle |= LVS_SORTDESCENDING;
365
366 #if !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 0 ) )
367 if ( style & wxLC_VIRTUAL )
368 {
369 int ver = wxApp::GetComCtl32Version();
370 if ( ver < 470 )
371 {
372 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."),
373 ver / 100, ver % 100);
374 }
375
376 wstyle |= LVS_OWNERDATA;
377 }
378 #endif // ancient cygwin
379
380 return wstyle;
381 }
382
383 void wxListCtrl::UpdateStyle()
384 {
385 if ( GetHwnd() )
386 {
387 // The new window view style
388 DWORD dwStyleNew = MSWGetStyle(m_windowStyle, NULL);
389
390 // some styles are not returned by MSWGetStyle()
391 if ( IsShown() )
392 dwStyleNew |= WS_VISIBLE;
393
394 // Get the current window style.
395 DWORD dwStyleOld = ::GetWindowLong(GetHwnd(), GWL_STYLE);
396
397 // we don't have wxVSCROLL style, but the list control may have it,
398 // don't change it then
399 dwStyleNew |= dwStyleOld & (WS_HSCROLL | WS_VSCROLL);
400
401 // Only set the window style if the view bits have changed.
402 if ( dwStyleOld != dwStyleNew )
403 {
404 ::SetWindowLong(GetHwnd(), GWL_STYLE, dwStyleNew);
405
406 // if we switched to the report view, set the extended styles for
407 // it too
408 if ( !(dwStyleOld & LVS_REPORT) && (dwStyleNew & LVS_REPORT) )
409 MSWSetExListStyles();
410 }
411 }
412 }
413
414 void wxListCtrl::FreeAllInternalData()
415 {
416 const unsigned count = m_internalData.size();
417 for ( unsigned n = 0; n < count; n++ )
418 delete m_internalData[n];
419
420 m_internalData.clear();
421 }
422
423 void wxListCtrl::DeleteEditControl()
424 {
425 if ( m_textCtrl )
426 {
427 m_textCtrl->UnsubclassWin();
428 m_textCtrl->SetHWND(0);
429 wxDELETE(m_textCtrl);
430 }
431 }
432
433 wxListCtrl::~wxListCtrl()
434 {
435 FreeAllInternalData();
436
437 DeleteEditControl();
438
439 if (m_ownsImageListNormal)
440 delete m_imageListNormal;
441 if (m_ownsImageListSmall)
442 delete m_imageListSmall;
443 if (m_ownsImageListState)
444 delete m_imageListState;
445 }
446
447 // ----------------------------------------------------------------------------
448 // set/get/change style
449 // ----------------------------------------------------------------------------
450
451 // Add or remove a single window style
452 void wxListCtrl::SetSingleStyle(long style, bool add)
453 {
454 long flag = GetWindowStyleFlag();
455
456 // Get rid of conflicting styles
457 if ( add )
458 {
459 if ( style & wxLC_MASK_TYPE)
460 flag = flag & ~wxLC_MASK_TYPE;
461 if ( style & wxLC_MASK_ALIGN )
462 flag = flag & ~wxLC_MASK_ALIGN;
463 if ( style & wxLC_MASK_SORT )
464 flag = flag & ~wxLC_MASK_SORT;
465 }
466
467 if ( add )
468 flag |= style;
469 else
470 flag &= ~style;
471
472 SetWindowStyleFlag(flag);
473 }
474
475 // Set the whole window style
476 void wxListCtrl::SetWindowStyleFlag(long flag)
477 {
478 if ( flag != m_windowStyle )
479 {
480 wxListCtrlBase::SetWindowStyleFlag(flag);
481
482 UpdateStyle();
483
484 Refresh();
485 }
486 }
487
488 // ----------------------------------------------------------------------------
489 // accessors
490 // ----------------------------------------------------------------------------
491
492 /* static */ wxVisualAttributes
493 wxListCtrl::GetClassDefaultAttributes(wxWindowVariant variant)
494 {
495 wxVisualAttributes attrs = GetCompositeControlsDefaultAttributes(variant);
496
497 // common controls have their own default font
498 attrs.font = wxGetCCDefaultFont();
499
500 return attrs;
501 }
502
503 // Sets the foreground, i.e. text, colour
504 bool wxListCtrl::SetForegroundColour(const wxColour& col)
505 {
506 if ( !wxWindow::SetForegroundColour(col) )
507 return false;
508
509 ListView_SetTextColor(GetHwnd(), wxColourToRGB(col));
510
511 return true;
512 }
513
514 // Sets the background colour
515 bool wxListCtrl::SetBackgroundColour(const wxColour& col)
516 {
517 if ( !wxWindow::SetBackgroundColour(col) )
518 return false;
519
520 // we set the same colour for both the "empty" background and the items
521 // background
522 COLORREF color = wxColourToRGB(col);
523 ListView_SetBkColor(GetHwnd(), color);
524 ListView_SetTextBkColor(GetHwnd(), color);
525
526 return true;
527 }
528
529 // Gets information about this column
530 bool wxListCtrl::GetColumn(int col, wxListItem& item) const
531 {
532 LV_COLUMN lvCol;
533 wxZeroMemory(lvCol);
534
535 lvCol.mask = LVCF_WIDTH;
536
537 if ( item.m_mask & wxLIST_MASK_TEXT )
538 {
539 lvCol.mask |= LVCF_TEXT;
540 lvCol.pszText = new wxChar[513];
541 lvCol.cchTextMax = 512;
542 }
543
544 if ( item.m_mask & wxLIST_MASK_FORMAT )
545 {
546 lvCol.mask |= LVCF_FMT;
547 }
548
549 if ( item.m_mask & wxLIST_MASK_IMAGE )
550 {
551 lvCol.mask |= LVCF_IMAGE;
552 }
553
554 bool success = ListView_GetColumn(GetHwnd(), col, &lvCol) != 0;
555
556 // item.m_subItem = lvCol.iSubItem;
557 item.m_width = lvCol.cx;
558
559 if ( (item.m_mask & wxLIST_MASK_TEXT) && lvCol.pszText )
560 {
561 item.m_text = lvCol.pszText;
562 delete[] lvCol.pszText;
563 }
564
565 if ( item.m_mask & wxLIST_MASK_FORMAT )
566 {
567 switch (lvCol.fmt & LVCFMT_JUSTIFYMASK) {
568 case LVCFMT_LEFT:
569 item.m_format = wxLIST_FORMAT_LEFT;
570 break;
571 case LVCFMT_RIGHT:
572 item.m_format = wxLIST_FORMAT_RIGHT;
573 break;
574 case LVCFMT_CENTER:
575 item.m_format = wxLIST_FORMAT_CENTRE;
576 break;
577 default:
578 item.m_format = -1; // Unknown?
579 break;
580 }
581 }
582
583 // the column images were not supported in older versions but how to check
584 // for this? we can't use _WIN32_IE because we always define it to a very
585 // high value, so see if another symbol which is only defined starting from
586 // comctl32.dll 4.70 is available
587 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
588 if ( item.m_mask & wxLIST_MASK_IMAGE )
589 {
590 item.m_image = lvCol.iImage;
591 }
592 #endif // LVCOLUMN::iImage exists
593
594 return success;
595 }
596
597 // Sets information about this column
598 bool wxListCtrl::SetColumn(int col, const wxListItem& item)
599 {
600 LV_COLUMN lvCol;
601 wxConvertToMSWListCol(GetHwnd(), col, item, lvCol);
602
603 return ListView_SetColumn(GetHwnd(), col, &lvCol) != 0;
604 }
605
606 // Gets the column width
607 int wxListCtrl::GetColumnWidth(int col) const
608 {
609 return ListView_GetColumnWidth(GetHwnd(), col);
610 }
611
612 // Sets the column width
613 bool wxListCtrl::SetColumnWidth(int col, int width)
614 {
615 if ( m_windowStyle & wxLC_LIST )
616 col = 0;
617
618 if ( width == wxLIST_AUTOSIZE)
619 width = LVSCW_AUTOSIZE;
620 else if ( width == wxLIST_AUTOSIZE_USEHEADER)
621 width = LVSCW_AUTOSIZE_USEHEADER;
622
623 return ListView_SetColumnWidth(GetHwnd(), col, width) != 0;
624 }
625
626 // ----------------------------------------------------------------------------
627 // columns order
628 // ----------------------------------------------------------------------------
629
630 int wxListCtrl::GetColumnIndexFromOrder(int order) const
631 {
632 const int numCols = GetColumnCount();
633 wxCHECK_MSG( order >= 0 && order < numCols, -1,
634 wxT("Column position out of bounds") );
635
636 wxArrayInt indexArray(numCols);
637 if ( !ListView_GetColumnOrderArray(GetHwnd(), numCols, &indexArray[0]) )
638 return -1;
639
640 return indexArray[order];
641 }
642
643 int wxListCtrl::GetColumnOrder(int col) const
644 {
645 const int numCols = GetColumnCount();
646 wxASSERT_MSG( col >= 0 && col < numCols, wxT("Column index out of bounds") );
647
648 wxArrayInt indexArray(numCols);
649 if ( !ListView_GetColumnOrderArray(GetHwnd(), numCols, &indexArray[0]) )
650 return -1;
651
652 for ( int pos = 0; pos < numCols; pos++ )
653 {
654 if ( indexArray[pos] == col )
655 return pos;
656 }
657
658 wxFAIL_MSG( wxT("no column with with given order?") );
659
660 return -1;
661 }
662
663 // Gets the column order for all columns
664 wxArrayInt wxListCtrl::GetColumnsOrder() const
665 {
666 const int numCols = GetColumnCount();
667
668 wxArrayInt orders(numCols);
669 if ( !ListView_GetColumnOrderArray(GetHwnd(), numCols, &orders[0]) )
670 orders.clear();
671
672 return orders;
673 }
674
675 // Sets the column order for all columns
676 bool wxListCtrl::SetColumnsOrder(const wxArrayInt& orders)
677 {
678 const int numCols = GetColumnCount();
679
680 wxCHECK_MSG( orders.size() == (size_t)numCols, false,
681 wxT("wrong number of elements in column orders array") );
682
683 return ListView_SetColumnOrderArray(GetHwnd(), numCols, &orders[0]) != 0;
684 }
685
686
687 // Gets the number of items that can fit vertically in the
688 // visible area of the list control (list or report view)
689 // or the total number of items in the list control (icon
690 // or small icon view)
691 int wxListCtrl::GetCountPerPage() const
692 {
693 return ListView_GetCountPerPage(GetHwnd());
694 }
695
696 // Gets the edit control for editing labels.
697 wxTextCtrl* wxListCtrl::GetEditControl() const
698 {
699 // first check corresponds to the case when the label editing was started
700 // by user and hence m_textCtrl wasn't created by EditLabel() at all, while
701 // the second case corresponds to us being called from inside EditLabel()
702 // (e.g. from a user wxEVT_LIST_BEGIN_LABEL_EDIT handler): in this
703 // case EditLabel() did create the control but it didn't have an HWND to
704 // initialize it with yet
705 if ( !m_textCtrl || !m_textCtrl->GetHWND() )
706 {
707 HWND hwndEdit = ListView_GetEditControl(GetHwnd());
708 if ( hwndEdit )
709 {
710 wxListCtrl * const self = const_cast<wxListCtrl *>(this);
711
712 if ( !m_textCtrl )
713 self->m_textCtrl = new wxTextCtrl;
714 self->InitEditControl((WXHWND)hwndEdit);
715 }
716 }
717
718 return m_textCtrl;
719 }
720
721 // Gets information about the item
722 bool wxListCtrl::GetItem(wxListItem& info) const
723 {
724 LV_ITEM lvItem;
725 wxZeroMemory(lvItem);
726
727 lvItem.iItem = info.m_itemId;
728 lvItem.iSubItem = info.m_col;
729
730 if ( info.m_mask & wxLIST_MASK_TEXT )
731 {
732 lvItem.mask |= LVIF_TEXT;
733 lvItem.pszText = new wxChar[513];
734 lvItem.cchTextMax = 512;
735 }
736 else
737 {
738 lvItem.pszText = NULL;
739 }
740
741 if (info.m_mask & wxLIST_MASK_DATA)
742 lvItem.mask |= LVIF_PARAM;
743
744 if (info.m_mask & wxLIST_MASK_IMAGE)
745 lvItem.mask |= LVIF_IMAGE;
746
747 if ( info.m_mask & wxLIST_MASK_STATE )
748 {
749 lvItem.mask |= LVIF_STATE;
750 wxConvertToMSWFlags(0, info.m_stateMask, lvItem);
751 }
752
753 bool success = ListView_GetItem((HWND)GetHWND(), &lvItem) != 0;
754 if ( !success )
755 {
756 wxLogError(_("Couldn't retrieve information about list control item %d."),
757 lvItem.iItem);
758 }
759 else
760 {
761 // give NULL as hwnd as we already have everything we need
762 wxConvertFromMSWListItem(NULL, info, lvItem);
763 }
764
765 if (lvItem.pszText)
766 delete[] lvItem.pszText;
767
768 return success;
769 }
770
771 // Sets information about the item
772 bool wxListCtrl::SetItem(wxListItem& info)
773 {
774 const long id = info.GetId();
775 wxCHECK_MSG( id >= 0 && id < GetItemCount(), false,
776 wxT("invalid item index in SetItem") );
777
778 LV_ITEM item;
779 wxConvertToMSWListItem(this, info, item);
780
781 // we never update the lParam if it contains our pointer
782 // to the wxMSWListItemData structure
783 item.mask &= ~LVIF_PARAM;
784
785 // check if setting attributes or lParam
786 if ( info.HasAttributes() || (info.m_mask & wxLIST_MASK_DATA) )
787 {
788 // get internal item data
789 wxMSWListItemData *data = MSWGetItemData(id);
790
791 if ( !data )
792 {
793 // need to allocate the internal data object
794 data = new wxMSWListItemData;
795 m_internalData.push_back(data);
796 item.lParam = (LPARAM) data;
797 item.mask |= LVIF_PARAM;
798 }
799
800
801 // user data
802 if ( info.m_mask & wxLIST_MASK_DATA )
803 data->lParam = info.m_data;
804
805 // attributes
806 if ( info.HasAttributes() )
807 {
808 const wxListItemAttr& attrNew = *info.GetAttributes();
809
810 // don't overwrite the already set attributes if we have them
811 if ( data->attr )
812 data->attr->AssignFrom(attrNew);
813 else
814 data->attr = new wxListItemAttr(attrNew);
815 }
816 }
817
818
819 // we could be changing only the attribute in which case we don't need to
820 // call ListView_SetItem() at all
821 if ( item.mask )
822 {
823 if ( !ListView_SetItem(GetHwnd(), &item) )
824 {
825 wxLogDebug(wxT("ListView_SetItem() failed"));
826
827 return false;
828 }
829 }
830
831 // we need to update the item immediately to show the new image
832 bool updateNow = (info.m_mask & wxLIST_MASK_IMAGE) != 0;
833
834 // check whether it has any custom attributes
835 if ( info.HasAttributes() )
836 {
837 m_hasAnyAttr = true;
838
839 // if the colour has changed, we must redraw the item
840 updateNow = true;
841 }
842
843 if ( updateNow )
844 {
845 // we need this to make the change visible right now
846 RefreshItem(item.iItem);
847 }
848
849 return true;
850 }
851
852 long wxListCtrl::SetItem(long index, int col, const wxString& label, int imageId)
853 {
854 wxListItem info;
855 info.m_text = label;
856 info.m_mask = wxLIST_MASK_TEXT;
857 info.m_itemId = index;
858 info.m_col = col;
859 if ( imageId > -1 )
860 {
861 info.m_image = imageId;
862 info.m_mask |= wxLIST_MASK_IMAGE;
863 }
864 return SetItem(info);
865 }
866
867
868 // Gets the item state
869 int wxListCtrl::GetItemState(long item, long stateMask) const
870 {
871 wxListItem info;
872
873 info.m_mask = wxLIST_MASK_STATE;
874 info.m_stateMask = stateMask;
875 info.m_itemId = item;
876
877 if (!GetItem(info))
878 return 0;
879
880 return info.m_state;
881 }
882
883 // Sets the item state
884 bool wxListCtrl::SetItemState(long item, long state, long stateMask)
885 {
886 // NB: don't use SetItem() here as it doesn't work with the virtual list
887 // controls
888 LV_ITEM lvItem;
889 wxZeroMemory(lvItem);
890
891 wxConvertToMSWFlags(state, stateMask, lvItem);
892
893 const bool changingFocus = (stateMask & wxLIST_STATE_FOCUSED) &&
894 (state & wxLIST_STATE_FOCUSED);
895
896 // for the virtual list controls we need to refresh the previously focused
897 // item manually when changing focus without changing selection
898 // programmatically because otherwise it keeps its focus rectangle until
899 // next repaint (yet another comctl32 bug)
900 long focusOld;
901 if ( IsVirtual() && changingFocus )
902 {
903 focusOld = GetNextItem(-1, wxLIST_NEXT_ALL, wxLIST_STATE_FOCUSED);
904 }
905 else
906 {
907 focusOld = -1;
908 }
909
910 if ( !::SendMessage(GetHwnd(), LVM_SETITEMSTATE,
911 (WPARAM)item, (LPARAM)&lvItem) )
912 {
913 wxLogLastError(wxT("ListView_SetItemState"));
914
915 return false;
916 }
917
918 if ( focusOld != -1 )
919 {
920 // no need to refresh the item if it was previously selected, it would
921 // only result in annoying flicker
922 if ( !(GetItemState(focusOld,
923 wxLIST_STATE_SELECTED) & wxLIST_STATE_SELECTED) )
924 {
925 RefreshItem(focusOld);
926 }
927 }
928
929 // we expect the selection anchor, i.e. the item from which multiple
930 // selection (such as performed with e.g. Shift-arrows) starts, to be the
931 // same as the currently focused item but the native control doesn't update
932 // it when we change focus and leaves at the last item it set itself focus
933 // to, so do it explicitly
934 if ( changingFocus && !HasFlag(wxLC_SINGLE_SEL) )
935 {
936 ListView_SetSelectionMark(GetHwnd(), item);
937 }
938
939 return true;
940 }
941
942 // Sets the item image
943 bool wxListCtrl::SetItemImage(long item, int image, int WXUNUSED(selImage))
944 {
945 return SetItemColumnImage(item, 0, image);
946 }
947
948 // Sets the item image
949 bool wxListCtrl::SetItemColumnImage(long item, long column, int image)
950 {
951 wxListItem info;
952
953 info.m_mask = wxLIST_MASK_IMAGE;
954 info.m_image = image == -1 ? I_IMAGENONE : image;
955 info.m_itemId = item;
956 info.m_col = column;
957
958 return SetItem(info);
959 }
960
961 // Gets the item text
962 wxString wxListCtrl::GetItemText(long item, int col) const
963 {
964 wxListItem info;
965
966 info.m_mask = wxLIST_MASK_TEXT;
967 info.m_itemId = item;
968 info.m_col = col;
969
970 if (!GetItem(info))
971 return wxEmptyString;
972 return info.m_text;
973 }
974
975 // Sets the item text
976 void wxListCtrl::SetItemText(long item, const wxString& str)
977 {
978 wxListItem info;
979
980 info.m_mask = wxLIST_MASK_TEXT;
981 info.m_itemId = item;
982 info.m_text = str;
983
984 SetItem(info);
985 }
986
987 // Gets the internal item data
988 wxMSWListItemData *wxListCtrl::MSWGetItemData(long itemId) const
989 {
990 LV_ITEM it;
991 it.mask = LVIF_PARAM;
992 it.iItem = itemId;
993
994 if ( !ListView_GetItem(GetHwnd(), &it) )
995 return NULL;
996
997 return (wxMSWListItemData *) it.lParam;
998 }
999
1000 // Gets the item data
1001 wxUIntPtr wxListCtrl::GetItemData(long item) const
1002 {
1003 wxListItem info;
1004
1005 info.m_mask = wxLIST_MASK_DATA;
1006 info.m_itemId = item;
1007
1008 if (!GetItem(info))
1009 return 0;
1010 return info.m_data;
1011 }
1012
1013 // Sets the item data
1014 bool wxListCtrl::SetItemPtrData(long item, wxUIntPtr data)
1015 {
1016 wxListItem info;
1017
1018 info.m_mask = wxLIST_MASK_DATA;
1019 info.m_itemId = item;
1020 info.m_data = data;
1021
1022 return SetItem(info);
1023 }
1024
1025 wxRect wxListCtrl::GetViewRect() const
1026 {
1027 wxRect rect;
1028
1029 // ListView_GetViewRect() can only be used in icon and small icon views
1030 // (this is documented in MSDN and, indeed, it returns bogus results in
1031 // report view, at least with comctl32.dll v6 under Windows 2003)
1032 if ( HasFlag(wxLC_ICON | wxLC_SMALL_ICON) )
1033 {
1034 RECT rc;
1035 if ( !ListView_GetViewRect(GetHwnd(), &rc) )
1036 {
1037 wxLogDebug(wxT("ListView_GetViewRect() failed."));
1038
1039 wxZeroMemory(rc);
1040 }
1041
1042 wxCopyRECTToRect(rc, rect);
1043 }
1044 else if ( HasFlag(wxLC_REPORT) )
1045 {
1046 const long count = GetItemCount();
1047 if ( count )
1048 {
1049 GetItemRect(wxMin(GetTopItem() + GetCountPerPage(), count - 1), rect);
1050
1051 // extend the rectangle to start at the top (we include the column
1052 // headers, if any, for compatibility with the generic version)
1053 rect.height += rect.y;
1054 rect.y = 0;
1055 }
1056 }
1057 else
1058 {
1059 wxFAIL_MSG( wxT("not implemented in this mode") );
1060 }
1061
1062 return rect;
1063 }
1064
1065 // Gets the item rectangle
1066 bool wxListCtrl::GetItemRect(long item, wxRect& rect, int code) const
1067 {
1068 return GetSubItemRect( item, wxLIST_GETSUBITEMRECT_WHOLEITEM, rect, code) ;
1069 }
1070
1071 bool wxListCtrl::GetSubItemRect(long item, long subItem, wxRect& rect, int code) const
1072 {
1073 // ListView_GetSubItemRect() doesn't do subItem error checking and returns
1074 // true even for the out of range values of it (even if the results are
1075 // completely bogus in this case), so we check item validity ourselves
1076 wxCHECK_MSG( subItem == wxLIST_GETSUBITEMRECT_WHOLEITEM ||
1077 (subItem >= 0 && subItem < GetColumnCount()),
1078 false, wxT("invalid sub item index") );
1079
1080 // use wxCHECK_MSG against "item" too, for coherency with the generic implementation:
1081 wxCHECK_MSG( item >= 0 && item < GetItemCount(), false,
1082 wxT("invalid item in GetSubItemRect") );
1083
1084 int codeWin;
1085 if ( code == wxLIST_RECT_BOUNDS )
1086 codeWin = LVIR_BOUNDS;
1087 else if ( code == wxLIST_RECT_ICON )
1088 codeWin = LVIR_ICON;
1089 else if ( code == wxLIST_RECT_LABEL )
1090 codeWin = LVIR_LABEL;
1091 else
1092 {
1093 wxFAIL_MSG( wxT("incorrect code in GetItemRect() / GetSubItemRect()") );
1094 codeWin = LVIR_BOUNDS;
1095 }
1096
1097 RECT rectWin;
1098 if ( !wxGetListCtrlSubItemRect
1099 (
1100 GetHwnd(),
1101 item,
1102 subItem == wxLIST_GETSUBITEMRECT_WHOLEITEM ? 0 : subItem,
1103 codeWin,
1104 rectWin
1105 ) )
1106 {
1107 return false;
1108 }
1109
1110 wxCopyRECTToRect(rectWin, rect);
1111
1112 // there is no way to retrieve the first sub item bounding rectangle using
1113 // wxGetListCtrlSubItemRect() as 0 means the whole item, so we need to
1114 // truncate it at first column ourselves
1115 if ( subItem == 0 && code == wxLIST_RECT_BOUNDS )
1116 rect.width = GetColumnWidth(0);
1117
1118 return true;
1119 }
1120
1121
1122
1123
1124 // Gets the item position
1125 bool wxListCtrl::GetItemPosition(long item, wxPoint& pos) const
1126 {
1127 POINT pt;
1128
1129 bool success = (ListView_GetItemPosition(GetHwnd(), (int) item, &pt) != 0);
1130
1131 pos.x = pt.x; pos.y = pt.y;
1132 return success;
1133 }
1134
1135 // Sets the item position.
1136 bool wxListCtrl::SetItemPosition(long item, const wxPoint& pos)
1137 {
1138 return (ListView_SetItemPosition(GetHwnd(), (int) item, pos.x, pos.y) != 0);
1139 }
1140
1141 // Gets the number of items in the list control
1142 int wxListCtrl::GetItemCount() const
1143 {
1144 return m_count;
1145 }
1146
1147 wxSize wxListCtrl::GetItemSpacing() const
1148 {
1149 const int spacing = ListView_GetItemSpacing(GetHwnd(), (BOOL)HasFlag(wxLC_SMALL_ICON));
1150
1151 return wxSize(LOWORD(spacing), HIWORD(spacing));
1152 }
1153
1154 #if WXWIN_COMPATIBILITY_2_6
1155
1156 int wxListCtrl::GetItemSpacing(bool isSmall) const
1157 {
1158 return ListView_GetItemSpacing(GetHwnd(), (BOOL) isSmall);
1159 }
1160
1161 #endif // WXWIN_COMPATIBILITY_2_6
1162
1163 void wxListCtrl::SetItemTextColour( long item, const wxColour &col )
1164 {
1165 wxListItem info;
1166 info.m_itemId = item;
1167 info.SetTextColour( col );
1168 SetItem( info );
1169 }
1170
1171 wxColour wxListCtrl::GetItemTextColour( long item ) const
1172 {
1173 wxColour col;
1174 wxMSWListItemData *data = MSWGetItemData(item);
1175 if ( data && data->attr )
1176 col = data->attr->GetTextColour();
1177
1178 return col;
1179 }
1180
1181 void wxListCtrl::SetItemBackgroundColour( long item, const wxColour &col )
1182 {
1183 wxListItem info;
1184 info.m_itemId = item;
1185 info.SetBackgroundColour( col );
1186 SetItem( info );
1187 }
1188
1189 wxColour wxListCtrl::GetItemBackgroundColour( long item ) const
1190 {
1191 wxColour col;
1192 wxMSWListItemData *data = MSWGetItemData(item);
1193 if ( data && data->attr )
1194 col = data->attr->GetBackgroundColour();
1195
1196 return col;
1197 }
1198
1199 void wxListCtrl::SetItemFont( long item, const wxFont &f )
1200 {
1201 wxListItem info;
1202 info.m_itemId = item;
1203 info.SetFont( f );
1204 SetItem( info );
1205 }
1206
1207 wxFont wxListCtrl::GetItemFont( long item ) const
1208 {
1209 wxFont f;
1210 wxMSWListItemData *data = MSWGetItemData(item);
1211 if ( data && data->attr )
1212 f = data->attr->GetFont();
1213
1214 return f;
1215 }
1216
1217 // Gets the number of selected items in the list control
1218 int wxListCtrl::GetSelectedItemCount() const
1219 {
1220 return ListView_GetSelectedCount(GetHwnd());
1221 }
1222
1223 // Gets the text colour of the listview
1224 wxColour wxListCtrl::GetTextColour() const
1225 {
1226 COLORREF ref = ListView_GetTextColor(GetHwnd());
1227 wxColour col(GetRValue(ref), GetGValue(ref), GetBValue(ref));
1228 return col;
1229 }
1230
1231 // Sets the text colour of the listview
1232 void wxListCtrl::SetTextColour(const wxColour& col)
1233 {
1234 ListView_SetTextColor(GetHwnd(), PALETTERGB(col.Red(), col.Green(), col.Blue()));
1235 }
1236
1237 // Gets the index of the topmost visible item when in
1238 // list or report view
1239 long wxListCtrl::GetTopItem() const
1240 {
1241 return (long) ListView_GetTopIndex(GetHwnd());
1242 }
1243
1244 // Searches for an item, starting from 'item'.
1245 // 'geometry' is one of
1246 // wxLIST_NEXT_ABOVE/ALL/BELOW/LEFT/RIGHT.
1247 // 'state' is a state bit flag, one or more of
1248 // wxLIST_STATE_DROPHILITED/FOCUSED/SELECTED/CUT.
1249 // item can be -1 to find the first item that matches the
1250 // specified flags.
1251 // Returns the item or -1 if unsuccessful.
1252 long wxListCtrl::GetNextItem(long item, int geom, int state) const
1253 {
1254 long flags = 0;
1255
1256 if ( geom == wxLIST_NEXT_ABOVE )
1257 flags |= LVNI_ABOVE;
1258 if ( geom == wxLIST_NEXT_ALL )
1259 flags |= LVNI_ALL;
1260 if ( geom == wxLIST_NEXT_BELOW )
1261 flags |= LVNI_BELOW;
1262 if ( geom == wxLIST_NEXT_LEFT )
1263 flags |= LVNI_TOLEFT;
1264 if ( geom == wxLIST_NEXT_RIGHT )
1265 flags |= LVNI_TORIGHT;
1266
1267 if ( state & wxLIST_STATE_CUT )
1268 flags |= LVNI_CUT;
1269 if ( state & wxLIST_STATE_DROPHILITED )
1270 flags |= LVNI_DROPHILITED;
1271 if ( state & wxLIST_STATE_FOCUSED )
1272 flags |= LVNI_FOCUSED;
1273 if ( state & wxLIST_STATE_SELECTED )
1274 flags |= LVNI_SELECTED;
1275
1276 return (long) ListView_GetNextItem(GetHwnd(), item, flags);
1277 }
1278
1279
1280 wxImageList *wxListCtrl::GetImageList(int which) const
1281 {
1282 if ( which == wxIMAGE_LIST_NORMAL )
1283 {
1284 return m_imageListNormal;
1285 }
1286 else if ( which == wxIMAGE_LIST_SMALL )
1287 {
1288 return m_imageListSmall;
1289 }
1290 else if ( which == wxIMAGE_LIST_STATE )
1291 {
1292 return m_imageListState;
1293 }
1294 return NULL;
1295 }
1296
1297 void wxListCtrl::SetImageList(wxImageList *imageList, int which)
1298 {
1299 int flags = 0;
1300 if ( which == wxIMAGE_LIST_NORMAL )
1301 {
1302 flags = LVSIL_NORMAL;
1303 if (m_ownsImageListNormal) delete m_imageListNormal;
1304 m_imageListNormal = imageList;
1305 m_ownsImageListNormal = false;
1306 }
1307 else if ( which == wxIMAGE_LIST_SMALL )
1308 {
1309 flags = LVSIL_SMALL;
1310 if (m_ownsImageListSmall) delete m_imageListSmall;
1311 m_imageListSmall = imageList;
1312 m_ownsImageListSmall = false;
1313 }
1314 else if ( which == wxIMAGE_LIST_STATE )
1315 {
1316 flags = LVSIL_STATE;
1317 if (m_ownsImageListState) delete m_imageListState;
1318 m_imageListState = imageList;
1319 m_ownsImageListState = false;
1320 }
1321 (void) ListView_SetImageList(GetHwnd(), (HIMAGELIST) imageList ? imageList->GetHIMAGELIST() : 0, flags);
1322 }
1323
1324 void wxListCtrl::AssignImageList(wxImageList *imageList, int which)
1325 {
1326 SetImageList(imageList, which);
1327 if ( which == wxIMAGE_LIST_NORMAL )
1328 m_ownsImageListNormal = true;
1329 else if ( which == wxIMAGE_LIST_SMALL )
1330 m_ownsImageListSmall = true;
1331 else if ( which == wxIMAGE_LIST_STATE )
1332 m_ownsImageListState = true;
1333 }
1334
1335 // ----------------------------------------------------------------------------
1336 // Geometry
1337 // ----------------------------------------------------------------------------
1338
1339 wxSize wxListCtrl::MSWGetBestViewRect(int x, int y) const
1340 {
1341 // The cast is necessary to suppress a MinGW warning due to a missing cast
1342 // to WPARAM in the definition of ListView_ApproximateViewRect() in its
1343 // own headers (this was the case up to at least MinGW 4.8).
1344 const DWORD rc = ListView_ApproximateViewRect(GetHwnd(), x, y, (WPARAM)-1);
1345
1346 wxSize size(LOWORD(rc), HIWORD(rc));
1347
1348 // We have to add space for the scrollbars ourselves, they're not taken
1349 // into account by ListView_ApproximateViewRect(), at least not with
1350 // commctrl32.dll v6.
1351 const DWORD mswStyle = ::GetWindowLong(GetHwnd(), GWL_STYLE);
1352
1353 if ( mswStyle & WS_HSCROLL )
1354 size.y += wxSystemSettings::GetMetric(wxSYS_HSCROLL_Y);
1355 if ( mswStyle & WS_VSCROLL )
1356 size.x += wxSystemSettings::GetMetric(wxSYS_VSCROLL_X);
1357
1358 return size;
1359 }
1360
1361 // ----------------------------------------------------------------------------
1362 // Operations
1363 // ----------------------------------------------------------------------------
1364
1365 // Arranges the items
1366 bool wxListCtrl::Arrange(int flag)
1367 {
1368 UINT code = 0;
1369 if ( flag == wxLIST_ALIGN_LEFT )
1370 code = LVA_ALIGNLEFT;
1371 else if ( flag == wxLIST_ALIGN_TOP )
1372 code = LVA_ALIGNTOP;
1373 else if ( flag == wxLIST_ALIGN_DEFAULT )
1374 code = LVA_DEFAULT;
1375 else if ( flag == wxLIST_ALIGN_SNAP_TO_GRID )
1376 code = LVA_SNAPTOGRID;
1377
1378 return (ListView_Arrange(GetHwnd(), code) != 0);
1379 }
1380
1381 // Deletes an item
1382 bool wxListCtrl::DeleteItem(long item)
1383 {
1384 if ( !ListView_DeleteItem(GetHwnd(), (int) item) )
1385 {
1386 wxLogLastError(wxT("ListView_DeleteItem"));
1387 return false;
1388 }
1389
1390 m_count--;
1391 wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()),
1392 wxT("m_count should match ListView_GetItemCount"));
1393
1394 // the virtual list control doesn't refresh itself correctly, help it
1395 if ( IsVirtual() )
1396 {
1397 // we need to refresh all the lines below the one which was deleted
1398 wxRect rectItem;
1399 if ( item > 0 && GetItemCount() )
1400 {
1401 GetItemRect(item - 1, rectItem);
1402 }
1403 else
1404 {
1405 rectItem.y =
1406 rectItem.height = 0;
1407 }
1408
1409 wxRect rectWin = GetRect();
1410 rectWin.height = rectWin.GetBottom() - rectItem.GetBottom();
1411 rectWin.y = rectItem.GetBottom();
1412
1413 RefreshRect(rectWin);
1414 }
1415
1416 return true;
1417 }
1418
1419 // Deletes all items
1420 bool wxListCtrl::DeleteAllItems()
1421 {
1422 // Calling ListView_DeleteAllItems() will always generate an event but we
1423 // shouldn't do it if the control is empty
1424 return !GetItemCount() || ListView_DeleteAllItems(GetHwnd()) != 0;
1425 }
1426
1427 // Deletes all items
1428 bool wxListCtrl::DeleteAllColumns()
1429 {
1430 while ( m_colCount > 0 )
1431 {
1432 if ( ListView_DeleteColumn(GetHwnd(), 0) == 0 )
1433 {
1434 wxLogLastError(wxT("ListView_DeleteColumn"));
1435
1436 return false;
1437 }
1438
1439 m_colCount--;
1440 }
1441
1442 wxASSERT_MSG( m_colCount == 0, wxT("no columns should be left") );
1443
1444 return true;
1445 }
1446
1447 // Deletes a column
1448 bool wxListCtrl::DeleteColumn(int col)
1449 {
1450 bool success = (ListView_DeleteColumn(GetHwnd(), col) != 0);
1451
1452 if ( success && (m_colCount > 0) )
1453 m_colCount --;
1454 return success;
1455 }
1456
1457 // Clears items, and columns if there are any.
1458 void wxListCtrl::ClearAll()
1459 {
1460 DeleteAllItems();
1461 if ( m_colCount > 0 )
1462 DeleteAllColumns();
1463 }
1464
1465 void wxListCtrl::InitEditControl(WXHWND hWnd)
1466 {
1467 m_textCtrl->SetHWND(hWnd);
1468 m_textCtrl->SubclassWin(hWnd);
1469 m_textCtrl->SetParent(this);
1470
1471 // we must disallow TABbing away from the control while the edit control is
1472 // shown because this leaves it in some strange state (just try removing
1473 // this line and then pressing TAB while editing an item in listctrl
1474 // inside a panel)
1475 m_textCtrl->SetWindowStyle(m_textCtrl->GetWindowStyle() | wxTE_PROCESS_TAB);
1476 }
1477
1478 wxTextCtrl* wxListCtrl::EditLabel(long item, wxClassInfo* textControlClass)
1479 {
1480 wxCHECK_MSG( textControlClass->IsKindOf(wxCLASSINFO(wxTextCtrl)), NULL,
1481 "control used for label editing must be a wxTextCtrl" );
1482
1483 // ListView_EditLabel requires that the list has focus.
1484 SetFocus();
1485
1486 // create m_textCtrl here before calling ListView_EditLabel() because it
1487 // generates wxEVT_LIST_BEGIN_LABEL_EDIT event from inside it and
1488 // the user handler for it can call GetEditControl() resulting in an on
1489 // demand creation of a stock wxTextCtrl instead of the control of a
1490 // (possibly) custom wxClassInfo
1491 DeleteEditControl();
1492 m_textCtrl = (wxTextCtrl *)textControlClass->CreateObject();
1493
1494 WXHWND hWnd = (WXHWND) ListView_EditLabel(GetHwnd(), item);
1495 if ( !hWnd )
1496 {
1497 // failed to start editing
1498 wxDELETE(m_textCtrl);
1499
1500 return NULL;
1501 }
1502
1503 // if GetEditControl() hasn't been called, we need to initialize the edit
1504 // control ourselves
1505 if ( !m_textCtrl->GetHWND() )
1506 InitEditControl(hWnd);
1507
1508 return m_textCtrl;
1509 }
1510
1511 // End label editing, optionally cancelling the edit
1512 bool wxListCtrl::EndEditLabel(bool cancel)
1513 {
1514 // m_textCtrl is not always ready, ie. in EVT_LIST_BEGIN_LABEL_EDIT
1515 HWND hwnd = ListView_GetEditControl(GetHwnd());
1516 if ( !hwnd )
1517 return false;
1518
1519 // Newer versions of Windows have a special ListView_CancelEditLabel()
1520 // message for cancelling editing but it, rather counter-intuitively, keeps
1521 // the last text entered in the dialog while cancelling as we do it below
1522 // restores the original text which is the more expected behaviour.
1523
1524 // We shouldn't destroy the control ourselves according to MSDN, which
1525 // proposes WM_CANCELMODE to do this, but it doesn't seem to work so
1526 // emulate the corresponding user action instead.
1527 ::SendMessage(hwnd, WM_KEYDOWN, cancel ? VK_ESCAPE : VK_RETURN, 0);
1528
1529 return true;
1530 }
1531
1532 // Ensures this item is visible
1533 bool wxListCtrl::EnsureVisible(long item)
1534 {
1535 return ListView_EnsureVisible(GetHwnd(), (int) item, FALSE) != FALSE;
1536 }
1537
1538 // Find an item whose label matches this string, starting from the item after 'start'
1539 // or the beginning if 'start' is -1.
1540 long wxListCtrl::FindItem(long start, const wxString& str, bool partial)
1541 {
1542 LV_FINDINFO findInfo;
1543
1544 findInfo.flags = LVFI_STRING;
1545 if ( partial )
1546 findInfo.flags |= LVFI_PARTIAL;
1547 findInfo.psz = str.t_str();
1548
1549 // ListView_FindItem() excludes the first item from search and to look
1550 // through all the items you need to start from -1 which is unnatural and
1551 // inconsistent with the generic version - so we adjust the index
1552 if (start != -1)
1553 start --;
1554 return ListView_FindItem(GetHwnd(), start, &findInfo);
1555 }
1556
1557 // Find an item whose data matches this data, starting from the item after
1558 // 'start' or the beginning if 'start' is -1.
1559 long wxListCtrl::FindItem(long start, wxUIntPtr data)
1560 {
1561 // we can't use ListView_FindItem() directly as we don't store the data
1562 // pointer itself in the control but rather our own internal data, so first
1563 // we need to find the right value to search for (and there can be several
1564 // of them)
1565 int idx = wxNOT_FOUND;
1566 const unsigned count = m_internalData.size();
1567 for ( unsigned n = 0; n < count; n++ )
1568 {
1569 if ( m_internalData[n]->lParam == (LPARAM)data )
1570 {
1571 LV_FINDINFO findInfo;
1572 findInfo.flags = LVFI_PARAM;
1573 findInfo.lParam = (LPARAM)wxPtrToUInt(m_internalData[n]);
1574
1575 int rc = ListView_FindItem(GetHwnd(), start, &findInfo);
1576 if ( rc != -1 )
1577 {
1578 if ( idx == wxNOT_FOUND || rc < idx )
1579 {
1580 idx = rc;
1581 if ( idx == start + 1 )
1582 {
1583 // we can stop here, we don't risk finding a closer
1584 // match
1585 break;
1586 }
1587 }
1588 //else: this item is after the previously found one
1589 }
1590 }
1591 }
1592
1593 return idx;
1594 }
1595
1596 // Find an item nearest this position in the specified direction, starting from
1597 // the item after 'start' or the beginning if 'start' is -1.
1598 long wxListCtrl::FindItem(long start, const wxPoint& pt, int direction)
1599 {
1600 LV_FINDINFO findInfo;
1601
1602 findInfo.flags = LVFI_NEARESTXY;
1603 findInfo.pt.x = pt.x;
1604 findInfo.pt.y = pt.y;
1605 findInfo.vkDirection = VK_RIGHT;
1606
1607 if ( direction == wxLIST_FIND_UP )
1608 findInfo.vkDirection = VK_UP;
1609 else if ( direction == wxLIST_FIND_DOWN )
1610 findInfo.vkDirection = VK_DOWN;
1611 else if ( direction == wxLIST_FIND_LEFT )
1612 findInfo.vkDirection = VK_LEFT;
1613 else if ( direction == wxLIST_FIND_RIGHT )
1614 findInfo.vkDirection = VK_RIGHT;
1615
1616 return ListView_FindItem(GetHwnd(), start, &findInfo);
1617 }
1618
1619 // Determines which item (if any) is at the specified point,
1620 // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
1621 long
1622 wxListCtrl::HitTest(const wxPoint& point, int& flags, long *ptrSubItem) const
1623 {
1624 LV_HITTESTINFO hitTestInfo;
1625 hitTestInfo.pt.x = (int) point.x;
1626 hitTestInfo.pt.y = (int) point.y;
1627
1628 long item;
1629 #ifdef LVM_SUBITEMHITTEST
1630 if ( ptrSubItem && wxApp::GetComCtl32Version() >= 470 )
1631 {
1632 item = ListView_SubItemHitTest(GetHwnd(), &hitTestInfo);
1633 *ptrSubItem = hitTestInfo.iSubItem;
1634 }
1635 else
1636 #endif // LVM_SUBITEMHITTEST
1637 {
1638 item = ListView_HitTest(GetHwnd(), &hitTestInfo);
1639 }
1640
1641 flags = 0;
1642
1643 if ( hitTestInfo.flags & LVHT_ABOVE )
1644 flags |= wxLIST_HITTEST_ABOVE;
1645 if ( hitTestInfo.flags & LVHT_BELOW )
1646 flags |= wxLIST_HITTEST_BELOW;
1647 if ( hitTestInfo.flags & LVHT_TOLEFT )
1648 flags |= wxLIST_HITTEST_TOLEFT;
1649 if ( hitTestInfo.flags & LVHT_TORIGHT )
1650 flags |= wxLIST_HITTEST_TORIGHT;
1651
1652 if ( hitTestInfo.flags & LVHT_NOWHERE )
1653 flags |= wxLIST_HITTEST_NOWHERE;
1654
1655 // note a bug or at least a very strange feature of comtl32.dll (tested
1656 // with version 4.0 under Win95 and 6.0 under Win 2003): if you click to
1657 // the right of the item label, ListView_HitTest() returns a combination of
1658 // LVHT_ONITEMICON, LVHT_ONITEMLABEL and LVHT_ONITEMSTATEICON -- filter out
1659 // the bits which don't make sense
1660 if ( hitTestInfo.flags & LVHT_ONITEMLABEL )
1661 {
1662 flags |= wxLIST_HITTEST_ONITEMLABEL;
1663
1664 // do not translate LVHT_ONITEMICON here, as per above
1665 }
1666 else
1667 {
1668 if ( hitTestInfo.flags & LVHT_ONITEMICON )
1669 flags |= wxLIST_HITTEST_ONITEMICON;
1670 if ( hitTestInfo.flags & LVHT_ONITEMSTATEICON )
1671 flags |= wxLIST_HITTEST_ONITEMSTATEICON;
1672 }
1673
1674 return item;
1675 }
1676
1677
1678 // Inserts an item, returning the index of the new item if successful,
1679 // -1 otherwise.
1680 long wxListCtrl::InsertItem(const wxListItem& info)
1681 {
1682 wxASSERT_MSG( !IsVirtual(), wxT("can't be used with virtual controls") );
1683
1684 // In 2.8 it was possible to succeed inserting an item without initializing
1685 // its ID as it defaulted to 0. This was however never supported and in 2.9
1686 // the ID is -1 by default and inserting it simply fails, but it might be
1687 // not obvious why does it happen, so check it proactively.
1688 wxASSERT_MSG( info.m_itemId != -1, wxS("Item ID must be set.") );
1689
1690 LV_ITEM item;
1691 wxConvertToMSWListItem(this, info, item);
1692 item.mask &= ~LVIF_PARAM;
1693
1694 // check whether we need to allocate our internal data
1695 bool needInternalData = (info.m_mask & wxLIST_MASK_DATA) ||
1696 info.HasAttributes();
1697 if ( needInternalData )
1698 {
1699 item.mask |= LVIF_PARAM;
1700
1701 wxMSWListItemData * const data = new wxMSWListItemData;
1702 m_internalData.push_back(data);
1703 item.lParam = (LPARAM)data;
1704
1705 if ( info.m_mask & wxLIST_MASK_DATA )
1706 data->lParam = info.m_data;
1707
1708 // check whether it has any custom attributes
1709 if ( info.HasAttributes() )
1710 {
1711 // take copy of attributes
1712 data->attr = new wxListItemAttr(*info.GetAttributes());
1713
1714 // and remember that we have some now...
1715 m_hasAnyAttr = true;
1716 }
1717 }
1718
1719 const long rv = ListView_InsertItem(GetHwnd(), & item);
1720
1721 // failing to insert the item is really unexpected
1722 wxCHECK_MSG( rv != -1, rv, "failed to insert an item in wxListCtrl" );
1723
1724 m_count++;
1725 wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()),
1726 wxT("m_count should match ListView_GetItemCount"));
1727
1728 return rv;
1729 }
1730
1731 long wxListCtrl::InsertItem(long index, const wxString& label)
1732 {
1733 wxListItem info;
1734 info.m_text = label;
1735 info.m_mask = wxLIST_MASK_TEXT;
1736 info.m_itemId = index;
1737 return InsertItem(info);
1738 }
1739
1740 // Inserts an image item
1741 long wxListCtrl::InsertItem(long index, int imageIndex)
1742 {
1743 wxListItem info;
1744 info.m_image = imageIndex;
1745 info.m_mask = wxLIST_MASK_IMAGE;
1746 info.m_itemId = index;
1747 return InsertItem(info);
1748 }
1749
1750 // Inserts an image/string item
1751 long wxListCtrl::InsertItem(long index, const wxString& label, int imageIndex)
1752 {
1753 wxListItem info;
1754 info.m_image = imageIndex == -1 ? I_IMAGENONE : imageIndex;
1755 info.m_text = label;
1756 info.m_mask = wxLIST_MASK_TEXT | wxLIST_MASK_IMAGE;
1757 info.m_itemId = index;
1758 return InsertItem(info);
1759 }
1760
1761 // For list view mode (only), inserts a column.
1762 long wxListCtrl::DoInsertColumn(long col, const wxListItem& item)
1763 {
1764 LV_COLUMN lvCol;
1765 wxConvertToMSWListCol(GetHwnd(), col, item, lvCol);
1766
1767 // LVSCW_AUTOSIZE_USEHEADER is not supported when inserting new column,
1768 // we'll deal with it below instead. Plain LVSCW_AUTOSIZE is not supported
1769 // neither but it doesn't need any special handling as we use fixed value
1770 // for it here, both because we can't do anything else (there are no items
1771 // with values in this column to compute the size from yet) and for
1772 // compatibility as wxLIST_AUTOSIZE == -1 and -1 as InsertColumn() width
1773 // parameter used to mean "arbitrary fixed width".
1774 if ( !(lvCol.mask & LVCF_WIDTH) || lvCol.cx < 0 )
1775 {
1776 // always give some width to the new column: this one is compatible
1777 // with the generic version
1778 lvCol.mask |= LVCF_WIDTH;
1779 lvCol.cx = 80;
1780 }
1781
1782 long n = ListView_InsertColumn(GetHwnd(), col, &lvCol);
1783 if ( n == -1 )
1784 {
1785 wxLogDebug(wxT("Failed to insert the column '%s' into listview!"),
1786 lvCol.pszText);
1787 return -1;
1788 }
1789
1790 m_colCount++;
1791
1792 // Now adjust the new column size.
1793 if ( (item.GetMask() & wxLIST_MASK_WIDTH) &&
1794 (item.GetWidth() == wxLIST_AUTOSIZE_USEHEADER) )
1795 {
1796 SetColumnWidth(n, wxLIST_AUTOSIZE_USEHEADER);
1797 }
1798
1799 return n;
1800 }
1801
1802 // scroll the control by the given number of pixels (exception: in list view,
1803 // dx is interpreted as number of columns)
1804 bool wxListCtrl::ScrollList(int dx, int dy)
1805 {
1806 if ( !ListView_Scroll(GetHwnd(), dx, dy) )
1807 {
1808 wxLogDebug(wxT("ListView_Scroll(%d, %d) failed"), dx, dy);
1809
1810 return false;
1811 }
1812
1813 return true;
1814 }
1815
1816 // Sort items.
1817
1818 // fn is a function which takes 3 long arguments: item1, item2, data.
1819 // item1 is the long data associated with a first item (NOT the index).
1820 // item2 is the long data associated with a second item (NOT the index).
1821 // data is the same value as passed to SortItems.
1822 // The return value is a negative number if the first item should precede the second
1823 // item, a positive number of the second item should precede the first,
1824 // or zero if the two items are equivalent.
1825
1826 // data is arbitrary data to be passed to the sort function.
1827
1828 // Internal structures for proxying the user compare function
1829 // so that we can pass it the *real* user data
1830
1831 // translate lParam data and call user func
1832 struct wxInternalDataSort
1833 {
1834 wxListCtrlCompare user_fn;
1835 wxIntPtr data;
1836 };
1837
1838 int CALLBACK wxInternalDataCompareFunc(LPARAM lParam1, LPARAM lParam2, LPARAM lParamSort)
1839 {
1840 wxInternalDataSort * const internalData = (wxInternalDataSort *) lParamSort;
1841
1842 wxMSWListItemData *data1 = (wxMSWListItemData *) lParam1;
1843 wxMSWListItemData *data2 = (wxMSWListItemData *) lParam2;
1844
1845 wxIntPtr d1 = (data1 == NULL ? 0 : data1->lParam);
1846 wxIntPtr d2 = (data2 == NULL ? 0 : data2->lParam);
1847
1848 return internalData->user_fn(d1, d2, internalData->data);
1849
1850 }
1851
1852 bool wxListCtrl::SortItems(wxListCtrlCompare fn, wxIntPtr data)
1853 {
1854 wxInternalDataSort internalData;
1855 internalData.user_fn = fn;
1856 internalData.data = data;
1857
1858 // WPARAM cast is needed for mingw/cygwin
1859 if ( !ListView_SortItems(GetHwnd(),
1860 wxInternalDataCompareFunc,
1861 (WPARAM) &internalData) )
1862 {
1863 wxLogDebug(wxT("ListView_SortItems() failed"));
1864
1865 return false;
1866 }
1867
1868 return true;
1869 }
1870
1871
1872
1873 // ----------------------------------------------------------------------------
1874 // message processing
1875 // ----------------------------------------------------------------------------
1876
1877 bool wxListCtrl::MSWShouldPreProcessMessage(WXMSG* msg)
1878 {
1879 if ( msg->message == WM_KEYDOWN )
1880 {
1881 // Only eat VK_RETURN if not being used by the application in
1882 // conjunction with modifiers
1883 if ( msg->wParam == VK_RETURN && !wxIsAnyModifierDown() )
1884 {
1885 // we need VK_RETURN to generate wxEVT_LIST_ITEM_ACTIVATED
1886 return false;
1887 }
1888 }
1889 return wxListCtrlBase::MSWShouldPreProcessMessage(msg);
1890 }
1891
1892 bool wxListCtrl::MSWCommand(WXUINT cmd, WXWORD id_)
1893 {
1894 const int id = (signed short)id_;
1895 if (cmd == EN_UPDATE)
1896 {
1897 wxCommandEvent event(wxEVT_TEXT, id);
1898 event.SetEventObject( this );
1899 ProcessCommand(event);
1900 return true;
1901 }
1902 else if (cmd == EN_KILLFOCUS)
1903 {
1904 wxCommandEvent event(wxEVT_KILL_FOCUS, id);
1905 event.SetEventObject( this );
1906 ProcessCommand(event);
1907 return true;
1908 }
1909 else
1910 return false;
1911 }
1912
1913 // utility used by wxListCtrl::MSWOnNotify and by wxDataViewHeaderWindowMSW::MSWOnNotify
1914 int WXDLLIMPEXP_CORE wxMSWGetColumnClicked(NMHDR *nmhdr, POINT *ptClick)
1915 {
1916 // find the column clicked: we have to search for it ourselves as the
1917 // notification message doesn't provide this info
1918
1919 // where did the click occur?
1920 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
1921 if ( nmhdr->code == GN_CONTEXTMENU )
1922 {
1923 *ptClick = ((NMRGINFO*)nmhdr)->ptAction;
1924 }
1925 else
1926 #endif //__WXWINCE__
1927 {
1928 wxGetCursorPosMSW(ptClick);
1929 }
1930
1931 // we need to use listctrl coordinates for the event point so this is what
1932 // we return in ptClick, but for comparison with Header_GetItemRect()
1933 // result below we need to use header window coordinates
1934 POINT ptClickHeader = *ptClick;
1935 if ( !::ScreenToClient(nmhdr->hwndFrom, &ptClickHeader) )
1936 {
1937 wxLogLastError(wxT("ScreenToClient(listctrl header)"));
1938 }
1939
1940 if ( !::ScreenToClient(::GetParent(nmhdr->hwndFrom), ptClick) )
1941 {
1942 wxLogLastError(wxT("ScreenToClient(listctrl)"));
1943 }
1944
1945 const int colCount = Header_GetItemCount(nmhdr->hwndFrom);
1946 for ( int col = 0; col < colCount; col++ )
1947 {
1948 RECT rect;
1949 if ( Header_GetItemRect(nmhdr->hwndFrom, col, &rect) )
1950 {
1951 if ( ::PtInRect(&rect, ptClickHeader) )
1952 {
1953 return col;
1954 }
1955 }
1956 }
1957
1958 return wxNOT_FOUND;
1959 }
1960
1961 bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
1962 {
1963
1964 // prepare the event
1965 // -----------------
1966
1967 wxListEvent event(wxEVT_NULL, m_windowId);
1968 event.SetEventObject(this);
1969
1970 wxEventType eventType = wxEVT_NULL;
1971
1972 NMHDR *nmhdr = (NMHDR *)lParam;
1973
1974 // if your compiler is as broken as this, you should really change it: this
1975 // code is needed for normal operation! #ifdef below is only useful for
1976 // automatic rebuilds which are done with a very old compiler version
1977 #ifdef HDN_BEGINTRACKA
1978
1979 // check for messages from the header (in report view)
1980 HWND hwndHdr = ListView_GetHeader(GetHwnd());
1981
1982 // is it a message from the header?
1983 if ( nmhdr->hwndFrom == hwndHdr )
1984 {
1985 HD_NOTIFY *nmHDR = (HD_NOTIFY *)nmhdr;
1986
1987 event.m_itemIndex = -1;
1988
1989 bool ignore = false;
1990 switch ( nmhdr->code )
1991 {
1992 // yet another comctl32.dll bug: under NT/W2K it sends Unicode
1993 // TRACK messages even to ANSI programs: on my system I get
1994 // HDN_BEGINTRACKW and HDN_ENDTRACKA!
1995 //
1996 // work around is to simply catch both versions and hope that it
1997 // works (why should this message exist in ANSI and Unicode is
1998 // beyond me as it doesn't deal with strings at all...)
1999 //
2000 // another problem is that HDN_TRACK is not sent at all by header
2001 // with HDS_FULLDRAG style which is used by default by wxListCtrl
2002 // under recent Windows versions (starting from at least XP) so we
2003 // need to use HDN_ITEMCHANGING instead of it
2004 case HDN_BEGINTRACKA:
2005 case HDN_BEGINTRACKW:
2006 eventType = wxEVT_LIST_COL_BEGIN_DRAG;
2007 // fall through
2008
2009 case HDN_ITEMCHANGING:
2010 if ( eventType == wxEVT_NULL )
2011 {
2012 if ( !nmHDR->pitem || !(nmHDR->pitem->mask & HDI_WIDTH) )
2013 {
2014 // something other than the width is being changed,
2015 // ignore it
2016 ignore = true;
2017 break;
2018 }
2019
2020 // also ignore the events sent when the width didn't really
2021 // change: this is not just an optimization but also gets
2022 // rid of a useless and unexpected DRAGGING event which
2023 // would otherwise be sent after the END_DRAG one as we get
2024 // an HDN_ITEMCHANGING after HDN_ENDTRACK for some reason
2025 if ( nmHDR->pitem->cxy == GetColumnWidth(nmHDR->iItem) )
2026 {
2027 ignore = true;
2028 break;
2029 }
2030
2031 eventType = wxEVT_LIST_COL_DRAGGING;
2032 }
2033 // fall through
2034
2035 case HDN_ENDTRACKA:
2036 case HDN_ENDTRACKW:
2037 if ( eventType == wxEVT_NULL )
2038 eventType = wxEVT_LIST_COL_END_DRAG;
2039
2040 event.m_item.m_width = nmHDR->pitem->cxy;
2041 event.m_col = nmHDR->iItem;
2042 break;
2043
2044 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
2045 case GN_CONTEXTMENU:
2046 #endif //__WXWINCE__
2047 case NM_RCLICK:
2048 {
2049 POINT ptClick;
2050
2051 eventType = wxEVT_LIST_COL_RIGHT_CLICK;
2052 event.m_col = wxMSWGetColumnClicked(nmhdr, &ptClick);
2053 event.m_pointDrag.x = ptClick.x;
2054 event.m_pointDrag.y = ptClick.y;
2055 }
2056 break;
2057
2058 case HDN_GETDISPINFOW:
2059 // letting Windows XP handle this message results in mysterious
2060 // crashes in comctl32.dll seemingly because of bad message
2061 // parameters
2062 //
2063 // I have no idea what is the real cause of the bug (which is,
2064 // just to make things interesting, impossible to reproduce
2065 // reliably) but ignoring all these messages does fix it and
2066 // doesn't seem to have any negative consequences
2067 return true;
2068
2069 default:
2070 ignore = true;
2071 }
2072
2073 if ( ignore )
2074 return wxListCtrlBase::MSWOnNotify(idCtrl, lParam, result);
2075 }
2076 else
2077 #endif // defined(HDN_BEGINTRACKA)
2078 if ( nmhdr->hwndFrom == GetHwnd() )
2079 {
2080 // almost all messages use NM_LISTVIEW
2081 NM_LISTVIEW *nmLV = (NM_LISTVIEW *)nmhdr;
2082
2083 const int iItem = nmLV->iItem;
2084
2085
2086 // If we have a valid item then check if there is a data value
2087 // associated with it and put it in the event.
2088 if ( iItem >= 0 && iItem < GetItemCount() )
2089 {
2090 wxMSWListItemData *internaldata =
2091 MSWGetItemData(iItem);
2092
2093 if ( internaldata )
2094 event.m_item.m_data = internaldata->lParam;
2095 }
2096
2097 bool processed = true;
2098 switch ( nmhdr->code )
2099 {
2100 case LVN_BEGINRDRAG:
2101 eventType = wxEVT_LIST_BEGIN_RDRAG;
2102 // fall through
2103
2104 case LVN_BEGINDRAG:
2105 if ( eventType == wxEVT_NULL )
2106 {
2107 eventType = wxEVT_LIST_BEGIN_DRAG;
2108 }
2109
2110 event.m_itemIndex = iItem;
2111 event.m_pointDrag.x = nmLV->ptAction.x;
2112 event.m_pointDrag.y = nmLV->ptAction.y;
2113 break;
2114
2115 // NB: we have to handle both *A and *W versions here because some
2116 // versions of comctl32.dll send ANSI messages even to the
2117 // Unicode windows
2118 case LVN_BEGINLABELEDITA:
2119 case LVN_BEGINLABELEDITW:
2120 {
2121 wxLV_ITEM item;
2122 if ( nmhdr->code == LVN_BEGINLABELEDITA )
2123 {
2124 item.Init(((LV_DISPINFOA *)lParam)->item);
2125 }
2126 else // LVN_BEGINLABELEDITW
2127 {
2128 item.Init(((LV_DISPINFOW *)lParam)->item);
2129 }
2130
2131 eventType = wxEVT_LIST_BEGIN_LABEL_EDIT;
2132 wxConvertFromMSWListItem(GetHwnd(), event.m_item, item);
2133 event.m_itemIndex = event.m_item.m_itemId;
2134 }
2135 break;
2136
2137 case LVN_ENDLABELEDITA:
2138 case LVN_ENDLABELEDITW:
2139 {
2140 wxLV_ITEM item;
2141 if ( nmhdr->code == LVN_ENDLABELEDITA )
2142 {
2143 item.Init(((LV_DISPINFOA *)lParam)->item);
2144 }
2145 else // LVN_ENDLABELEDITW
2146 {
2147 item.Init(((LV_DISPINFOW *)lParam)->item);
2148 }
2149
2150 // was editing cancelled?
2151 const LV_ITEM& lvi = (LV_ITEM)item;
2152 if ( !lvi.pszText || lvi.iItem == -1 )
2153 {
2154 // EDIT control will be deleted by the list control
2155 // itself so prevent us from deleting it as well
2156 DeleteEditControl();
2157
2158 event.SetEditCanceled(true);
2159 }
2160
2161 eventType = wxEVT_LIST_END_LABEL_EDIT;
2162 wxConvertFromMSWListItem(NULL, event.m_item, item);
2163 event.m_itemIndex = event.m_item.m_itemId;
2164 }
2165 break;
2166
2167 case LVN_COLUMNCLICK:
2168 eventType = wxEVT_LIST_COL_CLICK;
2169 event.m_itemIndex = -1;
2170 event.m_col = nmLV->iSubItem;
2171 break;
2172
2173 case LVN_DELETEALLITEMS:
2174 eventType = wxEVT_LIST_DELETE_ALL_ITEMS;
2175 event.m_itemIndex = -1;
2176 break;
2177
2178 case LVN_DELETEITEM:
2179 if ( m_count == 0 )
2180 {
2181 // this should be prevented by the post-processing code
2182 // below, but "just in case"
2183 return false;
2184 }
2185
2186 eventType = wxEVT_LIST_DELETE_ITEM;
2187 event.m_itemIndex = iItem;
2188
2189 break;
2190
2191 case LVN_INSERTITEM:
2192 eventType = wxEVT_LIST_INSERT_ITEM;
2193 event.m_itemIndex = iItem;
2194 break;
2195
2196 case LVN_ITEMCHANGED:
2197 // we translate this catch all message into more interesting
2198 // (and more easy to process) wxWidgets events
2199
2200 // first of all, we deal with the state change events only and
2201 // only for valid items (item == -1 for the virtual list
2202 // control)
2203 if ( nmLV->uChanged & LVIF_STATE && iItem != -1 )
2204 {
2205 // temp vars for readability
2206 const UINT stOld = nmLV->uOldState;
2207 const UINT stNew = nmLV->uNewState;
2208
2209 event.m_item.SetId(iItem);
2210 event.m_item.SetMask(wxLIST_MASK_TEXT |
2211 wxLIST_MASK_IMAGE |
2212 wxLIST_MASK_DATA);
2213 GetItem(event.m_item);
2214
2215 // has the focus changed?
2216 if ( !(stOld & LVIS_FOCUSED) && (stNew & LVIS_FOCUSED) )
2217 {
2218 eventType = wxEVT_LIST_ITEM_FOCUSED;
2219 event.m_itemIndex = iItem;
2220 }
2221
2222 if ( (stNew & LVIS_SELECTED) != (stOld & LVIS_SELECTED) )
2223 {
2224 if ( eventType != wxEVT_NULL )
2225 {
2226 // focus and selection have both changed: send the
2227 // focus event from here and the selection one
2228 // below
2229 event.SetEventType(eventType);
2230 (void)HandleWindowEvent(event);
2231 }
2232 else // no focus event to send
2233 {
2234 // then need to set m_itemIndex as it wasn't done
2235 // above
2236 event.m_itemIndex = iItem;
2237 }
2238
2239 eventType = stNew & LVIS_SELECTED
2240 ? wxEVT_LIST_ITEM_SELECTED
2241 : wxEVT_LIST_ITEM_DESELECTED;
2242 }
2243 }
2244
2245 if ( eventType == wxEVT_NULL )
2246 {
2247 // not an interesting event for us
2248 return false;
2249 }
2250
2251 break;
2252
2253 case LVN_KEYDOWN:
2254 {
2255 LV_KEYDOWN *info = (LV_KEYDOWN *)lParam;
2256 WORD wVKey = info->wVKey;
2257
2258 // get the current selection
2259 long lItem = GetNextItem(-1,
2260 wxLIST_NEXT_ALL,
2261 wxLIST_STATE_SELECTED);
2262
2263 // <Enter> or <Space> activate the selected item if any (but
2264 // not with any modifiers as they have a predefined meaning
2265 // then)
2266 if ( lItem != -1 &&
2267 (wVKey == VK_RETURN || wVKey == VK_SPACE) &&
2268 !wxIsAnyModifierDown() )
2269 {
2270 eventType = wxEVT_LIST_ITEM_ACTIVATED;
2271 }
2272 else
2273 {
2274 eventType = wxEVT_LIST_KEY_DOWN;
2275
2276 event.m_code = wxMSWKeyboard::VKToWX(wVKey);
2277
2278 if ( event.m_code == WXK_NONE )
2279 {
2280 // We can't translate this to a standard key code,
2281 // until support for Unicode key codes is added to
2282 // wxListEvent we just ignore them.
2283 return false;
2284 }
2285 }
2286
2287 event.m_itemIndex =
2288 event.m_item.m_itemId = lItem;
2289
2290 if ( lItem != -1 )
2291 {
2292 // fill the other fields too
2293 event.m_item.m_text = GetItemText(lItem);
2294 event.m_item.m_data = GetItemData(lItem);
2295 }
2296 }
2297 break;
2298
2299 case NM_DBLCLK:
2300 // if the user processes it in wxEVT_COMMAND_LEFT_CLICK(), don't do
2301 // anything else
2302 if ( wxListCtrlBase::MSWOnNotify(idCtrl, lParam, result) )
2303 {
2304 return true;
2305 }
2306
2307 // else translate it into wxEVT_LIST_ITEM_ACTIVATED event
2308 // if it happened on an item (and not on empty place)
2309 if ( iItem == -1 )
2310 {
2311 // not on item
2312 return false;
2313 }
2314
2315 eventType = wxEVT_LIST_ITEM_ACTIVATED;
2316 event.m_itemIndex = iItem;
2317 event.m_item.m_text = GetItemText(iItem);
2318 event.m_item.m_data = GetItemData(iItem);
2319 break;
2320
2321 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
2322 case GN_CONTEXTMENU:
2323 #endif //__WXWINCE__
2324 case NM_RCLICK:
2325 // if the user processes it in wxEVT_COMMAND_RIGHT_CLICK(),
2326 // don't do anything else
2327 if ( wxListCtrlBase::MSWOnNotify(idCtrl, lParam, result) )
2328 {
2329 return true;
2330 }
2331
2332 // else translate it into wxEVT_LIST_ITEM_RIGHT_CLICK event
2333 LV_HITTESTINFO lvhti;
2334 wxZeroMemory(lvhti);
2335
2336 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
2337 if ( nmhdr->code == GN_CONTEXTMENU )
2338 {
2339 lvhti.pt = ((NMRGINFO*)nmhdr)->ptAction;
2340 }
2341 else
2342 #endif //__WXWINCE__
2343 {
2344 wxGetCursorPosMSW(&(lvhti.pt));
2345 }
2346
2347 ::ScreenToClient(GetHwnd(), &lvhti.pt);
2348 if ( ListView_HitTest(GetHwnd(), &lvhti) != -1 )
2349 {
2350 if ( lvhti.flags & LVHT_ONITEM )
2351 {
2352 eventType = wxEVT_LIST_ITEM_RIGHT_CLICK;
2353 event.m_itemIndex = lvhti.iItem;
2354 event.m_pointDrag.x = lvhti.pt.x;
2355 event.m_pointDrag.y = lvhti.pt.y;
2356 }
2357 }
2358 break;
2359
2360 #ifdef NM_CUSTOMDRAW
2361 case NM_CUSTOMDRAW:
2362 *result = OnCustomDraw(lParam);
2363
2364 return *result != CDRF_DODEFAULT;
2365 #endif // _WIN32_IE >= 0x300
2366
2367 case LVN_ODCACHEHINT:
2368 {
2369 const NM_CACHEHINT *cacheHint = (NM_CACHEHINT *)lParam;
2370
2371 eventType = wxEVT_LIST_CACHE_HINT;
2372
2373 // we get some really stupid cache hints like ones for
2374 // items in range 0..0 for an empty control or, after
2375 // deleting an item, for items in invalid range -- filter
2376 // this garbage out
2377 if ( cacheHint->iFrom > cacheHint->iTo )
2378 return false;
2379
2380 event.m_oldItemIndex = cacheHint->iFrom;
2381
2382 const long iMax = GetItemCount();
2383 event.m_itemIndex = cacheHint->iTo < iMax ? cacheHint->iTo
2384 : iMax - 1;
2385 }
2386 break;
2387
2388 #ifdef HAVE_NMLVFINDITEM
2389 case LVN_ODFINDITEM:
2390 // Find an item in a (necessarily virtual) list control.
2391 if ( IsVirtual() )
2392 {
2393 NMLVFINDITEM* pFindInfo = (NMLVFINDITEM*)lParam;
2394
2395 // no match by default
2396 *result = -1;
2397
2398 // we only handle string-based searches here
2399 //
2400 // TODO: what about LVFI_PARTIAL, should we handle this?
2401 if ( !(pFindInfo->lvfi.flags & LVFI_STRING) )
2402 {
2403 return false;
2404 }
2405
2406 const wxChar * const searchstr = pFindInfo->lvfi.psz;
2407 const size_t len = wxStrlen(searchstr);
2408
2409 // this is the first item we should examine, search from it
2410 // wrapping if necessary
2411 int startPos = pFindInfo->iStart;
2412 const int maxPos = GetItemCount();
2413
2414 // Check that the index is valid to ensure that our loop
2415 // below always terminates.
2416 if ( startPos < 0 || startPos >= maxPos )
2417 {
2418 // When the last item in the control is selected,
2419 // iStart is really set to (invalid) maxPos index so
2420 // accept this silently.
2421 if ( startPos != maxPos )
2422 {
2423 wxLogDebug(wxT("Ignoring invalid search start ")
2424 wxT("position %d in list control with ")
2425 wxT("%d items."), startPos, maxPos);
2426 }
2427
2428 startPos = 0;
2429 }
2430
2431 // Linear search in a control with a lot of items can take
2432 // a long time so we limit the total time of the search to
2433 // ensure that the program doesn't appear to hang.
2434 #if wxUSE_STOPWATCH
2435 wxStopWatch sw;
2436 #endif // wxUSE_STOPWATCH
2437 for ( int currentPos = startPos; ; )
2438 {
2439 // does this item begin with searchstr?
2440 if ( wxStrnicmp(searchstr,
2441 GetItemText(currentPos), len) == 0 )
2442 {
2443 *result = currentPos;
2444 break;
2445 }
2446
2447 // Go to next item with wrapping if necessary.
2448 if ( ++currentPos == maxPos )
2449 {
2450 // Surprisingly, LVFI_WRAP seems to be never set in
2451 // the flags so wrap regardless of it.
2452 currentPos = 0;
2453 }
2454
2455 if ( currentPos == startPos )
2456 {
2457 // We examined all items without finding anything.
2458 //
2459 // Notice that we still return true as we did
2460 // perform the search, if we didn't do this the
2461 // message would have been considered unhandled and
2462 // the control seems to always select the first
2463 // item by default in this case.
2464 return true;
2465 }
2466
2467 #if wxUSE_STOPWATCH
2468 // Check the time elapsed only every thousand
2469 // iterations for performance reasons: if we did it
2470 // more often calling wxStopWatch::Time() could take
2471 // noticeable time on its own.
2472 if ( !((currentPos - startPos)%1000) )
2473 {
2474 // We use half a second to limit the search time
2475 // which is about as long as we can take without
2476 // annoying the user.
2477 if ( sw.Time() > 500 )
2478 {
2479 // As above, return true to prevent the control
2480 // from selecting the first item by default.
2481 return true;
2482 }
2483 }
2484 #endif // wxUSE_STOPWATCH
2485
2486 }
2487
2488 SetItemState(*result,
2489 wxLIST_STATE_SELECTED | wxLIST_STATE_FOCUSED,
2490 wxLIST_STATE_SELECTED | wxLIST_STATE_FOCUSED);
2491 EnsureVisible(*result);
2492 return true;
2493 }
2494 else
2495 {
2496 processed = false;
2497 }
2498 break;
2499 #endif // HAVE_NMLVFINDITEM
2500
2501 case LVN_GETDISPINFO:
2502 if ( IsVirtual() )
2503 {
2504 LV_DISPINFO *info = (LV_DISPINFO *)lParam;
2505
2506 LV_ITEM& lvi = info->item;
2507 long item = lvi.iItem;
2508
2509 if ( lvi.mask & LVIF_TEXT )
2510 {
2511 wxString text = OnGetItemText(item, lvi.iSubItem);
2512 wxStrlcpy(lvi.pszText, text.c_str(), lvi.cchTextMax);
2513 }
2514
2515 // see comment at the end of wxListCtrl::GetColumn()
2516 #ifdef NM_CUSTOMDRAW
2517 if ( lvi.mask & LVIF_IMAGE )
2518 {
2519 lvi.iImage = OnGetItemColumnImage(item, lvi.iSubItem);
2520 }
2521 #endif // NM_CUSTOMDRAW
2522
2523 // even though we never use LVM_SETCALLBACKMASK, we still
2524 // can get messages with LVIF_STATE in lvi.mask under Vista
2525 if ( lvi.mask & LVIF_STATE )
2526 {
2527 // we don't have anything to return from here...
2528 lvi.stateMask = 0;
2529 }
2530
2531 return true;
2532 }
2533 // fall through
2534
2535 default:
2536 processed = false;
2537 }
2538
2539 if ( !processed )
2540 return wxListCtrlBase::MSWOnNotify(idCtrl, lParam, result);
2541 }
2542 else
2543 {
2544 // where did this one come from?
2545 return false;
2546 }
2547
2548 // process the event
2549 // -----------------
2550
2551 event.SetEventType(eventType);
2552
2553 // fill in the item before passing it to the event handler if we do have a
2554 // valid item index and haven't filled it yet (e.g. for LVN_ITEMCHANGED)
2555 // and we're not using a virtual control as in this case the program
2556 // already has the data anyhow and we don't want to call GetItem() for
2557 // potentially many items
2558 if ( event.m_itemIndex != -1 && !event.m_item.GetMask()
2559 && !IsVirtual() )
2560 {
2561 wxListItem& item = event.m_item;
2562
2563 item.SetId(event.m_itemIndex);
2564 item.SetMask(wxLIST_MASK_TEXT | wxLIST_MASK_IMAGE | wxLIST_MASK_DATA);
2565 GetItem(item);
2566 }
2567
2568 bool processed = HandleWindowEvent(event);
2569
2570 // post processing
2571 // ---------------
2572 switch ( nmhdr->code )
2573 {
2574 case LVN_DELETEALLITEMS:
2575 // always return true to suppress all additional LVN_DELETEITEM
2576 // notifications - this makes deleting all items from a list ctrl
2577 // much faster
2578 *result = TRUE;
2579
2580 // also, we may free all user data now (couldn't do it before as
2581 // the user should have access to it in OnDeleteAllItems() handler)
2582 FreeAllInternalData();
2583
2584 // the control is empty now, synchronize the cached number of items
2585 // with the real one
2586 m_count = 0;
2587 return true;
2588
2589 case LVN_DELETEITEM:
2590 // Delete the associated internal data. Notice that this can be
2591 // done only after the event has been handled as the data could be
2592 // accessed during the handling of the event.
2593 if ( wxMSWListItemData *data = MSWGetItemData(event.m_itemIndex) )
2594 {
2595 const unsigned count = m_internalData.size();
2596 for ( unsigned n = 0; n < count; n++ )
2597 {
2598 if ( m_internalData[n] == data )
2599 {
2600 m_internalData.erase(m_internalData.begin() + n);
2601 wxDELETE(data);
2602 break;
2603 }
2604 }
2605
2606 wxASSERT_MSG( !data, "invalid internal data pointer?" );
2607 }
2608 break;
2609
2610 case LVN_ENDLABELEDITA:
2611 case LVN_ENDLABELEDITW:
2612 // logic here is inverted compared to all the other messages
2613 *result = event.IsAllowed();
2614
2615 // EDIT control will be deleted by the list control itself so
2616 // prevent us from deleting it as well
2617 DeleteEditControl();
2618
2619 return true;
2620 }
2621
2622 if ( processed )
2623 *result = !event.IsAllowed();
2624
2625 return processed;
2626 }
2627
2628 // ----------------------------------------------------------------------------
2629 // custom draw stuff
2630 // ----------------------------------------------------------------------------
2631
2632 // see comment at the end of wxListCtrl::GetColumn()
2633 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
2634
2635 static RECT GetCustomDrawnItemRect(const NMCUSTOMDRAW& nmcd)
2636 {
2637 RECT rc;
2638 wxGetListCtrlItemRect(nmcd.hdr.hwndFrom, nmcd.dwItemSpec, LVIR_BOUNDS, rc);
2639
2640 RECT rcIcon;
2641 wxGetListCtrlItemRect(nmcd.hdr.hwndFrom, nmcd.dwItemSpec, LVIR_ICON, rcIcon);
2642
2643 // exclude the icon part, neither the selection background nor focus rect
2644 // should cover it
2645 rc.left = rcIcon.right;
2646
2647 return rc;
2648 }
2649
2650 static
2651 bool HandleSubItemPrepaint(LPNMLVCUSTOMDRAW pLVCD, HFONT hfont, int colCount)
2652 {
2653 NMCUSTOMDRAW& nmcd = pLVCD->nmcd;
2654
2655 HDC hdc = nmcd.hdc;
2656 HWND hwndList = nmcd.hdr.hwndFrom;
2657 const int col = pLVCD->iSubItem;
2658 const DWORD item = nmcd.dwItemSpec;
2659
2660 // the font must be valid, otherwise we wouldn't be painting the item at all
2661 SelectInHDC selFont(hdc, hfont);
2662
2663 // get the rectangle to paint
2664 RECT rc;
2665 wxGetListCtrlSubItemRect(hwndList, item, col, LVIR_BOUNDS, rc);
2666 if ( !col && colCount > 1 )
2667 {
2668 // ListView_GetSubItemRect() returns the entire item rect for 0th
2669 // subitem while we really need just the part for this column
2670 RECT rc2;
2671 wxGetListCtrlSubItemRect(hwndList, item, 1, LVIR_BOUNDS, rc2);
2672 rc.right = rc2.left;
2673 rc.left += 4;
2674 }
2675 else // not first subitem
2676 {
2677 rc.left += 6;
2678 }
2679
2680 // get the image and text to draw
2681 wxChar text[512];
2682 LV_ITEM it;
2683 wxZeroMemory(it);
2684 it.mask = LVIF_TEXT | LVIF_IMAGE;
2685 it.iItem = item;
2686 it.iSubItem = col;
2687 it.pszText = text;
2688 it.cchTextMax = WXSIZEOF(text);
2689 ListView_GetItem(hwndList, &it);
2690
2691 HIMAGELIST himl = ListView_GetImageList(hwndList, LVSIL_SMALL);
2692 if ( himl && ImageList_GetImageCount(himl) )
2693 {
2694 if ( it.iImage != -1 )
2695 {
2696 ImageList_Draw(himl, it.iImage, hdc, rc.left, rc.top,
2697 nmcd.uItemState & CDIS_SELECTED ? ILD_SELECTED
2698 : ILD_TRANSPARENT);
2699 }
2700
2701 // notice that even if this item doesn't have any image, the list
2702 // control still leaves space for the image in the first column if the
2703 // image list is not empty (presumably so that items with and without
2704 // images align?)
2705 if ( it.iImage != -1 || it.iSubItem == 0 )
2706 {
2707 int wImage, hImage;
2708 ImageList_GetIconSize(himl, &wImage, &hImage);
2709
2710 rc.left += wImage + 2;
2711 }
2712 }
2713
2714 ::SetBkMode(hdc, TRANSPARENT);
2715
2716 UINT fmt = DT_SINGLELINE |
2717 #ifndef __WXWINCE__
2718 DT_WORD_ELLIPSIS |
2719 #endif // __WXWINCE__
2720 DT_NOPREFIX |
2721 DT_VCENTER;
2722
2723 LV_COLUMN lvCol;
2724 wxZeroMemory(lvCol);
2725 lvCol.mask = LVCF_FMT;
2726 if ( ListView_GetColumn(hwndList, col, &lvCol) )
2727 {
2728 switch ( lvCol.fmt & LVCFMT_JUSTIFYMASK )
2729 {
2730 case LVCFMT_LEFT:
2731 fmt |= DT_LEFT;
2732 break;
2733
2734 case LVCFMT_CENTER:
2735 fmt |= DT_CENTER;
2736 break;
2737
2738 case LVCFMT_RIGHT:
2739 fmt |= DT_RIGHT;
2740 break;
2741 }
2742 }
2743 //else: failed to get alignment, assume it's DT_LEFT (default)
2744
2745 DrawText(hdc, text, -1, &rc, fmt);
2746
2747 return true;
2748 }
2749
2750 static void HandleItemPostpaint(NMCUSTOMDRAW nmcd)
2751 {
2752 if ( nmcd.uItemState & CDIS_FOCUS )
2753 {
2754 RECT rc = GetCustomDrawnItemRect(nmcd);
2755
2756 // don't use the provided HDC, it's in some strange state by now
2757 ::DrawFocusRect(WindowHDC(nmcd.hdr.hwndFrom), &rc);
2758 }
2759 }
2760
2761 // pLVCD->clrText and clrTextBk should contain the colours to use
2762 static void HandleItemPaint(LPNMLVCUSTOMDRAW pLVCD, HFONT hfont)
2763 {
2764 NMCUSTOMDRAW& nmcd = pLVCD->nmcd; // just a shortcut
2765
2766 const HWND hwndList = nmcd.hdr.hwndFrom;
2767 const int item = nmcd.dwItemSpec;
2768
2769 // unfortunately we can't trust CDIS_SELECTED, it is often set even when
2770 // the item is not at all selected for some reason (comctl32 6), but we
2771 // also can't always trust ListView_GetItem() as it could return the old
2772 // item status if we're called just after the (de)selection, so remember
2773 // the last item to gain selection and also check for it here
2774 for ( int i = -1;; )
2775 {
2776 i = ListView_GetNextItem(hwndList, i, LVNI_SELECTED);
2777 if ( i == -1 )
2778 {
2779 nmcd.uItemState &= ~CDIS_SELECTED;
2780 break;
2781 }
2782
2783 if ( i == item )
2784 {
2785 nmcd.uItemState |= CDIS_SELECTED;
2786 break;
2787 }
2788 }
2789
2790 // same thing for CDIS_FOCUS (except simpler as there is only one of them)
2791 //
2792 // NB: cast is needed to work around the bug in mingw32 headers which don't
2793 // have it inside ListView_GetNextItem() itself (unlike SDK ones)
2794 if ( ::GetFocus() == hwndList &&
2795 ListView_GetNextItem(
2796 hwndList, static_cast<WPARAM>(-1), LVNI_FOCUSED) == item )
2797 {
2798 nmcd.uItemState |= CDIS_FOCUS;
2799 }
2800 else
2801 {
2802 nmcd.uItemState &= ~CDIS_FOCUS;
2803 }
2804
2805 if ( nmcd.uItemState & CDIS_SELECTED )
2806 {
2807 int syscolFg, syscolBg;
2808 if ( ::GetFocus() == hwndList )
2809 {
2810 syscolFg = COLOR_HIGHLIGHTTEXT;
2811 syscolBg = COLOR_HIGHLIGHT;
2812 }
2813 else // selected but unfocused
2814 {
2815 syscolFg = COLOR_WINDOWTEXT;
2816 syscolBg = COLOR_BTNFACE;
2817
2818 // don't grey out the icon in this case neither
2819 nmcd.uItemState &= ~CDIS_SELECTED;
2820 }
2821
2822 pLVCD->clrText = ::GetSysColor(syscolFg);
2823 pLVCD->clrTextBk = ::GetSysColor(syscolBg);
2824 }
2825 //else: not selected, use normal colours from pLVCD
2826
2827 HDC hdc = nmcd.hdc;
2828 RECT rc = GetCustomDrawnItemRect(nmcd);
2829
2830 ::SetTextColor(hdc, pLVCD->clrText);
2831 ::FillRect(hdc, &rc, AutoHBRUSH(pLVCD->clrTextBk));
2832
2833 // we could use CDRF_NOTIFYSUBITEMDRAW here but it results in weird repaint
2834 // problems so just draw everything except the focus rect from here instead
2835 const int colCount = Header_GetItemCount(ListView_GetHeader(hwndList));
2836 for ( int col = 0; col < colCount; col++ )
2837 {
2838 pLVCD->iSubItem = col;
2839 HandleSubItemPrepaint(pLVCD, hfont, colCount);
2840 }
2841
2842 HandleItemPostpaint(nmcd);
2843 }
2844
2845 static WXLPARAM HandleItemPrepaint(wxListCtrl *listctrl,
2846 LPNMLVCUSTOMDRAW pLVCD,
2847 wxListItemAttr *attr)
2848 {
2849 if ( !attr )
2850 {
2851 // nothing to do for this item
2852 return CDRF_DODEFAULT;
2853 }
2854
2855
2856 // set the colours to use for text drawing
2857 pLVCD->clrText = attr->HasTextColour()
2858 ? wxColourToRGB(attr->GetTextColour())
2859 : wxColourToRGB(listctrl->GetTextColour());
2860 pLVCD->clrTextBk = attr->HasBackgroundColour()
2861 ? wxColourToRGB(attr->GetBackgroundColour())
2862 : wxColourToRGB(listctrl->GetBackgroundColour());
2863
2864 // select the font if non default one is specified
2865 if ( attr->HasFont() )
2866 {
2867 wxFont font = attr->GetFont();
2868 if ( font.GetEncoding() != wxFONTENCODING_SYSTEM )
2869 {
2870 // the standard control ignores the font encoding/charset, at least
2871 // with recent comctl32.dll versions (5 and 6, it uses to work with
2872 // 4.something) so we have to draw the item entirely ourselves in
2873 // this case
2874 HandleItemPaint(pLVCD, GetHfontOf(font));
2875 return CDRF_SKIPDEFAULT;
2876 }
2877
2878 ::SelectObject(pLVCD->nmcd.hdc, GetHfontOf(font));
2879
2880 return CDRF_NEWFONT;
2881 }
2882
2883 return CDRF_DODEFAULT;
2884 }
2885
2886 WXLPARAM wxListCtrl::OnCustomDraw(WXLPARAM lParam)
2887 {
2888 LPNMLVCUSTOMDRAW pLVCD = (LPNMLVCUSTOMDRAW)lParam;
2889 NMCUSTOMDRAW& nmcd = pLVCD->nmcd;
2890 switch ( nmcd.dwDrawStage )
2891 {
2892 case CDDS_PREPAINT:
2893 // if we've got any items with non standard attributes,
2894 // notify us before painting each item
2895 //
2896 // for virtual controls, always suppose that we have attributes as
2897 // there is no way to check for this
2898 if ( IsVirtual() || m_hasAnyAttr )
2899 return CDRF_NOTIFYITEMDRAW;
2900 break;
2901
2902 case CDDS_ITEMPREPAINT:
2903 // get a message for each subitem
2904 return CDRF_NOTIFYITEMDRAW;
2905
2906 case CDDS_SUBITEM | CDDS_ITEMPREPAINT:
2907 const int item = nmcd.dwItemSpec;
2908 const int column = pLVCD->iSubItem;
2909
2910 // we get this message with item == 0 for an empty control, we
2911 // must ignore it as calling OnGetItemAttr() would be wrong
2912 if ( item < 0 || item >= GetItemCount() )
2913 break;
2914 // same for columns
2915 if ( column < 0 || column >= GetColumnCount() )
2916 break;
2917
2918 return HandleItemPrepaint(this, pLVCD, DoGetItemColumnAttr(item, column));
2919 }
2920
2921 return CDRF_DODEFAULT;
2922 }
2923
2924 #endif // NM_CUSTOMDRAW supported
2925
2926 // Necessary for drawing hrules and vrules, if specified
2927 void wxListCtrl::OnPaint(wxPaintEvent& event)
2928 {
2929 const int itemCount = GetItemCount();
2930 const bool drawHRules = HasFlag(wxLC_HRULES);
2931 const bool drawVRules = HasFlag(wxLC_VRULES);
2932
2933 if (!InReportView() || !(drawHRules || drawVRules) || !itemCount)
2934 {
2935 event.Skip();
2936 return;
2937 }
2938
2939 wxPaintDC dc(this);
2940
2941 wxListCtrlBase::OnPaint(event);
2942
2943 // Reset the device origin since it may have been set
2944 dc.SetDeviceOrigin(0, 0);
2945
2946 wxPen pen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT));
2947 dc.SetPen(pen);
2948 dc.SetBrush(* wxTRANSPARENT_BRUSH);
2949
2950 wxSize clientSize = GetClientSize();
2951 wxRect itemRect;
2952
2953 if (drawHRules)
2954 {
2955 const long top = GetTopItem();
2956 for ( int i = top; i < top + GetCountPerPage() + 1; i++ )
2957 {
2958 if (GetItemRect(i, itemRect))
2959 {
2960 int cy = itemRect.GetTop();
2961 if (i != 0) // Don't draw the first one
2962 {
2963 dc.DrawLine(0, cy, clientSize.x, cy);
2964 }
2965 // Draw last line
2966 if (i == itemCount - 1)
2967 {
2968 cy = itemRect.GetBottom();
2969 dc.DrawLine(0, cy, clientSize.x, cy);
2970 break;
2971 }
2972 }
2973 }
2974 }
2975
2976 if (drawVRules)
2977 {
2978 wxRect firstItemRect;
2979 GetItemRect(0, firstItemRect);
2980
2981 if (GetItemRect(itemCount - 1, itemRect))
2982 {
2983 // this is a fix for bug 673394: erase the pixels which we would
2984 // otherwise leave on the screen
2985 static const int gap = 2;
2986 dc.SetPen(*wxTRANSPARENT_PEN);
2987 dc.SetBrush(wxBrush(GetBackgroundColour()));
2988 dc.DrawRectangle(0, firstItemRect.GetY() - gap,
2989 clientSize.GetWidth(), gap);
2990
2991 dc.SetPen(pen);
2992 dc.SetBrush(*wxTRANSPARENT_BRUSH);
2993
2994 const int numCols = GetColumnCount();
2995 wxVector<int> indexArray(numCols);
2996 if ( !ListView_GetColumnOrderArray(GetHwnd(),
2997 numCols,
2998 &indexArray[0]) )
2999 {
3000 wxFAIL_MSG( wxT("invalid column index array in OnPaint()") );
3001 return;
3002 }
3003
3004 int x = itemRect.GetX();
3005 for (int col = 0; col < numCols; col++)
3006 {
3007 int colWidth = GetColumnWidth(indexArray[col]);
3008 x += colWidth ;
3009 dc.DrawLine(x-1, firstItemRect.GetY() - gap,
3010 x-1, itemRect.GetBottom());
3011 }
3012 }
3013 }
3014 }
3015
3016 void wxListCtrl::OnCharHook(wxKeyEvent& event)
3017 {
3018 if ( GetEditControl() )
3019 {
3020 // We need to ensure that Escape is not stolen from the in-place editor
3021 // by the containing dialog.
3022 //
3023 // Notice that we don't have to care about Enter key here as we return
3024 // false from MSWShouldPreProcessMessage() for it.
3025 if ( event.GetKeyCode() == WXK_ESCAPE )
3026 {
3027 EndEditLabel(true /* cancel */);
3028
3029 // Don't call Skip() below.
3030 return;
3031 }
3032 }
3033
3034 event.Skip();
3035 }
3036
3037 WXLRESULT
3038 wxListCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
3039 {
3040 switch ( nMsg )
3041 {
3042 #ifdef WM_PRINT
3043 case WM_PRINT:
3044 // we should bypass our own WM_PRINT handling as we don't handle
3045 // PRF_CHILDREN flag, so leave it to the native control itself
3046 return MSWDefWindowProc(nMsg, wParam, lParam);
3047 #endif // WM_PRINT
3048
3049 case WM_CONTEXTMENU:
3050 // because this message is propagated upwards the child-parent
3051 // chain, we get it for the right clicks on the header window but
3052 // this is confusing in wx as right clicking there already
3053 // generates a separate wxEVT_LIST_COL_RIGHT_CLICK event
3054 // so just ignore them
3055 if ( (HWND)wParam == ListView_GetHeader(GetHwnd()) )
3056 return 0;
3057 //else: break
3058 }
3059
3060 return wxListCtrlBase::MSWWindowProc(nMsg, wParam, lParam);
3061 }
3062
3063 // ----------------------------------------------------------------------------
3064 // virtual list controls
3065 // ----------------------------------------------------------------------------
3066
3067 wxString wxListCtrl::OnGetItemText(long WXUNUSED(item), long WXUNUSED(col)) const
3068 {
3069 // this is a pure virtual function, in fact - which is not really pure
3070 // because the controls which are not virtual don't need to implement it
3071 wxFAIL_MSG( wxT("wxListCtrl::OnGetItemText not supposed to be called") );
3072
3073 return wxEmptyString;
3074 }
3075
3076 int wxListCtrl::OnGetItemImage(long WXUNUSED(item)) const
3077 {
3078 wxCHECK_MSG(!GetImageList(wxIMAGE_LIST_SMALL),
3079 -1,
3080 wxT("List control has an image list, OnGetItemImage or OnGetItemColumnImage should be overridden."));
3081 return -1;
3082 }
3083
3084 int wxListCtrl::OnGetItemColumnImage(long item, long column) const
3085 {
3086 if (!column)
3087 return OnGetItemImage(item);
3088
3089 return -1;
3090 }
3091
3092 wxListItemAttr *wxListCtrl::DoGetItemColumnAttr(long item, long column) const
3093 {
3094 if ( IsVirtual() )
3095 return OnGetItemColumnAttr(item, column);
3096
3097 wxMSWListItemData * const data = MSWGetItemData(item);
3098 return data ? data->attr : NULL;
3099 }
3100
3101 void wxListCtrl::SetItemCount(long count)
3102 {
3103 wxASSERT_MSG( IsVirtual(), wxT("this is for virtual controls only") );
3104
3105 if ( !::SendMessage(GetHwnd(), LVM_SETITEMCOUNT, (WPARAM)count,
3106 LVSICF_NOSCROLL | LVSICF_NOINVALIDATEALL) )
3107 {
3108 wxLogLastError(wxT("ListView_SetItemCount"));
3109 }
3110 m_count = count;
3111 wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()),
3112 wxT("m_count should match ListView_GetItemCount"));
3113 }
3114
3115 void wxListCtrl::RefreshItem(long item)
3116 {
3117 RefreshItems(item, item);
3118 }
3119
3120 void wxListCtrl::RefreshItems(long itemFrom, long itemTo)
3121 {
3122 ListView_RedrawItems(GetHwnd(), itemFrom, itemTo);
3123 }
3124
3125 // ----------------------------------------------------------------------------
3126 // wxWin <-> MSW items conversions
3127 // ----------------------------------------------------------------------------
3128
3129 static void wxConvertFromMSWListItem(HWND hwndListCtrl,
3130 wxListItem& info,
3131 LV_ITEM& lvItem)
3132 {
3133 wxMSWListItemData *internaldata =
3134 (wxMSWListItemData *) lvItem.lParam;
3135
3136 if (internaldata)
3137 info.m_data = internaldata->lParam;
3138
3139 info.m_mask = 0;
3140 info.m_state = 0;
3141 info.m_stateMask = 0;
3142 info.m_itemId = lvItem.iItem;
3143
3144 long oldMask = lvItem.mask;
3145
3146 bool needText = false;
3147 if (hwndListCtrl != 0)
3148 {
3149 if ( lvItem.mask & LVIF_TEXT )
3150 needText = false;
3151 else
3152 needText = true;
3153
3154 if ( needText )
3155 {
3156 lvItem.pszText = new wxChar[513];
3157 lvItem.cchTextMax = 512;
3158 }
3159 lvItem.mask |= LVIF_TEXT | LVIF_IMAGE | LVIF_PARAM;
3160 ::SendMessage(hwndListCtrl, LVM_GETITEM, 0, (LPARAM)& lvItem);
3161 }
3162
3163 if ( lvItem.mask & LVIF_STATE )
3164 {
3165 info.m_mask |= wxLIST_MASK_STATE;
3166
3167 if ( lvItem.stateMask & LVIS_CUT)
3168 {
3169 info.m_stateMask |= wxLIST_STATE_CUT;
3170 if ( lvItem.state & LVIS_CUT )
3171 info.m_state |= wxLIST_STATE_CUT;
3172 }
3173 if ( lvItem.stateMask & LVIS_DROPHILITED)
3174 {
3175 info.m_stateMask |= wxLIST_STATE_DROPHILITED;
3176 if ( lvItem.state & LVIS_DROPHILITED )
3177 info.m_state |= wxLIST_STATE_DROPHILITED;
3178 }
3179 if ( lvItem.stateMask & LVIS_FOCUSED)
3180 {
3181 info.m_stateMask |= wxLIST_STATE_FOCUSED;
3182 if ( lvItem.state & LVIS_FOCUSED )
3183 info.m_state |= wxLIST_STATE_FOCUSED;
3184 }
3185 if ( lvItem.stateMask & LVIS_SELECTED)
3186 {
3187 info.m_stateMask |= wxLIST_STATE_SELECTED;
3188 if ( lvItem.state & LVIS_SELECTED )
3189 info.m_state |= wxLIST_STATE_SELECTED;
3190 }
3191 }
3192
3193 if ( lvItem.mask & LVIF_TEXT )
3194 {
3195 info.m_mask |= wxLIST_MASK_TEXT;
3196 info.m_text = lvItem.pszText;
3197 }
3198 if ( lvItem.mask & LVIF_IMAGE )
3199 {
3200 info.m_mask |= wxLIST_MASK_IMAGE;
3201 info.m_image = lvItem.iImage;
3202 }
3203 if ( lvItem.mask & LVIF_PARAM )
3204 info.m_mask |= wxLIST_MASK_DATA;
3205 if ( lvItem.mask & LVIF_DI_SETITEM )
3206 info.m_mask |= wxLIST_SET_ITEM;
3207 info.m_col = lvItem.iSubItem;
3208
3209 if (needText)
3210 {
3211 if (lvItem.pszText)
3212 delete[] lvItem.pszText;
3213 }
3214 lvItem.mask = oldMask;
3215 }
3216
3217 static void wxConvertToMSWFlags(long state, long stateMask, LV_ITEM& lvItem)
3218 {
3219 if (stateMask & wxLIST_STATE_CUT)
3220 {
3221 lvItem.stateMask |= LVIS_CUT;
3222 if (state & wxLIST_STATE_CUT)
3223 lvItem.state |= LVIS_CUT;
3224 }
3225 if (stateMask & wxLIST_STATE_DROPHILITED)
3226 {
3227 lvItem.stateMask |= LVIS_DROPHILITED;
3228 if (state & wxLIST_STATE_DROPHILITED)
3229 lvItem.state |= LVIS_DROPHILITED;
3230 }
3231 if (stateMask & wxLIST_STATE_FOCUSED)
3232 {
3233 lvItem.stateMask |= LVIS_FOCUSED;
3234 if (state & wxLIST_STATE_FOCUSED)
3235 lvItem.state |= LVIS_FOCUSED;
3236 }
3237 if (stateMask & wxLIST_STATE_SELECTED)
3238 {
3239 lvItem.stateMask |= LVIS_SELECTED;
3240 if (state & wxLIST_STATE_SELECTED)
3241 lvItem.state |= LVIS_SELECTED;
3242 }
3243 }
3244
3245 static void wxConvertToMSWListItem(const wxListCtrl *ctrl,
3246 const wxListItem& info,
3247 LV_ITEM& lvItem)
3248 {
3249 if ( ctrl->InReportView() )
3250 {
3251 wxASSERT_MSG( 0 <= info.m_col && info.m_col < ctrl->GetColumnCount(),
3252 "wxListCtrl column index out of bounds" );
3253 }
3254 else // not in report view
3255 {
3256 wxASSERT_MSG( info.m_col == 0, "columns only exist in report view" );
3257 }
3258
3259 lvItem.iItem = (int) info.m_itemId;
3260
3261 lvItem.iImage = info.m_image;
3262 lvItem.stateMask = 0;
3263 lvItem.state = 0;
3264 lvItem.mask = 0;
3265 lvItem.iSubItem = info.m_col;
3266
3267 if (info.m_mask & wxLIST_MASK_STATE)
3268 {
3269 lvItem.mask |= LVIF_STATE;
3270
3271 wxConvertToMSWFlags(info.m_state, info.m_stateMask, lvItem);
3272 }
3273
3274 if (info.m_mask & wxLIST_MASK_TEXT)
3275 {
3276 lvItem.mask |= LVIF_TEXT;
3277 if ( ctrl->HasFlag(wxLC_USER_TEXT) )
3278 {
3279 lvItem.pszText = LPSTR_TEXTCALLBACK;
3280 }
3281 else
3282 {
3283 // pszText is not const, hence the cast
3284 lvItem.pszText = wxMSW_CONV_LPTSTR(info.m_text);
3285 if ( lvItem.pszText )
3286 lvItem.cchTextMax = info.m_text.length();
3287 else
3288 lvItem.cchTextMax = 0;
3289 }
3290 }
3291 if (info.m_mask & wxLIST_MASK_IMAGE)
3292 lvItem.mask |= LVIF_IMAGE;
3293 }
3294
3295 static void wxConvertToMSWListCol(HWND hwndList,
3296 int col,
3297 const wxListItem& item,
3298 LV_COLUMN& lvCol)
3299 {
3300 wxZeroMemory(lvCol);
3301
3302 if ( item.m_mask & wxLIST_MASK_TEXT )
3303 {
3304 lvCol.mask |= LVCF_TEXT;
3305 lvCol.pszText = wxMSW_CONV_LPTSTR(item.m_text);
3306 }
3307
3308 if ( item.m_mask & wxLIST_MASK_FORMAT )
3309 {
3310 lvCol.mask |= LVCF_FMT;
3311
3312 if ( item.m_format == wxLIST_FORMAT_LEFT )
3313 lvCol.fmt = LVCFMT_LEFT;
3314 else if ( item.m_format == wxLIST_FORMAT_RIGHT )
3315 lvCol.fmt = LVCFMT_RIGHT;
3316 else if ( item.m_format == wxLIST_FORMAT_CENTRE )
3317 lvCol.fmt = LVCFMT_CENTER;
3318 }
3319
3320 if ( item.m_mask & wxLIST_MASK_WIDTH )
3321 {
3322 lvCol.mask |= LVCF_WIDTH;
3323 if ( item.m_width == wxLIST_AUTOSIZE)
3324 lvCol.cx = LVSCW_AUTOSIZE;
3325 else if ( item.m_width == wxLIST_AUTOSIZE_USEHEADER)
3326 lvCol.cx = LVSCW_AUTOSIZE_USEHEADER;
3327 else
3328 lvCol.cx = item.m_width;
3329 }
3330
3331 // see comment at the end of wxListCtrl::GetColumn()
3332 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
3333 if ( item.m_mask & wxLIST_MASK_IMAGE )
3334 {
3335 if ( wxApp::GetComCtl32Version() >= 470 )
3336 {
3337 lvCol.mask |= LVCF_IMAGE;
3338
3339 // we use LVCFMT_BITMAP_ON_RIGHT because the images on the right
3340 // seem to be generally nicer than on the left and the generic
3341 // version only draws them on the right (we don't have a flag to
3342 // specify the image location anyhow)
3343 //
3344 // we don't use LVCFMT_COL_HAS_IMAGES because it doesn't seem to
3345 // make any difference in my tests -- but maybe we should?
3346 if ( item.m_image != -1 )
3347 {
3348 // as we're going to overwrite the format field, get its
3349 // current value first -- unless we want to overwrite it anyhow
3350 if ( !(lvCol.mask & LVCF_FMT) )
3351 {
3352 LV_COLUMN lvColOld;
3353 wxZeroMemory(lvColOld);
3354 lvColOld.mask = LVCF_FMT;
3355 if ( ListView_GetColumn(hwndList, col, &lvColOld) )
3356 {
3357 lvCol.fmt = lvColOld.fmt;
3358 }
3359
3360 lvCol.mask |= LVCF_FMT;
3361 }
3362
3363 lvCol.fmt |= LVCFMT_BITMAP_ON_RIGHT | LVCFMT_IMAGE;
3364 }
3365
3366 lvCol.iImage = item.m_image;
3367 }
3368 //else: it doesn't support item images anyhow
3369 }
3370 #endif // _WIN32_IE >= 0x0300
3371 }
3372
3373 #endif // wxUSE_LISTCTRL