src/msw/listctrl.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/msw/listctrl.cpp
   3 // Purpose:     wxListCtrl
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart and Markus Holzem
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #ifdef __GNUG__
  21     #pragma implementation "listctrl.h"
  22     #pragma implementation "listctrlbase.h"
  23 #endif
  24
  25 // For compilers that support precompilation, includes "wx.h".
  26 #include "wx/wxprec.h"
  27
  28 #ifdef __BORLANDC__
  29     #pragma hdrstop
  30 #endif
  31
  32 #if wxUSE_LISTCTRL && defined(__WIN95__)
  33
  34 #ifndef WX_PRECOMP
  35     #include "wx/app.h"
  36     #include "wx/intl.h"
  37     #include "wx/log.h"
  38     #include "wx/settings.h"
  39 #endif
  40
  41 #include "wx/textctrl.h"
  42 #include "wx/imaglist.h"
  43 #include "wx/listctrl.h"
  44 #include "wx/dcclient.h"
  45
  46 #include "wx/msw/private.h"
  47
  48 #if ((defined(__GNUWIN32_OLD__) || defined(__TWIN32__)) && !defined(__CYGWIN10__))
  49     #include "wx/msw/gnuwin32/extra.h"
  50 #else
  51     #include <commctrl.h>
  52 #endif
  53
  54 #include "wx/msw/missing.h"
  55
  56 // ----------------------------------------------------------------------------
  57 // private functions
  58 // ----------------------------------------------------------------------------
  59
  60 // convert our state and mask flags to LV_ITEM constants
  61 static void wxConvertToMSWFlags(long state, long mask, LV_ITEM& lvItem);
  62
  63 // convert wxListItem to LV_ITEM
  64 static void wxConvertToMSWListItem(const wxListCtrl *ctrl,
  65                                    const wxListItem& info, LV_ITEM& lvItem);
  66
  67 // convert LV_ITEM to wxListItem
  68 static void wxConvertFromMSWListItem(HWND hwndListCtrl,
  69                                      wxListItem& info,
  70                                      /* const */ LV_ITEM& lvItem);
  71
  72 // convert our wxListItem to LV_COLUMN
  73 static void wxConvertToMSWListCol(int col, const wxListItem& item,
  74                                   LV_COLUMN& lvCol);
  75
  76 // ----------------------------------------------------------------------------
  77 // private helper classes
  78 // ----------------------------------------------------------------------------
  79
  80 // We have to handle both fooW and fooA notifications in several cases
  81 // because of broken commctl.dll and/or unicows.dll. This class is used to
  82 // convert LV_ITEMA and LV_ITEMW to LV_ITEM (which is either LV_ITEMA or
  83 // LV_ITEMW depending on wxUSE_UNICODE setting), so that it can be processed
  84 // by wxConvertToMSWListItem().
  85 class wxLV_ITEM
  86 {
  87 public:
  88     ~wxLV_ITEM() { delete m_buf; }
  89     operator LV_ITEM&() const { return *m_item; }
  90
  91 #if wxUSE_UNICODE
  92     wxLV_ITEM(LV_ITEMW &item) : m_buf(NULL), m_item(&item) {}
  93     wxLV_ITEM(LV_ITEMA &item)
  94     {
  95         m_item = new LV_ITEM((LV_ITEM&)item);
  96         if ( (item.mask & LVIF_TEXT) && item.pszText )
  97         {
  98             m_buf = new wxMB2WXbuf(wxConvLocal.cMB2WX(item.pszText));
  99             m_item->pszText = (wxChar*)m_buf->data();
 100         }
 101         else
 102             m_buf = NULL;
 103     }
 104 private:
 105     wxMB2WXbuf *m_buf;
 106
 107 #else
 108     wxLV_ITEM(LV_ITEMW &item)
 109     {
 110         m_item = new LV_ITEM((LV_ITEM&)item);
 111         if ( (item.mask & LVIF_TEXT) && item.pszText )
 112         {
 113             m_buf = new wxWC2WXbuf(wxConvLocal.cWC2WX(item.pszText));
 114             m_item->pszText = (wxChar*)m_buf->data();
 115         }
 116         else
 117             m_buf = NULL;
 118     }
 119     wxLV_ITEM(LV_ITEMA &item) : m_buf(NULL), m_item(&item) {}
 120 private:
 121     wxWC2WXbuf *m_buf;
 122 #endif
 123
 124     LV_ITEM *m_item;
 125 };
 126
 127 ///////////////////////////////////////////////////////
 128 // Problem:
 129 // The MSW version had problems with SetTextColour() et
 130 // al as the wxListItemAttr's were stored keyed on the
 131 // item index. If a item was inserted anywhere but the end
 132 // of the list the the text attributes (colour etc) for
 133 // the following items were out of sync.
 134 //
 135 // Solution:
 136 // Under MSW the only way to associate data with a List
 137 // item independant of its position in the list is to
 138 // store a pointer to it in its lParam attribute. However
 139 // user programs are already using this (via the
 140 // SetItemData() GetItemData() calls).
 141 //
 142 // However what we can do is store a pointer to a
 143 // structure which contains the attributes we want *and*
 144 // a lParam for the users data, e.g.
 145 //
 146 // class wxListItemInternalData
 147 // {
 148 // public:
 149 //   wxListItemAttr *attr;
 150 //   long lParam; // user data
 151 // };
 152 //
 153 // To conserve memory, a wxListItemInternalData is
 154 // only allocated for a LV_ITEM if text attributes or
 155 // user data(lparam) are being set.
 156
 157
 158 // class wxListItemInternalData
 159 class wxListItemInternalData
 160 {
 161 public:
 162    wxListItemAttr *attr;
 163    LPARAM lParam; // user data
 164
 165    wxListItemInternalData() : attr(NULL), lParam(0) {}
 166    ~wxListItemInternalData()
 167    {
 168        if (attr)
 169            delete attr;
 170    };
 171 };
 172
 173 // Get the internal data structure
 174 static wxListItemInternalData *GetInternalData(HWND hwnd, long itemId);
 175 static wxListItemInternalData *GetInternalData(wxListCtrl *ctl, long itemId);
 176 static wxListItemAttr *GetInternalDataAttr(wxListCtrl *ctl, long itemId);
 177
 178
 179 // ----------------------------------------------------------------------------
 180 // events
 181 // ----------------------------------------------------------------------------
 182
 183 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_DRAG)
 184 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_RDRAG)
 185 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT)
 186 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_END_LABEL_EDIT)
 187 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ITEM)
 188 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS)
 189 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_GET_INFO)
 190 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_SET_INFO)
 191 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_SELECTED)
 192 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_DESELECTED)
 193 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_KEY_DOWN)
 194 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_INSERT_ITEM)
 195 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_CLICK)
 196 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_RIGHT_CLICK)
 197 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_BEGIN_DRAG)
 198 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_DRAGGING)
 199 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_END_DRAG)
 200 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK)
 201 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK)
 202 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_ACTIVATED)
 203 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_FOCUSED)
 204 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_CACHE_HINT)
 205
 206 IMPLEMENT_DYNAMIC_CLASS(wxListCtrl, wxControl)
 207 IMPLEMENT_DYNAMIC_CLASS(wxListView, wxListCtrl)
 208 IMPLEMENT_DYNAMIC_CLASS(wxListItem, wxObject)
 209
 210 IMPLEMENT_DYNAMIC_CLASS(wxListEvent, wxNotifyEvent)
 211
 212 BEGIN_EVENT_TABLE(wxListCtrl, wxControl)
 213     EVT_PAINT(wxListCtrl::OnPaint)
 214 END_EVENT_TABLE()
 215
 216 // ============================================================================
 217 // implementation
 218 // ============================================================================
 219
 220 // ----------------------------------------------------------------------------
 221 // wxListCtrl construction
 222 // ----------------------------------------------------------------------------
 223
 224 void wxListCtrl::Init()
 225 {
 226     m_imageListNormal = NULL;
 227     m_imageListSmall = NULL;
 228     m_imageListState = NULL;
 229     m_ownsImageListNormal = m_ownsImageListSmall = m_ownsImageListState = FALSE;
 230     m_baseStyle = 0;
 231     m_colCount = 0;
 232     m_textCtrl = NULL;
 233     m_AnyInternalData = FALSE;
 234     m_hasAnyAttr = FALSE;
 235 }
 236
 237 bool wxListCtrl::Create(wxWindow *parent,
 238                         wxWindowID id,
 239                         const wxPoint& pos,
 240                         const wxSize& size,
 241                         long style,
 242                         const wxValidator& validator,
 243                         const wxString& name)
 244 {
 245 #if wxUSE_VALIDATORS
 246     SetValidator(validator);
 247 #endif // wxUSE_VALIDATORS
 248
 249     SetName(name);
 250
 251     int x = pos.x;
 252     int y = pos.y;
 253     int width = size.x;
 254     int height = size.y;
 255
 256     m_windowStyle = style;
 257
 258     SetParent(parent);
 259
 260     if (width <= 0)
 261         width = 100;
 262     if (height <= 0)
 263         height = 30;
 264     if (x < 0)
 265         x = 0;
 266     if (y < 0)
 267         y = 0;
 268
 269     m_windowId = (id == -1) ? NewControlId() : id;
 270
 271     DWORD wstyle = WS_VISIBLE | WS_CHILD | WS_TABSTOP |
 272                    LVS_SHAREIMAGELISTS | LVS_SHOWSELALWAYS;
 273
 274     if ( m_windowStyle & wxCLIP_SIBLINGS )
 275         wstyle |= WS_CLIPSIBLINGS;
 276
 277     if ( wxStyleHasBorder(m_windowStyle) )
 278         wstyle |= WS_BORDER;
 279     m_baseStyle = wstyle;
 280
 281     if ( !DoCreateControl(x, y, width, height) )
 282         return FALSE;
 283
 284     if (parent)
 285         parent->AddChild(this);
 286
 287     return TRUE;
 288 }
 289
 290 bool wxListCtrl::DoCreateControl(int x, int y, int w, int h)
 291 {
 292     DWORD wstyle = m_baseStyle;
 293
 294     bool want3D;
 295     WXDWORD exStyle = Determine3DEffects(WS_EX_CLIENTEDGE, &want3D);
 296
 297     // Even with extended styles, need to combine with WS_BORDER
 298     // for them to look right.
 299     if ( want3D )
 300         wstyle |= WS_BORDER;
 301
 302     long oldStyle = 0; // Dummy
 303     wstyle |= ConvertToMSWStyle(oldStyle, m_windowStyle);
 304
 305     // Create the ListView control.
 306     m_hWnd = (WXHWND)CreateWindowEx(exStyle,
 307                                     WC_LISTVIEW,
 308                                     wxT(""),
 309                                     wstyle,
 310                                     x, y, w, h,
 311                                     GetWinHwnd(GetParent()),
 312                                     (HMENU)m_windowId,
 313                                     wxGetInstance(),
 314                                     NULL);
 315
 316     if ( !m_hWnd )
 317     {
 318         wxLogError(_("Can't create list control window, check that comctl32.dll is installed."));
 319
 320         return FALSE;
 321     }
 322
 323     // for comctl32.dll v 4.70+ we want to have this attribute because it's
 324     // prettier (and also because wxGTK does it like this)
 325     if ( (wstyle & LVS_REPORT) && wxTheApp->GetComCtl32Version() >= 470 )
 326     {
 327         ::SendMessage(GetHwnd(), LVM_SETEXTENDEDLISTVIEWSTYLE,
 328                       0, LVS_EX_FULLROWSELECT);
 329     }
 330
 331     SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
 332     SetForegroundColour(GetParent()->GetForegroundColour());
 333
 334     SubclassWin(m_hWnd);
 335
 336     return TRUE;
 337 }
 338
 339 void wxListCtrl::UpdateStyle()
 340 {
 341     if ( GetHWND() )
 342     {
 343         // The new window view style
 344         long dummy;
 345         DWORD dwStyleNew = ConvertToMSWStyle(dummy, m_windowStyle);
 346         dwStyleNew |= m_baseStyle;
 347
 348         // Get the current window style.
 349         DWORD dwStyleOld = ::GetWindowLong(GetHwnd(), GWL_STYLE);
 350
 351         // Only set the window style if the view bits have changed.
 352         if ( dwStyleOld != dwStyleNew )
 353         {
 354             ::SetWindowLong(GetHwnd(), GWL_STYLE, dwStyleNew);
 355         }
 356     }
 357 }
 358
 359 void wxListCtrl::FreeAllInternalData()
 360 {
 361     if (m_AnyInternalData)
 362         {
 363         int n = GetItemCount();
 364         int i = 0;
 365
 366         for (i = 0; i < n; i++)
 367         {
 368             wxListItemInternalData *data = GetInternalData(this, i);
 369             if (data)
 370                 delete data;
 371         };
 372     };
 373 }
 374
 375 wxListCtrl::~wxListCtrl()
 376 {
 377     FreeAllInternalData();
 378
 379     if ( m_textCtrl )
 380     {
 381         m_textCtrl->SetHWND(0);
 382         m_textCtrl->UnsubclassWin();
 383         delete m_textCtrl;
 384         m_textCtrl = NULL;
 385     }
 386
 387     if (m_ownsImageListNormal) delete m_imageListNormal;
 388     if (m_ownsImageListSmall) delete m_imageListSmall;
 389     if (m_ownsImageListState) delete m_imageListState;
 390 }
 391
 392 // ----------------------------------------------------------------------------
 393 // set/get/change style
 394 // ----------------------------------------------------------------------------
 395
 396 // Add or remove a single window style
 397 void wxListCtrl::SetSingleStyle(long style, bool add)
 398 {
 399     long flag = GetWindowStyleFlag();
 400
 401     // Get rid of conflicting styles
 402     if ( add )
 403     {
 404         if ( style & wxLC_MASK_TYPE)
 405             flag = flag & ~wxLC_MASK_TYPE;
 406         if ( style & wxLC_MASK_ALIGN )
 407             flag = flag & ~wxLC_MASK_ALIGN;
 408         if ( style & wxLC_MASK_SORT )
 409             flag = flag & ~wxLC_MASK_SORT;
 410     }
 411
 412     if ( flag & style )
 413     {
 414         if ( !add )
 415             flag -= style;
 416     }
 417     else
 418     {
 419         if ( add )
 420         {
 421             flag |= style;
 422         }
 423     }
 424
 425     m_windowStyle = flag;
 426
 427     UpdateStyle();
 428 }
 429
 430 // Set the whole window style
 431 void wxListCtrl::SetWindowStyleFlag(long flag)
 432 {
 433     m_windowStyle = flag;
 434
 435     UpdateStyle();
 436 }
 437
 438 // Can be just a single style, or a bitlist
 439 long wxListCtrl::ConvertToMSWStyle(long& oldStyle, long style) const
 440 {
 441     long wstyle = 0;
 442     if ( style & wxLC_ICON )
 443     {
 444         if ( (oldStyle & LVS_TYPEMASK) == LVS_SMALLICON )
 445             oldStyle -= LVS_SMALLICON;
 446         if ( (oldStyle & LVS_TYPEMASK) == LVS_REPORT )
 447             oldStyle -= LVS_REPORT;
 448         if ( (oldStyle & LVS_TYPEMASK) == LVS_LIST )
 449             oldStyle -= LVS_LIST;
 450         wstyle |= LVS_ICON;
 451     }
 452
 453     if ( style & wxLC_SMALL_ICON )
 454     {
 455         if ( (oldStyle & LVS_TYPEMASK) == LVS_ICON )
 456             oldStyle -= LVS_ICON;
 457         if ( (oldStyle & LVS_TYPEMASK) == LVS_REPORT )
 458             oldStyle -= LVS_REPORT;
 459         if ( (oldStyle & LVS_TYPEMASK) == LVS_LIST )
 460             oldStyle -= LVS_LIST;
 461         wstyle |= LVS_SMALLICON;
 462     }
 463
 464     if ( style & wxLC_LIST )
 465     {
 466         if ( (oldStyle & LVS_TYPEMASK) == LVS_ICON )
 467             oldStyle -= LVS_ICON;
 468         if ( (oldStyle & LVS_TYPEMASK) == LVS_REPORT )
 469             oldStyle -= LVS_REPORT;
 470         if ( (oldStyle & LVS_TYPEMASK) == LVS_SMALLICON )
 471             oldStyle -= LVS_SMALLICON;
 472         wstyle |= LVS_LIST;
 473     }
 474
 475     if ( style & wxLC_REPORT )
 476     {
 477         if ( (oldStyle & LVS_TYPEMASK) == LVS_ICON )
 478             oldStyle -= LVS_ICON;
 479         if ( (oldStyle & LVS_TYPEMASK) == LVS_LIST )
 480             oldStyle -= LVS_LIST;
 481         if ( (oldStyle & LVS_TYPEMASK) == LVS_SMALLICON )
 482             oldStyle -= LVS_SMALLICON;
 483
 484         wstyle |= LVS_REPORT;
 485     }
 486
 487     if ( style & wxLC_ALIGN_LEFT )
 488     {
 489         if ( oldStyle & LVS_ALIGNTOP )
 490             oldStyle -= LVS_ALIGNTOP;
 491         wstyle |= LVS_ALIGNLEFT;
 492     }
 493
 494     if ( style & wxLC_ALIGN_TOP )
 495     {
 496         if ( oldStyle & LVS_ALIGNLEFT )
 497             oldStyle -= LVS_ALIGNLEFT;
 498         wstyle |= LVS_ALIGNTOP;
 499     }
 500
 501     if ( style & wxLC_AUTOARRANGE )
 502         wstyle |= LVS_AUTOARRANGE;
 503
 504     if ( style & wxLC_NO_SORT_HEADER )
 505         wstyle |= LVS_NOSORTHEADER;
 506
 507     if ( style & wxLC_NO_HEADER )
 508         wstyle |= LVS_NOCOLUMNHEADER;
 509
 510     if ( style & wxLC_EDIT_LABELS )
 511         wstyle |= LVS_EDITLABELS;
 512
 513     if ( style & wxLC_SINGLE_SEL )
 514         wstyle |= LVS_SINGLESEL;
 515
 516     if ( style & wxLC_SORT_ASCENDING )
 517     {
 518         if ( oldStyle & LVS_SORTDESCENDING )
 519             oldStyle -= LVS_SORTDESCENDING;
 520         wstyle |= LVS_SORTASCENDING;
 521     }
 522
 523     if ( style & wxLC_SORT_DESCENDING )
 524     {
 525         if ( oldStyle & LVS_SORTASCENDING )
 526             oldStyle -= LVS_SORTASCENDING;
 527         wstyle |= LVS_SORTDESCENDING;
 528     }
 529
 530 #if !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 0 ) )
 531     if ( style & wxLC_VIRTUAL )
 532     {
 533         int ver = wxTheApp->GetComCtl32Version();
 534         if ( ver < 470 )
 535         {
 536             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."),
 537                         ver / 100, ver % 100);
 538         }
 539
 540         wstyle |= LVS_OWNERDATA;
 541     }
 542 #endif
 543
 544     return wstyle;
 545 }
 546
 547 // ----------------------------------------------------------------------------
 548 // accessors
 549 // ----------------------------------------------------------------------------
 550
 551 // Sets the foreground, i.e. text, colour
 552 bool wxListCtrl::SetForegroundColour(const wxColour& col)
 553 {
 554     if ( !wxWindow::SetForegroundColour(col) )
 555         return FALSE;
 556
 557     ListView_SetTextColor(GetHwnd(), wxColourToRGB(col));
 558
 559     return TRUE;
 560 }
 561
 562 // Sets the background colour
 563 bool wxListCtrl::SetBackgroundColour(const wxColour& col)
 564 {
 565     if ( !wxWindow::SetBackgroundColour(col) )
 566         return FALSE;
 567
 568     // we set the same colour for both the "empty" background and the items
 569     // background
 570     COLORREF color = wxColourToRGB(col);
 571     ListView_SetBkColor(GetHwnd(), color);
 572     ListView_SetTextBkColor(GetHwnd(), color);
 573
 574     return TRUE;
 575 }
 576
 577 // Gets information about this column
 578 bool wxListCtrl::GetColumn(int col, wxListItem& item) const
 579 {
 580     LV_COLUMN lvCol;
 581     wxZeroMemory(lvCol);
 582
 583     if ( item.m_mask & wxLIST_MASK_TEXT )
 584     {
 585         lvCol.mask |= LVCF_TEXT;
 586         lvCol.pszText = new wxChar[513];
 587         lvCol.cchTextMax = 512;
 588     }
 589
 590     bool success = ListView_GetColumn(GetHwnd(), col, & lvCol) != 0;
 591
 592     //  item.m_subItem = lvCol.iSubItem;
 593     item.m_width = lvCol.cx;
 594
 595     if ( (item.m_mask & wxLIST_MASK_TEXT) && lvCol.pszText )
 596     {
 597         item.m_text = lvCol.pszText;
 598         delete[] lvCol.pszText;
 599     }
 600
 601     if ( item.m_mask & wxLIST_MASK_FORMAT )
 602     {
 603         if (lvCol.fmt == LVCFMT_LEFT)
 604             item.m_format = wxLIST_FORMAT_LEFT;
 605         else if (lvCol.fmt == LVCFMT_RIGHT)
 606             item.m_format = wxLIST_FORMAT_RIGHT;
 607         else if (lvCol.fmt == LVCFMT_CENTER)
 608             item.m_format = wxLIST_FORMAT_CENTRE;
 609     }
 610
 611     return success;
 612 }
 613
 614 // Sets information about this column
 615 bool wxListCtrl::SetColumn(int col, wxListItem& item)
 616 {
 617     LV_COLUMN lvCol;
 618     wxConvertToMSWListCol(col, item, lvCol);
 619
 620     return ListView_SetColumn(GetHwnd(), col, &lvCol) != 0;
 621 }
 622
 623 // Gets the column width
 624 int wxListCtrl::GetColumnWidth(int col) const
 625 {
 626     return ListView_GetColumnWidth(GetHwnd(), col);
 627 }
 628
 629 // Sets the column width
 630 bool wxListCtrl::SetColumnWidth(int col, int width)
 631 {
 632     int col2 = col;
 633     if ( m_windowStyle & wxLC_LIST )
 634         col2 = -1;
 635
 636     int width2 = width;
 637     if ( width2 == wxLIST_AUTOSIZE)
 638         width2 = LVSCW_AUTOSIZE;
 639     else if ( width2 == wxLIST_AUTOSIZE_USEHEADER)
 640         width2 = LVSCW_AUTOSIZE_USEHEADER;
 641
 642     return ListView_SetColumnWidth(GetHwnd(), col2, width2) != 0;
 643 }
 644
 645 // Gets the number of items that can fit vertically in the
 646 // visible area of the list control (list or report view)
 647 // or the total number of items in the list control (icon
 648 // or small icon view)
 649 int wxListCtrl::GetCountPerPage() const
 650 {
 651     return ListView_GetCountPerPage(GetHwnd());
 652 }
 653
 654 // Gets the edit control for editing labels.
 655 wxTextCtrl* wxListCtrl::GetEditControl() const
 656 {
 657     return m_textCtrl;
 658 }
 659
 660 // Gets information about the item
 661 bool wxListCtrl::GetItem(wxListItem& info) const
 662 {
 663     LV_ITEM lvItem;
 664     wxZeroMemory(lvItem);
 665
 666     lvItem.iItem = info.m_itemId;
 667     lvItem.iSubItem = info.m_col;
 668
 669     if ( info.m_mask & wxLIST_MASK_TEXT )
 670     {
 671         lvItem.mask |= LVIF_TEXT;
 672         lvItem.pszText = new wxChar[513];
 673         lvItem.cchTextMax = 512;
 674     }
 675     else
 676     {
 677         lvItem.pszText = NULL;
 678     }
 679
 680     if (info.m_mask & wxLIST_MASK_DATA)
 681         lvItem.mask |= LVIF_PARAM;
 682
 683     if (info.m_mask & wxLIST_MASK_IMAGE)
 684         lvItem.mask |= LVIF_IMAGE;
 685
 686     if ( info.m_mask & wxLIST_MASK_STATE )
 687     {
 688         lvItem.mask |= LVIF_STATE;
 689         // the other bits are hardly interesting anyhow
 690         lvItem.stateMask = LVIS_SELECTED | LVIS_FOCUSED;
 691     }
 692
 693     bool success = ListView_GetItem((HWND)GetHWND(), &lvItem) != 0;
 694     if ( !success )
 695     {
 696         wxLogError(_("Couldn't retrieve information about list control item %d."),
 697                 lvItem.iItem);
 698     }
 699     else
 700     {
 701         // give NULL as hwnd as we already have everything we need
 702         wxConvertFromMSWListItem(NULL, info, lvItem);
 703     }
 704
 705     if (lvItem.pszText)
 706         delete[] lvItem.pszText;
 707
 708     return success;
 709 }
 710
 711 // Sets information about the item
 712 bool wxListCtrl::SetItem(wxListItem& info)
 713 {
 714     LV_ITEM item;
 715     wxConvertToMSWListItem(this, info, item);
 716
 717     // we never update the lParam if it contains our pointer
 718     // to the wxListItemInternalData structure
 719     item.mask &= ~LVIF_PARAM;
 720
 721     // check if setting attributes or lParam
 722     if (info.HasAttributes() || (info.m_mask  & wxLIST_MASK_DATA))
 723     {
 724         // get internal item data
 725         // perhaps a cache here ?
 726         wxListItemInternalData *data = GetInternalData(this, info.m_itemId);
 727
 728         if (! data)
 729         {
 730             // need to set it
 731             m_AnyInternalData = TRUE;
 732             data = new wxListItemInternalData();
 733             item.lParam = (LPARAM) data;
 734             item.mask |= LVIF_PARAM;
 735         };
 736
 737
 738         // user data
 739         if (info.m_mask  & wxLIST_MASK_DATA)
 740             data->lParam = info.m_data;
 741
 742         // attributes
 743         if (info.HasAttributes())
 744         {
 745             if (data->attr)
 746                 *data->attr = *info.GetAttributes();
 747             else
 748                 data->attr = new wxListItemAttr(*info.GetAttributes());
 749         };
 750     };
 751
 752
 753     // we could be changing only the attribute in which case we don't need to
 754     // call ListView_SetItem() at all
 755     if ( item.mask )
 756     {
 757         item.cchTextMax = 0;
 758         if ( !ListView_SetItem(GetHwnd(), &item) )
 759         {
 760             wxLogDebug(_T("ListView_SetItem() failed"));
 761
 762             return FALSE;
 763         }
 764     }
 765
 766     // we need to update the item immediately to show the new image
 767     bool updateNow = (info.m_mask & wxLIST_MASK_IMAGE) != 0;
 768
 769     // check whether it has any custom attributes
 770     if ( info.HasAttributes() )
 771     {
 772         m_hasAnyAttr = TRUE;
 773
 774         // if the colour has changed, we must redraw the item
 775         updateNow = TRUE;
 776     }
 777
 778     if ( updateNow )
 779     {
 780         // we need this to make the change visible right now
 781         RefreshItem(item.iItem);
 782     }
 783
 784     return TRUE;
 785 }
 786
 787 long wxListCtrl::SetItem(long index, int col, const wxString& label, int imageId)
 788 {
 789     wxListItem info;
 790     info.m_text = label;
 791     info.m_mask = wxLIST_MASK_TEXT;
 792     info.m_itemId = index;
 793     info.m_col = col;
 794     if ( imageId > -1 )
 795     {
 796         info.m_image = imageId;
 797         info.m_mask |= wxLIST_MASK_IMAGE;
 798     }
 799     return SetItem(info);
 800 }
 801
 802
 803 // Gets the item state
 804 int wxListCtrl::GetItemState(long item, long stateMask) const
 805 {
 806     wxListItem info;
 807
 808     info.m_mask = wxLIST_MASK_STATE;
 809     info.m_stateMask = stateMask;
 810     info.m_itemId = item;
 811
 812     if (!GetItem(info))
 813         return 0;
 814
 815     return info.m_state;
 816 }
 817
 818 // Sets the item state
 819 bool wxListCtrl::SetItemState(long item, long state, long stateMask)
 820 {
 821     // NB: don't use SetItem() here as it doesn't work with the virtual list
 822     //     controls
 823     LV_ITEM lvItem;
 824     wxZeroMemory(lvItem);
 825
 826     wxConvertToMSWFlags(state, stateMask, lvItem);
 827
 828     // for the virtual list controls we need to refresh the previously focused
 829     // item manually when changing focus without changing selection
 830     // programmatically because otherwise it keeps its focus rectangle until
 831     // next repaint (yet another comctl32 bug)
 832     long focusOld;
 833     if ( IsVirtual() &&
 834          (stateMask & wxLIST_STATE_FOCUSED) &&
 835          (state & wxLIST_STATE_FOCUSED) )
 836     {
 837         focusOld = GetNextItem(-1, wxLIST_NEXT_ALL, wxLIST_STATE_FOCUSED);
 838     }
 839     else
 840     {
 841         focusOld = -1;
 842     }
 843
 844     if ( !::SendMessage(GetHwnd(), LVM_SETITEMSTATE,
 845                         (WPARAM)item, (LPARAM)&lvItem) )
 846     {
 847         wxLogLastError(_T("ListView_SetItemState"));
 848
 849         return FALSE;
 850     }
 851
 852     if ( focusOld != -1 )
 853     {
 854         // no need to refresh the item if it was previously selected, it would
 855         // only result in annoying flicker
 856         if ( !(GetItemState(focusOld,
 857                             wxLIST_STATE_SELECTED) & wxLIST_STATE_SELECTED) )
 858         {
 859             RefreshItem(focusOld);
 860         }
 861     }
 862
 863     return TRUE;
 864 }
 865
 866 // Sets the item image
 867 bool wxListCtrl::SetItemImage(long item, int image, int WXUNUSED(selImage))
 868 {
 869     wxListItem info;
 870
 871     info.m_mask = wxLIST_MASK_IMAGE;
 872     info.m_image = image;
 873     info.m_itemId = item;
 874
 875     return SetItem(info);
 876 }
 877
 878 // Gets the item text
 879 wxString wxListCtrl::GetItemText(long item) const
 880 {
 881     wxListItem info;
 882
 883     info.m_mask = wxLIST_MASK_TEXT;
 884     info.m_itemId = item;
 885
 886     if (!GetItem(info))
 887         return wxString("");
 888     return info.m_text;
 889 }
 890
 891 // Sets the item text
 892 void wxListCtrl::SetItemText(long item, const wxString& str)
 893 {
 894     wxListItem info;
 895
 896     info.m_mask = wxLIST_MASK_TEXT;
 897     info.m_itemId = item;
 898     info.m_text = str;
 899
 900     SetItem(info);
 901 }
 902
 903 // Gets the item data
 904 long wxListCtrl::GetItemData(long item) const
 905 {
 906     wxListItem info;
 907
 908     info.m_mask = wxLIST_MASK_DATA;
 909     info.m_itemId = item;
 910
 911     if (!GetItem(info))
 912         return 0;
 913     return info.m_data;
 914 }
 915
 916 // Sets the item data
 917 bool wxListCtrl::SetItemData(long item, long data)
 918 {
 919     wxListItem info;
 920
 921     info.m_mask = wxLIST_MASK_DATA;
 922     info.m_itemId = item;
 923     info.m_data = data;
 924
 925     return SetItem(info);
 926 }
 927
 928 // Gets the item rectangle
 929 bool wxListCtrl::GetItemRect(long item, wxRect& rect, int code) const
 930 {
 931     RECT rectWin;
 932
 933     int codeWin;
 934     if ( code == wxLIST_RECT_BOUNDS )
 935         codeWin = LVIR_BOUNDS;
 936     else if ( code == wxLIST_RECT_ICON )
 937         codeWin = LVIR_ICON;
 938     else if ( code == wxLIST_RECT_LABEL )
 939         codeWin = LVIR_LABEL;
 940     else
 941     {
 942         wxFAIL_MSG( _T("incorrect code in GetItemRect()") );
 943
 944         codeWin = LVIR_BOUNDS;
 945     }
 946
 947 #ifdef __WXWINE__
 948     bool success = ListView_GetItemRect(GetHwnd(), (int) item, &rectWin ) != 0;
 949 #else
 950     bool success = ListView_GetItemRect(GetHwnd(), (int) item, &rectWin, codeWin) != 0;
 951 #endif
 952
 953     rect.x = rectWin.left;
 954     rect.y = rectWin.top;
 955     rect.width = rectWin.right - rectWin.left;
 956     rect.height = rectWin.bottom - rectWin.top;
 957
 958     return success;
 959 }
 960
 961 // Gets the item position
 962 bool wxListCtrl::GetItemPosition(long item, wxPoint& pos) const
 963 {
 964     POINT pt;
 965
 966     bool success = (ListView_GetItemPosition(GetHwnd(), (int) item, &pt) != 0);
 967
 968     pos.x = pt.x; pos.y = pt.y;
 969     return success;
 970 }
 971
 972 // Sets the item position.
 973 bool wxListCtrl::SetItemPosition(long item, const wxPoint& pos)
 974 {
 975     return (ListView_SetItemPosition(GetHwnd(), (int) item, pos.x, pos.y) != 0);
 976 }
 977
 978 // Gets the number of items in the list control
 979 int wxListCtrl::GetItemCount() const
 980 {
 981     return ListView_GetItemCount(GetHwnd());
 982 }
 983
 984 // Retrieves the spacing between icons in pixels.
 985 // If small is TRUE, gets the spacing for the small icon
 986 // view, otherwise the large icon view.
 987 int wxListCtrl::GetItemSpacing(bool isSmall) const
 988 {
 989     return ListView_GetItemSpacing(GetHwnd(), (BOOL) isSmall);
 990 }
 991
 992 void wxListCtrl::SetItemTextColour( long item, const wxColour &col )
 993 {
 994     wxListItem info;
 995     info.m_itemId = item;
 996     info.SetTextColour( col );
 997     SetItem( info );
 998 }
 999
