src/msw/listctrl.cpp

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