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