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