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