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