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