src/msw/listctrl.cpp

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