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