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