src/msw/listctrl.cpp

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