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