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