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