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