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