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