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