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