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