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