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