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