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