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