src/msw/listctrl.cpp

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