Check for an image list before complaining in OnGetItemImage
[wxWidgets.git] / src / msw / listctrl.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/listctrl.cpp
3 // Purpose: wxListCtrl
4 // Author: Julian Smart
5 // Modified by:
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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
21 #pragma implementation "listctrl.h"
22 #pragma implementation "listctrlbase.h"
23 #endif
24
25 // For compilers that support precompilation, includes "wx.h".
26 #include "wx/wxprec.h"
27
28 #ifdef __BORLANDC__
29 #pragma hdrstop
30 #endif
31
32 #if wxUSE_LISTCTRL && defined(__WIN95__)
33
34 #ifndef WX_PRECOMP
35 #include "wx/app.h"
36 #include "wx/intl.h"
37 #include "wx/log.h"
38 #include "wx/settings.h"
39 #endif
40
41 #include "wx/textctrl.h"
42 #include "wx/imaglist.h"
43 #include "wx/listctrl.h"
44 #include "wx/dcclient.h"
45
46 #include "wx/msw/private.h"
47
48 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__)
49 #include <ole2.h>
50 #include <shellapi.h>
51 #if _WIN32_WCE < 400
52 #include <aygshell.h>
53 #endif
54 #endif
55
56 // include <commctrl.h> "properly"
57 #include "wx/msw/wrapcctl.h"
58
59 // ----------------------------------------------------------------------------
60 // private functions
61 // ----------------------------------------------------------------------------
62
63 // convert our state and mask flags to LV_ITEM constants
64 static void wxConvertToMSWFlags(long state, long mask, LV_ITEM& lvItem);
65
66 // convert wxListItem to LV_ITEM
67 static void wxConvertToMSWListItem(const wxListCtrl *ctrl,
68 const wxListItem& info, LV_ITEM& lvItem);
69
70 // convert LV_ITEM to wxListItem
71 static void wxConvertFromMSWListItem(HWND hwndListCtrl,
72 wxListItem& info,
73 /* const */ LV_ITEM& lvItem);
74
75 // convert our wxListItem to LV_COLUMN
76 static void wxConvertToMSWListCol(int col, const wxListItem& item,
77 LV_COLUMN& lvCol);
78
79 // ----------------------------------------------------------------------------
80 // private helper classes
81 // ----------------------------------------------------------------------------
82
83 // We have to handle both fooW and fooA notifications in several cases
84 // because of broken comctl32.dll and/or unicows.dll. This class is used to
85 // convert LV_ITEMA and LV_ITEMW to LV_ITEM (which is either LV_ITEMA or
86 // LV_ITEMW depending on wxUSE_UNICODE setting), so that it can be processed
87 // by wxConvertToMSWListItem().
88 #if wxUSE_UNICODE
89 #define LV_ITEM_NATIVE LV_ITEMW
90 #define LV_ITEM_OTHER LV_ITEMA
91
92 #define LV_CONV_TO_WX cMB2WX
93 #define LV_CONV_BUF wxMB2WXbuf
94 #else // ANSI
95 #define LV_ITEM_NATIVE LV_ITEMA
96 #define LV_ITEM_OTHER LV_ITEMW
97
98 #define LV_CONV_TO_WX cWC2WX
99 #define LV_CONV_BUF wxWC2WXbuf
100 #endif // Unicode/ANSI
101
102 class wxLV_ITEM
103 {
104 public:
105 // default ctor, use Init() later
106 wxLV_ITEM() { m_buf = NULL; m_pItem = NULL; }
107
108 // init without conversion
109 void Init(LV_ITEM_NATIVE& item)
110 {
111 wxASSERT_MSG( !m_pItem, _T("Init() called twice?") );
112
113 m_pItem = &item;
114 }
115
116 // init with conversion
117 void Init(LV_ITEM_OTHER& item)
118 {
119 // avoid unnecessary dynamic memory allocation, jjust make m_pItem
120 // point to our own m_item
121
122 // memcpy() can't work if the struct sizes are different
123 wxCOMPILE_TIME_ASSERT( sizeof(LV_ITEM_OTHER) == sizeof(LV_ITEM_NATIVE),
124 CodeCantWorkIfDiffSizes);
125
126 memcpy(&m_item, &item, sizeof(LV_ITEM_NATIVE));
127
128 // convert text from ANSI to Unicod if necessary
129 if ( (item.mask & LVIF_TEXT) && item.pszText )
130 {
131 m_buf = new LV_CONV_BUF(wxConvLocal.LV_CONV_TO_WX(item.pszText));
132 m_item.pszText = (wxChar *)m_buf->data();
133 }
134 }
135
136 // ctor without conversion
137 wxLV_ITEM(LV_ITEM_NATIVE& item) : m_buf(NULL), m_pItem(&item) { }
138
139 // ctor with conversion
140 wxLV_ITEM(LV_ITEM_OTHER& item) : m_buf(NULL)
141 {
142 Init(item);
143 }
144
145 ~wxLV_ITEM() { delete m_buf; }
146
147 // conversion to the real LV_ITEM
148 operator LV_ITEM_NATIVE&() const { return *m_pItem; }
149
150 private:
151 LV_CONV_BUF *m_buf;
152
153 LV_ITEM_NATIVE *m_pItem;
154 LV_ITEM_NATIVE m_item;
155
156 DECLARE_NO_COPY_CLASS(wxLV_ITEM)
157 };
158
159 ///////////////////////////////////////////////////////
160 // Problem:
161 // The MSW version had problems with SetTextColour() et
162 // al as the wxListItemAttr's were stored keyed on the
163 // item index. If a item was inserted anywhere but the end
164 // of the list the the text attributes (colour etc) for
165 // the following items were out of sync.
166 //
167 // Solution:
168 // Under MSW the only way to associate data with a List
169 // item independant of its position in the list is to
170 // store a pointer to it in its lParam attribute. However
171 // user programs are already using this (via the
172 // SetItemData() GetItemData() calls).
173 //
174 // However what we can do is store a pointer to a
175 // structure which contains the attributes we want *and*
176 // a lParam for the users data, e.g.
177 //
178 // class wxListItemInternalData
179 // {
180 // public:
181 // wxListItemAttr *attr;
182 // long lParam; // user data
183 // };
184 //
185 // To conserve memory, a wxListItemInternalData is
186 // only allocated for a LV_ITEM if text attributes or
187 // user data(lparam) are being set.
188
189
190 // class wxListItemInternalData
191 class wxListItemInternalData
192 {
193 public:
194 wxListItemAttr *attr;
195 LPARAM lParam; // user data
196
197 wxListItemInternalData() : attr(NULL), lParam(0) {}
198 ~wxListItemInternalData()
199 {
200 if (attr)
201 delete attr;
202 };
203
204 DECLARE_NO_COPY_CLASS(wxListItemInternalData)
205 };
206
207 // Get the internal data structure
208 static wxListItemInternalData *wxGetInternalData(HWND hwnd, long itemId);
209 static wxListItemInternalData *wxGetInternalData(const wxListCtrl *ctl, long itemId);
210 static wxListItemAttr *wxGetInternalDataAttr(wxListCtrl *ctl, long itemId);
211 static void wxDeleteInternalData(wxListCtrl* ctl, long itemId);
212
213
214 // ----------------------------------------------------------------------------
215 // events
216 // ----------------------------------------------------------------------------
217
218 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_DRAG)
219 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_RDRAG)
220 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT)
221 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_END_LABEL_EDIT)
222 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ITEM)
223 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS)
224 #if WXWIN_COMPATIBILITY_2_4
225 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_GET_INFO)
226 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_SET_INFO)
227 #endif
228 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_SELECTED)
229 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_DESELECTED)
230 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_KEY_DOWN)
231 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_INSERT_ITEM)
232 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_CLICK)
233 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_RIGHT_CLICK)
234 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_BEGIN_DRAG)
235 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_DRAGGING)
236 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_END_DRAG)
237 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK)
238 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK)
239 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_ACTIVATED)
240 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_FOCUSED)
241 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_CACHE_HINT)
242
243 #if wxUSE_EXTENDED_RTTI
244 WX_DEFINE_FLAGS( wxListCtrlStyle )
245
246 wxBEGIN_FLAGS( wxListCtrlStyle )
247 // new style border flags, we put them first to
248 // use them for streaming out
249 wxFLAGS_MEMBER(wxBORDER_SIMPLE)
250 wxFLAGS_MEMBER(wxBORDER_SUNKEN)
251 wxFLAGS_MEMBER(wxBORDER_DOUBLE)
252 wxFLAGS_MEMBER(wxBORDER_RAISED)
253 wxFLAGS_MEMBER(wxBORDER_STATIC)
254 wxFLAGS_MEMBER(wxBORDER_NONE)
255
256 // old style border flags
257 wxFLAGS_MEMBER(wxSIMPLE_BORDER)
258 wxFLAGS_MEMBER(wxSUNKEN_BORDER)
259 wxFLAGS_MEMBER(wxDOUBLE_BORDER)
260 wxFLAGS_MEMBER(wxRAISED_BORDER)
261 wxFLAGS_MEMBER(wxSTATIC_BORDER)
262 wxFLAGS_MEMBER(wxBORDER)
263
264 // standard window styles
265 wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
266 wxFLAGS_MEMBER(wxCLIP_CHILDREN)
267 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
268 wxFLAGS_MEMBER(wxWANTS_CHARS)
269 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
270 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
271 wxFLAGS_MEMBER(wxVSCROLL)
272 wxFLAGS_MEMBER(wxHSCROLL)
273
274 wxFLAGS_MEMBER(wxLC_LIST)
275 wxFLAGS_MEMBER(wxLC_REPORT)
276 wxFLAGS_MEMBER(wxLC_ICON)
277 wxFLAGS_MEMBER(wxLC_SMALL_ICON)
278 wxFLAGS_MEMBER(wxLC_ALIGN_TOP)
279 wxFLAGS_MEMBER(wxLC_ALIGN_LEFT)
280 wxFLAGS_MEMBER(wxLC_AUTOARRANGE)
281 wxFLAGS_MEMBER(wxLC_USER_TEXT)
282 wxFLAGS_MEMBER(wxLC_EDIT_LABELS)
283 wxFLAGS_MEMBER(wxLC_NO_HEADER)
284 wxFLAGS_MEMBER(wxLC_SINGLE_SEL)
285 wxFLAGS_MEMBER(wxLC_SORT_ASCENDING)
286 wxFLAGS_MEMBER(wxLC_SORT_DESCENDING)
287 wxFLAGS_MEMBER(wxLC_VIRTUAL)
288
289 wxEND_FLAGS( wxListCtrlStyle )
290
291 IMPLEMENT_DYNAMIC_CLASS_XTI(wxListCtrl, wxControl,"wx/listctrl.h")
292
293 wxBEGIN_PROPERTIES_TABLE(wxListCtrl)
294 wxEVENT_PROPERTY( TextUpdated , wxEVT_COMMAND_TEXT_UPDATED , wxCommandEvent )
295
296 wxPROPERTY_FLAGS( WindowStyle , wxListCtrlStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
297 wxEND_PROPERTIES_TABLE()
298
299 wxBEGIN_HANDLERS_TABLE(wxListCtrl)
300 wxEND_HANDLERS_TABLE()
301
302 wxCONSTRUCTOR_5( wxListCtrl , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size , long , WindowStyle )
303
304 /*
305 TODO : Expose more information of a list's layout etc. via appropriate objects (à la NotebookPageInfo)
306 */
307 #else
308 IMPLEMENT_DYNAMIC_CLASS(wxListCtrl, wxControl)
309 #endif
310
311 IMPLEMENT_DYNAMIC_CLASS(wxListView, wxListCtrl)
312 IMPLEMENT_DYNAMIC_CLASS(wxListItem, wxObject)
313
314 IMPLEMENT_DYNAMIC_CLASS(wxListEvent, wxNotifyEvent)
315
316 BEGIN_EVENT_TABLE(wxListCtrl, wxControl)
317 EVT_PAINT(wxListCtrl::OnPaint)
318 END_EVENT_TABLE()
319
320 // ============================================================================
321 // implementation
322 // ============================================================================
323
324 // ----------------------------------------------------------------------------
325 // wxListCtrl construction
326 // ----------------------------------------------------------------------------
327
328 void wxListCtrl::Init()
329 {
330 m_imageListNormal = NULL;
331 m_imageListSmall = NULL;
332 m_imageListState = NULL;
333 m_ownsImageListNormal = m_ownsImageListSmall = m_ownsImageListState = false;
334 m_colCount = 0;
335 m_count = 0;
336 m_ignoreChangeMessages = false;
337 m_textCtrl = NULL;
338 m_AnyInternalData = false;
339 m_hasAnyAttr = false;
340 }
341
342 bool wxListCtrl::Create(wxWindow *parent,
343 wxWindowID id,
344 const wxPoint& pos,
345 const wxSize& size,
346 long style,
347 const wxValidator& validator,
348 const wxString& name)
349 {
350 if ( !CreateControl(parent, id, pos, size, style, validator, name) )
351 return false;
352
353 if ( !MSWCreateControl(WC_LISTVIEW, _T(""), pos, size) )
354 return false;
355
356 // explicitly say that we want to use Unicode because otherwise we get ANSI
357 // versions of _some_ messages (notably LVN_GETDISPINFOA) in MSLU build
358 wxSetCCUnicodeFormat(GetHwnd());
359
360 // for comctl32.dll v 4.70+ we want to have this attribute because it's
361 // prettier (and also because wxGTK does it like this)
362 if ( InReportView() && wxTheApp->GetComCtl32Version() >= 470 )
363 {
364 ::SendMessage(GetHwnd(), LVM_SETEXTENDEDLISTVIEWSTYLE,
365 0, LVS_EX_FULLROWSELECT);
366 }
367
368 return true;
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 = wxTheApp->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 }
469 }
470
471 void wxListCtrl::FreeAllInternalData()
472 {
473 if (m_AnyInternalData)
474 {
475 int n = GetItemCount();
476
477 m_ignoreChangeMessages = true;
478 for (int i = 0; i < n; i++)
479 wxDeleteInternalData(this, i);
480 m_ignoreChangeMessages = false;
481
482 m_AnyInternalData = false;
483 }
484 }
485
486 wxListCtrl::~wxListCtrl()
487 {
488 FreeAllInternalData();
489
490 if ( m_textCtrl )
491 {
492 m_textCtrl->UnsubclassWin();
493 m_textCtrl->SetHWND(0);
494 delete m_textCtrl;
495 m_textCtrl = NULL;
496 }
497
498 if (m_ownsImageListNormal) delete m_imageListNormal;
499 if (m_ownsImageListSmall) delete m_imageListSmall;
500 if (m_ownsImageListState) delete m_imageListState;
501 }
502
503 // ----------------------------------------------------------------------------
504 // set/get/change style
505 // ----------------------------------------------------------------------------
506
507 // Add or remove a single window style
508 void wxListCtrl::SetSingleStyle(long style, bool add)
509 {
510 long flag = GetWindowStyleFlag();
511
512 // Get rid of conflicting styles
513 if ( add )
514 {
515 if ( style & wxLC_MASK_TYPE)
516 flag = flag & ~wxLC_MASK_TYPE;
517 if ( style & wxLC_MASK_ALIGN )
518 flag = flag & ~wxLC_MASK_ALIGN;
519 if ( style & wxLC_MASK_SORT )
520 flag = flag & ~wxLC_MASK_SORT;
521 }
522
523 if ( add )
524 flag |= style;
525 else
526 flag &= ~style;
527
528 SetWindowStyleFlag(flag);
529 }
530
531 // Set the whole window style
532 void wxListCtrl::SetWindowStyleFlag(long flag)
533 {
534 if ( flag != m_windowStyle )
535 {
536 m_windowStyle = flag;
537
538 UpdateStyle();
539
540 Refresh();
541 }
542 }
543
544 // ----------------------------------------------------------------------------
545 // accessors
546 // ----------------------------------------------------------------------------
547
548 /* static */ wxVisualAttributes
549 wxListCtrl::GetClassDefaultAttributes(wxWindowVariant variant)
550 {
551 wxVisualAttributes attrs = GetCompositeControlsDefaultAttributes(variant);
552
553 // common controls have their own default font
554 attrs.font = wxGetCCDefaultFont();
555
556 return attrs;
557 }
558
559 // Sets the foreground, i.e. text, colour
560 bool wxListCtrl::SetForegroundColour(const wxColour& col)
561 {
562 if ( !wxWindow::SetForegroundColour(col) )
563 return false;
564
565 ListView_SetTextColor(GetHwnd(), wxColourToRGB(col));
566
567 return true;
568 }
569
570 // Sets the background colour
571 bool wxListCtrl::SetBackgroundColour(const wxColour& col)
572 {
573 if ( !wxWindow::SetBackgroundColour(col) )
574 return false;
575
576 // we set the same colour for both the "empty" background and the items
577 // background
578 COLORREF color = wxColourToRGB(col);
579 ListView_SetBkColor(GetHwnd(), color);
580 ListView_SetTextBkColor(GetHwnd(), color);
581
582 return true;
583 }
584
585 // Gets information about this column
586 bool wxListCtrl::GetColumn(int col, wxListItem& item) const
587 {
588 LV_COLUMN lvCol;
589 wxZeroMemory(lvCol);
590
591 lvCol.mask = LVCF_WIDTH;
592
593 if ( item.m_mask & wxLIST_MASK_TEXT )
594 {
595 lvCol.mask |= LVCF_TEXT;
596 lvCol.pszText = new wxChar[513];
597 lvCol.cchTextMax = 512;
598 }
599
600 if ( item.m_mask & wxLIST_MASK_FORMAT )
601 {
602 lvCol.mask |= LVCF_FMT;
603 }
604
605 if ( item.m_mask & wxLIST_MASK_IMAGE )
606 {
607 lvCol.mask |= LVCF_IMAGE;
608 }
609
610 bool success = ListView_GetColumn(GetHwnd(), col, &lvCol) != 0;
611
612 // item.m_subItem = lvCol.iSubItem;
613 item.m_width = lvCol.cx;
614
615 if ( (item.m_mask & wxLIST_MASK_TEXT) && lvCol.pszText )
616 {
617 item.m_text = lvCol.pszText;
618 delete[] lvCol.pszText;
619 }
620
621 if ( item.m_mask & wxLIST_MASK_FORMAT )
622 {
623 switch (lvCol.fmt & LVCFMT_JUSTIFYMASK) {
624 case LVCFMT_LEFT:
625 item.m_format = wxLIST_FORMAT_LEFT;
626 break;
627 case LVCFMT_RIGHT:
628 item.m_format = wxLIST_FORMAT_RIGHT;
629 break;
630 case LVCFMT_CENTER:
631 item.m_format = wxLIST_FORMAT_CENTRE;
632 break;
633 default:
634 item.m_format = -1; // Unknown?
635 break;
636 }
637 }
638
639 // the column images were not supported in older versions but how to check
640 // for this? we can't use _WIN32_IE because we always define it to a very
641 // high value, so see if another symbol which is only defined starting from
642 // comctl32.dll 4.70 is available
643 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
644 if ( item.m_mask & wxLIST_MASK_IMAGE )
645 {
646 item.m_image = lvCol.iImage;
647 }
648 #endif // LVCOLUMN::iImage exists
649
650 return success;
651 }
652
653 // Sets information about this column
654 bool wxListCtrl::SetColumn(int col, wxListItem& item)
655 {
656 LV_COLUMN lvCol;
657 wxConvertToMSWListCol(col, item, lvCol);
658
659 return ListView_SetColumn(GetHwnd(), col, &lvCol) != 0;
660 }
661
662 // Gets the column width
663 int wxListCtrl::GetColumnWidth(int col) const
664 {
665 return ListView_GetColumnWidth(GetHwnd(), col);
666 }
667
668 // Sets the column width
669 bool wxListCtrl::SetColumnWidth(int col, int width)
670 {
671 int col2 = col;
672 if ( m_windowStyle & wxLC_LIST )
673 col2 = -1;
674
675 int width2 = width;
676 if ( width2 == wxLIST_AUTOSIZE)
677 width2 = LVSCW_AUTOSIZE;
678 else if ( width2 == wxLIST_AUTOSIZE_USEHEADER)
679 width2 = LVSCW_AUTOSIZE_USEHEADER;
680
681 return ListView_SetColumnWidth(GetHwnd(), col2, width2) != 0;
682 }
683
684 // Gets the number of items that can fit vertically in the
685 // visible area of the list control (list or report view)
686 // or the total number of items in the list control (icon
687 // or small icon view)
688 int wxListCtrl::GetCountPerPage() const
689 {
690 return ListView_GetCountPerPage(GetHwnd());
691 }
692
693 // Gets the edit control for editing labels.
694 wxTextCtrl* wxListCtrl::GetEditControl() const
695 {
696 return m_textCtrl;
697 }
698
699 // Gets information about the item
700 bool wxListCtrl::GetItem(wxListItem& info) const
701 {
702 LV_ITEM lvItem;
703 wxZeroMemory(lvItem);
704
705 lvItem.iItem = info.m_itemId;
706 lvItem.iSubItem = info.m_col;
707
708 if ( info.m_mask & wxLIST_MASK_TEXT )
709 {
710 lvItem.mask |= LVIF_TEXT;
711 lvItem.pszText = new wxChar[513];
712 lvItem.cchTextMax = 512;
713 }
714 else
715 {
716 lvItem.pszText = NULL;
717 }
718
719 if (info.m_mask & wxLIST_MASK_DATA)
720 lvItem.mask |= LVIF_PARAM;
721
722 if (info.m_mask & wxLIST_MASK_IMAGE)
723 lvItem.mask |= LVIF_IMAGE;
724
725 if ( info.m_mask & wxLIST_MASK_STATE )
726 {
727 lvItem.mask |= LVIF_STATE;
728 // the other bits are hardly interesting anyhow
729 lvItem.stateMask = LVIS_SELECTED | LVIS_FOCUSED;
730 }
731
732 bool success = ListView_GetItem((HWND)GetHWND(), &lvItem) != 0;
733 if ( !success )
734 {
735 wxLogError(_("Couldn't retrieve information about list control item %d."),
736 lvItem.iItem);
737 }
738 else
739 {
740 // give NULL as hwnd as we already have everything we need
741 wxConvertFromMSWListItem(NULL, info, lvItem);
742 }
743
744 if (lvItem.pszText)
745 delete[] lvItem.pszText;
746
747 return success;
748 }
749
750 // Sets information about the item
751 bool wxListCtrl::SetItem(wxListItem& info)
752 {
753 LV_ITEM item;
754 wxConvertToMSWListItem(this, info, item);
755
756 // we never update the lParam if it contains our pointer
757 // to the wxListItemInternalData structure
758 item.mask &= ~LVIF_PARAM;
759
760 // check if setting attributes or lParam
761 if (info.HasAttributes() || (info.m_mask & wxLIST_MASK_DATA))
762 {
763 // get internal item data
764 // perhaps a cache here ?
765 wxListItemInternalData *data = wxGetInternalData(this, info.m_itemId);
766
767 if (! data)
768 {
769 // need to set it
770 m_AnyInternalData = true;
771 data = new wxListItemInternalData();
772 item.lParam = (LPARAM) data;
773 item.mask |= LVIF_PARAM;
774 };
775
776
777 // user data
778 if (info.m_mask & wxLIST_MASK_DATA)
779 data->lParam = info.m_data;
780
781 // attributes
782 if (info.HasAttributes())
783 {
784 if (data->attr)
785 *data->attr = *info.GetAttributes();
786 else
787 data->attr = new wxListItemAttr(*info.GetAttributes());
788 };
789 };
790
791
792 // we could be changing only the attribute in which case we don't need to
793 // call ListView_SetItem() at all
794 if ( item.mask )
795 {
796 item.cchTextMax = 0;
797 if ( !ListView_SetItem(GetHwnd(), &item) )
798 {
799 wxLogDebug(_T("ListView_SetItem() failed"));
800
801 return false;
802 }
803 }
804
805 // we need to update the item immediately to show the new image
806 bool updateNow = (info.m_mask & wxLIST_MASK_IMAGE) != 0;
807
808 // check whether it has any custom attributes
809 if ( info.HasAttributes() )
810 {
811 m_hasAnyAttr = true;
812
813 // if the colour has changed, we must redraw the item
814 updateNow = true;
815 }
816
817 if ( updateNow )
818 {
819 // we need this to make the change visible right now
820 RefreshItem(item.iItem);
821 }
822
823 return true;
824 }
825
826 long wxListCtrl::SetItem(long index, int col, const wxString& label, int imageId)
827 {
828 wxListItem info;
829 info.m_text = label;
830 info.m_mask = wxLIST_MASK_TEXT;
831 info.m_itemId = index;
832 info.m_col = col;
833 if ( imageId > -1 )
834 {
835 info.m_image = imageId;
836 info.m_mask |= wxLIST_MASK_IMAGE;
837 }
838 return SetItem(info);
839 }
840
841
842 // Gets the item state
843 int wxListCtrl::GetItemState(long item, long stateMask) const
844 {
845 wxListItem info;
846
847 info.m_mask = wxLIST_MASK_STATE;
848 info.m_stateMask = stateMask;
849 info.m_itemId = item;
850
851 if (!GetItem(info))
852 return 0;
853
854 return info.m_state;
855 }
856
857 // Sets the item state
858 bool wxListCtrl::SetItemState(long item, long state, long stateMask)
859 {
860 // NB: don't use SetItem() here as it doesn't work with the virtual list
861 // controls
862 LV_ITEM lvItem;
863 wxZeroMemory(lvItem);
864
865 wxConvertToMSWFlags(state, stateMask, lvItem);
866
867 // for the virtual list controls we need to refresh the previously focused
868 // item manually when changing focus without changing selection
869 // programmatically because otherwise it keeps its focus rectangle until
870 // next repaint (yet another comctl32 bug)
871 long focusOld;
872 if ( IsVirtual() &&
873 (stateMask & wxLIST_STATE_FOCUSED) &&
874 (state & wxLIST_STATE_FOCUSED) )
875 {
876 focusOld = GetNextItem(-1, wxLIST_NEXT_ALL, wxLIST_STATE_FOCUSED);
877 }
878 else
879 {
880 focusOld = -1;
881 }
882
883 if ( !::SendMessage(GetHwnd(), LVM_SETITEMSTATE,
884 (WPARAM)item, (LPARAM)&lvItem) )
885 {
886 wxLogLastError(_T("ListView_SetItemState"));
887
888 return false;
889 }
890
891 if ( focusOld != -1 )
892 {
893 // no need to refresh the item if it was previously selected, it would
894 // only result in annoying flicker
895 if ( !(GetItemState(focusOld,
896 wxLIST_STATE_SELECTED) & wxLIST_STATE_SELECTED) )
897 {
898 RefreshItem(focusOld);
899 }
900 }
901
902 return true;
903 }
904
905 // Sets the item image
906 bool wxListCtrl::SetItemImage(long item, int image, int WXUNUSED(selImage))
907 {
908 wxListItem info;
909
910 info.m_mask = wxLIST_MASK_IMAGE;
911 info.m_image = image;
912 info.m_itemId = item;
913
914 return SetItem(info);
915 }
916
917 // Gets the item text
918 wxString wxListCtrl::GetItemText(long item) const
919 {
920 wxListItem info;
921
922 info.m_mask = wxLIST_MASK_TEXT;
923 info.m_itemId = item;
924
925 if (!GetItem(info))
926 return wxEmptyString;
927 return info.m_text;
928 }
929
930 // Sets the item text
931 void wxListCtrl::SetItemText(long item, const wxString& str)
932 {
933 wxListItem info;
934
935 info.m_mask = wxLIST_MASK_TEXT;
936 info.m_itemId = item;
937 info.m_text = str;
938
939 SetItem(info);
940 }
941
942 // Gets the item data
943 wxUIntPtr wxListCtrl::GetItemData(long item) const
944 {
945 wxListItem info;
946
947 info.m_mask = wxLIST_MASK_DATA;
948 info.m_itemId = item;
949
950 if (!GetItem(info))
951 return 0;
952 return info.m_data;
953 }
954
955 // Sets the item data
956 bool wxListCtrl::SetItemData(long item, long data)
957 {
958 wxListItem info;
959
960 info.m_mask = wxLIST_MASK_DATA;
961 info.m_itemId = item;
962 info.m_data = data;
963
964 return SetItem(info);
965 }
966
967 wxRect wxListCtrl::GetViewRect() const
968 {
969 wxASSERT_MSG( !HasFlag(wxLC_REPORT | wxLC_LIST),
970 _T("wxListCtrl::GetViewRect() only works in icon mode") );
971
972 RECT rc;
973 if ( !ListView_GetViewRect(GetHwnd(), &rc) )
974 {
975 wxLogDebug(_T("ListView_GetViewRect() failed."));
976
977 wxZeroMemory(rc);
978 }
979
980 wxRect rect;
981 wxCopyRECTToRect(rc, rect);
982
983 return rect;
984 }
985
986 // Gets the item rectangle
987 bool wxListCtrl::GetItemRect(long item, wxRect& rect, int code) const
988 {
989 RECT rectWin;
990
991 int codeWin;
992 if ( code == wxLIST_RECT_BOUNDS )
993 codeWin = LVIR_BOUNDS;
994 else if ( code == wxLIST_RECT_ICON )
995 codeWin = LVIR_ICON;
996 else if ( code == wxLIST_RECT_LABEL )
997 codeWin = LVIR_LABEL;
998 else
999 {
1000 wxFAIL_MSG( _T("incorrect code in GetItemRect()") );
1001
1002 codeWin = LVIR_BOUNDS;
1003 }
1004
1005 bool success = ListView_GetItemRect(GetHwnd(), (int) item, &rectWin, codeWin) != 0;
1006
1007 rect.x = rectWin.left;
1008 rect.y = rectWin.top;
1009 rect.width = rectWin.right - rectWin.left;
1010 rect.height = rectWin.bottom - rectWin.top;
1011
1012 return success;
1013 }
1014
1015 // Gets the item position
1016 bool wxListCtrl::GetItemPosition(long item, wxPoint& pos) const
1017 {
1018 POINT pt;
1019
1020 bool success = (ListView_GetItemPosition(GetHwnd(), (int) item, &pt) != 0);
1021
1022 pos.x = pt.x; pos.y = pt.y;
1023 return success;
1024 }
1025
1026 // Sets the item position.
1027 bool wxListCtrl::SetItemPosition(long item, const wxPoint& pos)
1028 {
1029 return (ListView_SetItemPosition(GetHwnd(), (int) item, pos.x, pos.y) != 0);
1030 }
1031
1032 // Gets the number of items in the list control
1033 int wxListCtrl::GetItemCount() const
1034 {
1035 return m_count;
1036 }
1037
1038 wxSize wxListCtrl::GetItemSpacing() const
1039 {
1040 const int spacing = ListView_GetItemSpacing(GetHwnd(), (BOOL)HasFlag(wxLC_SMALL_ICON));
1041
1042 return wxSize(LOWORD(spacing), HIWORD(spacing));
1043 }
1044
1045 int wxListCtrl::GetItemSpacing(bool isSmall) const
1046 {
1047 return ListView_GetItemSpacing(GetHwnd(), (BOOL) isSmall);
1048 }
1049
1050 void wxListCtrl::SetItemTextColour( long item, const wxColour &col )
1051 {
1052 wxListItem info;
1053 info.m_itemId = item;
1054 info.SetTextColour( col );
1055 SetItem( info );
1056 }
1057
1058 wxColour wxListCtrl::GetItemTextColour( long item ) const
1059 {
1060 wxColour col;
1061 wxListItemInternalData *data = wxGetInternalData(this, item);
1062 if ( data && data->attr )
1063 col = data->attr->GetTextColour();
1064
1065 return col;
1066 }
1067
1068 void wxListCtrl::SetItemBackgroundColour( long item, const wxColour &col )
1069 {
1070 wxListItem info;
1071 info.m_itemId = item;
1072 info.SetBackgroundColour( col );
1073 SetItem( info );
1074 }
1075
1076 wxColour wxListCtrl::GetItemBackgroundColour( long item ) const
1077 {
1078 wxColour col;
1079 wxListItemInternalData *data = wxGetInternalData(this, item);
1080 if ( data && data->attr )
1081 col = data->attr->GetBackgroundColour();
1082
1083 return col;
1084 }
1085
1086 // Gets the number of selected items in the list control
1087 int wxListCtrl::GetSelectedItemCount() const
1088 {
1089 return ListView_GetSelectedCount(GetHwnd());
1090 }
1091
1092 // Gets the text colour of the listview
1093 wxColour wxListCtrl::GetTextColour() const
1094 {
1095 COLORREF ref = ListView_GetTextColor(GetHwnd());
1096 wxColour col(GetRValue(ref), GetGValue(ref), GetBValue(ref));
1097 return col;
1098 }
1099
1100 // Sets the text colour of the listview
1101 void wxListCtrl::SetTextColour(const wxColour& col)
1102 {
1103 ListView_SetTextColor(GetHwnd(), PALETTERGB(col.Red(), col.Green(), col.Blue()));
1104 }
1105
1106 // Gets the index of the topmost visible item when in
1107 // list or report view
1108 long wxListCtrl::GetTopItem() const
1109 {
1110 return (long) ListView_GetTopIndex(GetHwnd());
1111 }
1112
1113 // Searches for an item, starting from 'item'.
1114 // 'geometry' is one of
1115 // wxLIST_NEXT_ABOVE/ALL/BELOW/LEFT/RIGHT.
1116 // 'state' is a state bit flag, one or more of
1117 // wxLIST_STATE_DROPHILITED/FOCUSED/SELECTED/CUT.
1118 // item can be -1 to find the first item that matches the
1119 // specified flags.
1120 // Returns the item or -1 if unsuccessful.
1121 long wxListCtrl::GetNextItem(long item, int geom, int state) const
1122 {
1123 long flags = 0;
1124
1125 if ( geom == wxLIST_NEXT_ABOVE )
1126 flags |= LVNI_ABOVE;
1127 if ( geom == wxLIST_NEXT_ALL )
1128 flags |= LVNI_ALL;
1129 if ( geom == wxLIST_NEXT_BELOW )
1130 flags |= LVNI_BELOW;
1131 if ( geom == wxLIST_NEXT_LEFT )
1132 flags |= LVNI_TOLEFT;
1133 if ( geom == wxLIST_NEXT_RIGHT )
1134 flags |= LVNI_TORIGHT;
1135
1136 if ( state & wxLIST_STATE_CUT )
1137 flags |= LVNI_CUT;
1138 if ( state & wxLIST_STATE_DROPHILITED )
1139 flags |= LVNI_DROPHILITED;
1140 if ( state & wxLIST_STATE_FOCUSED )
1141 flags |= LVNI_FOCUSED;
1142 if ( state & wxLIST_STATE_SELECTED )
1143 flags |= LVNI_SELECTED;
1144
1145 return (long) ListView_GetNextItem(GetHwnd(), item, flags);
1146 }
1147
1148
1149 wxImageList *wxListCtrl::GetImageList(int which) const
1150 {
1151 if ( which == wxIMAGE_LIST_NORMAL )
1152 {
1153 return m_imageListNormal;
1154 }
1155 else if ( which == wxIMAGE_LIST_SMALL )
1156 {
1157 return m_imageListSmall;
1158 }
1159 else if ( which == wxIMAGE_LIST_STATE )
1160 {
1161 return m_imageListState;
1162 }
1163 return NULL;
1164 }
1165
1166 void wxListCtrl::SetImageList(wxImageList *imageList, int which)
1167 {
1168 int flags = 0;
1169 if ( which == wxIMAGE_LIST_NORMAL )
1170 {
1171 flags = LVSIL_NORMAL;
1172 if (m_ownsImageListNormal) delete m_imageListNormal;
1173 m_imageListNormal = imageList;
1174 m_ownsImageListNormal = false;
1175 }
1176 else if ( which == wxIMAGE_LIST_SMALL )
1177 {
1178 flags = LVSIL_SMALL;
1179 if (m_ownsImageListSmall) delete m_imageListSmall;
1180 m_imageListSmall = imageList;
1181 m_ownsImageListSmall = false;
1182 }
1183 else if ( which == wxIMAGE_LIST_STATE )
1184 {
1185 flags = LVSIL_STATE;
1186 if (m_ownsImageListState) delete m_imageListState;
1187 m_imageListState = imageList;
1188 m_ownsImageListState = false;
1189 }
1190 ListView_SetImageList(GetHwnd(), (HIMAGELIST) imageList ? imageList->GetHIMAGELIST() : 0, flags);
1191 }
1192
1193 void wxListCtrl::AssignImageList(wxImageList *imageList, int which)
1194 {
1195 SetImageList(imageList, which);
1196 if ( which == wxIMAGE_LIST_NORMAL )
1197 m_ownsImageListNormal = true;
1198 else if ( which == wxIMAGE_LIST_SMALL )
1199 m_ownsImageListSmall = true;
1200 else if ( which == wxIMAGE_LIST_STATE )
1201 m_ownsImageListState = true;
1202 }
1203
1204 // ----------------------------------------------------------------------------
1205 // Operations
1206 // ----------------------------------------------------------------------------
1207
1208 // Arranges the items
1209 bool wxListCtrl::Arrange(int flag)
1210 {
1211 UINT code = 0;
1212 if ( flag == wxLIST_ALIGN_LEFT )
1213 code = LVA_ALIGNLEFT;
1214 else if ( flag == wxLIST_ALIGN_TOP )
1215 code = LVA_ALIGNTOP;
1216 else if ( flag == wxLIST_ALIGN_DEFAULT )
1217 code = LVA_DEFAULT;
1218 else if ( flag == wxLIST_ALIGN_SNAP_TO_GRID )
1219 code = LVA_SNAPTOGRID;
1220
1221 return (ListView_Arrange(GetHwnd(), code) != 0);
1222 }
1223
1224 // Deletes an item
1225 bool wxListCtrl::DeleteItem(long item)
1226 {
1227 if ( !ListView_DeleteItem(GetHwnd(), (int) item) )
1228 {
1229 wxLogLastError(_T("ListView_DeleteItem"));
1230 return false;
1231 }
1232
1233 m_count -= 1;
1234 wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()),
1235 wxT("m_count should match ListView_GetItemCount"));
1236
1237 // the virtual list control doesn't refresh itself correctly, help it
1238 if ( IsVirtual() )
1239 {
1240 // we need to refresh all the lines below the one which was deleted
1241 wxRect rectItem;
1242 if ( item > 0 && GetItemCount() )
1243 {
1244 GetItemRect(item - 1, rectItem);
1245 }
1246 else
1247 {
1248 rectItem.y =
1249 rectItem.height = 0;
1250 }
1251
1252 wxRect rectWin = GetRect();
1253 rectWin.height = rectWin.GetBottom() - rectItem.GetBottom();
1254 rectWin.y = rectItem.GetBottom();
1255
1256 RefreshRect(rectWin);
1257 }
1258
1259 return true;
1260 }
1261
1262 // Deletes all items
1263 bool wxListCtrl::DeleteAllItems()
1264 {
1265 return ListView_DeleteAllItems(GetHwnd()) != 0;
1266 }
1267
1268 // Deletes all items
1269 bool wxListCtrl::DeleteAllColumns()
1270 {
1271 while ( m_colCount > 0 )
1272 {
1273 if ( ListView_DeleteColumn(GetHwnd(), 0) == 0 )
1274 {
1275 wxLogLastError(wxT("ListView_DeleteColumn"));
1276
1277 return false;
1278 }
1279
1280 m_colCount--;
1281 }
1282
1283 wxASSERT_MSG( m_colCount == 0, wxT("no columns should be left") );
1284
1285 return true;
1286 }
1287
1288 // Deletes a column
1289 bool wxListCtrl::DeleteColumn(int col)
1290 {
1291 bool success = (ListView_DeleteColumn(GetHwnd(), col) != 0);
1292
1293 if ( success && (m_colCount > 0) )
1294 m_colCount --;
1295 return success;
1296 }
1297
1298 // Clears items, and columns if there are any.
1299 void wxListCtrl::ClearAll()
1300 {
1301 DeleteAllItems();
1302 if ( m_colCount > 0 )
1303 DeleteAllColumns();
1304 }
1305
1306 wxTextCtrl* wxListCtrl::EditLabel(long item, wxClassInfo* textControlClass)
1307 {
1308 wxASSERT( (textControlClass->IsKindOf(CLASSINFO(wxTextCtrl))) );
1309
1310 // ListView_EditLabel requires that the list has focus.
1311 SetFocus();
1312
1313 WXHWND hWnd = (WXHWND) ListView_EditLabel(GetHwnd(), item);
1314 if ( !hWnd )
1315 {
1316 // failed to start editing
1317 return NULL;
1318 }
1319
1320 // [re]create the text control wrapping the HWND we got
1321 if ( m_textCtrl )
1322 {
1323 m_textCtrl->UnsubclassWin();
1324 m_textCtrl->SetHWND(0);
1325 delete m_textCtrl;
1326 }
1327
1328 m_textCtrl = (wxTextCtrl *)textControlClass->CreateObject();
1329 m_textCtrl->SetHWND(hWnd);
1330 m_textCtrl->SubclassWin(hWnd);
1331 m_textCtrl->SetParent(this);
1332
1333 // we must disallow TABbing away from the control while the edit contol is
1334 // shown because this leaves it in some strange state (just try removing
1335 // this line and then pressing TAB while editing an item in listctrl
1336 // inside a panel)
1337 m_textCtrl->SetWindowStyle(m_textCtrl->GetWindowStyle() | wxTE_PROCESS_TAB);
1338
1339 return m_textCtrl;
1340 }
1341
1342 // End label editing, optionally cancelling the edit
1343 bool wxListCtrl::EndEditLabel(bool WXUNUSED(cancel))
1344 {
1345 wxFAIL_MSG( _T("not implemented") );
1346
1347 return false;
1348 }
1349
1350 // Ensures this item is visible
1351 bool wxListCtrl::EnsureVisible(long item)
1352 {
1353 return ListView_EnsureVisible(GetHwnd(), (int) item, FALSE) != FALSE;
1354 }
1355
1356 // Find an item whose label matches this string, starting from the item after 'start'
1357 // or the beginning if 'start' is -1.
1358 long wxListCtrl::FindItem(long start, const wxString& str, bool partial)
1359 {
1360 LV_FINDINFO findInfo;
1361
1362 findInfo.flags = LVFI_STRING;
1363 if ( partial )
1364 findInfo.flags |= LVFI_PARTIAL;
1365 findInfo.psz = str;
1366
1367 // ListView_FindItem() excludes the first item from search and to look
1368 // through all the items you need to start from -1 which is unnatural and
1369 // inconsistent with the generic version - so we adjust the index
1370 if (start != -1)
1371 start --;
1372 return ListView_FindItem(GetHwnd(), (int) start, &findInfo);
1373 }
1374
1375 // Find an item whose data matches this data, starting from the item after 'start'
1376 // or the beginning if 'start' is -1.
1377 // NOTE : Lindsay Mathieson - 14-July-2002
1378 // No longer use ListView_FindItem as the data attribute is now stored
1379 // in a wxListItemInternalData structure refernced by the actual lParam
1380 long wxListCtrl::FindItem(long start, wxUIntPtr data)
1381 {
1382 long idx = start + 1;
1383 long count = GetItemCount();
1384
1385 while (idx < count)
1386 {
1387 if (GetItemData(idx) == data)
1388 return idx;
1389 idx++;
1390 };
1391
1392 return -1;
1393 }
1394
1395 // Find an item nearest this position in the specified direction, starting from
1396 // the item after 'start' or the beginning if 'start' is -1.
1397 long wxListCtrl::FindItem(long start, const wxPoint& pt, int direction)
1398 {
1399 LV_FINDINFO findInfo;
1400
1401 findInfo.flags = LVFI_NEARESTXY;
1402 findInfo.pt.x = pt.x;
1403 findInfo.pt.y = pt.y;
1404 findInfo.vkDirection = VK_RIGHT;
1405
1406 if ( direction == wxLIST_FIND_UP )
1407 findInfo.vkDirection = VK_UP;
1408 else if ( direction == wxLIST_FIND_DOWN )
1409 findInfo.vkDirection = VK_DOWN;
1410 else if ( direction == wxLIST_FIND_LEFT )
1411 findInfo.vkDirection = VK_LEFT;
1412 else if ( direction == wxLIST_FIND_RIGHT )
1413 findInfo.vkDirection = VK_RIGHT;
1414
1415 return ListView_FindItem(GetHwnd(), (int) start, & findInfo);
1416 }
1417
1418 // Determines which item (if any) is at the specified point,
1419 // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
1420 long wxListCtrl::HitTest(const wxPoint& point, int& flags)
1421 {
1422 LV_HITTESTINFO hitTestInfo;
1423 hitTestInfo.pt.x = (int) point.x;
1424 hitTestInfo.pt.y = (int) point.y;
1425
1426 ListView_HitTest(GetHwnd(), & hitTestInfo);
1427
1428 flags = 0;
1429 if ( hitTestInfo.flags & LVHT_ABOVE )
1430 flags |= wxLIST_HITTEST_ABOVE;
1431 if ( hitTestInfo.flags & LVHT_BELOW )
1432 flags |= wxLIST_HITTEST_BELOW;
1433 if ( hitTestInfo.flags & LVHT_NOWHERE )
1434 flags |= wxLIST_HITTEST_NOWHERE;
1435 if ( hitTestInfo.flags & LVHT_ONITEMICON )
1436 flags |= wxLIST_HITTEST_ONITEMICON;
1437 if ( hitTestInfo.flags & LVHT_ONITEMLABEL )
1438 flags |= wxLIST_HITTEST_ONITEMLABEL;
1439 if ( hitTestInfo.flags & LVHT_ONITEMSTATEICON )
1440 flags |= wxLIST_HITTEST_ONITEMSTATEICON;
1441 if ( hitTestInfo.flags & LVHT_TOLEFT )
1442 flags |= wxLIST_HITTEST_TOLEFT;
1443 if ( hitTestInfo.flags & LVHT_TORIGHT )
1444 flags |= wxLIST_HITTEST_TORIGHT;
1445
1446 return (long) hitTestInfo.iItem;
1447 }
1448
1449 // Inserts an item, returning the index of the new item if successful,
1450 // -1 otherwise.
1451 long wxListCtrl::InsertItem(wxListItem& info)
1452 {
1453 wxASSERT_MSG( !IsVirtual(), _T("can't be used with virtual controls") );
1454
1455 LV_ITEM item;
1456 wxConvertToMSWListItem(this, info, item);
1457 item.mask &= ~LVIF_PARAM;
1458
1459 // check wether we need to allocate our internal data
1460 bool needInternalData = ((info.m_mask & wxLIST_MASK_DATA) || info.HasAttributes());
1461 if (needInternalData)
1462 {
1463 m_AnyInternalData = true;
1464 item.mask |= LVIF_PARAM;
1465
1466 // internal stucture that manages data
1467 wxListItemInternalData *data = new wxListItemInternalData();
1468 item.lParam = (LPARAM) data;
1469
1470 if (info.m_mask & wxLIST_MASK_DATA)
1471 data->lParam = info.m_data;
1472
1473 // check whether it has any custom attributes
1474 if ( info.HasAttributes() )
1475 {
1476 // take copy of attributes
1477 data->attr = new wxListItemAttr(*info.GetAttributes());
1478
1479 // and remember that we have some now...
1480 m_hasAnyAttr = true;
1481 }
1482 };
1483
1484 long rv = ListView_InsertItem(GetHwnd(), & item);
1485
1486 m_count++;
1487 wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()),
1488 wxT("m_count should match ListView_GetItemCount"));
1489
1490 return rv;
1491 }
1492
1493 long wxListCtrl::InsertItem(long index, const wxString& label)
1494 {
1495 wxListItem info;
1496 info.m_text = label;
1497 info.m_mask = wxLIST_MASK_TEXT;
1498 info.m_itemId = index;
1499 return InsertItem(info);
1500 }
1501
1502 // Inserts an image item
1503 long wxListCtrl::InsertItem(long index, int imageIndex)
1504 {
1505 wxListItem info;
1506 info.m_image = imageIndex;
1507 info.m_mask = wxLIST_MASK_IMAGE;
1508 info.m_itemId = index;
1509 return InsertItem(info);
1510 }
1511
1512 // Inserts an image/string item
1513 long wxListCtrl::InsertItem(long index, const wxString& label, int imageIndex)
1514 {
1515 wxListItem info;
1516 info.m_image = imageIndex;
1517 info.m_text = label;
1518 info.m_mask = wxLIST_MASK_IMAGE | wxLIST_MASK_TEXT;
1519 info.m_itemId = index;
1520 return InsertItem(info);
1521 }
1522
1523 // For list view mode (only), inserts a column.
1524 long wxListCtrl::InsertColumn(long col, wxListItem& item)
1525 {
1526 LV_COLUMN lvCol;
1527 wxConvertToMSWListCol(col, item, lvCol);
1528
1529 if ( !(lvCol.mask & LVCF_WIDTH) )
1530 {
1531 // always give some width to the new column: this one is compatible
1532 // with the generic version
1533 lvCol.mask |= LVCF_WIDTH;
1534 lvCol.cx = 80;
1535 }
1536
1537 long n = ListView_InsertColumn(GetHwnd(), col, &lvCol);
1538 if ( n != -1 )
1539 {
1540 m_colCount++;
1541 }
1542 else // failed to insert?
1543 {
1544 wxLogDebug(wxT("Failed to insert the column '%s' into listview!"),
1545 lvCol.pszText);
1546 }
1547
1548 return n;
1549 }
1550
1551 long wxListCtrl::InsertColumn(long col,
1552 const wxString& heading,
1553 int format,
1554 int width)
1555 {
1556 wxListItem item;
1557 item.m_mask = wxLIST_MASK_TEXT | wxLIST_MASK_FORMAT;
1558 item.m_text = heading;
1559 if ( width > -1 )
1560 {
1561 item.m_mask |= wxLIST_MASK_WIDTH;
1562 item.m_width = width;
1563 }
1564 item.m_format = format;
1565
1566 return InsertColumn(col, item);
1567 }
1568
1569 // scroll the control by the given number of pixels (exception: in list view,
1570 // dx is interpreted as number of columns)
1571 bool wxListCtrl::ScrollList(int dx, int dy)
1572 {
1573 if ( !ListView_Scroll(GetHwnd(), dx, dy) )
1574 {
1575 wxLogDebug(_T("ListView_Scroll(%d, %d) failed"), dx, dy);
1576
1577 return false;
1578 }
1579
1580 return true;
1581 }
1582
1583 // Sort items.
1584
1585 // fn is a function which takes 3 long arguments: item1, item2, data.
1586 // item1 is the long data associated with a first item (NOT the index).
1587 // item2 is the long data associated with a second item (NOT the index).
1588 // data is the same value as passed to SortItems.
1589 // The return value is a negative number if the first item should precede the second
1590 // item, a positive number of the second item should precede the first,
1591 // or zero if the two items are equivalent.
1592
1593 // data is arbitrary data to be passed to the sort function.
1594
1595 // Internal structures for proxying the user compare function
1596 // so that we can pass it the *real* user data
1597
1598 // translate lParam data and call user func
1599 struct wxInternalDataSort
1600 {
1601 wxListCtrlCompare user_fn;
1602 long data;
1603 };
1604
1605 int CALLBACK wxInternalDataCompareFunc(LPARAM lParam1, LPARAM lParam2, LPARAM lParamSort)
1606 {
1607 struct wxInternalDataSort *internalData = (struct wxInternalDataSort *) lParamSort;
1608
1609 wxListItemInternalData *data1 = (wxListItemInternalData *) lParam1;
1610 wxListItemInternalData *data2 = (wxListItemInternalData *) lParam2;
1611
1612 long d1 = (data1 == NULL ? 0 : data1->lParam);
1613 long d2 = (data2 == NULL ? 0 : data2->lParam);
1614
1615 return internalData->user_fn(d1, d2, internalData->data);
1616
1617 };
1618
1619 bool wxListCtrl::SortItems(wxListCtrlCompare fn, long data)
1620 {
1621 struct wxInternalDataSort internalData;
1622 internalData.user_fn = fn;
1623 internalData.data = data;
1624
1625 // WPARAM cast is needed for mingw/cygwin
1626 if ( !ListView_SortItems(GetHwnd(),
1627 wxInternalDataCompareFunc,
1628 (WPARAM) &internalData) )
1629 {
1630 wxLogDebug(_T("ListView_SortItems() failed"));
1631
1632 return false;
1633 }
1634
1635 return true;
1636 }
1637
1638
1639
1640 // ----------------------------------------------------------------------------
1641 // message processing
1642 // ----------------------------------------------------------------------------
1643
1644 bool wxListCtrl::MSWCommand(WXUINT cmd, WXWORD id)
1645 {
1646 if (cmd == EN_UPDATE)
1647 {
1648 wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, id);
1649 event.SetEventObject( this );
1650 ProcessCommand(event);
1651 return true;
1652 }
1653 else if (cmd == EN_KILLFOCUS)
1654 {
1655 wxCommandEvent event(wxEVT_KILL_FOCUS, id);
1656 event.SetEventObject( this );
1657 ProcessCommand(event);
1658 return true;
1659 }
1660 else
1661 return false;
1662 }
1663
1664 bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
1665 {
1666
1667 // prepare the event
1668 // -----------------
1669
1670 wxListEvent event(wxEVT_NULL, m_windowId);
1671 event.SetEventObject(this);
1672
1673 wxEventType eventType = wxEVT_NULL;
1674
1675 NMHDR *nmhdr = (NMHDR *)lParam;
1676
1677 // if your compiler is as broken as this, you should really change it: this
1678 // code is needed for normal operation! #ifdef below is only useful for
1679 // automatic rebuilds which are done with a very old compiler version
1680 #ifdef HDN_BEGINTRACKA
1681
1682 // check for messages from the header (in report view)
1683 HWND hwndHdr = ListView_GetHeader(GetHwnd());
1684
1685 // is it a message from the header?
1686 if ( nmhdr->hwndFrom == hwndHdr )
1687 {
1688 HD_NOTIFY *nmHDR = (HD_NOTIFY *)nmhdr;
1689
1690 event.m_itemIndex = -1;
1691
1692 switch ( nmhdr->code )
1693 {
1694 // yet another comctl32.dll bug: under NT/W2K it sends Unicode
1695 // TRACK messages even to ANSI programs: on my system I get
1696 // HDN_BEGINTRACKW and HDN_ENDTRACKA and no HDN_TRACK at all!
1697 //
1698 // work around is to simply catch both versions and hope that it
1699 // works (why should this message exist in ANSI and Unicode is
1700 // beyond me as it doesn't deal with strings at all...)
1701 //
1702 // note that fr HDN_TRACK another possibility could be to use
1703 // HDN_ITEMCHANGING but it is sent even after HDN_ENDTRACK and when
1704 // something other than the item width changes so we'd have to
1705 // filter out the unwanted events then
1706 case HDN_BEGINTRACKA:
1707 case HDN_BEGINTRACKW:
1708 eventType = wxEVT_COMMAND_LIST_COL_BEGIN_DRAG;
1709 // fall through
1710
1711 case HDN_TRACKA:
1712 case HDN_TRACKW:
1713 if ( eventType == wxEVT_NULL )
1714 eventType = wxEVT_COMMAND_LIST_COL_DRAGGING;
1715 // fall through
1716
1717 case HDN_ENDTRACKA:
1718 case HDN_ENDTRACKW:
1719 if ( eventType == wxEVT_NULL )
1720 eventType = wxEVT_COMMAND_LIST_COL_END_DRAG;
1721
1722 event.m_item.m_width = nmHDR->pitem->cxy;
1723 event.m_col = nmHDR->iItem;
1724 break;
1725
1726 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
1727 case GN_CONTEXTMENU:
1728 #endif //__WXWINCE__
1729 case NM_RCLICK:
1730 {
1731 eventType = wxEVT_COMMAND_LIST_COL_RIGHT_CLICK;
1732 event.m_col = -1;
1733
1734 // find the column clicked: we have to search for it
1735 // ourselves as the notification message doesn't provide
1736 // this info
1737
1738 // where did the click occur?
1739 POINT ptClick;
1740 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
1741 if(nmhdr->code == GN_CONTEXTMENU) {
1742 ptClick = ((NMRGINFO*)nmhdr)->ptAction;
1743 } else
1744 #endif //__WXWINCE__
1745 if ( !::GetCursorPos(&ptClick) )
1746 {
1747 wxLogLastError(_T("GetCursorPos"));
1748 }
1749
1750 if ( !::ScreenToClient(GetHwnd(), &ptClick) )
1751 {
1752 wxLogLastError(_T("ScreenToClient(listctrl header)"));
1753 }
1754
1755 event.m_pointDrag.x = ptClick.x;
1756 event.m_pointDrag.y = ptClick.y;
1757
1758 int colCount = Header_GetItemCount(hwndHdr);
1759
1760 RECT rect;
1761 for ( int col = 0; col < colCount; col++ )
1762 {
1763 if ( Header_GetItemRect(hwndHdr, col, &rect) )
1764 {
1765 if ( ::PtInRect(&rect, ptClick) )
1766 {
1767 event.m_col = col;
1768 break;
1769 }
1770 }
1771 }
1772 }
1773 break;
1774
1775 case HDN_GETDISPINFOW:
1776 // letting Windows XP handle this message results in mysterious
1777 // crashes in comctl32.dll seemingly because of bad message
1778 // parameters
1779 //
1780 // I have no idea what is the real cause of the bug (which is,
1781 // just to make things interesting, is impossible to reproduce
1782 // reliably) but ignoring all these messages does fix it and
1783 // doesn't seem to have any negative consequences
1784 return true;
1785
1786 default:
1787 return wxControl::MSWOnNotify(idCtrl, lParam, result);
1788 }
1789 }
1790 else
1791 #endif // defined(HDN_BEGINTRACKA)
1792 if ( nmhdr->hwndFrom == GetHwnd() )
1793 {
1794 // almost all messages use NM_LISTVIEW
1795 NM_LISTVIEW *nmLV = (NM_LISTVIEW *)nmhdr;
1796
1797 const int iItem = nmLV->iItem;
1798
1799
1800 // FreeAllInternalData will cause LVN_ITEMCHANG* messages, which can be
1801 // ignored for efficiency. It is done here because the internal data is in the
1802 // process of being deleted so we don't want to try and access it below.
1803 if ( m_ignoreChangeMessages &&
1804 ( (nmLV->hdr.code == LVN_ITEMCHANGED) || (nmLV->hdr.code == LVN_ITEMCHANGING)))
1805 {
1806 return true;
1807 }
1808
1809
1810 // If we have a valid item then check if there is a data value
1811 // associated with it and put it in the event.
1812 if ( iItem >= 0 && iItem < GetItemCount() )
1813 {
1814 wxListItemInternalData *internaldata =
1815 wxGetInternalData(GetHwnd(), iItem);
1816
1817 if ( internaldata )
1818 event.m_item.m_data = internaldata->lParam;
1819 }
1820
1821
1822 switch ( nmhdr->code )
1823 {
1824 case LVN_BEGINRDRAG:
1825 eventType = wxEVT_COMMAND_LIST_BEGIN_RDRAG;
1826 // fall through
1827
1828 case LVN_BEGINDRAG:
1829 if ( eventType == wxEVT_NULL )
1830 {
1831 eventType = wxEVT_COMMAND_LIST_BEGIN_DRAG;
1832 }
1833
1834 event.m_itemIndex = iItem;
1835 event.m_pointDrag.x = nmLV->ptAction.x;
1836 event.m_pointDrag.y = nmLV->ptAction.y;
1837 break;
1838
1839 // NB: we have to handle both *A and *W versions here because some
1840 // versions of comctl32.dll send ANSI messages even to the
1841 // Unicode windows
1842 case LVN_BEGINLABELEDITA:
1843 case LVN_BEGINLABELEDITW:
1844 {
1845 wxLV_ITEM item;
1846 if ( nmhdr->code == LVN_BEGINLABELEDITA )
1847 {
1848 item.Init(((LV_DISPINFOA *)lParam)->item);
1849 }
1850 else // LVN_BEGINLABELEDITW
1851 {
1852 item.Init(((LV_DISPINFOW *)lParam)->item);
1853 }
1854
1855 eventType = wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT;
1856 wxConvertFromMSWListItem(GetHwnd(), event.m_item, item);
1857 event.m_itemIndex = event.m_item.m_itemId;
1858 }
1859 break;
1860
1861 case LVN_ENDLABELEDITA:
1862 case LVN_ENDLABELEDITW:
1863 {
1864 wxLV_ITEM item;
1865 if ( nmhdr->code == LVN_ENDLABELEDITA )
1866 {
1867 item.Init(((LV_DISPINFOA *)lParam)->item);
1868 }
1869 else // LVN_ENDLABELEDITW
1870 {
1871 item.Init(((LV_DISPINFOW *)lParam)->item);
1872 }
1873
1874 // was editing cancelled?
1875 const LV_ITEM& lvi = (LV_ITEM)item;
1876 if ( !lvi.pszText || lvi.iItem == -1 )
1877 {
1878 // don't keep a stale wxTextCtrl around
1879 if ( m_textCtrl )
1880 {
1881 // EDIT control will be deleted by the list control itself so
1882 // prevent us from deleting it as well
1883 m_textCtrl->UnsubclassWin();
1884 m_textCtrl->SetHWND(0);
1885 delete m_textCtrl;
1886 m_textCtrl = NULL;
1887 }
1888
1889 event.SetEditCanceled(true);
1890 }
1891
1892 eventType = wxEVT_COMMAND_LIST_END_LABEL_EDIT;
1893 wxConvertFromMSWListItem(NULL, event.m_item, item);
1894 event.m_itemIndex = event.m_item.m_itemId;
1895 }
1896 break;
1897
1898 case LVN_COLUMNCLICK:
1899 eventType = wxEVT_COMMAND_LIST_COL_CLICK;
1900 event.m_itemIndex = -1;
1901 event.m_col = nmLV->iSubItem;
1902 break;
1903
1904 case LVN_DELETEALLITEMS:
1905 m_count = 0;
1906 eventType = wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS;
1907 event.m_itemIndex = -1;
1908 break;
1909
1910 case LVN_DELETEITEM:
1911 if (m_count == 0)
1912 // this should be prevented by the post-processing code below,
1913 // but "just in case"
1914 return false;
1915
1916 eventType = wxEVT_COMMAND_LIST_DELETE_ITEM;
1917 event.m_itemIndex = iItem;
1918 // delete the assoicated internal data
1919 wxDeleteInternalData(this, iItem);
1920 break;
1921
1922 #if WXWIN_COMPATIBILITY_2_4
1923 case LVN_SETDISPINFO:
1924 {
1925 eventType = wxEVT_COMMAND_LIST_SET_INFO;
1926 LV_DISPINFO *info = (LV_DISPINFO *)lParam;
1927 wxConvertFromMSWListItem(GetHwnd(), event.m_item, info->item);
1928 }
1929 break;
1930 #endif
1931
1932 case LVN_INSERTITEM:
1933 eventType = wxEVT_COMMAND_LIST_INSERT_ITEM;
1934 event.m_itemIndex = iItem;
1935 break;
1936
1937 case LVN_ITEMCHANGED:
1938 // we translate this catch all message into more interesting
1939 // (and more easy to process) wxWidgets events
1940
1941 // first of all, we deal with the state change events only and
1942 // only for valid items (item == -1 for the virtual list
1943 // control)
1944 if ( nmLV->uChanged & LVIF_STATE && iItem != -1 )
1945 {
1946 // temp vars for readability
1947 const UINT stOld = nmLV->uOldState;
1948 const UINT stNew = nmLV->uNewState;
1949
1950 event.m_item.SetId(iItem);
1951 event.m_item.SetMask(wxLIST_MASK_TEXT |
1952 wxLIST_MASK_IMAGE |
1953 wxLIST_MASK_DATA);
1954 GetItem(event.m_item);
1955
1956 // has the focus changed?
1957 if ( !(stOld & LVIS_FOCUSED) && (stNew & LVIS_FOCUSED) )
1958 {
1959 eventType = wxEVT_COMMAND_LIST_ITEM_FOCUSED;
1960 event.m_itemIndex = iItem;
1961 }
1962
1963 if ( (stNew & LVIS_SELECTED) != (stOld & LVIS_SELECTED) )
1964 {
1965 if ( eventType != wxEVT_NULL )
1966 {
1967 // focus and selection have both changed: send the
1968 // focus event from here and the selection one
1969 // below
1970 event.SetEventType(eventType);
1971 (void)GetEventHandler()->ProcessEvent(event);
1972 }
1973 else // no focus event to send
1974 {
1975 // then need to set m_itemIndex as it wasn't done
1976 // above
1977 event.m_itemIndex = iItem;
1978 }
1979
1980 eventType = stNew & LVIS_SELECTED
1981 ? wxEVT_COMMAND_LIST_ITEM_SELECTED
1982 : wxEVT_COMMAND_LIST_ITEM_DESELECTED;
1983 }
1984 }
1985
1986 if ( eventType == wxEVT_NULL )
1987 {
1988 // not an interesting event for us
1989 return false;
1990 }
1991
1992 break;
1993
1994 case LVN_KEYDOWN:
1995 {
1996 LV_KEYDOWN *info = (LV_KEYDOWN *)lParam;
1997 WORD wVKey = info->wVKey;
1998
1999 // get the current selection
2000 long lItem = GetNextItem(-1,
2001 wxLIST_NEXT_ALL,
2002 wxLIST_STATE_SELECTED);
2003
2004 // <Enter> or <Space> activate the selected item if any (but
2005 // not with Shift and/or Ctrl as then they have a predefined
2006 // meaning for the list view)
2007 if ( lItem != -1 &&
2008 (wVKey == VK_RETURN || wVKey == VK_SPACE) &&
2009 !(wxIsShiftDown() || wxIsCtrlDown()) )
2010 {
2011 eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED;
2012 }
2013 else
2014 {
2015 eventType = wxEVT_COMMAND_LIST_KEY_DOWN;
2016
2017 // wxCharCodeMSWToWX() returns 0 if the key is an ASCII
2018 // value which should be used as is
2019 int code = wxCharCodeMSWToWX(wVKey);
2020 event.m_code = code ? code : wVKey;
2021 }
2022
2023 event.m_itemIndex =
2024 event.m_item.m_itemId = lItem;
2025
2026 if ( lItem != -1 )
2027 {
2028 // fill the other fields too
2029 event.m_item.m_text = GetItemText(lItem);
2030 event.m_item.m_data = GetItemData(lItem);
2031 }
2032 }
2033 break;
2034
2035 case NM_DBLCLK:
2036 // if the user processes it in wxEVT_COMMAND_LEFT_CLICK(), don't do
2037 // anything else
2038 if ( wxControl::MSWOnNotify(idCtrl, lParam, result) )
2039 {
2040 return true;
2041 }
2042
2043 // else translate it into wxEVT_COMMAND_LIST_ITEM_ACTIVATED event
2044 // if it happened on an item (and not on empty place)
2045 if ( iItem == -1 )
2046 {
2047 // not on item
2048 return false;
2049 }
2050
2051 eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED;
2052 event.m_itemIndex = iItem;
2053 event.m_item.m_text = GetItemText(iItem);
2054 event.m_item.m_data = GetItemData(iItem);
2055 break;
2056
2057 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
2058 case GN_CONTEXTMENU:
2059 #endif //__WXWINCE__
2060 case NM_RCLICK:
2061 // if the user processes it in wxEVT_COMMAND_RIGHT_CLICK(),
2062 // don't do anything else
2063 if ( wxControl::MSWOnNotify(idCtrl, lParam, result) )
2064 {
2065 return true;
2066 }
2067
2068 // else translate it into wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK event
2069 LV_HITTESTINFO lvhti;
2070 wxZeroMemory(lvhti);
2071
2072 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
2073 if(nmhdr->code == GN_CONTEXTMENU) {
2074 lvhti.pt = ((NMRGINFO*)nmhdr)->ptAction;
2075 } else
2076 #endif //__WXWINCE__
2077 ::GetCursorPos(&(lvhti.pt));
2078 ::ScreenToClient(GetHwnd(),&(lvhti.pt));
2079 if ( ListView_HitTest(GetHwnd(),&lvhti) != -1 )
2080 {
2081 if ( lvhti.flags & LVHT_ONITEM )
2082 {
2083 eventType = wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK;
2084 event.m_itemIndex = lvhti.iItem;
2085 event.m_pointDrag.x = lvhti.pt.x;
2086 event.m_pointDrag.y = lvhti.pt.y;
2087 }
2088 }
2089 break;
2090
2091 #ifdef NM_CUSTOMDRAW
2092 case NM_CUSTOMDRAW:
2093 *result = OnCustomDraw(lParam);
2094
2095 return true;
2096 #endif // _WIN32_IE >= 0x300
2097
2098 case LVN_ODCACHEHINT:
2099 {
2100 const NM_CACHEHINT *cacheHint = (NM_CACHEHINT *)lParam;
2101
2102 eventType = wxEVT_COMMAND_LIST_CACHE_HINT;
2103
2104 // we get some really stupid cache hints like ones for
2105 // items in range 0..0 for an empty control or, after
2106 // deleting an item, for items in invalid range -- filter
2107 // this garbage out
2108 if ( cacheHint->iFrom > cacheHint->iTo )
2109 return false;
2110
2111 event.m_oldItemIndex = cacheHint->iFrom;
2112
2113 const long iMax = GetItemCount();
2114 event.m_itemIndex = cacheHint->iTo < iMax ? cacheHint->iTo
2115 : iMax - 1;
2116 }
2117 break;
2118
2119 case LVN_GETDISPINFO:
2120 if ( IsVirtual() )
2121 {
2122 LV_DISPINFO *info = (LV_DISPINFO *)lParam;
2123
2124 LV_ITEM& lvi = info->item;
2125 long item = lvi.iItem;
2126
2127 if ( lvi.mask & LVIF_TEXT )
2128 {
2129 wxString text = OnGetItemText(item, lvi.iSubItem);
2130 wxStrncpy(lvi.pszText, text, lvi.cchTextMax);
2131 }
2132
2133 // see comment at the end of wxListCtrl::GetColumn()
2134 #ifdef NM_CUSTOMDRAW
2135 if ( lvi.mask & LVIF_IMAGE )
2136 {
2137 lvi.iImage = OnGetItemImage(item);
2138 }
2139 #endif // NM_CUSTOMDRAW
2140
2141 // a little dose of healthy paranoia: as we never use
2142 // LVM_SETCALLBACKMASK we're not supposed to get these ones
2143 wxASSERT_MSG( !(lvi.mask & LVIF_STATE),
2144 _T("we don't support state callbacks yet!") );
2145
2146 return true;
2147 }
2148 // fall through
2149
2150 default:
2151 return wxControl::MSWOnNotify(idCtrl, lParam, result);
2152 }
2153 }
2154 else
2155 {
2156 // where did this one come from?
2157 return false;
2158 }
2159
2160 // process the event
2161 // -----------------
2162
2163 event.SetEventType(eventType);
2164
2165 bool processed = GetEventHandler()->ProcessEvent(event);
2166
2167 // post processing
2168 // ---------------
2169 switch ( nmhdr->code )
2170 {
2171 case LVN_DELETEALLITEMS:
2172 // always return true to suppress all additional LVN_DELETEITEM
2173 // notifications - this makes deleting all items from a list ctrl
2174 // much faster
2175 *result = TRUE;
2176
2177 // also, we may free all user data now (couldn't do it before as
2178 // the user should have access to it in OnDeleteAllItems() handler)
2179 FreeAllInternalData();
2180 return true;
2181
2182 case LVN_ENDLABELEDITA:
2183 case LVN_ENDLABELEDITW:
2184 // logic here is inversed compared to all the other messages
2185 *result = event.IsAllowed();
2186
2187 // don't keep a stale wxTextCtrl around
2188 if ( m_textCtrl )
2189 {
2190 // EDIT control will be deleted by the list control itself so
2191 // prevent us from deleting it as well
2192 m_textCtrl->UnsubclassWin();
2193 m_textCtrl->SetHWND(0);
2194 delete m_textCtrl;
2195 m_textCtrl = NULL;
2196 }
2197
2198 return true;
2199 }
2200
2201 if ( processed )
2202 *result = !event.IsAllowed();
2203
2204 return processed;
2205 }
2206
2207 // see comment at the end of wxListCtrl::GetColumn()
2208 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
2209
2210 WXLPARAM wxListCtrl::OnCustomDraw(WXLPARAM lParam)
2211 {
2212 LPNMLVCUSTOMDRAW lplvcd = (LPNMLVCUSTOMDRAW)lParam;
2213 NMCUSTOMDRAW& nmcd = lplvcd->nmcd;
2214 switch ( nmcd.dwDrawStage )
2215 {
2216 case CDDS_PREPAINT:
2217 // if we've got any items with non standard attributes,
2218 // notify us before painting each item
2219 //
2220 // for virtual controls, always suppose that we have attributes as
2221 // there is no way to check for this
2222 return IsVirtual() || m_hasAnyAttr ? CDRF_NOTIFYITEMDRAW
2223 : CDRF_DODEFAULT;
2224
2225 case CDDS_ITEMPREPAINT:
2226 {
2227 size_t item = (size_t)nmcd.dwItemSpec;
2228 if ( item >= (size_t)GetItemCount() )
2229 {
2230 // we get this message with item == 0 for an empty control,
2231 // we must ignore it as calling OnGetItemAttr() would be
2232 // wrong
2233 return CDRF_DODEFAULT;
2234 }
2235
2236 wxListItemAttr *attr =
2237 IsVirtual() ? OnGetItemAttr(item)
2238 : wxGetInternalDataAttr(this, item);
2239
2240 if ( !attr )
2241 {
2242 // nothing to do for this item
2243 return CDRF_DODEFAULT;
2244 }
2245
2246 HFONT hFont;
2247 wxColour colText, colBack;
2248 if ( attr->HasFont() )
2249 {
2250 wxFont font = attr->GetFont();
2251 hFont = (HFONT)font.GetResourceHandle();
2252 }
2253 else
2254 {
2255 hFont = 0;
2256 }
2257
2258 if ( attr->HasTextColour() )
2259 {
2260 colText = attr->GetTextColour();
2261 }
2262 else
2263 {
2264 colText = GetTextColour();
2265 }
2266
2267 if ( attr->HasBackgroundColour() )
2268 {
2269 colBack = attr->GetBackgroundColour();
2270 }
2271 else
2272 {
2273 colBack = GetBackgroundColour();
2274 }
2275
2276 lplvcd->clrText = wxColourToRGB(colText);
2277 lplvcd->clrTextBk = wxColourToRGB(colBack);
2278
2279 // note that if we wanted to set colours for
2280 // individual columns (subitems), we would have
2281 // returned CDRF_NOTIFYSUBITEMREDRAW from here
2282 if ( hFont )
2283 {
2284 ::SelectObject(nmcd.hdc, hFont);
2285
2286 return CDRF_NEWFONT;
2287 }
2288 }
2289 // fall through to return CDRF_DODEFAULT
2290
2291 default:
2292 return CDRF_DODEFAULT;
2293 }
2294 }
2295
2296 #endif // NM_CUSTOMDRAW supported
2297
2298 // Necessary for drawing hrules and vrules, if specified
2299 void wxListCtrl::OnPaint(wxPaintEvent& event)
2300 {
2301 wxPaintDC dc(this);
2302
2303 wxControl::OnPaint(event);
2304
2305 // Reset the device origin since it may have been set
2306 dc.SetDeviceOrigin(0, 0);
2307
2308 bool drawHRules = HasFlag(wxLC_HRULES);
2309 bool drawVRules = HasFlag(wxLC_VRULES);
2310
2311 if (!InReportView() || !drawHRules && !drawVRules)
2312 return;
2313
2314 wxPen pen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT), 1, wxSOLID);
2315 dc.SetPen(pen);
2316 dc.SetBrush(* wxTRANSPARENT_BRUSH);
2317
2318 wxSize clientSize = GetClientSize();
2319 wxRect itemRect;
2320
2321 int itemCount = GetItemCount();
2322 int i;
2323 if (drawHRules)
2324 {
2325 long top = GetTopItem();
2326 for (i = top; i < top + GetCountPerPage() + 1; i++)
2327 {
2328 if (GetItemRect(i, itemRect))
2329 {
2330 int cy = itemRect.GetTop();
2331 if (i != 0) // Don't draw the first one
2332 {
2333 dc.DrawLine(0, cy, clientSize.x, cy);
2334 }
2335 // Draw last line
2336 if (i == itemCount - 1)
2337 {
2338 cy = itemRect.GetBottom();
2339 dc.DrawLine(0, cy, clientSize.x, cy);
2340 }
2341 }
2342 }
2343 }
2344 i = itemCount - 1;
2345 if (drawVRules && (i > -1))
2346 {
2347 wxRect firstItemRect;
2348 GetItemRect(0, firstItemRect);
2349
2350 if (GetItemRect(i, itemRect))
2351 {
2352 int col;
2353 int x = itemRect.GetX();
2354 for (col = 0; col < GetColumnCount(); col++)
2355 {
2356 int colWidth = GetColumnWidth(col);
2357 x += colWidth ;
2358 dc.DrawLine(x-1, firstItemRect.GetY() - 2, x-1, itemRect.GetBottom());
2359 }
2360 }
2361 }
2362 }
2363
2364 // ----------------------------------------------------------------------------
2365 // virtual list controls
2366 // ----------------------------------------------------------------------------
2367
2368 wxString wxListCtrl::OnGetItemText(long WXUNUSED(item), long WXUNUSED(col)) const
2369 {
2370 // this is a pure virtual function, in fact - which is not really pure
2371 // because the controls which are not virtual don't need to implement it
2372 wxFAIL_MSG( _T("wxListCtrl::OnGetItemText not supposed to be called") );
2373
2374 return wxEmptyString;
2375 }
2376
2377 int wxListCtrl::OnGetItemImage(long WXUNUSED(item)) const
2378 {
2379 wxCHECK_MSG(!GetImageList(wxIMAGE_LIST_SMALL),
2380 -1,
2381 wxT("List control has an image list, OnGetItemImage should be overridden."));
2382 return -1;
2383 }
2384
2385 wxListItemAttr *wxListCtrl::OnGetItemAttr(long WXUNUSED_UNLESS_DEBUG(item)) const
2386 {
2387 wxASSERT_MSG( item >= 0 && item < GetItemCount(),
2388 _T("invalid item index in OnGetItemAttr()") );
2389
2390 // no attributes by default
2391 return NULL;
2392 }
2393
2394 void wxListCtrl::SetItemCount(long count)
2395 {
2396 wxASSERT_MSG( IsVirtual(), _T("this is for virtual controls only") );
2397
2398 if ( !::SendMessage(GetHwnd(), LVM_SETITEMCOUNT, (WPARAM)count,
2399 LVSICF_NOSCROLL | LVSICF_NOINVALIDATEALL) )
2400 {
2401 wxLogLastError(_T("ListView_SetItemCount"));
2402 }
2403 m_count = count;
2404 wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()),
2405 wxT("m_count should match ListView_GetItemCount"));
2406 }
2407
2408 void wxListCtrl::RefreshItem(long item)
2409 {
2410 // strangely enough, ListView_Update() results in much more flicker here
2411 // than a dumb Refresh() -- why?
2412 #if 0
2413 if ( !ListView_Update(GetHwnd(), item) )
2414 {
2415 wxLogLastError(_T("ListView_Update"));
2416 }
2417 #else // 1
2418 wxRect rect;
2419 GetItemRect(item, rect);
2420 RefreshRect(rect);
2421 #endif // 0/1
2422 }
2423
2424 void wxListCtrl::RefreshItems(long itemFrom, long itemTo)
2425 {
2426 wxRect rect1, rect2;
2427 GetItemRect(itemFrom, rect1);
2428 GetItemRect(itemTo, rect2);
2429
2430 wxRect rect = rect1;
2431 rect.height = rect2.GetBottom() - rect1.GetTop();
2432
2433 RefreshRect(rect);
2434 }
2435
2436 // ----------------------------------------------------------------------------
2437 // internal data stuff
2438 // ----------------------------------------------------------------------------
2439
2440 static wxListItemInternalData *wxGetInternalData(HWND hwnd, long itemId)
2441 {
2442 LV_ITEM it;
2443 it.mask = LVIF_PARAM;
2444 it.iItem = itemId;
2445
2446 if ( !ListView_GetItem(hwnd, &it) )
2447 return NULL;
2448
2449 return (wxListItemInternalData *) it.lParam;
2450 };
2451
2452 static
2453 wxListItemInternalData *wxGetInternalData(const wxListCtrl *ctl, long itemId)
2454 {
2455 return wxGetInternalData(GetHwndOf(ctl), itemId);
2456 };
2457
2458 static wxListItemAttr *wxGetInternalDataAttr(wxListCtrl *ctl, long itemId)
2459 {
2460 wxListItemInternalData *data = wxGetInternalData(ctl, itemId);
2461
2462 return data ? data->attr : NULL;
2463 };
2464
2465 static void wxDeleteInternalData(wxListCtrl* ctl, long itemId)
2466 {
2467 wxListItemInternalData *data = wxGetInternalData(ctl, itemId);
2468 if (data)
2469 {
2470 LV_ITEM item;
2471 memset(&item, 0, sizeof(item));
2472 item.iItem = itemId;
2473 item.mask = LVIF_PARAM;
2474 item.lParam = (LPARAM) 0;
2475 ListView_SetItem((HWND)ctl->GetHWND(), &item);
2476 delete data;
2477 }
2478 }
2479
2480 // ----------------------------------------------------------------------------
2481 // wxWin <-> MSW items conversions
2482 // ----------------------------------------------------------------------------
2483
2484 static void wxConvertFromMSWListItem(HWND hwndListCtrl,
2485 wxListItem& info,
2486 LV_ITEM& lvItem)
2487 {
2488 wxListItemInternalData *internaldata =
2489 (wxListItemInternalData *) lvItem.lParam;
2490
2491 if (internaldata)
2492 info.m_data = internaldata->lParam;
2493
2494 info.m_mask = 0;
2495 info.m_state = 0;
2496 info.m_stateMask = 0;
2497 info.m_itemId = lvItem.iItem;
2498
2499 long oldMask = lvItem.mask;
2500
2501 bool needText = false;
2502 if (hwndListCtrl != 0)
2503 {
2504 if ( lvItem.mask & LVIF_TEXT )
2505 needText = false;
2506 else
2507 needText = true;
2508
2509 if ( needText )
2510 {
2511 lvItem.pszText = new wxChar[513];
2512 lvItem.cchTextMax = 512;
2513 }
2514 lvItem.mask |= LVIF_TEXT | LVIF_IMAGE | LVIF_PARAM;
2515 ::SendMessage(hwndListCtrl, LVM_GETITEM, 0, (LPARAM)& lvItem);
2516 }
2517
2518 if ( lvItem.mask & LVIF_STATE )
2519 {
2520 info.m_mask |= wxLIST_MASK_STATE;
2521
2522 if ( lvItem.stateMask & LVIS_CUT)
2523 {
2524 info.m_stateMask |= wxLIST_STATE_CUT;
2525 if ( lvItem.state & LVIS_CUT )
2526 info.m_state |= wxLIST_STATE_CUT;
2527 }
2528 if ( lvItem.stateMask & LVIS_DROPHILITED)
2529 {
2530 info.m_stateMask |= wxLIST_STATE_DROPHILITED;
2531 if ( lvItem.state & LVIS_DROPHILITED )
2532 info.m_state |= wxLIST_STATE_DROPHILITED;
2533 }
2534 if ( lvItem.stateMask & LVIS_FOCUSED)
2535 {
2536 info.m_stateMask |= wxLIST_STATE_FOCUSED;
2537 if ( lvItem.state & LVIS_FOCUSED )
2538 info.m_state |= wxLIST_STATE_FOCUSED;
2539 }
2540 if ( lvItem.stateMask & LVIS_SELECTED)
2541 {
2542 info.m_stateMask |= wxLIST_STATE_SELECTED;
2543 if ( lvItem.state & LVIS_SELECTED )
2544 info.m_state |= wxLIST_STATE_SELECTED;
2545 }
2546 }
2547
2548 if ( lvItem.mask & LVIF_TEXT )
2549 {
2550 info.m_mask |= wxLIST_MASK_TEXT;
2551 info.m_text = lvItem.pszText;
2552 }
2553 if ( lvItem.mask & LVIF_IMAGE )
2554 {
2555 info.m_mask |= wxLIST_MASK_IMAGE;
2556 info.m_image = lvItem.iImage;
2557 }
2558 if ( lvItem.mask & LVIF_PARAM )
2559 info.m_mask |= wxLIST_MASK_DATA;
2560 if ( lvItem.mask & LVIF_DI_SETITEM )
2561 info.m_mask |= wxLIST_SET_ITEM;
2562 info.m_col = lvItem.iSubItem;
2563
2564 if (needText)
2565 {
2566 if (lvItem.pszText)
2567 delete[] lvItem.pszText;
2568 }
2569 lvItem.mask = oldMask;
2570 }
2571
2572 static void wxConvertToMSWFlags(long state, long stateMask, LV_ITEM& lvItem)
2573 {
2574 if (stateMask & wxLIST_STATE_CUT)
2575 {
2576 lvItem.stateMask |= LVIS_CUT;
2577 if (state & wxLIST_STATE_CUT)
2578 lvItem.state |= LVIS_CUT;
2579 }
2580 if (stateMask & wxLIST_STATE_DROPHILITED)
2581 {
2582 lvItem.stateMask |= LVIS_DROPHILITED;
2583 if (state & wxLIST_STATE_DROPHILITED)
2584 lvItem.state |= LVIS_DROPHILITED;
2585 }
2586 if (stateMask & wxLIST_STATE_FOCUSED)
2587 {
2588 lvItem.stateMask |= LVIS_FOCUSED;
2589 if (state & wxLIST_STATE_FOCUSED)
2590 lvItem.state |= LVIS_FOCUSED;
2591 }
2592 if (stateMask & wxLIST_STATE_SELECTED)
2593 {
2594 lvItem.stateMask |= LVIS_SELECTED;
2595 if (state & wxLIST_STATE_SELECTED)
2596 lvItem.state |= LVIS_SELECTED;
2597 }
2598 }
2599
2600 static void wxConvertToMSWListItem(const wxListCtrl *ctrl,
2601 const wxListItem& info,
2602 LV_ITEM& lvItem)
2603 {
2604 lvItem.iItem = (int) info.m_itemId;
2605
2606 lvItem.iImage = info.m_image;
2607 lvItem.stateMask = 0;
2608 lvItem.state = 0;
2609 lvItem.mask = 0;
2610 lvItem.iSubItem = info.m_col;
2611
2612 if (info.m_mask & wxLIST_MASK_STATE)
2613 {
2614 lvItem.mask |= LVIF_STATE;
2615
2616 wxConvertToMSWFlags(info.m_state, info.m_stateMask, lvItem);
2617 }
2618
2619 if (info.m_mask & wxLIST_MASK_TEXT)
2620 {
2621 lvItem.mask |= LVIF_TEXT;
2622 if ( ctrl->HasFlag(wxLC_USER_TEXT) )
2623 {
2624 lvItem.pszText = LPSTR_TEXTCALLBACK;
2625 }
2626 else
2627 {
2628 // pszText is not const, hence the cast
2629 lvItem.pszText = (wxChar *)info.m_text.c_str();
2630 if ( lvItem.pszText )
2631 lvItem.cchTextMax = info.m_text.Length();
2632 else
2633 lvItem.cchTextMax = 0;
2634 }
2635 }
2636 if (info.m_mask & wxLIST_MASK_IMAGE)
2637 lvItem.mask |= LVIF_IMAGE;
2638 }
2639
2640 static void wxConvertToMSWListCol(int WXUNUSED(col), const wxListItem& item,
2641 LV_COLUMN& lvCol)
2642 {
2643 wxZeroMemory(lvCol);
2644
2645 if ( item.m_mask & wxLIST_MASK_TEXT )
2646 {
2647 lvCol.mask |= LVCF_TEXT;
2648 lvCol.pszText = (wxChar *)item.m_text.c_str(); // cast is safe
2649 }
2650
2651 if ( item.m_mask & wxLIST_MASK_FORMAT )
2652 {
2653 lvCol.mask |= LVCF_FMT;
2654
2655 if ( item.m_format == wxLIST_FORMAT_LEFT )
2656 lvCol.fmt = LVCFMT_LEFT;
2657 else if ( item.m_format == wxLIST_FORMAT_RIGHT )
2658 lvCol.fmt = LVCFMT_RIGHT;
2659 else if ( item.m_format == wxLIST_FORMAT_CENTRE )
2660 lvCol.fmt = LVCFMT_CENTER;
2661 }
2662
2663 if ( item.m_mask & wxLIST_MASK_WIDTH )
2664 {
2665 lvCol.mask |= LVCF_WIDTH;
2666 if ( item.m_width == wxLIST_AUTOSIZE)
2667 lvCol.cx = LVSCW_AUTOSIZE;
2668 else if ( item.m_width == wxLIST_AUTOSIZE_USEHEADER)
2669 lvCol.cx = LVSCW_AUTOSIZE_USEHEADER;
2670 else
2671 lvCol.cx = item.m_width;
2672 }
2673
2674 // see comment at the end of wxListCtrl::GetColumn()
2675 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
2676 if ( item.m_mask & wxLIST_MASK_IMAGE )
2677 {
2678 if ( wxTheApp->GetComCtl32Version() >= 470 )
2679 {
2680 lvCol.mask |= LVCF_IMAGE | LVCF_FMT;
2681
2682 // we use LVCFMT_BITMAP_ON_RIGHT because thei mages on the right
2683 // seem to be generally nicer than on the left and the generic
2684 // version only draws them on the right (we don't have a flag to
2685 // specify the image location anyhow)
2686 //
2687 // we don't use LVCFMT_COL_HAS_IMAGES because it doesn't seem to
2688 // make any difference in my tests -- but maybe we should?
2689 lvCol.fmt |= LVCFMT_BITMAP_ON_RIGHT | LVCFMT_IMAGE;
2690
2691 lvCol.iImage = item.m_image;
2692 }
2693 //else: it doesn't support item images anyhow
2694 }
2695 #endif // _WIN32_IE >= 0x0300
2696 }
2697
2698 #endif // wxUSE_LISTCTRL
2699