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