Don't fill wxListEvent::m_item when using virtual list control in wxMSW.
[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, wxControl)
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 = wxControl::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 wxControl::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_COMMAND_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 // Operations
1338 // ----------------------------------------------------------------------------
1339
1340 // Arranges the items
1341 bool wxListCtrl::Arrange(int flag)
1342 {
1343 UINT code = 0;
1344 if ( flag == wxLIST_ALIGN_LEFT )
1345 code = LVA_ALIGNLEFT;
1346 else if ( flag == wxLIST_ALIGN_TOP )
1347 code = LVA_ALIGNTOP;
1348 else if ( flag == wxLIST_ALIGN_DEFAULT )
1349 code = LVA_DEFAULT;
1350 else if ( flag == wxLIST_ALIGN_SNAP_TO_GRID )
1351 code = LVA_SNAPTOGRID;
1352
1353 return (ListView_Arrange(GetHwnd(), code) != 0);
1354 }
1355
1356 // Deletes an item
1357 bool wxListCtrl::DeleteItem(long item)
1358 {
1359 if ( !ListView_DeleteItem(GetHwnd(), (int) item) )
1360 {
1361 wxLogLastError(wxT("ListView_DeleteItem"));
1362 return false;
1363 }
1364
1365 m_count--;
1366 wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()),
1367 wxT("m_count should match ListView_GetItemCount"));
1368
1369 // the virtual list control doesn't refresh itself correctly, help it
1370 if ( IsVirtual() )
1371 {
1372 // we need to refresh all the lines below the one which was deleted
1373 wxRect rectItem;
1374 if ( item > 0 && GetItemCount() )
1375 {
1376 GetItemRect(item - 1, rectItem);
1377 }
1378 else
1379 {
1380 rectItem.y =
1381 rectItem.height = 0;
1382 }
1383
1384 wxRect rectWin = GetRect();
1385 rectWin.height = rectWin.GetBottom() - rectItem.GetBottom();
1386 rectWin.y = rectItem.GetBottom();
1387
1388 RefreshRect(rectWin);
1389 }
1390
1391 return true;
1392 }
1393
1394 // Deletes all items
1395 bool wxListCtrl::DeleteAllItems()
1396 {
1397 // Calling ListView_DeleteAllItems() will always generate an event but we
1398 // shouldn't do it if the control is empty
1399 return !GetItemCount() || ListView_DeleteAllItems(GetHwnd()) != 0;
1400 }
1401
1402 // Deletes all items
1403 bool wxListCtrl::DeleteAllColumns()
1404 {
1405 while ( m_colCount > 0 )
1406 {
1407 if ( ListView_DeleteColumn(GetHwnd(), 0) == 0 )
1408 {
1409 wxLogLastError(wxT("ListView_DeleteColumn"));
1410
1411 return false;
1412 }
1413
1414 m_colCount--;
1415 }
1416
1417 wxASSERT_MSG( m_colCount == 0, wxT("no columns should be left") );
1418
1419 return true;
1420 }
1421
1422 // Deletes a column
1423 bool wxListCtrl::DeleteColumn(int col)
1424 {
1425 bool success = (ListView_DeleteColumn(GetHwnd(), col) != 0);
1426
1427 if ( success && (m_colCount > 0) )
1428 m_colCount --;
1429 return success;
1430 }
1431
1432 // Clears items, and columns if there are any.
1433 void wxListCtrl::ClearAll()
1434 {
1435 DeleteAllItems();
1436 if ( m_colCount > 0 )
1437 DeleteAllColumns();
1438 }
1439
1440 void wxListCtrl::InitEditControl(WXHWND hWnd)
1441 {
1442 m_textCtrl->SetHWND(hWnd);
1443 m_textCtrl->SubclassWin(hWnd);
1444 m_textCtrl->SetParent(this);
1445
1446 // we must disallow TABbing away from the control while the edit control is
1447 // shown because this leaves it in some strange state (just try removing
1448 // this line and then pressing TAB while editing an item in listctrl
1449 // inside a panel)
1450 m_textCtrl->SetWindowStyle(m_textCtrl->GetWindowStyle() | wxTE_PROCESS_TAB);
1451 }
1452
1453 wxTextCtrl* wxListCtrl::EditLabel(long item, wxClassInfo* textControlClass)
1454 {
1455 wxCHECK_MSG( textControlClass->IsKindOf(CLASSINFO(wxTextCtrl)), NULL,
1456 "control used for label editing must be a wxTextCtrl" );
1457
1458 // ListView_EditLabel requires that the list has focus.
1459 SetFocus();
1460
1461 // create m_textCtrl here before calling ListView_EditLabel() because it
1462 // generates wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT event from inside it and
1463 // the user handler for it can call GetEditControl() resulting in an on
1464 // demand creation of a stock wxTextCtrl instead of the control of a
1465 // (possibly) custom wxClassInfo
1466 DeleteEditControl();
1467 m_textCtrl = (wxTextCtrl *)textControlClass->CreateObject();
1468
1469 WXHWND hWnd = (WXHWND) ListView_EditLabel(GetHwnd(), item);
1470 if ( !hWnd )
1471 {
1472 // failed to start editing
1473 wxDELETE(m_textCtrl);
1474
1475 return NULL;
1476 }
1477
1478 // if GetEditControl() hasn't been called, we need to initialize the edit
1479 // control ourselves
1480 if ( !m_textCtrl->GetHWND() )
1481 InitEditControl(hWnd);
1482
1483 return m_textCtrl;
1484 }
1485
1486 // End label editing, optionally cancelling the edit
1487 bool wxListCtrl::EndEditLabel(bool cancel)
1488 {
1489 // m_textCtrl is not always ready, ie. in EVT_LIST_BEGIN_LABEL_EDIT
1490 HWND hwnd = ListView_GetEditControl(GetHwnd());
1491 if ( !hwnd )
1492 return false;
1493
1494 // Newer versions of Windows have a special ListView_CancelEditLabel()
1495 // message for cancelling editing but it, rather counter-intuitively, keeps
1496 // the last text entered in the dialog while cancelling as we do it below
1497 // restores the original text which is the more expected behaviour.
1498
1499 // We shouldn't destroy the control ourselves according to MSDN, which
1500 // proposes WM_CANCELMODE to do this, but it doesn't seem to work so
1501 // emulate the corresponding user action instead.
1502 ::SendMessage(hwnd, WM_KEYDOWN, cancel ? VK_ESCAPE : VK_RETURN, 0);
1503
1504 return true;
1505 }
1506
1507 // Ensures this item is visible
1508 bool wxListCtrl::EnsureVisible(long item)
1509 {
1510 return ListView_EnsureVisible(GetHwnd(), (int) item, FALSE) != FALSE;
1511 }
1512
1513 // Find an item whose label matches this string, starting from the item after 'start'
1514 // or the beginning if 'start' is -1.
1515 long wxListCtrl::FindItem(long start, const wxString& str, bool partial)
1516 {
1517 LV_FINDINFO findInfo;
1518
1519 findInfo.flags = LVFI_STRING;
1520 if ( partial )
1521 findInfo.flags |= LVFI_PARTIAL;
1522 findInfo.psz = str.wx_str();
1523
1524 // ListView_FindItem() excludes the first item from search and to look
1525 // through all the items you need to start from -1 which is unnatural and
1526 // inconsistent with the generic version - so we adjust the index
1527 if (start != -1)
1528 start --;
1529 return ListView_FindItem(GetHwnd(), start, &findInfo);
1530 }
1531
1532 // Find an item whose data matches this data, starting from the item after
1533 // 'start' or the beginning if 'start' is -1.
1534 long wxListCtrl::FindItem(long start, wxUIntPtr data)
1535 {
1536 // we can't use ListView_FindItem() directly as we don't store the data
1537 // pointer itself in the control but rather our own internal data, so first
1538 // we need to find the right value to search for (and there can be several
1539 // of them)
1540 int idx = wxNOT_FOUND;
1541 const unsigned count = m_internalData.size();
1542 for ( unsigned n = 0; n < count; n++ )
1543 {
1544 if ( m_internalData[n]->lParam == (LPARAM)data )
1545 {
1546 LV_FINDINFO findInfo;
1547 findInfo.flags = LVFI_PARAM;
1548 findInfo.lParam = (LPARAM)wxPtrToUInt(m_internalData[n]);
1549
1550 int rc = ListView_FindItem(GetHwnd(), start, &findInfo);
1551 if ( rc != -1 )
1552 {
1553 if ( idx == wxNOT_FOUND || rc < idx )
1554 {
1555 idx = rc;
1556 if ( idx == start + 1 )
1557 {
1558 // we can stop here, we don't risk finding a closer
1559 // match
1560 break;
1561 }
1562 }
1563 //else: this item is after the previously found one
1564 }
1565 }
1566 }
1567
1568 return idx;
1569 }
1570
1571 // Find an item nearest this position in the specified direction, starting from
1572 // the item after 'start' or the beginning if 'start' is -1.
1573 long wxListCtrl::FindItem(long start, const wxPoint& pt, int direction)
1574 {
1575 LV_FINDINFO findInfo;
1576
1577 findInfo.flags = LVFI_NEARESTXY;
1578 findInfo.pt.x = pt.x;
1579 findInfo.pt.y = pt.y;
1580 findInfo.vkDirection = VK_RIGHT;
1581
1582 if ( direction == wxLIST_FIND_UP )
1583 findInfo.vkDirection = VK_UP;
1584 else if ( direction == wxLIST_FIND_DOWN )
1585 findInfo.vkDirection = VK_DOWN;
1586 else if ( direction == wxLIST_FIND_LEFT )
1587 findInfo.vkDirection = VK_LEFT;
1588 else if ( direction == wxLIST_FIND_RIGHT )
1589 findInfo.vkDirection = VK_RIGHT;
1590
1591 return ListView_FindItem(GetHwnd(), start, &findInfo);
1592 }
1593
1594 // Determines which item (if any) is at the specified point,
1595 // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
1596 long
1597 wxListCtrl::HitTest(const wxPoint& point, int& flags, long *ptrSubItem) const
1598 {
1599 LV_HITTESTINFO hitTestInfo;
1600 hitTestInfo.pt.x = (int) point.x;
1601 hitTestInfo.pt.y = (int) point.y;
1602
1603 long item;
1604 #ifdef LVM_SUBITEMHITTEST
1605 if ( ptrSubItem && wxApp::GetComCtl32Version() >= 470 )
1606 {
1607 item = ListView_SubItemHitTest(GetHwnd(), &hitTestInfo);
1608 *ptrSubItem = hitTestInfo.iSubItem;
1609 }
1610 else
1611 #endif // LVM_SUBITEMHITTEST
1612 {
1613 item = ListView_HitTest(GetHwnd(), &hitTestInfo);
1614 }
1615
1616 flags = 0;
1617
1618 if ( hitTestInfo.flags & LVHT_ABOVE )
1619 flags |= wxLIST_HITTEST_ABOVE;
1620 if ( hitTestInfo.flags & LVHT_BELOW )
1621 flags |= wxLIST_HITTEST_BELOW;
1622 if ( hitTestInfo.flags & LVHT_TOLEFT )
1623 flags |= wxLIST_HITTEST_TOLEFT;
1624 if ( hitTestInfo.flags & LVHT_TORIGHT )
1625 flags |= wxLIST_HITTEST_TORIGHT;
1626
1627 if ( hitTestInfo.flags & LVHT_NOWHERE )
1628 flags |= wxLIST_HITTEST_NOWHERE;
1629
1630 // note a bug or at least a very strange feature of comtl32.dll (tested
1631 // with version 4.0 under Win95 and 6.0 under Win 2003): if you click to
1632 // the right of the item label, ListView_HitTest() returns a combination of
1633 // LVHT_ONITEMICON, LVHT_ONITEMLABEL and LVHT_ONITEMSTATEICON -- filter out
1634 // the bits which don't make sense
1635 if ( hitTestInfo.flags & LVHT_ONITEMLABEL )
1636 {
1637 flags |= wxLIST_HITTEST_ONITEMLABEL;
1638
1639 // do not translate LVHT_ONITEMICON here, as per above
1640 }
1641 else
1642 {
1643 if ( hitTestInfo.flags & LVHT_ONITEMICON )
1644 flags |= wxLIST_HITTEST_ONITEMICON;
1645 if ( hitTestInfo.flags & LVHT_ONITEMSTATEICON )
1646 flags |= wxLIST_HITTEST_ONITEMSTATEICON;
1647 }
1648
1649 return item;
1650 }
1651
1652
1653 // Inserts an item, returning the index of the new item if successful,
1654 // -1 otherwise.
1655 long wxListCtrl::InsertItem(const wxListItem& info)
1656 {
1657 wxASSERT_MSG( !IsVirtual(), wxT("can't be used with virtual controls") );
1658
1659 LV_ITEM item;
1660 wxConvertToMSWListItem(this, info, item);
1661 item.mask &= ~LVIF_PARAM;
1662
1663 // check whether we need to allocate our internal data
1664 bool needInternalData = (info.m_mask & wxLIST_MASK_DATA) ||
1665 info.HasAttributes();
1666 if ( needInternalData )
1667 {
1668 item.mask |= LVIF_PARAM;
1669
1670 wxMSWListItemData * const data = new wxMSWListItemData;
1671 m_internalData.push_back(data);
1672 item.lParam = (LPARAM)data;
1673
1674 if ( info.m_mask & wxLIST_MASK_DATA )
1675 data->lParam = info.m_data;
1676
1677 // check whether it has any custom attributes
1678 if ( info.HasAttributes() )
1679 {
1680 // take copy of attributes
1681 data->attr = new wxListItemAttr(*info.GetAttributes());
1682
1683 // and remember that we have some now...
1684 m_hasAnyAttr = true;
1685 }
1686 }
1687
1688 const long rv = ListView_InsertItem(GetHwnd(), & item);
1689
1690 // failing to insert the item is really unexpected
1691 wxCHECK_MSG( rv != -1, rv, "failed to insert an item in wxListCtrl" );
1692
1693 m_count++;
1694 wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()),
1695 wxT("m_count should match ListView_GetItemCount"));
1696
1697 return rv;
1698 }
1699
1700 long wxListCtrl::InsertItem(long index, const wxString& label)
1701 {
1702 wxListItem info;
1703 info.m_text = label;
1704 info.m_mask = wxLIST_MASK_TEXT;
1705 info.m_itemId = index;
1706 return InsertItem(info);
1707 }
1708
1709 // Inserts an image item
1710 long wxListCtrl::InsertItem(long index, int imageIndex)
1711 {
1712 wxListItem info;
1713 info.m_image = imageIndex;
1714 info.m_mask = wxLIST_MASK_IMAGE;
1715 info.m_itemId = index;
1716 return InsertItem(info);
1717 }
1718
1719 // Inserts an image/string item
1720 long wxListCtrl::InsertItem(long index, const wxString& label, int imageIndex)
1721 {
1722 wxListItem info;
1723 info.m_image = imageIndex;
1724 info.m_text = label;
1725 info.m_mask = wxLIST_MASK_TEXT;
1726 if (imageIndex > -1)
1727 info.m_mask |= wxLIST_MASK_IMAGE;
1728 info.m_itemId = index;
1729 return InsertItem(info);
1730 }
1731
1732 // For list view mode (only), inserts a column.
1733 long wxListCtrl::InsertColumn(long col, const wxListItem& item)
1734 {
1735 LV_COLUMN lvCol;
1736 wxConvertToMSWListCol(GetHwnd(), col, item, lvCol);
1737
1738 if ( !(lvCol.mask & LVCF_WIDTH) )
1739 {
1740 // always give some width to the new column: this one is compatible
1741 // with the generic version
1742 lvCol.mask |= LVCF_WIDTH;
1743 lvCol.cx = 80;
1744 }
1745
1746 long n = ListView_InsertColumn(GetHwnd(), col, &lvCol);
1747 if ( n != -1 )
1748 {
1749 m_colCount++;
1750 }
1751 else // failed to insert?
1752 {
1753 wxLogDebug(wxT("Failed to insert the column '%s' into listview!"),
1754 lvCol.pszText);
1755 }
1756
1757 return n;
1758 }
1759
1760 long wxListCtrl::InsertColumn(long col,
1761 const wxString& heading,
1762 int format,
1763 int width)
1764 {
1765 wxListItem item;
1766 item.m_mask = wxLIST_MASK_TEXT | wxLIST_MASK_FORMAT;
1767 item.m_text = heading;
1768 if ( width > -1 )
1769 {
1770 item.m_mask |= wxLIST_MASK_WIDTH;
1771 item.m_width = width;
1772 }
1773 item.m_format = format;
1774
1775 return InsertColumn(col, item);
1776 }
1777
1778 // scroll the control by the given number of pixels (exception: in list view,
1779 // dx is interpreted as number of columns)
1780 bool wxListCtrl::ScrollList(int dx, int dy)
1781 {
1782 if ( !ListView_Scroll(GetHwnd(), dx, dy) )
1783 {
1784 wxLogDebug(wxT("ListView_Scroll(%d, %d) failed"), dx, dy);
1785
1786 return false;
1787 }
1788
1789 return true;
1790 }
1791
1792 // Sort items.
1793
1794 // fn is a function which takes 3 long arguments: item1, item2, data.
1795 // item1 is the long data associated with a first item (NOT the index).
1796 // item2 is the long data associated with a second item (NOT the index).
1797 // data is the same value as passed to SortItems.
1798 // The return value is a negative number if the first item should precede the second
1799 // item, a positive number of the second item should precede the first,
1800 // or zero if the two items are equivalent.
1801
1802 // data is arbitrary data to be passed to the sort function.
1803
1804 // Internal structures for proxying the user compare function
1805 // so that we can pass it the *real* user data
1806
1807 // translate lParam data and call user func
1808 struct wxInternalDataSort
1809 {
1810 wxListCtrlCompare user_fn;
1811 wxIntPtr data;
1812 };
1813
1814 int CALLBACK wxInternalDataCompareFunc(LPARAM lParam1, LPARAM lParam2, LPARAM lParamSort)
1815 {
1816 wxInternalDataSort * const internalData = (wxInternalDataSort *) lParamSort;
1817
1818 wxMSWListItemData *data1 = (wxMSWListItemData *) lParam1;
1819 wxMSWListItemData *data2 = (wxMSWListItemData *) lParam2;
1820
1821 wxIntPtr d1 = (data1 == NULL ? 0 : data1->lParam);
1822 wxIntPtr d2 = (data2 == NULL ? 0 : data2->lParam);
1823
1824 return internalData->user_fn(d1, d2, internalData->data);
1825
1826 }
1827
1828 bool wxListCtrl::SortItems(wxListCtrlCompare fn, wxIntPtr data)
1829 {
1830 wxInternalDataSort internalData;
1831 internalData.user_fn = fn;
1832 internalData.data = data;
1833
1834 // WPARAM cast is needed for mingw/cygwin
1835 if ( !ListView_SortItems(GetHwnd(),
1836 wxInternalDataCompareFunc,
1837 (WPARAM) &internalData) )
1838 {
1839 wxLogDebug(wxT("ListView_SortItems() failed"));
1840
1841 return false;
1842 }
1843
1844 return true;
1845 }
1846
1847
1848
1849 // ----------------------------------------------------------------------------
1850 // message processing
1851 // ----------------------------------------------------------------------------
1852
1853 bool wxListCtrl::MSWShouldPreProcessMessage(WXMSG* msg)
1854 {
1855 if ( msg->message == WM_KEYDOWN )
1856 {
1857 // Only eat VK_RETURN if not being used by the application in
1858 // conjunction with modifiers
1859 if ( msg->wParam == VK_RETURN && !wxIsAnyModifierDown() )
1860 {
1861 // we need VK_RETURN to generate wxEVT_COMMAND_LIST_ITEM_ACTIVATED
1862 return false;
1863 }
1864 }
1865 return wxControl::MSWShouldPreProcessMessage(msg);
1866 }
1867
1868 bool wxListCtrl::MSWCommand(WXUINT cmd, WXWORD id_)
1869 {
1870 const int id = (signed short)id_;
1871 if (cmd == EN_UPDATE)
1872 {
1873 wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, id);
1874 event.SetEventObject( this );
1875 ProcessCommand(event);
1876 return true;
1877 }
1878 else if (cmd == EN_KILLFOCUS)
1879 {
1880 wxCommandEvent event(wxEVT_KILL_FOCUS, id);
1881 event.SetEventObject( this );
1882 ProcessCommand(event);
1883 return true;
1884 }
1885 else
1886 return false;
1887 }
1888
1889 // utility used by wxListCtrl::MSWOnNotify and by wxDataViewHeaderWindowMSW::MSWOnNotify
1890 int WXDLLIMPEXP_CORE wxMSWGetColumnClicked(NMHDR *nmhdr, POINT *ptClick)
1891 {
1892 // find the column clicked: we have to search for it ourselves as the
1893 // notification message doesn't provide this info
1894
1895 // where did the click occur?
1896 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
1897 if ( nmhdr->code == GN_CONTEXTMENU )
1898 {
1899 *ptClick = ((NMRGINFO*)nmhdr)->ptAction;
1900 }
1901 else
1902 #endif //__WXWINCE__
1903 {
1904 wxGetCursorPosMSW(ptClick);
1905 }
1906
1907 // we need to use listctrl coordinates for the event point so this is what
1908 // we return in ptClick, but for comparison with Header_GetItemRect()
1909 // result below we need to use header window coordinates
1910 POINT ptClickHeader = *ptClick;
1911 if ( !::ScreenToClient(nmhdr->hwndFrom, &ptClickHeader) )
1912 {
1913 wxLogLastError(wxT("ScreenToClient(listctrl header)"));
1914 }
1915
1916 if ( !::ScreenToClient(::GetParent(nmhdr->hwndFrom), ptClick) )
1917 {
1918 wxLogLastError(wxT("ScreenToClient(listctrl)"));
1919 }
1920
1921 const int colCount = Header_GetItemCount(nmhdr->hwndFrom);
1922 for ( int col = 0; col < colCount; col++ )
1923 {
1924 RECT rect;
1925 if ( Header_GetItemRect(nmhdr->hwndFrom, col, &rect) )
1926 {
1927 if ( ::PtInRect(&rect, ptClickHeader) )
1928 {
1929 return col;
1930 }
1931 }
1932 }
1933
1934 return wxNOT_FOUND;
1935 }
1936
1937 bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
1938 {
1939
1940 // prepare the event
1941 // -----------------
1942
1943 wxListEvent event(wxEVT_NULL, m_windowId);
1944 event.SetEventObject(this);
1945
1946 wxEventType eventType = wxEVT_NULL;
1947
1948 NMHDR *nmhdr = (NMHDR *)lParam;
1949
1950 // if your compiler is as broken as this, you should really change it: this
1951 // code is needed for normal operation! #ifdef below is only useful for
1952 // automatic rebuilds which are done with a very old compiler version
1953 #ifdef HDN_BEGINTRACKA
1954
1955 // check for messages from the header (in report view)
1956 HWND hwndHdr = ListView_GetHeader(GetHwnd());
1957
1958 // is it a message from the header?
1959 if ( nmhdr->hwndFrom == hwndHdr )
1960 {
1961 HD_NOTIFY *nmHDR = (HD_NOTIFY *)nmhdr;
1962
1963 event.m_itemIndex = -1;
1964
1965 bool ignore = false;
1966 switch ( nmhdr->code )
1967 {
1968 // yet another comctl32.dll bug: under NT/W2K it sends Unicode
1969 // TRACK messages even to ANSI programs: on my system I get
1970 // HDN_BEGINTRACKW and HDN_ENDTRACKA!
1971 //
1972 // work around is to simply catch both versions and hope that it
1973 // works (why should this message exist in ANSI and Unicode is
1974 // beyond me as it doesn't deal with strings at all...)
1975 //
1976 // another problem is that HDN_TRACK is not sent at all by header
1977 // with HDS_FULLDRAG style which is used by default by wxListCtrl
1978 // under recent Windows versions (starting from at least XP) so we
1979 // need to use HDN_ITEMCHANGING instead of it
1980 case HDN_BEGINTRACKA:
1981 case HDN_BEGINTRACKW:
1982 eventType = wxEVT_COMMAND_LIST_COL_BEGIN_DRAG;
1983 // fall through
1984
1985 case HDN_ITEMCHANGING:
1986 if ( eventType == wxEVT_NULL )
1987 {
1988 if ( !nmHDR->pitem || !(nmHDR->pitem->mask & HDI_WIDTH) )
1989 {
1990 // something other than the width is being changed,
1991 // ignore it
1992 ignore = true;
1993 break;
1994 }
1995
1996 // also ignore the events sent when the width didn't really
1997 // change: this is not just an optimization but also gets
1998 // rid of a useless and unexpected DRAGGING event which
1999 // would otherwise be sent after the END_DRAG one as we get
2000 // an HDN_ITEMCHANGING after HDN_ENDTRACK for some reason
2001 if ( nmHDR->pitem->cxy == GetColumnWidth(nmHDR->iItem) )
2002 {
2003 ignore = true;
2004 break;
2005 }
2006
2007 eventType = wxEVT_COMMAND_LIST_COL_DRAGGING;
2008 }
2009 // fall through
2010
2011 case HDN_ENDTRACKA:
2012 case HDN_ENDTRACKW:
2013 if ( eventType == wxEVT_NULL )
2014 eventType = wxEVT_COMMAND_LIST_COL_END_DRAG;
2015
2016 event.m_item.m_width = nmHDR->pitem->cxy;
2017 event.m_col = nmHDR->iItem;
2018 break;
2019
2020 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
2021 case GN_CONTEXTMENU:
2022 #endif //__WXWINCE__
2023 case NM_RCLICK:
2024 {
2025 POINT ptClick;
2026
2027 eventType = wxEVT_COMMAND_LIST_COL_RIGHT_CLICK;
2028 event.m_col = wxMSWGetColumnClicked(nmhdr, &ptClick);
2029 event.m_pointDrag.x = ptClick.x;
2030 event.m_pointDrag.y = ptClick.y;
2031 }
2032 break;
2033
2034 case HDN_GETDISPINFOW:
2035 // letting Windows XP handle this message results in mysterious
2036 // crashes in comctl32.dll seemingly because of bad message
2037 // parameters
2038 //
2039 // I have no idea what is the real cause of the bug (which is,
2040 // just to make things interesting, impossible to reproduce
2041 // reliably) but ignoring all these messages does fix it and
2042 // doesn't seem to have any negative consequences
2043 return true;
2044
2045 default:
2046 ignore = true;
2047 }
2048
2049 if ( ignore )
2050 return wxControl::MSWOnNotify(idCtrl, lParam, result);
2051 }
2052 else
2053 #endif // defined(HDN_BEGINTRACKA)
2054 if ( nmhdr->hwndFrom == GetHwnd() )
2055 {
2056 // almost all messages use NM_LISTVIEW
2057 NM_LISTVIEW *nmLV = (NM_LISTVIEW *)nmhdr;
2058
2059 const int iItem = nmLV->iItem;
2060
2061
2062 // If we have a valid item then check if there is a data value
2063 // associated with it and put it in the event.
2064 if ( iItem >= 0 && iItem < GetItemCount() )
2065 {
2066 wxMSWListItemData *internaldata =
2067 MSWGetItemData(iItem);
2068
2069 if ( internaldata )
2070 event.m_item.m_data = internaldata->lParam;
2071 }
2072
2073 bool processed = true;
2074 switch ( nmhdr->code )
2075 {
2076 case LVN_BEGINRDRAG:
2077 eventType = wxEVT_COMMAND_LIST_BEGIN_RDRAG;
2078 // fall through
2079
2080 case LVN_BEGINDRAG:
2081 if ( eventType == wxEVT_NULL )
2082 {
2083 eventType = wxEVT_COMMAND_LIST_BEGIN_DRAG;
2084 }
2085
2086 event.m_itemIndex = iItem;
2087 event.m_pointDrag.x = nmLV->ptAction.x;
2088 event.m_pointDrag.y = nmLV->ptAction.y;
2089 break;
2090
2091 // NB: we have to handle both *A and *W versions here because some
2092 // versions of comctl32.dll send ANSI messages even to the
2093 // Unicode windows
2094 case LVN_BEGINLABELEDITA:
2095 case LVN_BEGINLABELEDITW:
2096 {
2097 wxLV_ITEM item;
2098 if ( nmhdr->code == LVN_BEGINLABELEDITA )
2099 {
2100 item.Init(((LV_DISPINFOA *)lParam)->item);
2101 }
2102 else // LVN_BEGINLABELEDITW
2103 {
2104 item.Init(((LV_DISPINFOW *)lParam)->item);
2105 }
2106
2107 eventType = wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT;
2108 wxConvertFromMSWListItem(GetHwnd(), event.m_item, item);
2109 event.m_itemIndex = event.m_item.m_itemId;
2110 }
2111 break;
2112
2113 case LVN_ENDLABELEDITA:
2114 case LVN_ENDLABELEDITW:
2115 {
2116 wxLV_ITEM item;
2117 if ( nmhdr->code == LVN_ENDLABELEDITA )
2118 {
2119 item.Init(((LV_DISPINFOA *)lParam)->item);
2120 }
2121 else // LVN_ENDLABELEDITW
2122 {
2123 item.Init(((LV_DISPINFOW *)lParam)->item);
2124 }
2125
2126 // was editing cancelled?
2127 const LV_ITEM& lvi = (LV_ITEM)item;
2128 if ( !lvi.pszText || lvi.iItem == -1 )
2129 {
2130 // EDIT control will be deleted by the list control
2131 // itself so prevent us from deleting it as well
2132 DeleteEditControl();
2133
2134 event.SetEditCanceled(true);
2135 }
2136
2137 eventType = wxEVT_COMMAND_LIST_END_LABEL_EDIT;
2138 wxConvertFromMSWListItem(NULL, event.m_item, item);
2139 event.m_itemIndex = event.m_item.m_itemId;
2140 }
2141 break;
2142
2143 case LVN_COLUMNCLICK:
2144 eventType = wxEVT_COMMAND_LIST_COL_CLICK;
2145 event.m_itemIndex = -1;
2146 event.m_col = nmLV->iSubItem;
2147 break;
2148
2149 case LVN_DELETEALLITEMS:
2150 eventType = wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS;
2151 event.m_itemIndex = -1;
2152 break;
2153
2154 case LVN_DELETEITEM:
2155 if ( m_count == 0 )
2156 {
2157 // this should be prevented by the post-processing code
2158 // below, but "just in case"
2159 return false;
2160 }
2161
2162 eventType = wxEVT_COMMAND_LIST_DELETE_ITEM;
2163 event.m_itemIndex = iItem;
2164
2165 break;
2166
2167 case LVN_INSERTITEM:
2168 eventType = wxEVT_COMMAND_LIST_INSERT_ITEM;
2169 event.m_itemIndex = iItem;
2170 break;
2171
2172 case LVN_ITEMCHANGED:
2173 // we translate this catch all message into more interesting
2174 // (and more easy to process) wxWidgets events
2175
2176 // first of all, we deal with the state change events only and
2177 // only for valid items (item == -1 for the virtual list
2178 // control)
2179 if ( nmLV->uChanged & LVIF_STATE && iItem != -1 )
2180 {
2181 // temp vars for readability
2182 const UINT stOld = nmLV->uOldState;
2183 const UINT stNew = nmLV->uNewState;
2184
2185 event.m_item.SetId(iItem);
2186 event.m_item.SetMask(wxLIST_MASK_TEXT |
2187 wxLIST_MASK_IMAGE |
2188 wxLIST_MASK_DATA);
2189 GetItem(event.m_item);
2190
2191 // has the focus changed?
2192 if ( !(stOld & LVIS_FOCUSED) && (stNew & LVIS_FOCUSED) )
2193 {
2194 eventType = wxEVT_COMMAND_LIST_ITEM_FOCUSED;
2195 event.m_itemIndex = iItem;
2196 }
2197
2198 if ( (stNew & LVIS_SELECTED) != (stOld & LVIS_SELECTED) )
2199 {
2200 if ( eventType != wxEVT_NULL )
2201 {
2202 // focus and selection have both changed: send the
2203 // focus event from here and the selection one
2204 // below
2205 event.SetEventType(eventType);
2206 (void)HandleWindowEvent(event);
2207 }
2208 else // no focus event to send
2209 {
2210 // then need to set m_itemIndex as it wasn't done
2211 // above
2212 event.m_itemIndex = iItem;
2213 }
2214
2215 eventType = stNew & LVIS_SELECTED
2216 ? wxEVT_COMMAND_LIST_ITEM_SELECTED
2217 : wxEVT_COMMAND_LIST_ITEM_DESELECTED;
2218 }
2219 }
2220
2221 if ( eventType == wxEVT_NULL )
2222 {
2223 // not an interesting event for us
2224 return false;
2225 }
2226
2227 break;
2228
2229 case LVN_KEYDOWN:
2230 {
2231 LV_KEYDOWN *info = (LV_KEYDOWN *)lParam;
2232 WORD wVKey = info->wVKey;
2233
2234 // get the current selection
2235 long lItem = GetNextItem(-1,
2236 wxLIST_NEXT_ALL,
2237 wxLIST_STATE_SELECTED);
2238
2239 // <Enter> or <Space> activate the selected item if any (but
2240 // not with any modifiers as they have a predefined meaning
2241 // then)
2242 if ( lItem != -1 &&
2243 (wVKey == VK_RETURN || wVKey == VK_SPACE) &&
2244 !wxIsAnyModifierDown() )
2245 {
2246 eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED;
2247 }
2248 else
2249 {
2250 eventType = wxEVT_COMMAND_LIST_KEY_DOWN;
2251
2252 event.m_code = wxMSWKeyboard::VKToWX(wVKey);
2253
2254 if ( event.m_code == WXK_NONE )
2255 {
2256 // We can't translate this to a standard key code,
2257 // until support for Unicode key codes is added to
2258 // wxListEvent we just ignore them.
2259 return false;
2260 }
2261 }
2262
2263 event.m_itemIndex =
2264 event.m_item.m_itemId = lItem;
2265
2266 if ( lItem != -1 )
2267 {
2268 // fill the other fields too
2269 event.m_item.m_text = GetItemText(lItem);
2270 event.m_item.m_data = GetItemData(lItem);
2271 }
2272 }
2273 break;
2274
2275 case NM_DBLCLK:
2276 // if the user processes it in wxEVT_COMMAND_LEFT_CLICK(), don't do
2277 // anything else
2278 if ( wxControl::MSWOnNotify(idCtrl, lParam, result) )
2279 {
2280 return true;
2281 }
2282
2283 // else translate it into wxEVT_COMMAND_LIST_ITEM_ACTIVATED event
2284 // if it happened on an item (and not on empty place)
2285 if ( iItem == -1 )
2286 {
2287 // not on item
2288 return false;
2289 }
2290
2291 eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED;
2292 event.m_itemIndex = iItem;
2293 event.m_item.m_text = GetItemText(iItem);
2294 event.m_item.m_data = GetItemData(iItem);
2295 break;
2296
2297 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
2298 case GN_CONTEXTMENU:
2299 #endif //__WXWINCE__
2300 case NM_RCLICK:
2301 // if the user processes it in wxEVT_COMMAND_RIGHT_CLICK(),
2302 // don't do anything else
2303 if ( wxControl::MSWOnNotify(idCtrl, lParam, result) )
2304 {
2305 return true;
2306 }
2307
2308 // else translate it into wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK event
2309 LV_HITTESTINFO lvhti;
2310 wxZeroMemory(lvhti);
2311
2312 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
2313 if ( nmhdr->code == GN_CONTEXTMENU )
2314 {
2315 lvhti.pt = ((NMRGINFO*)nmhdr)->ptAction;
2316 }
2317 else
2318 #endif //__WXWINCE__
2319 {
2320 wxGetCursorPosMSW(&(lvhti.pt));
2321 }
2322
2323 ::ScreenToClient(GetHwnd(), &lvhti.pt);
2324 if ( ListView_HitTest(GetHwnd(), &lvhti) != -1 )
2325 {
2326 if ( lvhti.flags & LVHT_ONITEM )
2327 {
2328 eventType = wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK;
2329 event.m_itemIndex = lvhti.iItem;
2330 event.m_pointDrag.x = lvhti.pt.x;
2331 event.m_pointDrag.y = lvhti.pt.y;
2332 }
2333 }
2334 break;
2335
2336 #ifdef NM_CUSTOMDRAW
2337 case NM_CUSTOMDRAW:
2338 *result = OnCustomDraw(lParam);
2339
2340 return *result != CDRF_DODEFAULT;
2341 #endif // _WIN32_IE >= 0x300
2342
2343 case LVN_ODCACHEHINT:
2344 {
2345 const NM_CACHEHINT *cacheHint = (NM_CACHEHINT *)lParam;
2346
2347 eventType = wxEVT_COMMAND_LIST_CACHE_HINT;
2348
2349 // we get some really stupid cache hints like ones for
2350 // items in range 0..0 for an empty control or, after
2351 // deleting an item, for items in invalid range -- filter
2352 // this garbage out
2353 if ( cacheHint->iFrom > cacheHint->iTo )
2354 return false;
2355
2356 event.m_oldItemIndex = cacheHint->iFrom;
2357
2358 const long iMax = GetItemCount();
2359 event.m_itemIndex = cacheHint->iTo < iMax ? cacheHint->iTo
2360 : iMax - 1;
2361 }
2362 break;
2363
2364 #ifdef HAVE_NMLVFINDITEM
2365 case LVN_ODFINDITEM:
2366 // Find an item in a (necessarily virtual) list control.
2367 if ( IsVirtual() )
2368 {
2369 NMLVFINDITEM* pFindInfo = (NMLVFINDITEM*)lParam;
2370
2371 // no match by default
2372 *result = -1;
2373
2374 // we only handle string-based searches here
2375 //
2376 // TODO: what about LVFI_PARTIAL, should we handle this?
2377 if ( !(pFindInfo->lvfi.flags & LVFI_STRING) )
2378 {
2379 return false;
2380 }
2381
2382 const wxChar * const searchstr = pFindInfo->lvfi.psz;
2383 const size_t len = wxStrlen(searchstr);
2384
2385 // this is the first item we should examine, search from it
2386 // wrapping if necessary
2387 int startPos = pFindInfo->iStart;
2388 const int maxPos = GetItemCount();
2389
2390 // Check that the index is valid to ensure that our loop
2391 // below always terminates.
2392 if ( startPos < 0 || startPos >= maxPos )
2393 {
2394 // When the last item in the control is selected,
2395 // iStart is really set to (invalid) maxPos index so
2396 // accept this silently.
2397 if ( startPos != maxPos )
2398 {
2399 wxLogDebug(wxT("Ignoring invalid search start ")
2400 wxT("position %d in list control with ")
2401 wxT("%d items."), startPos, maxPos);
2402 }
2403
2404 startPos = 0;
2405 }
2406
2407 // Linear search in a control with a lot of items can take
2408 // a long time so we limit the total time of the search to
2409 // ensure that the program doesn't appear to hang.
2410 #if wxUSE_STOPWATCH
2411 wxStopWatch sw;
2412 #endif // wxUSE_STOPWATCH
2413 for ( int currentPos = startPos; ; )
2414 {
2415 // does this item begin with searchstr?
2416 if ( wxStrnicmp(searchstr,
2417 GetItemText(currentPos), len) == 0 )
2418 {
2419 *result = currentPos;
2420 break;
2421 }
2422
2423 // Go to next item with wrapping if necessary.
2424 if ( ++currentPos == maxPos )
2425 {
2426 // Surprisingly, LVFI_WRAP seems to be never set in
2427 // the flags so wrap regardless of it.
2428 currentPos = 0;
2429 }
2430
2431 if ( currentPos == startPos )
2432 {
2433 // We examined all items without finding anything.
2434 //
2435 // Notice that we still return true as we did
2436 // perform the search, if we didn't do this the
2437 // message would have been considered unhandled and
2438 // the control seems to always select the first
2439 // item by default in this case.
2440 return true;
2441 }
2442
2443 #if wxUSE_STOPWATCH
2444 // Check the time elapsed only every thousand
2445 // iterations for performance reasons: if we did it
2446 // more often calling wxStopWatch::Time() could take
2447 // noticeable time on its own.
2448 if ( !((currentPos - startPos)%1000) )
2449 {
2450 // We use half a second to limit the search time
2451 // which is about as long as we can take without
2452 // annoying the user.
2453 if ( sw.Time() > 500 )
2454 {
2455 // As above, return true to prevent the control
2456 // from selecting the first item by default.
2457 return true;
2458 }
2459 }
2460 #endif // wxUSE_STOPWATCH
2461
2462 }
2463
2464 SetItemState(*result,
2465 wxLIST_STATE_SELECTED | wxLIST_STATE_FOCUSED,
2466 wxLIST_STATE_SELECTED | wxLIST_STATE_FOCUSED);
2467 EnsureVisible(*result);
2468 return true;
2469 }
2470 else
2471 {
2472 processed = false;
2473 }
2474 break;
2475 #endif // HAVE_NMLVFINDITEM
2476
2477 case LVN_GETDISPINFO:
2478 if ( IsVirtual() )
2479 {
2480 LV_DISPINFO *info = (LV_DISPINFO *)lParam;
2481
2482 LV_ITEM& lvi = info->item;
2483 long item = lvi.iItem;
2484
2485 if ( lvi.mask & LVIF_TEXT )
2486 {
2487 wxString text = OnGetItemText(item, lvi.iSubItem);
2488 wxStrlcpy(lvi.pszText, text.c_str(), lvi.cchTextMax);
2489 }
2490
2491 // see comment at the end of wxListCtrl::GetColumn()
2492 #ifdef NM_CUSTOMDRAW
2493 if ( lvi.mask & LVIF_IMAGE )
2494 {
2495 lvi.iImage = OnGetItemColumnImage(item, lvi.iSubItem);
2496 }
2497 #endif // NM_CUSTOMDRAW
2498
2499 // even though we never use LVM_SETCALLBACKMASK, we still
2500 // can get messages with LVIF_STATE in lvi.mask under Vista
2501 if ( lvi.mask & LVIF_STATE )
2502 {
2503 // we don't have anything to return from here...
2504 lvi.stateMask = 0;
2505 }
2506
2507 return true;
2508 }
2509 // fall through
2510
2511 default:
2512 processed = false;
2513 }
2514
2515 if ( !processed )
2516 return wxControl::MSWOnNotify(idCtrl, lParam, result);
2517 }
2518 else
2519 {
2520 // where did this one come from?
2521 return false;
2522 }
2523
2524 // process the event
2525 // -----------------
2526
2527 event.SetEventType(eventType);
2528
2529 // fill in the item before passing it to the event handler if we do have a
2530 // valid item index and haven't filled it yet (e.g. for LVN_ITEMCHANGED)
2531 // and we're not using a virtual control as in this case the program
2532 // already has the data anyhow and we don't want to call GetItem() for
2533 // potentially many items
2534 if ( event.m_itemIndex != -1 && !event.m_item.GetMask()
2535 && !IsVirtual() )
2536 {
2537 wxListItem& item = event.m_item;
2538
2539 item.SetId(event.m_itemIndex);
2540 item.SetMask(wxLIST_MASK_TEXT | wxLIST_MASK_IMAGE | wxLIST_MASK_DATA);
2541 GetItem(item);
2542 }
2543
2544 bool processed = HandleWindowEvent(event);
2545
2546 // post processing
2547 // ---------------
2548 switch ( nmhdr->code )
2549 {
2550 case LVN_DELETEALLITEMS:
2551 // always return true to suppress all additional LVN_DELETEITEM
2552 // notifications - this makes deleting all items from a list ctrl
2553 // much faster
2554 *result = TRUE;
2555
2556 // also, we may free all user data now (couldn't do it before as
2557 // the user should have access to it in OnDeleteAllItems() handler)
2558 FreeAllInternalData();
2559
2560 // the control is empty now, synchronize the cached number of items
2561 // with the real one
2562 m_count = 0;
2563 return true;
2564
2565 case LVN_DELETEITEM:
2566 // Delete the associated internal data. Notice that this can be
2567 // done only after the event has been handled as the data could be
2568 // accessed during the handling of the event.
2569 if ( wxMSWListItemData *data = MSWGetItemData(event.m_itemIndex) )
2570 {
2571 const unsigned count = m_internalData.size();
2572 for ( unsigned n = 0; n < count; n++ )
2573 {
2574 if ( m_internalData[n] == data )
2575 {
2576 m_internalData.erase(m_internalData.begin() + n);
2577 wxDELETE(data);
2578 break;
2579 }
2580 }
2581
2582 wxASSERT_MSG( !data, "invalid internal data pointer?" );
2583 }
2584 break;
2585
2586 case LVN_ENDLABELEDITA:
2587 case LVN_ENDLABELEDITW:
2588 // logic here is inverted compared to all the other messages
2589 *result = event.IsAllowed();
2590
2591 // EDIT control will be deleted by the list control itself so
2592 // prevent us from deleting it as well
2593 DeleteEditControl();
2594
2595 return true;
2596 }
2597
2598 if ( processed )
2599 *result = !event.IsAllowed();
2600
2601 return processed;
2602 }
2603
2604 // ----------------------------------------------------------------------------
2605 // custom draw stuff
2606 // ----------------------------------------------------------------------------
2607
2608 // see comment at the end of wxListCtrl::GetColumn()
2609 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
2610
2611 static RECT GetCustomDrawnItemRect(const NMCUSTOMDRAW& nmcd)
2612 {
2613 RECT rc;
2614 wxGetListCtrlItemRect(nmcd.hdr.hwndFrom, nmcd.dwItemSpec, LVIR_BOUNDS, rc);
2615
2616 RECT rcIcon;
2617 wxGetListCtrlItemRect(nmcd.hdr.hwndFrom, nmcd.dwItemSpec, LVIR_ICON, rcIcon);
2618
2619 // exclude the icon part, neither the selection background nor focus rect
2620 // should cover it
2621 rc.left = rcIcon.right;
2622
2623 return rc;
2624 }
2625
2626 static
2627 bool HandleSubItemPrepaint(LPNMLVCUSTOMDRAW pLVCD, HFONT hfont, int colCount)
2628 {
2629 NMCUSTOMDRAW& nmcd = pLVCD->nmcd;
2630
2631 HDC hdc = nmcd.hdc;
2632 HWND hwndList = nmcd.hdr.hwndFrom;
2633 const int col = pLVCD->iSubItem;
2634 const DWORD item = nmcd.dwItemSpec;
2635
2636 // the font must be valid, otherwise we wouldn't be painting the item at all
2637 SelectInHDC selFont(hdc, hfont);
2638
2639 // get the rectangle to paint
2640 int subitem = colCount ? col + 1 : col;
2641 RECT rc;
2642 wxGetListCtrlSubItemRect(hwndList, item, subitem, LVIR_BOUNDS, rc);
2643 rc.left += 6;
2644
2645 // get the image and text to draw
2646 wxChar text[512];
2647 LV_ITEM it;
2648 wxZeroMemory(it);
2649 it.mask = LVIF_TEXT | LVIF_IMAGE;
2650 it.iItem = item;
2651 it.iSubItem = col;
2652 it.pszText = text;
2653 it.cchTextMax = WXSIZEOF(text);
2654 ListView_GetItem(hwndList, &it);
2655
2656 HIMAGELIST himl = ListView_GetImageList(hwndList, LVSIL_SMALL);
2657 if ( himl && ImageList_GetImageCount(himl) )
2658 {
2659 if ( it.iImage != -1 )
2660 {
2661 ImageList_Draw(himl, it.iImage, hdc, rc.left, rc.top,
2662 nmcd.uItemState & CDIS_SELECTED ? ILD_SELECTED
2663 : ILD_TRANSPARENT);
2664 }
2665
2666 // notice that even if this item doesn't have any image, the list
2667 // control still leaves space for the image in the first column if the
2668 // image list is not empty (presumably so that items with and without
2669 // images align?)
2670 if ( it.iImage != -1 || it.iSubItem == 0 )
2671 {
2672 int wImage, hImage;
2673 ImageList_GetIconSize(himl, &wImage, &hImage);
2674
2675 rc.left += wImage + 2;
2676 }
2677 }
2678
2679 ::SetBkMode(hdc, TRANSPARENT);
2680
2681 UINT fmt = DT_SINGLELINE |
2682 #ifndef __WXWINCE__
2683 DT_WORD_ELLIPSIS |
2684 #endif // __WXWINCE__
2685 DT_NOPREFIX |
2686 DT_VCENTER;
2687
2688 LV_COLUMN lvCol;
2689 wxZeroMemory(lvCol);
2690 lvCol.mask = LVCF_FMT;
2691 if ( ListView_GetColumn(hwndList, col, &lvCol) )
2692 {
2693 switch ( lvCol.fmt & LVCFMT_JUSTIFYMASK )
2694 {
2695 case LVCFMT_LEFT:
2696 fmt |= DT_LEFT;
2697 break;
2698
2699 case LVCFMT_CENTER:
2700 fmt |= DT_CENTER;
2701 break;
2702
2703 case LVCFMT_RIGHT:
2704 fmt |= DT_RIGHT;
2705 break;
2706 }
2707 }
2708 //else: failed to get alignment, assume it's DT_LEFT (default)
2709
2710 DrawText(hdc, text, -1, &rc, fmt);
2711
2712 return true;
2713 }
2714
2715 static void HandleItemPostpaint(NMCUSTOMDRAW nmcd)
2716 {
2717 if ( nmcd.uItemState & CDIS_FOCUS )
2718 {
2719 RECT rc = GetCustomDrawnItemRect(nmcd);
2720
2721 // don't use the provided HDC, it's in some strange state by now
2722 ::DrawFocusRect(WindowHDC(nmcd.hdr.hwndFrom), &rc);
2723 }
2724 }
2725
2726 // pLVCD->clrText and clrTextBk should contain the colours to use
2727 static void HandleItemPaint(LPNMLVCUSTOMDRAW pLVCD, HFONT hfont)
2728 {
2729 NMCUSTOMDRAW& nmcd = pLVCD->nmcd; // just a shortcut
2730
2731 const HWND hwndList = nmcd.hdr.hwndFrom;
2732 const int item = nmcd.dwItemSpec;
2733
2734 // unfortunately we can't trust CDIS_SELECTED, it is often set even when
2735 // the item is not at all selected for some reason (comctl32 6), but we
2736 // also can't always trust ListView_GetItem() as it could return the old
2737 // item status if we're called just after the (de)selection, so remember
2738 // the last item to gain selection and also check for it here
2739 for ( int i = -1;; )
2740 {
2741 i = ListView_GetNextItem(hwndList, i, LVNI_SELECTED);
2742 if ( i == -1 )
2743 {
2744 nmcd.uItemState &= ~CDIS_SELECTED;
2745 break;
2746 }
2747
2748 if ( i == item )
2749 {
2750 nmcd.uItemState |= CDIS_SELECTED;
2751 break;
2752 }
2753 }
2754
2755 // same thing for CDIS_FOCUS (except simpler as there is only one of them)
2756 //
2757 // NB: cast is needed to work around the bug in mingw32 headers which don't
2758 // have it inside ListView_GetNextItem() itself (unlike SDK ones)
2759 if ( ::GetFocus() == hwndList &&
2760 ListView_GetNextItem(
2761 hwndList, static_cast<WPARAM>(-1), LVNI_FOCUSED) == item )
2762 {
2763 nmcd.uItemState |= CDIS_FOCUS;
2764 }
2765 else
2766 {
2767 nmcd.uItemState &= ~CDIS_FOCUS;
2768 }
2769
2770 if ( nmcd.uItemState & CDIS_SELECTED )
2771 {
2772 int syscolFg, syscolBg;
2773 if ( ::GetFocus() == hwndList )
2774 {
2775 syscolFg = COLOR_HIGHLIGHTTEXT;
2776 syscolBg = COLOR_HIGHLIGHT;
2777 }
2778 else // selected but unfocused
2779 {
2780 syscolFg = COLOR_WINDOWTEXT;
2781 syscolBg = COLOR_BTNFACE;
2782
2783 // don't grey out the icon in this case neither
2784 nmcd.uItemState &= ~CDIS_SELECTED;
2785 }
2786
2787 pLVCD->clrText = ::GetSysColor(syscolFg);
2788 pLVCD->clrTextBk = ::GetSysColor(syscolBg);
2789 }
2790 //else: not selected, use normal colours from pLVCD
2791
2792 HDC hdc = nmcd.hdc;
2793 RECT rc = GetCustomDrawnItemRect(nmcd);
2794
2795 ::SetTextColor(hdc, pLVCD->clrText);
2796 ::FillRect(hdc, &rc, AutoHBRUSH(pLVCD->clrTextBk));
2797
2798 // we could use CDRF_NOTIFYSUBITEMDRAW here but it results in weird repaint
2799 // problems so just draw everything except the focus rect from here instead
2800 const int colCount = Header_GetItemCount(ListView_GetHeader(hwndList));
2801 for ( int col = 0; col < colCount; col++ )
2802 {
2803 pLVCD->iSubItem = col;
2804 HandleSubItemPrepaint(pLVCD, hfont, colCount);
2805 }
2806
2807 HandleItemPostpaint(nmcd);
2808 }
2809
2810 static WXLPARAM HandleItemPrepaint(wxListCtrl *listctrl,
2811 LPNMLVCUSTOMDRAW pLVCD,
2812 wxListItemAttr *attr)
2813 {
2814 if ( !attr )
2815 {
2816 // nothing to do for this item
2817 return CDRF_DODEFAULT;
2818 }
2819
2820
2821 // set the colours to use for text drawing
2822 pLVCD->clrText = attr->HasTextColour()
2823 ? wxColourToRGB(attr->GetTextColour())
2824 : wxColourToRGB(listctrl->GetTextColour());
2825 pLVCD->clrTextBk = attr->HasBackgroundColour()
2826 ? wxColourToRGB(attr->GetBackgroundColour())
2827 : wxColourToRGB(listctrl->GetBackgroundColour());
2828
2829 // select the font if non default one is specified
2830 if ( attr->HasFont() )
2831 {
2832 wxFont font = attr->GetFont();
2833 if ( font.GetEncoding() != wxFONTENCODING_SYSTEM )
2834 {
2835 // the standard control ignores the font encoding/charset, at least
2836 // with recent comctl32.dll versions (5 and 6, it uses to work with
2837 // 4.something) so we have to draw the item entirely ourselves in
2838 // this case
2839 HandleItemPaint(pLVCD, GetHfontOf(font));
2840 return CDRF_SKIPDEFAULT;
2841 }
2842
2843 ::SelectObject(pLVCD->nmcd.hdc, GetHfontOf(font));
2844
2845 return CDRF_NEWFONT;
2846 }
2847
2848 return CDRF_DODEFAULT;
2849 }
2850
2851 WXLPARAM wxListCtrl::OnCustomDraw(WXLPARAM lParam)
2852 {
2853 LPNMLVCUSTOMDRAW pLVCD = (LPNMLVCUSTOMDRAW)lParam;
2854 NMCUSTOMDRAW& nmcd = pLVCD->nmcd;
2855 switch ( nmcd.dwDrawStage )
2856 {
2857 case CDDS_PREPAINT:
2858 // if we've got any items with non standard attributes,
2859 // notify us before painting each item
2860 //
2861 // for virtual controls, always suppose that we have attributes as
2862 // there is no way to check for this
2863 if ( IsVirtual() || m_hasAnyAttr )
2864 return CDRF_NOTIFYITEMDRAW;
2865 break;
2866
2867 case CDDS_ITEMPREPAINT:
2868 // get a message for each subitem
2869 return CDRF_NOTIFYITEMDRAW;
2870
2871 case CDDS_SUBITEM | CDDS_ITEMPREPAINT:
2872 const int item = nmcd.dwItemSpec;
2873 const int column = pLVCD->iSubItem;
2874
2875 // we get this message with item == 0 for an empty control, we
2876 // must ignore it as calling OnGetItemAttr() would be wrong
2877 if ( item < 0 || item >= GetItemCount() )
2878 break;
2879 // same for columns
2880 if ( column < 0 || column >= GetColumnCount() )
2881 break;
2882
2883 return HandleItemPrepaint(this, pLVCD, DoGetItemColumnAttr(item, column));
2884 }
2885
2886 return CDRF_DODEFAULT;
2887 }
2888
2889 #endif // NM_CUSTOMDRAW supported
2890
2891 // Necessary for drawing hrules and vrules, if specified
2892 void wxListCtrl::OnPaint(wxPaintEvent& event)
2893 {
2894 const int itemCount = GetItemCount();
2895 const bool drawHRules = HasFlag(wxLC_HRULES);
2896 const bool drawVRules = HasFlag(wxLC_VRULES);
2897
2898 if (!InReportView() || !(drawHRules || drawVRules) || !itemCount)
2899 {
2900 event.Skip();
2901 return;
2902 }
2903
2904 wxPaintDC dc(this);
2905
2906 wxControl::OnPaint(event);
2907
2908 // Reset the device origin since it may have been set
2909 dc.SetDeviceOrigin(0, 0);
2910
2911 wxPen pen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT));
2912 dc.SetPen(pen);
2913 dc.SetBrush(* wxTRANSPARENT_BRUSH);
2914
2915 wxSize clientSize = GetClientSize();
2916 wxRect itemRect;
2917
2918 if (drawHRules)
2919 {
2920 const long top = GetTopItem();
2921 for ( int i = top; i < top + GetCountPerPage() + 1; i++ )
2922 {
2923 if (GetItemRect(i, itemRect))
2924 {
2925 int cy = itemRect.GetTop();
2926 if (i != 0) // Don't draw the first one
2927 {
2928 dc.DrawLine(0, cy, clientSize.x, cy);
2929 }
2930 // Draw last line
2931 if (i == itemCount - 1)
2932 {
2933 cy = itemRect.GetBottom();
2934 dc.DrawLine(0, cy, clientSize.x, cy);
2935 break;
2936 }
2937 }
2938 }
2939 }
2940
2941 if (drawVRules)
2942 {
2943 wxRect firstItemRect;
2944 GetItemRect(0, firstItemRect);
2945
2946 if (GetItemRect(itemCount - 1, itemRect))
2947 {
2948 // this is a fix for bug 673394: erase the pixels which we would
2949 // otherwise leave on the screen
2950 static const int gap = 2;
2951 dc.SetPen(*wxTRANSPARENT_PEN);
2952 dc.SetBrush(wxBrush(GetBackgroundColour()));
2953 dc.DrawRectangle(0, firstItemRect.GetY() - gap,
2954 clientSize.GetWidth(), gap);
2955
2956 dc.SetPen(pen);
2957 dc.SetBrush(*wxTRANSPARENT_BRUSH);
2958
2959 const int numCols = GetColumnCount();
2960 wxVector<int> indexArray(numCols);
2961 if ( !ListView_GetColumnOrderArray(GetHwnd(),
2962 numCols,
2963 &indexArray[0]) )
2964 {
2965 wxFAIL_MSG( wxT("invalid column index array in OnPaint()") );
2966 return;
2967 }
2968
2969 int x = itemRect.GetX();
2970 for (int col = 0; col < numCols; col++)
2971 {
2972 int colWidth = GetColumnWidth(indexArray[col]);
2973 x += colWidth ;
2974 dc.DrawLine(x-1, firstItemRect.GetY() - gap,
2975 x-1, itemRect.GetBottom());
2976 }
2977 }
2978 }
2979 }
2980
2981 void wxListCtrl::OnCharHook(wxKeyEvent& event)
2982 {
2983 if ( GetEditControl() )
2984 {
2985 // We need to ensure that Escape is not stolen from the in-place editor
2986 // by the containing dialog.
2987 //
2988 // Notice that we don't have to care about Enter key here as we return
2989 // false from MSWShouldPreProcessMessage() for it.
2990 if ( event.GetKeyCode() == WXK_ESCAPE )
2991 {
2992 EndEditLabel(true /* cancel */);
2993
2994 // Don't call Skip() below.
2995 return;
2996 }
2997 }
2998
2999 event.Skip();
3000 }
3001
3002 WXLRESULT
3003 wxListCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
3004 {
3005 switch ( nMsg )
3006 {
3007 #ifdef WM_PRINT
3008 case WM_PRINT:
3009 // we should bypass our own WM_PRINT handling as we don't handle
3010 // PRF_CHILDREN flag, so leave it to the native control itself
3011 return MSWDefWindowProc(nMsg, wParam, lParam);
3012 #endif // WM_PRINT
3013
3014 case WM_CONTEXTMENU:
3015 // because this message is propagated upwards the child-parent
3016 // chain, we get it for the right clicks on the header window but
3017 // this is confusing in wx as right clicking there already
3018 // generates a separate wxEVT_COMMAND_LIST_COL_RIGHT_CLICK event
3019 // so just ignore them
3020 if ( (HWND)wParam == ListView_GetHeader(GetHwnd()) )
3021 return 0;
3022 //else: break
3023 }
3024
3025 return wxControl::MSWWindowProc(nMsg, wParam, lParam);
3026 }
3027
3028 // ----------------------------------------------------------------------------
3029 // virtual list controls
3030 // ----------------------------------------------------------------------------
3031
3032 wxString wxListCtrl::OnGetItemText(long WXUNUSED(item), long WXUNUSED(col)) const
3033 {
3034 // this is a pure virtual function, in fact - which is not really pure
3035 // because the controls which are not virtual don't need to implement it
3036 wxFAIL_MSG( wxT("wxListCtrl::OnGetItemText not supposed to be called") );
3037
3038 return wxEmptyString;
3039 }
3040
3041 int wxListCtrl::OnGetItemImage(long WXUNUSED(item)) const
3042 {
3043 wxCHECK_MSG(!GetImageList(wxIMAGE_LIST_SMALL),
3044 -1,
3045 wxT("List control has an image list, OnGetItemImage or OnGetItemColumnImage should be overridden."));
3046 return -1;
3047 }
3048
3049 int wxListCtrl::OnGetItemColumnImage(long item, long column) const
3050 {
3051 if (!column)
3052 return OnGetItemImage(item);
3053
3054 return -1;
3055 }
3056
3057 wxListItemAttr *wxListCtrl::OnGetItemAttr(long WXUNUSED_UNLESS_DEBUG(item)) const
3058 {
3059 wxASSERT_MSG( item >= 0 && item < GetItemCount(),
3060 wxT("invalid item index in OnGetItemAttr()") );
3061
3062 // no attributes by default
3063 return NULL;
3064 }
3065
3066 wxListItemAttr *wxListCtrl::DoGetItemColumnAttr(long item, long column) const
3067 {
3068 if ( IsVirtual() )
3069 return OnGetItemColumnAttr(item, column);
3070
3071 wxMSWListItemData * const data = MSWGetItemData(item);
3072 return data ? data->attr : NULL;
3073 }
3074
3075 void wxListCtrl::SetItemCount(long count)
3076 {
3077 wxASSERT_MSG( IsVirtual(), wxT("this is for virtual controls only") );
3078
3079 if ( !::SendMessage(GetHwnd(), LVM_SETITEMCOUNT, (WPARAM)count,
3080 LVSICF_NOSCROLL | LVSICF_NOINVALIDATEALL) )
3081 {
3082 wxLogLastError(wxT("ListView_SetItemCount"));
3083 }
3084 m_count = count;
3085 wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()),
3086 wxT("m_count should match ListView_GetItemCount"));
3087 }
3088
3089 void wxListCtrl::RefreshItem(long item)
3090 {
3091 RefreshItems(item, item);
3092 }
3093
3094 void wxListCtrl::RefreshItems(long itemFrom, long itemTo)
3095 {
3096 ListView_RedrawItems(GetHwnd(), itemFrom, itemTo);
3097 }
3098
3099 // ----------------------------------------------------------------------------
3100 // wxWin <-> MSW items conversions
3101 // ----------------------------------------------------------------------------
3102
3103 static void wxConvertFromMSWListItem(HWND hwndListCtrl,
3104 wxListItem& info,
3105 LV_ITEM& lvItem)
3106 {
3107 wxMSWListItemData *internaldata =
3108 (wxMSWListItemData *) lvItem.lParam;
3109
3110 if (internaldata)
3111 info.m_data = internaldata->lParam;
3112
3113 info.m_mask = 0;
3114 info.m_state = 0;
3115 info.m_stateMask = 0;
3116 info.m_itemId = lvItem.iItem;
3117
3118 long oldMask = lvItem.mask;
3119
3120 bool needText = false;
3121 if (hwndListCtrl != 0)
3122 {
3123 if ( lvItem.mask & LVIF_TEXT )
3124 needText = false;
3125 else
3126 needText = true;
3127
3128 if ( needText )
3129 {
3130 lvItem.pszText = new wxChar[513];
3131 lvItem.cchTextMax = 512;
3132 }
3133 lvItem.mask |= LVIF_TEXT | LVIF_IMAGE | LVIF_PARAM;
3134 ::SendMessage(hwndListCtrl, LVM_GETITEM, 0, (LPARAM)& lvItem);
3135 }
3136
3137 if ( lvItem.mask & LVIF_STATE )
3138 {
3139 info.m_mask |= wxLIST_MASK_STATE;
3140
3141 if ( lvItem.stateMask & LVIS_CUT)
3142 {
3143 info.m_stateMask |= wxLIST_STATE_CUT;
3144 if ( lvItem.state & LVIS_CUT )
3145 info.m_state |= wxLIST_STATE_CUT;
3146 }
3147 if ( lvItem.stateMask & LVIS_DROPHILITED)
3148 {
3149 info.m_stateMask |= wxLIST_STATE_DROPHILITED;
3150 if ( lvItem.state & LVIS_DROPHILITED )
3151 info.m_state |= wxLIST_STATE_DROPHILITED;
3152 }
3153 if ( lvItem.stateMask & LVIS_FOCUSED)
3154 {
3155 info.m_stateMask |= wxLIST_STATE_FOCUSED;
3156 if ( lvItem.state & LVIS_FOCUSED )
3157 info.m_state |= wxLIST_STATE_FOCUSED;
3158 }
3159 if ( lvItem.stateMask & LVIS_SELECTED)
3160 {
3161 info.m_stateMask |= wxLIST_STATE_SELECTED;
3162 if ( lvItem.state & LVIS_SELECTED )
3163 info.m_state |= wxLIST_STATE_SELECTED;
3164 }
3165 }
3166
3167 if ( lvItem.mask & LVIF_TEXT )
3168 {
3169 info.m_mask |= wxLIST_MASK_TEXT;
3170 info.m_text = lvItem.pszText;
3171 }
3172 if ( lvItem.mask & LVIF_IMAGE )
3173 {
3174 info.m_mask |= wxLIST_MASK_IMAGE;
3175 info.m_image = lvItem.iImage;
3176 }
3177 if ( lvItem.mask & LVIF_PARAM )
3178 info.m_mask |= wxLIST_MASK_DATA;
3179 if ( lvItem.mask & LVIF_DI_SETITEM )
3180 info.m_mask |= wxLIST_SET_ITEM;
3181 info.m_col = lvItem.iSubItem;
3182
3183 if (needText)
3184 {
3185 if (lvItem.pszText)
3186 delete[] lvItem.pszText;
3187 }
3188 lvItem.mask = oldMask;
3189 }
3190
3191 static void wxConvertToMSWFlags(long state, long stateMask, LV_ITEM& lvItem)
3192 {
3193 if (stateMask & wxLIST_STATE_CUT)
3194 {
3195 lvItem.stateMask |= LVIS_CUT;
3196 if (state & wxLIST_STATE_CUT)
3197 lvItem.state |= LVIS_CUT;
3198 }
3199 if (stateMask & wxLIST_STATE_DROPHILITED)
3200 {
3201 lvItem.stateMask |= LVIS_DROPHILITED;
3202 if (state & wxLIST_STATE_DROPHILITED)
3203 lvItem.state |= LVIS_DROPHILITED;
3204 }
3205 if (stateMask & wxLIST_STATE_FOCUSED)
3206 {
3207 lvItem.stateMask |= LVIS_FOCUSED;
3208 if (state & wxLIST_STATE_FOCUSED)
3209 lvItem.state |= LVIS_FOCUSED;
3210 }
3211 if (stateMask & wxLIST_STATE_SELECTED)
3212 {
3213 lvItem.stateMask |= LVIS_SELECTED;
3214 if (state & wxLIST_STATE_SELECTED)
3215 lvItem.state |= LVIS_SELECTED;
3216 }
3217 }
3218
3219 static void wxConvertToMSWListItem(const wxListCtrl *ctrl,
3220 const wxListItem& info,
3221 LV_ITEM& lvItem)
3222 {
3223 if ( ctrl->InReportView() )
3224 {
3225 wxASSERT_MSG( 0 <= info.m_col && info.m_col < ctrl->GetColumnCount(),
3226 "wxListCtrl column index out of bounds" );
3227 }
3228 else // not in report view
3229 {
3230 wxASSERT_MSG( info.m_col == 0, "columns only exist in report view" );
3231 }
3232
3233 lvItem.iItem = (int) info.m_itemId;
3234
3235 lvItem.iImage = info.m_image;
3236 lvItem.stateMask = 0;
3237 lvItem.state = 0;
3238 lvItem.mask = 0;
3239 lvItem.iSubItem = info.m_col;
3240
3241 if (info.m_mask & wxLIST_MASK_STATE)
3242 {
3243 lvItem.mask |= LVIF_STATE;
3244
3245 wxConvertToMSWFlags(info.m_state, info.m_stateMask, lvItem);
3246 }
3247
3248 if (info.m_mask & wxLIST_MASK_TEXT)
3249 {
3250 lvItem.mask |= LVIF_TEXT;
3251 if ( ctrl->HasFlag(wxLC_USER_TEXT) )
3252 {
3253 lvItem.pszText = LPSTR_TEXTCALLBACK;
3254 }
3255 else
3256 {
3257 // pszText is not const, hence the cast
3258 lvItem.pszText = (wxChar *)info.m_text.wx_str();
3259 if ( lvItem.pszText )
3260 lvItem.cchTextMax = info.m_text.length();
3261 else
3262 lvItem.cchTextMax = 0;
3263 }
3264 }
3265 if (info.m_mask & wxLIST_MASK_IMAGE)
3266 lvItem.mask |= LVIF_IMAGE;
3267 }
3268
3269 static void wxConvertToMSWListCol(HWND hwndList,
3270 int col,
3271 const wxListItem& item,
3272 LV_COLUMN& lvCol)
3273 {
3274 wxZeroMemory(lvCol);
3275
3276 if ( item.m_mask & wxLIST_MASK_TEXT )
3277 {
3278 lvCol.mask |= LVCF_TEXT;
3279 lvCol.pszText = (wxChar *)item.m_text.wx_str(); // cast is safe
3280 }
3281
3282 if ( item.m_mask & wxLIST_MASK_FORMAT )
3283 {
3284 lvCol.mask |= LVCF_FMT;
3285
3286 if ( item.m_format == wxLIST_FORMAT_LEFT )
3287 lvCol.fmt = LVCFMT_LEFT;
3288 else if ( item.m_format == wxLIST_FORMAT_RIGHT )
3289 lvCol.fmt = LVCFMT_RIGHT;
3290 else if ( item.m_format == wxLIST_FORMAT_CENTRE )
3291 lvCol.fmt = LVCFMT_CENTER;
3292 }
3293
3294 if ( item.m_mask & wxLIST_MASK_WIDTH )
3295 {
3296 lvCol.mask |= LVCF_WIDTH;
3297 if ( item.m_width == wxLIST_AUTOSIZE)
3298 lvCol.cx = LVSCW_AUTOSIZE;
3299 else if ( item.m_width == wxLIST_AUTOSIZE_USEHEADER)
3300 lvCol.cx = LVSCW_AUTOSIZE_USEHEADER;
3301 else
3302 lvCol.cx = item.m_width;
3303 }
3304
3305 // see comment at the end of wxListCtrl::GetColumn()
3306 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
3307 if ( item.m_mask & wxLIST_MASK_IMAGE )
3308 {
3309 if ( wxApp::GetComCtl32Version() >= 470 )
3310 {
3311 lvCol.mask |= LVCF_IMAGE;
3312
3313 // we use LVCFMT_BITMAP_ON_RIGHT because the images on the right
3314 // seem to be generally nicer than on the left and the generic
3315 // version only draws them on the right (we don't have a flag to
3316 // specify the image location anyhow)
3317 //
3318 // we don't use LVCFMT_COL_HAS_IMAGES because it doesn't seem to
3319 // make any difference in my tests -- but maybe we should?
3320 if ( item.m_image != -1 )
3321 {
3322 // as we're going to overwrite the format field, get its
3323 // current value first -- unless we want to overwrite it anyhow
3324 if ( !(lvCol.mask & LVCF_FMT) )
3325 {
3326 LV_COLUMN lvColOld;
3327 wxZeroMemory(lvColOld);
3328 lvColOld.mask = LVCF_FMT;
3329 if ( ListView_GetColumn(hwndList, col, &lvColOld) )
3330 {
3331 lvCol.fmt = lvColOld.fmt;
3332 }
3333
3334 lvCol.mask |= LVCF_FMT;
3335 }
3336
3337 lvCol.fmt |= LVCFMT_BITMAP_ON_RIGHT | LVCFMT_IMAGE;
3338 }
3339
3340 lvCol.iImage = item.m_image;
3341 }
3342 //else: it doesn't support item images anyhow
3343 }
3344 #endif // _WIN32_IE >= 0x0300
3345 }
3346
3347 #endif // wxUSE_LISTCTRL