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