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