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