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