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