1000 wxColour wxListCtrl::GetItemTextColour( long item ) const
1001 {
1002     wxListItem info;
1003     info.m_itemId = item;
1004     GetItem( info );
1005     return info.GetTextColour();
1006 }
1007
1008 void wxListCtrl::SetItemBackgroundColour( long item, const wxColour &col )
1009 {
1010     wxListItem info;
1011     info.m_itemId = item;
1012     info.SetBackgroundColour( col );
1013     SetItem( info );
1014 }
1015
1016 wxColour wxListCtrl::GetItemBackgroundColour( long item ) const
1017 {
1018     wxListItem info;
1019     info.m_itemId = item;
1020     GetItem( info );
1021     return info.GetBackgroundColour();
1022 }
1023
1024 // Gets the number of selected items in the list control
1025 int wxListCtrl::GetSelectedItemCount() const
1026 {
1027     return ListView_GetSelectedCount(GetHwnd());
1028 }
1029
1030 // Gets the text colour of the listview
1031 wxColour wxListCtrl::GetTextColour() const
1032 {
1033     COLORREF ref = ListView_GetTextColor(GetHwnd());
1034     wxColour col(GetRValue(ref), GetGValue(ref), GetBValue(ref));
1035     return col;
1036 }
1037
1038 // Sets the text colour of the listview
1039 void wxListCtrl::SetTextColour(const wxColour& col)
1040 {
1041     ListView_SetTextColor(GetHwnd(), PALETTERGB(col.Red(), col.Green(), col.Blue()));
1042 }
1043
1044 // Gets the index of the topmost visible item when in
1045 // list or report view
1046 long wxListCtrl::GetTopItem() const
1047 {
1048     return (long) ListView_GetTopIndex(GetHwnd());
1049 }
1050
1051 // Searches for an item, starting from 'item'.
1052 // 'geometry' is one of
1053 // wxLIST_NEXT_ABOVE/ALL/BELOW/LEFT/RIGHT.
1054 // 'state' is a state bit flag, one or more of
1055 // wxLIST_STATE_DROPHILITED/FOCUSED/SELECTED/CUT.
1056 // item can be -1 to find the first item that matches the
1057 // specified flags.
1058 // Returns the item or -1 if unsuccessful.
1059 long wxListCtrl::GetNextItem(long item, int geom, int state) const
1060 {
1061     long flags = 0;
1062
1063     if ( geom == wxLIST_NEXT_ABOVE )
1064         flags |= LVNI_ABOVE;
1065     if ( geom == wxLIST_NEXT_ALL )
1066         flags |= LVNI_ALL;
1067     if ( geom == wxLIST_NEXT_BELOW )
1068         flags |= LVNI_BELOW;
1069     if ( geom == wxLIST_NEXT_LEFT )
1070         flags |= LVNI_TOLEFT;
1071     if ( geom == wxLIST_NEXT_RIGHT )
1072         flags |= LVNI_TORIGHT;
1073
1074     if ( state & wxLIST_STATE_CUT )
1075         flags |= LVNI_CUT;
1076     if ( state & wxLIST_STATE_DROPHILITED )
1077         flags |= LVNI_DROPHILITED;
1078     if ( state & wxLIST_STATE_FOCUSED )
1079         flags |= LVNI_FOCUSED;
1080     if ( state & wxLIST_STATE_SELECTED )
1081         flags |= LVNI_SELECTED;
1082
1083     return (long) ListView_GetNextItem(GetHwnd(), item, flags);
1084 }
1085
1086
1087 wxImageList *wxListCtrl::GetImageList(int which) const
1088 {
1089     if ( which == wxIMAGE_LIST_NORMAL )
1090     {
1091         return m_imageListNormal;
1092     }
1093     else if ( which == wxIMAGE_LIST_SMALL )
1094     {
1095         return m_imageListSmall;
1096     }
1097     else if ( which == wxIMAGE_LIST_STATE )
1098     {
1099         return m_imageListState;
1100     }
1101     return NULL;
1102 }
1103
1104 void wxListCtrl::SetImageList(wxImageList *imageList, int which)
1105 {
1106     int flags = 0;
1107     if ( which == wxIMAGE_LIST_NORMAL )
1108     {
1109         flags = LVSIL_NORMAL;
1110         if (m_ownsImageListNormal) delete m_imageListNormal;
1111         m_imageListNormal = imageList;
1112         m_ownsImageListNormal = FALSE;
1113     }
1114     else if ( which == wxIMAGE_LIST_SMALL )
1115     {
1116         flags = LVSIL_SMALL;
1117         if (m_ownsImageListSmall) delete m_imageListSmall;
1118         m_imageListSmall = imageList;
1119         m_ownsImageListSmall = FALSE;
1120     }
1121     else if ( which == wxIMAGE_LIST_STATE )
1122     {
1123         flags = LVSIL_STATE;
1124         if (m_ownsImageListState) delete m_imageListState;
1125         m_imageListState = imageList;
1126         m_ownsImageListState = FALSE;
1127     }
1128     ListView_SetImageList(GetHwnd(), (HIMAGELIST) imageList ? imageList->GetHIMAGELIST() : 0, flags);
1129 }
1130
1131 void wxListCtrl::AssignImageList(wxImageList *imageList, int which)
1132 {
1133     SetImageList(imageList, which);
1134     if ( which == wxIMAGE_LIST_NORMAL )
1135         m_ownsImageListNormal = TRUE;
1136     else if ( which == wxIMAGE_LIST_SMALL )
1137         m_ownsImageListSmall = TRUE;
1138     else if ( which == wxIMAGE_LIST_STATE )
1139         m_ownsImageListState = TRUE;
1140 }
1141
1142 // ----------------------------------------------------------------------------
1143 // Operations
1144 // ----------------------------------------------------------------------------
1145
1146 // Arranges the items
1147 bool wxListCtrl::Arrange(int flag)
1148 {
1149     UINT code = 0;
1150     if ( flag == wxLIST_ALIGN_LEFT )
1151         code = LVA_ALIGNLEFT;
1152     else if ( flag == wxLIST_ALIGN_TOP )
1153         code = LVA_ALIGNTOP;
1154     else if ( flag == wxLIST_ALIGN_DEFAULT )
1155         code = LVA_DEFAULT;
1156     else if ( flag == wxLIST_ALIGN_SNAP_TO_GRID )
1157         code = LVA_SNAPTOGRID;
1158
1159     return (ListView_Arrange(GetHwnd(), code) != 0);
1160 }
1161
1162 // Deletes an item
1163 bool wxListCtrl::DeleteItem(long item)
1164 {
1165     if ( !ListView_DeleteItem(GetHwnd(), (int) item) )
1166     {
1167         wxLogLastError(_T("ListView_DeleteItem"));
1168         return FALSE;
1169     }
1170
1171     // the virtual list control doesn't refresh itself correctly, help it
1172     if ( IsVirtual() )
1173     {
1174         // we need to refresh all the lines below the one which was deleted
1175         wxRect rectItem;
1176         if ( item > 0 && GetItemCount() )
1177         {
1178             GetItemRect(item - 1, rectItem);
1179         }
1180         else
1181         {
1182             rectItem.y =
1183             rectItem.height = 0;
1184         }
1185
1186         wxRect rectWin = GetRect();
1187         rectWin.height = rectWin.GetBottom() - rectItem.GetBottom();
1188         rectWin.y = rectItem.GetBottom();
1189
1190         RefreshRect(rectWin);
1191     }
1192
1193     return TRUE;
1194 }
1195
1196 // Deletes all items
1197 bool wxListCtrl::DeleteAllItems()
1198 {
1199     return ListView_DeleteAllItems(GetHwnd()) != 0;
1200 }
1201
1202 // Deletes all items
1203 bool wxListCtrl::DeleteAllColumns()
1204 {
1205     while ( m_colCount > 0 )
1206     {
1207         if ( ListView_DeleteColumn(GetHwnd(), 0) == 0 )
1208         {
1209             wxLogLastError(wxT("ListView_DeleteColumn"));
1210
1211             return FALSE;
1212         }
1213
1214         m_colCount--;
1215     }
1216
1217     wxASSERT_MSG( m_colCount == 0, wxT("no columns should be left") );
1218
1219     return TRUE;
1220 }
1221
1222 // Deletes a column
1223 bool wxListCtrl::DeleteColumn(int col)
1224 {
1225     bool success = (ListView_DeleteColumn(GetHwnd(), col) != 0);
1226
1227     if ( success && (m_colCount > 0) )
1228         m_colCount --;
1229     return success;
1230 }
1231
1232 // Clears items, and columns if there are any.
1233 void wxListCtrl::ClearAll()
1234 {
1235     DeleteAllItems();
1236     if ( m_colCount > 0 )
1237         DeleteAllColumns();
1238 }
1239
1240 wxTextCtrl* wxListCtrl::EditLabel(long item, wxClassInfo* textControlClass)
1241 {
1242     wxASSERT( (textControlClass->IsKindOf(CLASSINFO(wxTextCtrl))) );
1243
1244     // VS: ListView_EditLabel requires that the list has focus.
1245     SetFocus();
1246     HWND hWnd = (HWND) ListView_EditLabel(GetHwnd(), item);
1247
1248     if (m_textCtrl)
1249     {
1250         m_textCtrl->SetHWND(0);
1251         m_textCtrl->UnsubclassWin();
1252         delete m_textCtrl;
1253         m_textCtrl = NULL;
1254     }
1255
1256     m_textCtrl = (wxTextCtrl*) textControlClass->CreateObject();
1257     m_textCtrl->SetHWND((WXHWND) hWnd);
1258     m_textCtrl->SubclassWin((WXHWND) hWnd);
1259
1260     return m_textCtrl;
1261 }
1262
1263 // End label editing, optionally cancelling the edit
1264 bool wxListCtrl::EndEditLabel(bool WXUNUSED(cancel))
1265 {
1266     wxFAIL_MSG( _T("not implemented") );
1267
1268     return FALSE;
1269 }
1270
1271 // Ensures this item is visible
1272 bool wxListCtrl::EnsureVisible(long item)
1273 {
1274     return ListView_EnsureVisible(GetHwnd(), (int) item, FALSE) != 0;
1275 }
1276
1277 // Find an item whose label matches this string, starting from the item after 'start'
1278 // or the beginning if 'start' is -1.
1279 long wxListCtrl::FindItem(long start, const wxString& str, bool partial)
1280 {
1281     LV_FINDINFO findInfo;
1282
1283     findInfo.flags = LVFI_STRING;
1284     if ( partial )
1285         findInfo.flags |= LVFI_PARTIAL;
1286     findInfo.psz = str;
1287
1288     // ListView_FindItem() excludes the first item from search and to look
1289     // through all the items you need to start from -1 which is unnatural and
1290     // inconsistent with the generic version - so we adjust the index
1291     if (start != -1)
1292         start --;
1293     return ListView_FindItem(GetHwnd(), (int) start, &findInfo);
1294 }
1295
1296 // Find an item whose data matches this data, starting from the item after 'start'
1297 // or the beginning if 'start' is -1.
1298 long wxListCtrl::FindItem(long start, long data)
1299 {
1300     LV_FINDINFO findInfo;
1301
1302     findInfo.flags = LVFI_PARAM;
1303     findInfo.lParam = data;
1304
1305     return ListView_FindItem(GetHwnd(), (int) start, & findInfo);
1306 }
1307
1308 // Find an item nearest this position in the specified direction, starting from
1309 // the item after 'start' or the beginning if 'start' is -1.
1310 long wxListCtrl::FindItem(long start, const wxPoint& pt, int direction)
1311 {
1312     LV_FINDINFO findInfo;
1313
1314     findInfo.flags = LVFI_NEARESTXY;
1315     findInfo.pt.x = pt.x;
1316     findInfo.pt.y = pt.y;
1317     findInfo.vkDirection = VK_RIGHT;
1318
1319     if ( direction == wxLIST_FIND_UP )
1320         findInfo.vkDirection = VK_UP;
1321     else if ( direction == wxLIST_FIND_DOWN )
1322         findInfo.vkDirection = VK_DOWN;
1323     else if ( direction == wxLIST_FIND_LEFT )
1324         findInfo.vkDirection = VK_LEFT;
1325     else if ( direction == wxLIST_FIND_RIGHT )
1326         findInfo.vkDirection = VK_RIGHT;
1327
1328     return ListView_FindItem(GetHwnd(), (int) start, & findInfo);
1329 }
1330
1331 // Determines which item (if any) is at the specified point,
1332 // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
1333 long wxListCtrl::HitTest(const wxPoint& point, int& flags)
1334 {
1335     LV_HITTESTINFO hitTestInfo;
1336     hitTestInfo.pt.x = (int) point.x;
1337     hitTestInfo.pt.y = (int) point.y;
1338
1339     ListView_HitTest(GetHwnd(), & hitTestInfo);
1340
1341     flags = 0;
1342     if ( hitTestInfo.flags & LVHT_ABOVE )
1343         flags |= wxLIST_HITTEST_ABOVE;
1344     if ( hitTestInfo.flags & LVHT_BELOW )
1345         flags |= wxLIST_HITTEST_BELOW;
1346     if ( hitTestInfo.flags & LVHT_NOWHERE )
1347         flags |= wxLIST_HITTEST_NOWHERE;
1348     if ( hitTestInfo.flags & LVHT_ONITEMICON )
1349         flags |= wxLIST_HITTEST_ONITEMICON;
1350     if ( hitTestInfo.flags & LVHT_ONITEMLABEL )
1351         flags |= wxLIST_HITTEST_ONITEMLABEL;
1352     if ( hitTestInfo.flags & LVHT_ONITEMSTATEICON )
1353         flags |= wxLIST_HITTEST_ONITEMSTATEICON;
1354     if ( hitTestInfo.flags & LVHT_TOLEFT )
1355         flags |= wxLIST_HITTEST_TOLEFT;
1356     if ( hitTestInfo.flags & LVHT_TORIGHT )
1357         flags |= wxLIST_HITTEST_TORIGHT;
1358
1359     return (long) hitTestInfo.iItem;
1360 }
1361
1362 // Inserts an item, returning the index of the new item if successful,
1363 // -1 otherwise.
1364 long wxListCtrl::InsertItem(wxListItem& info)
1365 {
1366     wxASSERT_MSG( !IsVirtual(), _T("can't be used with virtual controls") );
1367
1368     LV_ITEM item;
1369     wxConvertToMSWListItem(this, info, item);
1370     item.mask &= ~LVIF_PARAM;
1371
1372     // check wether we need to allocate our internal data
1373     bool needInternalData = ((info.m_mask & wxLIST_MASK_DATA) || info.HasAttributes());
1374     if (needInternalData)
1375     {
1376         m_AnyInternalData = TRUE;
1377         item.mask |= LVIF_PARAM;
1378
1379         // internal stucture that manages data
1380         wxListItemInternalData *data = new wxListItemInternalData();
1381         item.lParam = (LPARAM) data;
1382
1383         if (info.m_mask & wxLIST_MASK_DATA)
1384             data->lParam = info.m_data;
1385
1386     // check whether it has any custom attributes
1387     if ( info.HasAttributes() )
1388     {
1389             // take copy of attributes
1390             data->attr = new wxListItemAttr(*info.GetAttributes());
1391     }
1392     };
1393
1394
1395     return (long) ListView_InsertItem(GetHwnd(), & item);
1396 }
1397
1398 long wxListCtrl::InsertItem(long index, const wxString& label)
1399 {
1400     wxListItem info;
1401     info.m_text = label;
1402     info.m_mask = wxLIST_MASK_TEXT;
1403     info.m_itemId = index;
1404     return InsertItem(info);
1405 }
1406
1407 // Inserts an image item
1408 long wxListCtrl::InsertItem(long index, int imageIndex)
1409 {
1410     wxListItem info;
1411     info.m_image = imageIndex;
1412     info.m_mask = wxLIST_MASK_IMAGE;
1413     info.m_itemId = index;
1414     return InsertItem(info);
1415 }
1416
1417 // Inserts an image/string item
1418 long wxListCtrl::InsertItem(long index, const wxString& label, int imageIndex)
1419 {
1420     wxListItem info;
1421     info.m_image = imageIndex;
1422     info.m_text = label;
1423     info.m_mask = wxLIST_MASK_IMAGE | wxLIST_MASK_TEXT;
1424     info.m_itemId = index;
1425     return InsertItem(info);
1426 }
1427
1428 // For list view mode (only), inserts a column.
1429 long wxListCtrl::InsertColumn(long col, wxListItem& item)
1430 {
1431     LV_COLUMN lvCol;
1432     wxConvertToMSWListCol(col, item, lvCol);
1433
1434     if ( !(lvCol.mask & LVCF_WIDTH) )
1435     {
1436         // always give some width to the new column: this one is compatible
1437         // with the generic version
1438         lvCol.mask |= LVCF_WIDTH;
1439         lvCol.cx = 80;
1440     }
1441
1442     // when we insert a column which can contain an image, we must specify this
1443     // flag right now as doing it later in SetColumn() has no effect
1444     //
1445     // we use LVCFMT_BITMAP_ON_RIGHT by default because without it there is no
1446     // way to dynamically set/clear the bitmap as the column without a bitmap
1447     // on the left looks ugly (there is a hole)
1448     //
1449     // unfortunately with my version of comctl32.dll (5.80), the left column
1450     // image is always on the left and it seems that it's a "feature" - I
1451     // didn't find any way to work around it in any case
1452     if ( lvCol.mask & LVCF_IMAGE )
1453     {
1454         lvCol.mask |= LVCF_FMT;
1455         lvCol.fmt |= LVCFMT_BITMAP_ON_RIGHT;
1456     }
1457
1458     bool success = ListView_InsertColumn(GetHwnd(), col, &lvCol) != -1;
1459     if ( success )
1460     {
1461         m_colCount++;
1462     }
1463     else
1464     {
1465         wxLogDebug(wxT("Failed to insert the column '%s' into listview!"),
1466                    lvCol.pszText);
1467     }
1468
1469     return success;
1470 }
1471
1472 long wxListCtrl::InsertColumn(long col,
1473                               const wxString& heading,
1474                               int format,
1475                               int width)
1476 {
1477     wxListItem item;
1478     item.m_mask = wxLIST_MASK_TEXT | wxLIST_MASK_FORMAT;
1479     item.m_text = heading;
1480     if ( width > -1 )
1481     {
1482         item.m_mask |= wxLIST_MASK_WIDTH;
1483         item.m_width = width;
1484     }
1485     item.m_format = format;
1486
1487     return InsertColumn(col, item);
1488 }
1489
1490 // Scrolls the list control. If in icon, small icon or report view mode,
1491 // x specifies the number of pixels to scroll. If in list view mode, x
1492 // specifies the number of columns to scroll.
1493 // If in icon, small icon or list view mode, y specifies the number of pixels
1494 // to scroll. If in report view mode, y specifies the number of lines to scroll.
1495 bool wxListCtrl::ScrollList(int dx, int dy)
1496 {
1497     return (ListView_Scroll(GetHwnd(), dx, dy) != 0);
1498 }
1499
1500 // Sort items.
1501
1502 // fn is a function which takes 3 long arguments: item1, item2, data.
1503 // item1 is the long data associated with a first item (NOT the index).
1504 // item2 is the long data associated with a second item (NOT the index).
1505 // data is the same value as passed to SortItems.
1506 // The return value is a negative number if the first item should precede the second
1507 // item, a positive number of the second item should precede the first,
1508 // or zero if the two items are equivalent.
1509
1510 // data is arbitrary data to be passed to the sort function.
1511
1512 // Internal structures for proxying the user compare function
1513 // so that we can pass it the *real* user data
1514
1515 // translate lParam data and call user func
1516 struct wxInternalDataSort
1517 {
1518     wxListCtrlCompare user_fn;
1519     long data;
1520 };
1521
1522 int CALLBACK wxInternalDataCompareFunc(LPARAM lParam1, LPARAM lParam2,  LPARAM lParamSort)
1523 {
1524     struct wxInternalDataSort *internalData = (struct wxInternalDataSort *) lParamSort;
1525
1526     wxListItemInternalData *data1 = (wxListItemInternalData *) lParam1;
1527     wxListItemInternalData *data2 = (wxListItemInternalData *) lParam2;
1528
1529     long d1 = (data1 == NULL ? 0 : data1->lParam);
1530     long d2 = (data2 == NULL ? 0 : data2->lParam);
1531
1532     return internalData->user_fn(d1, d2, internalData->data);
1533
1534 };
1535
1536 bool wxListCtrl::SortItems(wxListCtrlCompare fn, long data)
1537 {
1538     struct wxInternalDataSort internalData;
1539     internalData.user_fn = fn;
1540     internalData.data = data;
1541
1542     if ( !ListView_SortItems(GetHwnd(), wxInternalDataCompareFunc, &internalData) )
1543     {
1544         wxLogDebug(_T("ListView_SortItems() failed"));
1545
1546         return FALSE;
1547     }
1548
1549     return TRUE;
1550 }
1551
1552
1553
1554 // ----------------------------------------------------------------------------
1555 // message processing
1556 // ----------------------------------------------------------------------------
1557
1558 bool wxListCtrl::MSWCommand(WXUINT cmd, WXWORD id)
1559 {
1560     if (cmd == EN_UPDATE)
1561     {
1562         wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, id);
1563         event.SetEventObject( this );
1564         ProcessCommand(event);
1565         return TRUE;
1566     }
1567     else if (cmd == EN_KILLFOCUS)
1568     {
1569         wxCommandEvent event(wxEVT_KILL_FOCUS, id);
1570         event.SetEventObject( this );
1571         ProcessCommand(event);
1572         return TRUE;
1573     }
1574     else
1575         return FALSE;
1576 }
1577
1578 bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
1579 {
1580     // prepare the event
1581     // -----------------
1582
1583     wxListEvent event(wxEVT_NULL, m_windowId);
1584     event.SetEventObject(this);
1585
1586     wxEventType eventType = wxEVT_NULL;
1587
1588     NMHDR *nmhdr = (NMHDR *)lParam;
1589
1590     // if your compiler is as broken as this, you should really change it: this
1591     // code is needed for normal operation! #ifdef below is only useful for
1592     // automatic rebuilds which are done with a very old compiler version
1593 #ifdef HDN_BEGINTRACKA
1594
1595     // check for messages from the header (in report view)
1596     HWND hwndHdr = ListView_GetHeader(GetHwnd());
1597
1598     // is it a message from the header?
1599     if ( nmhdr->hwndFrom == hwndHdr )
1600     {
1601         HD_NOTIFY *nmHDR = (HD_NOTIFY *)nmhdr;
1602
1603         event.m_itemIndex = -1;
1604
1605         switch ( nmhdr->code )
1606         {
1607             // yet another comctl32.dll bug: under NT/W2K it sends Unicode
1608             // TRACK messages even to ANSI programs: on my system I get
1609             // HDN_BEGINTRACKW and HDN_ENDTRACKA and no HDN_TRACK at all!
1610             //
1611             // work around is to simply catch both versions and hope that it
1612             // works (why should this message exist in ANSI and Unicode is
1613             // beyond me as it doesn't deal with strings at all...)
1614             case HDN_BEGINTRACKA:
1615             case HDN_BEGINTRACKW:
1616                 eventType = wxEVT_COMMAND_LIST_COL_BEGIN_DRAG;
1617                 // fall through
1618
1619             case HDN_TRACKA:
1620             case HDN_TRACKW:
1621                 if ( eventType == wxEVT_NULL )
1622                     eventType = wxEVT_COMMAND_LIST_COL_DRAGGING;
1623                 // fall through
1624
1625             case HDN_ENDTRACKA:
1626             case HDN_ENDTRACKW:
1627                 if ( eventType == wxEVT_NULL )
1628                     eventType = wxEVT_COMMAND_LIST_COL_END_DRAG;
1629                 event.m_col = nmHDR->iItem;
1630                 break;
1631
1632             case NM_RCLICK:
1633                 {
1634                     eventType = wxEVT_COMMAND_LIST_COL_RIGHT_CLICK;
1635                     event.m_col = -1;
1636
1637                     // find the column clicked: we have to search for it
1638                     // ourselves as the notification message doesn't provide
1639                     // this info
1640
1641                     // where did the click occur?
1642                     POINT ptClick;
1643                     if ( !::GetCursorPos(&ptClick) )
1644                     {
1645                         wxLogLastError(_T("GetCursorPos"));
1646                     }
1647
1648                     if ( !::ScreenToClient(hwndHdr, &ptClick) )
1649                     {
1650                         wxLogLastError(_T("ScreenToClient(listctrl header)"));
1651                     }
1652
1653                     event.m_pointDrag.x = ptClick.x;
1654                     event.m_pointDrag.y = ptClick.y;
1655
1656                     int colCount = Header_GetItemCount(hwndHdr);
1657
1658                     RECT rect;
1659                     for ( int col = 0; col < colCount; col++ )
1660                     {
1661                         if ( Header_GetItemRect(hwndHdr, col, &rect) )
1662                         {
1663                             if ( ::PtInRect(&rect, ptClick) )
1664                             {
1665                                 event.m_col = col;
1666                                 break;
1667                             }
1668                         }
1669                     }
1670                 }
1671                 break;
1672
1673             default:
1674                 return wxControl::MSWOnNotify(idCtrl, lParam, result);
1675         }
1676     }
1677     else
1678 #endif // defined(HDN_BEGINTRACKA)
1679         if ( nmhdr->hwndFrom == GetHwnd() )
1680     {
1681         // almost all messages use NM_LISTVIEW
1682         NM_LISTVIEW *nmLV = (NM_LISTVIEW *)nmhdr;
1683
1684         // this is true for almost all events
1685         event.m_item.m_data = nmLV->lParam;
1686
1687         switch ( nmhdr->code )
1688         {
1689             case LVN_BEGINRDRAG:
1690                 eventType = wxEVT_COMMAND_LIST_BEGIN_RDRAG;
1691                 // fall through
1692
1693             case LVN_BEGINDRAG:
1694                 if ( eventType == wxEVT_NULL )
1695                 {
1696                     eventType = wxEVT_COMMAND_LIST_BEGIN_DRAG;
1697                 }
1698
1699                 event.m_itemIndex = nmLV->iItem;
1700                 event.m_pointDrag.x = nmLV->ptAction.x;
1701                 event.m_pointDrag.y = nmLV->ptAction.y;
1702                 break;
1703
1704             // NB: we have to handle both *A and *W versions here because some
1705             //    versions of comctl32.dll send ANSI message to an Unicode app
1706             case LVN_BEGINLABELEDITA:
1707                 {
1708                     eventType = wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT;
1709                     wxLV_ITEM item(((LV_DISPINFOA *)lParam)->item);
1710                     wxConvertFromMSWListItem(GetHwnd(), event.m_item, item);
1711                     event.m_itemIndex = event.m_item.m_itemId;
1712                 }
1713                 break;
1714             case LVN_BEGINLABELEDITW:
1715                 {
1716                     eventType = wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT;
1717                     wxLV_ITEM item(((LV_DISPINFOW *)lParam)->item);
1718                     wxConvertFromMSWListItem(GetHwnd(), event.m_item, item);
1719                     event.m_itemIndex = event.m_item.m_itemId;
1720                 }
1721                 break;
1722
1723             case LVN_ENDLABELEDITA:
1724                 {
1725                     eventType = wxEVT_COMMAND_LIST_END_LABEL_EDIT;
1726                     wxLV_ITEM item(((LV_DISPINFOA *)lParam)->item);
1727                     wxConvertFromMSWListItem(NULL, event.m_item, item);
1728                     if ( ((LV_ITEM)item).pszText == NULL ||
1729                          ((LV_ITEM)item).iItem == -1 )
1730                         return FALSE;
1731
1732                     event.m_itemIndex = event.m_item.m_itemId;
1733                 }
1734                 break;
1735             case LVN_ENDLABELEDITW:
1736                 {
1737                     eventType = wxEVT_COMMAND_LIST_END_LABEL_EDIT;
1738                     wxLV_ITEM item(((LV_DISPINFOW *)lParam)->item);
1739                     wxConvertFromMSWListItem(NULL, event.m_item, item);
1740                     if ( ((LV_ITEM)item).pszText == NULL ||
1741                          ((LV_ITEM)item).iItem == -1 )
1742                         return FALSE;
1743
1744                     event.m_itemIndex = event.m_item.m_itemId;
1745                 }
1746                 break;
1747
1748             case LVN_COLUMNCLICK:
1749                 eventType = wxEVT_COMMAND_LIST_COL_CLICK;
1750                 event.m_itemIndex = -1;
1751                 event.m_col = nmLV->iSubItem;
1752                 break;
1753
1754             case LVN_DELETEALLITEMS:
1755                 eventType = wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS;
1756                 event.m_itemIndex = -1;
1757                 break;
1758
1759             case LVN_DELETEITEM:
1760                 eventType = wxEVT_COMMAND_LIST_DELETE_ITEM;
1761                 event.m_itemIndex = nmLV->iItem;
1762
1763                 // delete the assoicated internal data
1764                 {
1765                     wxListItemInternalData *data =
1766                         GetInternalData(this, nmLV->iItem);
1767                     if (data)
1768                         delete data;
1769                 };
1770                 break;
1771
1772             case LVN_SETDISPINFO:
1773                 {
1774                     eventType = wxEVT_COMMAND_LIST_SET_INFO;
1775                     LV_DISPINFO *info = (LV_DISPINFO *)lParam;
1776                     wxConvertFromMSWListItem(GetHwnd(), event.m_item, info->item);
1777                 }
1778                 break;
1779
1780             case LVN_INSERTITEM:
1781                 eventType = wxEVT_COMMAND_LIST_INSERT_ITEM;
1782                 event.m_itemIndex = nmLV->iItem;
1783                 break;
1784
1785             case LVN_ITEMCHANGED:
1786                 // we translate this catch all message into more interesting
1787                 // (and more easy to process) wxWindows events
1788
1789                 // first of all, we deal with the state change events only
1790                 if ( nmLV->uChanged & LVIF_STATE )
1791                 {
1792                     // temp vars for readability
1793                     const UINT stOld = nmLV->uOldState;
1794                     const UINT stNew = nmLV->uNewState;
1795
1796                     // has the focus changed?
1797                     if ( !(stOld & LVIS_FOCUSED) && (stNew & LVIS_FOCUSED) )
1798                     {
1799                         eventType = wxEVT_COMMAND_LIST_ITEM_FOCUSED;
1800                         event.m_itemIndex = nmLV->iItem;
1801                     }
1802
1803                     if ( (stNew & LVIS_SELECTED) != (stOld & LVIS_SELECTED) )
1804                     {
1805                         if ( eventType != wxEVT_NULL )
1806                         {
1807                             // focus and selection have both changed: send the
1808                             // focus event from here and the selection one
1809                             // below
1810                             event.SetEventType(eventType);
1811                             (void)GetEventHandler()->ProcessEvent(event);
1812                         }
1813                         else // no focus event to send
1814                         {
1815                             // then need to set m_itemIndex as it wasn't done
1816                             // above
1817                             event.m_itemIndex = nmLV->iItem;
1818                         }
1819
1820                         eventType = stNew & LVIS_SELECTED
1821                                         ? wxEVT_COMMAND_LIST_ITEM_SELECTED
1822                                         : wxEVT_COMMAND_LIST_ITEM_DESELECTED;
1823                     }
1824                 }
1825
1826                 if ( eventType == wxEVT_NULL )
1827                 {
1828                     // not an interesting event for us
1829                     return FALSE;
1830                 }
1831
1832                 break;
1833
1834             case LVN_KEYDOWN:
1835                 {
1836                     LV_KEYDOWN *info = (LV_KEYDOWN *)lParam;
1837                     WORD wVKey = info->wVKey;
1838
1839                     // get the current selection
1840                     long lItem = GetNextItem(-1,
1841                                              wxLIST_NEXT_ALL,
1842                                              wxLIST_STATE_SELECTED);
1843
1844                     // <Enter> or <Space> activate the selected item if any (but
1845                     // not with Shift and/or Ctrl as then they have a predefined
1846                     // meaning for the list view)
1847                     if ( lItem != -1 &&
1848                          (wVKey == VK_RETURN || wVKey == VK_SPACE) &&
1849                          !(wxIsShiftDown() || wxIsCtrlDown()) )
1850                     {
1851                         eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED;
1852                     }
1853                     else
1854                     {
1855                         eventType = wxEVT_COMMAND_LIST_KEY_DOWN;
1856
1857                         // wxCharCodeMSWToWX() returns 0 if the key is an ASCII
1858                         // value which should be used as is
1859                         int code = wxCharCodeMSWToWX(wVKey);
1860                         event.m_code = code ? code : wVKey;
1861                     }
1862
1863                     event.m_itemIndex =
1864                     event.m_item.m_itemId = lItem;
1865
1866                     if ( lItem != -1 )
1867                     {
1868                         // fill the other fields too
1869                         event.m_item.m_text = GetItemText(lItem);
1870                         event.m_item.m_data = GetItemData(lItem);
1871                     }
1872                 }
1873                 break;
1874
1875             case NM_DBLCLK:
1876                 // if the user processes it in wxEVT_COMMAND_LEFT_CLICK(), don't do
1877                 // anything else
1878                 if ( wxControl::MSWOnNotify(idCtrl, lParam, result) )
1879                 {
1880                     return TRUE;
1881                 }
1882
1883                 // else translate it into wxEVT_COMMAND_LIST_ITEM_ACTIVATED event
1884                 // if it happened on an item (and not on empty place)
1885                 if ( nmLV->iItem == -1 )
1886                 {
1887                     // not on item
1888                     return FALSE;
1889                 }
1890
1891                 eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED;
1892                 event.m_itemIndex = nmLV->iItem;
1893                 event.m_item.m_text = GetItemText(nmLV->iItem);
1894                 event.m_item.m_data = GetItemData(nmLV->iItem);
1895                 break;
1896
1897             case NM_RCLICK:
1898                 // if the user processes it in wxEVT_COMMAND_RIGHT_CLICK(),
1899                 // don't do anything else
1900                 if ( wxControl::MSWOnNotify(idCtrl, lParam, result) )
1901                 {
1902                     return TRUE;
1903                 }
1904
1905                 // else translate it into wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK event
1906                 LV_HITTESTINFO lvhti;
1907                 wxZeroMemory(lvhti);
1908
1909                 ::GetCursorPos(&(lvhti.pt));
1910                 ::ScreenToClient(GetHwnd(),&(lvhti.pt));
1911                 if ( ListView_HitTest(GetHwnd(),&lvhti) != -1 )
1912                 {
1913                     if ( lvhti.flags & LVHT_ONITEM )
1914                     {
1915                         eventType = wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK;
1916                         event.m_itemIndex = lvhti.iItem;
1917                         event.m_pointDrag.x = lvhti.pt.x;
1918                         event.m_pointDrag.y = lvhti.pt.y;
1919                     }
1920                 }
1921                 break;
1922
1923 #if defined(_WIN32_IE) && _WIN32_IE >= 0x300 \
1924         && !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 0 ) )
1925             case NM_CUSTOMDRAW:
1926                 *result = OnCustomDraw(lParam);
1927
1928                 return TRUE;
1929 #endif // _WIN32_IE >= 0x300
1930
1931             case LVN_ODCACHEHINT:
1932                 {
1933                     const NM_CACHEHINT *cacheHint = (NM_CACHEHINT *)lParam;
1934
1935                     eventType = wxEVT_COMMAND_LIST_CACHE_HINT;
1936
1937                     // we get some really stupid cache hints like ones for items in
1938                     // range 0..0 for an empty control or, after deleting an item,
1939                     // for items in invalid range - filter this garbage out
1940                     if ( cacheHint->iFrom < cacheHint->iTo )
1941                     {
1942                         event.m_oldItemIndex = cacheHint->iFrom;
1943
1944                         long iMax = GetItemCount();
1945                         event.m_itemIndex = cacheHint->iTo < iMax ? cacheHint->iTo
1946                                                                   : iMax - 1;
1947                     }
1948                     else
1949                     {
1950                         return FALSE;
1951                     }
1952                 }
1953                 break;
1954
1955             case LVN_GETDISPINFO:
1956                 if ( IsVirtual() )
1957                 {
1958                     LV_DISPINFO *info = (LV_DISPINFO *)lParam;
1959
1960                     LV_ITEM& lvi = info->item;
1961                     long item = lvi.iItem;
1962
1963                     if ( lvi.mask & LVIF_TEXT )
1964                     {
1965                         wxString text = OnGetItemText(item, lvi.iSubItem);
1966                         wxStrncpy(lvi.pszText, text, lvi.cchTextMax);
1967                     }
1968
1969 #if defined(_WIN32_IE) && _WIN32_IE >= 0x300 \
1970         && !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 1 ) )
1971                     if ( lvi.mask & LVIF_IMAGE )
1972                     {
1973                         lvi.iImage = OnGetItemImage(item);
1974                     }
1975 #endif
1976
1977                     // a little dose of healthy paranoia: as we never use
1978                     // LVM_SETCALLBACKMASK we're not supposed to get these ones
1979                     wxASSERT_MSG( !(lvi.mask & LVIF_STATE),
1980                                   _T("we don't support state callbacks yet!") );
1981
1982                     return TRUE;
1983                 }
1984                 // fall through
1985
1986             default:
1987                 return wxControl::MSWOnNotify(idCtrl, lParam, result);
1988         }
1989     }
1990     else
1991     {
1992         // where did this one come from?
1993         return FALSE;
1994     }
1995
1996     // process the event
1997     // -----------------
1998
1999     event.SetEventType(eventType);
2000
2001     if ( !GetEventHandler()->ProcessEvent(event) )
2002         return FALSE;
2003
2004     // post processing
2005     // ---------------
2006
2007     switch ( nmhdr->code )
2008     {
2009         case LVN_DELETEALLITEMS:
2010             // always return TRUE to suppress all additional LVN_DELETEITEM
2011             // notifications - this makes deleting all items from a list ctrl
2012             // much faster
2013             *result = TRUE;
2014
2015             return TRUE;
2016
2017         case LVN_ENDLABELEDITA:
2018         case LVN_ENDLABELEDITW:
2019             // logic here is inversed compared to all the other messages
2020             *result = event.IsAllowed();
2021
2022             return TRUE;
2023     }
2024
2025     *result = !event.IsAllowed();
2026
2027     return TRUE;
2028 }
2029
2030 #if defined(_WIN32_IE) && _WIN32_IE >= 0x300
2031
2032 WXLPARAM wxListCtrl::OnCustomDraw(WXLPARAM lParam)
2033 {
2034     LPNMLVCUSTOMDRAW lplvcd = (LPNMLVCUSTOMDRAW)lParam;
2035     NMCUSTOMDRAW& nmcd = lplvcd->nmcd;
2036     switch ( nmcd.dwDrawStage )
2037     {
2038         case CDDS_PREPAINT:
2039             // if we've got any items with non standard attributes,
2040             // notify us before painting each item
2041             //
2042             // for virtual controls, always suppose that we have attributes as
2043             // there is no way to check for this
2044             return IsVirtual() || m_hasAnyAttr ? CDRF_NOTIFYITEMDRAW
2045                                                : CDRF_DODEFAULT;
2046
2047         case CDDS_ITEMPREPAINT:
2048             {
2049                 size_t item = (size_t)nmcd.dwItemSpec;
2050                 if ( item >= (size_t)GetItemCount() )
2051                 {
2052                     // we get this message with item == 0 for an empty control,
2053                     // we must ignore it as calling OnGetItemAttr() would be
2054                     // wrong
2055                     return CDRF_DODEFAULT;
2056                 }
2057
2058                 wxListItemAttr *attr =
2059                     IsVirtual() ? OnGetItemAttr(item)
2060                                 : GetInternalDataAttr(this, item);
2061
2062                 if ( !attr )
2063                 {
2064                     // nothing to do for this item
2065                     return CDRF_DODEFAULT;
2066                 }
2067
2068                 HFONT hFont;
2069                 wxColour colText, colBack;
2070                 if ( attr->HasFont() )
2071                 {
2072                     wxFont font = attr->GetFont();
2073                     hFont = (HFONT)font.GetResourceHandle();
2074                 }
2075                 else
2076                 {
2077                     hFont = 0;
2078                 }
2079
2080                 if ( attr->HasTextColour() )
2081                 {
2082                     colText = attr->GetTextColour();
2083                 }
2084                 else
2085                 {
2086                     colText = GetTextColour();
2087                 }
2088
2089                 if ( attr->HasBackgroundColour() )
2090                 {
2091                     colBack = attr->GetBackgroundColour();
2092                 }
2093                 else
2094                 {
2095                     colBack = GetBackgroundColour();
2096                 }
2097
2098                 lplvcd->clrText = wxColourToRGB(colText);
2099                 lplvcd->clrTextBk = wxColourToRGB(colBack);
2100
2101                 // note that if we wanted to set colours for
2102                 // individual columns (subitems), we would have
2103                 // returned CDRF_NOTIFYSUBITEMREDRAW from here
2104                 if ( hFont )
2105                 {
2106                     ::SelectObject(nmcd.hdc, hFont);
2107
2108                     return CDRF_NEWFONT;
2109                 }
2110             }
2111             // fall through to return CDRF_DODEFAULT
2112
2113         default:
2114             return CDRF_DODEFAULT;
2115     }
2116 }
2117
2118 #endif // NM_CUSTOMDRAW supported
2119
2120 // Necessary for drawing hrules and vrules, if specified
2121 void wxListCtrl::OnPaint(wxPaintEvent& event)
2122 {
2123     wxPaintDC dc(this);
2124
2125     wxControl::OnPaint(event);
2126
2127     // Reset the device origin since it may have been set
2128     dc.SetDeviceOrigin(0, 0);
2129
2130     bool drawHRules = ((GetWindowStyle() & wxLC_HRULES) != 0);
2131     bool drawVRules = ((GetWindowStyle() & wxLC_VRULES) != 0);
2132
2133     if (!drawHRules && !drawVRules)
2134         return;
2135     if ((GetWindowStyle() & wxLC_REPORT) == 0)
2136         return;
2137
2138     wxPen pen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT), 1, wxSOLID);
2139     dc.SetPen(pen);
2140     dc.SetBrush(* wxTRANSPARENT_BRUSH);
2141
2142     wxSize clientSize = GetClientSize();
2143     wxRect itemRect;
2144     int cy=0;
2145
2146     int itemCount = GetItemCount();
2147     int i;
2148     if (drawHRules)
2149     {
2150         long top = GetTopItem();
2151         for (i = top; i < top + GetCountPerPage() + 1; i++)
2152         {
2153             if (GetItemRect(i, itemRect))
2154             {
2155                 cy = itemRect.GetTop();
2156                 if (i != 0) // Don't draw the first one
2157                 {
2158                     dc.DrawLine(0, cy, clientSize.x, cy);
2159                 }
2160                 // Draw last line
2161                 if (i == itemCount - 1)
2162                 {
2163                     cy = itemRect.GetBottom();
2164                     dc.DrawLine(0, cy, clientSize.x, cy);
2165                 }
2166             }
2167         }
2168     }
2169     i = itemCount - 1;
2170     if (drawVRules && (i > -1))
2171     {
2172         wxRect firstItemRect;
2173         GetItemRect(0, firstItemRect);
2174
2175         if (GetItemRect(i, itemRect))
2176         {
2177             int col;
2178             int x = itemRect.GetX();
2179             for (col = 0; col < GetColumnCount(); col++)
2180             {
2181                 int colWidth = GetColumnWidth(col);
2182                 x += colWidth ;
2183                 dc.DrawLine(x, firstItemRect.GetY() - 2, x, itemRect.GetBottom());
2184             }
2185         }
2186     }
2187 }
2188
2189 // ----------------------------------------------------------------------------
2190 // virtual list controls
2191 // ----------------------------------------------------------------------------
2192
2193 wxString wxListCtrl::OnGetItemText(long WXUNUSED(item), long WXUNUSED(col)) const
2194 {
2195     // this is a pure virtual function, in fact - which is not really pure
2196     // because the controls which are not virtual don't need to implement it
2197     wxFAIL_MSG( _T("not supposed to be called") );
2198
2199     return wxEmptyString;
2200 }
2201
2202 int wxListCtrl::OnGetItemImage(long WXUNUSED(item)) const
2203 {
2204     // same as above
2205     wxFAIL_MSG( _T("not supposed to be called") );
2206
2207     return -1;
2208 }
2209
2210 wxListItemAttr *wxListCtrl::OnGetItemAttr(long WXUNUSED_UNLESS_DEBUG(item)) const
2211 {
2212     wxASSERT_MSG( item >= 0 && item < GetItemCount(),
2213                   _T("invalid item index in OnGetItemAttr()") );
2214
2215     // no attributes by default
2216     return NULL;
2217 }
2218
2219 void wxListCtrl::SetItemCount(long count)
2220 {
2221     wxASSERT_MSG( IsVirtual(), _T("this is for virtual controls only") );
2222
2223     if ( !::SendMessage(GetHwnd(), LVM_SETITEMCOUNT, (WPARAM)count, 0) )
2224     {
2225         wxLogLastError(_T("ListView_SetItemCount"));
2226     }
2227 }
2228
2229 void wxListCtrl::RefreshItem(long item)
2230 {
2231     // strangely enough, ListView_Update() results in much more flicker here
2232     // than a dumb Refresh() -- why?
2233 #if 0
2234     if ( !ListView_Update(GetHwnd(), item) )
2235     {
2236         wxLogLastError(_T("ListView_Update"));
2237     }
2238 #else // 1
2239     wxRect rect;
2240     GetItemRect(item, rect);
2241     RefreshRect(rect);
2242 #endif // 0/1
2243 }
2244
2245 void wxListCtrl::RefreshItems(long itemFrom, long itemTo)
2246 {
2247     wxRect rect1, rect2;
2248     GetItemRect(itemFrom, rect1);
2249     GetItemRect(itemTo, rect2);
2250
2251     wxRect rect = rect1;
2252     rect.height = rect2.GetBottom() - rect1.GetTop();
2253
2254     RefreshRect(rect);
2255 }
2256
2257 static wxListItemInternalData *GetInternalData(HWND hwnd, long itemId)
2258 {
2259     LV_ITEM it;
2260     it.mask = LVIF_PARAM;
2261     it.iItem = itemId;
2262
2263     bool success = ListView_GetItem(hwnd, &it) != 0;
2264     if (success)
2265         return (wxListItemInternalData *) it.lParam;
2266     else
2267         return NULL;
2268 };
2269
2270 static wxListItemInternalData *GetInternalData(wxListCtrl *ctl, long itemId)
2271 {
2272     return GetInternalData((HWND) ctl->GetHWND(), itemId);
2273 };
2274
2275 static wxListItemAttr *GetInternalDataAttr(wxListCtrl *ctl, long itemId)
2276 {
2277     wxListItemInternalData *data = GetInternalData(ctl, itemId);
2278     if (data)
2279         return data->attr;
2280     else
2281         return NULL;
2282 };
2283
2284
2285 static void wxConvertFromMSWListItem(HWND hwndListCtrl,
2286                                      wxListItem& info,
2287                                      LV_ITEM& lvItem)
2288 {
2289     wxListItemInternalData *internaldata =
2290         (wxListItemInternalData *) lvItem.lParam;
2291
2292     if (internaldata)
2293         info.m_data = internaldata->lParam;
2294
2295     info.m_mask = 0;
2296     info.m_state = 0;
2297     info.m_stateMask = 0;
2298     info.m_itemId = lvItem.iItem;
2299
2300     long oldMask = lvItem.mask;
2301
2302     bool needText = FALSE;
2303     if (hwndListCtrl != 0)
2304     {
2305         if ( lvItem.mask & LVIF_TEXT )
2306             needText = FALSE;
2307         else
2308             needText = TRUE;
2309
2310         if ( needText )
2311         {
2312             lvItem.pszText = new wxChar[513];
2313             lvItem.cchTextMax = 512;
2314         }
2315         lvItem.mask |= LVIF_TEXT | LVIF_IMAGE | LVIF_PARAM;
2316         ::SendMessage(hwndListCtrl, LVM_GETITEM, 0, (LPARAM)& lvItem);
2317     }
2318
2319     if ( lvItem.mask & LVIF_STATE )
2320     {
2321         info.m_mask |= wxLIST_MASK_STATE;
2322
2323         if ( lvItem.stateMask & LVIS_CUT)
2324         {
2325             info.m_stateMask |= wxLIST_STATE_CUT;
2326             if ( lvItem.state & LVIS_CUT )
2327                 info.m_state |= wxLIST_STATE_CUT;
2328         }
2329         if ( lvItem.stateMask & LVIS_DROPHILITED)
2330         {
2331             info.m_stateMask |= wxLIST_STATE_DROPHILITED;
2332             if ( lvItem.state & LVIS_DROPHILITED )
2333                 info.m_state |= wxLIST_STATE_DROPHILITED;
2334         }
2335         if ( lvItem.stateMask & LVIS_FOCUSED)
2336         {
2337             info.m_stateMask |= wxLIST_STATE_FOCUSED;
2338             if ( lvItem.state & LVIS_FOCUSED )
2339                 info.m_state |= wxLIST_STATE_FOCUSED;
2340         }
2341         if ( lvItem.stateMask & LVIS_SELECTED)
2342         {
2343             info.m_stateMask |= wxLIST_STATE_SELECTED;
2344             if ( lvItem.state & LVIS_SELECTED )
2345                 info.m_state |= wxLIST_STATE_SELECTED;
2346         }
2347     }
2348
2349     if ( lvItem.mask & LVIF_TEXT )
2350     {
2351         info.m_mask |= wxLIST_MASK_TEXT;
2352         info.m_text = lvItem.pszText;
2353     }
2354     if ( lvItem.mask & LVIF_IMAGE )
2355     {
2356         info.m_mask |= wxLIST_MASK_IMAGE;
2357         info.m_image = lvItem.iImage;
2358     }
2359     if ( lvItem.mask & LVIF_PARAM )
2360         info.m_mask |= wxLIST_MASK_DATA;
2361     if ( lvItem.mask & LVIF_DI_SETITEM )
2362         info.m_mask |= wxLIST_SET_ITEM;
2363     info.m_col = lvItem.iSubItem;
2364
2365     if (needText)
2366     {
2367         if (lvItem.pszText)
2368             delete[] lvItem.pszText;
2369     }
2370     lvItem.mask = oldMask;
2371 }
2372
2373 static void wxConvertToMSWFlags(long state, long stateMask, LV_ITEM& lvItem)
2374 {
2375     if (stateMask & wxLIST_STATE_CUT)
2376     {
2377         lvItem.stateMask |= LVIS_CUT;
2378         if (state & wxLIST_STATE_CUT)
2379             lvItem.state |= LVIS_CUT;
2380     }
2381     if (stateMask & wxLIST_STATE_DROPHILITED)
2382     {
2383         lvItem.stateMask |= LVIS_DROPHILITED;
2384         if (state & wxLIST_STATE_DROPHILITED)
2385             lvItem.state |= LVIS_DROPHILITED;
2386     }
2387     if (stateMask & wxLIST_STATE_FOCUSED)
2388     {
2389         lvItem.stateMask |= LVIS_FOCUSED;
2390         if (state & wxLIST_STATE_FOCUSED)
2391             lvItem.state |= LVIS_FOCUSED;
2392     }
2393     if (stateMask & wxLIST_STATE_SELECTED)
2394     {
2395         lvItem.stateMask |= LVIS_SELECTED;
2396         if (state & wxLIST_STATE_SELECTED)
2397             lvItem.state |= LVIS_SELECTED;
2398     }
2399 }
2400
2401 static void wxConvertToMSWListItem(const wxListCtrl *ctrl,
2402                                    const wxListItem& info,
2403                                    LV_ITEM& lvItem)
2404 {
2405     lvItem.iItem = (int) info.m_itemId;
2406
2407     lvItem.iImage = info.m_image;
2408     lvItem.stateMask = 0;
2409     lvItem.state = 0;
2410     lvItem.mask = 0;
2411     lvItem.iSubItem = info.m_col;
2412
2413     if (info.m_mask & wxLIST_MASK_STATE)
2414     {
2415         lvItem.mask |= LVIF_STATE;
2416
2417         wxConvertToMSWFlags(info.m_state, info.m_stateMask, lvItem);
2418     }
2419
2420     if (info.m_mask & wxLIST_MASK_TEXT)
2421     {
2422         lvItem.mask |= LVIF_TEXT;
2423         if ( ctrl->GetWindowStyleFlag() & wxLC_USER_TEXT )
2424         {
2425             lvItem.pszText = LPSTR_TEXTCALLBACK;
2426         }
2427         else
2428         {
2429             // pszText is not const, hence the cast
2430             lvItem.pszText = (wxChar *)info.m_text.c_str();
2431             if ( lvItem.pszText )
2432                 lvItem.cchTextMax = info.m_text.Length();
2433             else
2434                 lvItem.cchTextMax = 0;
2435         }
2436     }
2437     if (info.m_mask & wxLIST_MASK_IMAGE)
2438         lvItem.mask |= LVIF_IMAGE;
2439 }
2440
2441 static void wxConvertToMSWListCol(int WXUNUSED(col), const wxListItem& item,
2442                                   LV_COLUMN& lvCol)
2443 {
2444     wxZeroMemory(lvCol);
2445
2446     if ( item.m_mask & wxLIST_MASK_TEXT )
2447     {
2448         lvCol.mask |= LVCF_TEXT;
2449         lvCol.pszText = (wxChar *)item.m_text.c_str(); // cast is safe
2450     }
2451
2452     if ( item.m_mask & wxLIST_MASK_FORMAT )
2453     {
2454         lvCol.mask |= LVCF_FMT;
2455
2456         if ( item.m_format == wxLIST_FORMAT_LEFT )
2457             lvCol.fmt = LVCFMT_LEFT;
2458         else if ( item.m_format == wxLIST_FORMAT_RIGHT )
2459             lvCol.fmt = LVCFMT_RIGHT;
2460         else if ( item.m_format == wxLIST_FORMAT_CENTRE )
2461             lvCol.fmt = LVCFMT_CENTER;
2462     }
2463
2464     if ( item.m_mask & wxLIST_MASK_WIDTH )
2465     {
2466         lvCol.mask |= LVCF_WIDTH;
2467         if ( item.m_width == wxLIST_AUTOSIZE)
2468             lvCol.cx = LVSCW_AUTOSIZE;
2469         else if ( item.m_width == wxLIST_AUTOSIZE_USEHEADER)
2470             lvCol.cx = LVSCW_AUTOSIZE_USEHEADER;
2471         else
2472             lvCol.cx = item.m_width;
2473     }
2474
2475 #if defined(_WIN32_IE) && _WIN32_IE >= 0x300 \
2476         && !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 1 ) )
2477     if ( item.m_mask & wxLIST_MASK_IMAGE )
2478     {
2479         if ( wxTheApp->GetComCtl32Version() >= 470 )
2480         {
2481             lvCol.mask |= LVCF_IMAGE;
2482             lvCol.iImage = item.m_image;
2483         }
2484         //else: it doesn't support item images anyhow
2485     }
2486 #endif
2487 }
2488
2489 #endif // wxUSE_LISTCTRL