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