src/msw/listctrl.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 #ifdef __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
  44 #include "wx/listctrl.h"
  45
  46 #include "wx/msw/private.h"
  47
  48 #ifdef __GNUWIN32_OLD__
  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 // ----------------------------------------------------------------------------
  68 // private functions
  69 // ----------------------------------------------------------------------------
  70
  71 static void wxConvertToMSWListItem(const wxListCtrl *ctrl, wxListItem& info, LV_ITEM& tvItem);
  72 static void wxConvertFromMSWListItem(const wxListCtrl *ctrl, wxListItem& info, LV_ITEM& tvItem, HWND getFullInfo = 0);
  73
  74 // ----------------------------------------------------------------------------
  75 // macros
  76 // ----------------------------------------------------------------------------
  77
  78 IMPLEMENT_DYNAMIC_CLASS(wxListCtrl, wxControl)
  79 IMPLEMENT_DYNAMIC_CLASS(wxListItem, wxObject)
  80
  81 // ============================================================================
  82 // implementation
  83 // ============================================================================
  84
  85 // ----------------------------------------------------------------------------
  86 // wxListEvent
  87 // ----------------------------------------------------------------------------
  88
  89 void wxListEvent::CopyObject(wxObject& object_dest) const
  90 {
  91     wxListEvent *obj = (wxListEvent *)&object_dest;
  92
  93     wxNotifyEvent::CopyObject(object_dest);
  94
  95     obj->m_code = m_code;
  96     obj->m_itemIndex = m_itemIndex;
  97     obj->m_oldItemIndex = m_oldItemIndex;
  98     obj->m_col = m_col;
  99     obj->m_cancelled = m_cancelled;
 100     obj->m_pointDrag = m_pointDrag;
 101     obj->m_item.m_mask = m_item.m_mask;
 102     obj->m_item.m_itemId = m_item.m_itemId;
 103     obj->m_item.m_col = m_item.m_col;
 104     obj->m_item.m_state = m_item.m_state;
 105     obj->m_item.m_stateMask = m_item.m_stateMask;
 106     obj->m_item.m_text = m_item.m_text;
 107     obj->m_item.m_image = m_item.m_image;
 108     obj->m_item.m_data = m_item.m_data;
 109     obj->m_item.m_format = m_item.m_format;
 110     obj->m_item.m_width = m_item.m_width;
 111
 112     if ( m_item.HasAttributes() )
 113     {
 114         obj->m_item.SetTextColour(m_item.GetTextColour());
 115         obj->m_item.SetBackgroundColour(m_item.GetBackgroundColour());
 116         obj->m_item.SetFont(m_item.GetFont());
 117     }
 118 }
 119
 120 // ----------------------------------------------------------------------------
 121 // wxListCtrl construction
 122 // ----------------------------------------------------------------------------
 123
 124 void wxListCtrl::Init()
 125 {
 126     m_imageListNormal = NULL;
 127     m_imageListSmall = NULL;
 128     m_imageListState = NULL;
 129     m_baseStyle = 0;
 130     m_colCount = 0;
 131     m_textCtrl = NULL;
 132     m_hasAnyAttr = FALSE;
 133 }
 134
 135 bool wxListCtrl::Create(wxWindow *parent,
 136                         wxWindowID id,
 137                         const wxPoint& pos,
 138                         const wxSize& size,
 139                         long style,
 140                         const wxValidator& validator,
 141                         const wxString& name)
 142 {
 143 #if wxUSE_VALIDATORS
 144     SetValidator(validator);
 145 #endif // wxUSE_VALIDATORS
 146
 147     SetName(name);
 148
 149     int x = pos.x;
 150     int y = pos.y;
 151     int width = size.x;
 152     int height = size.y;
 153
 154     m_windowStyle = style;
 155
 156     SetParent(parent);
 157
 158     if (width <= 0)
 159         width = 100;
 160     if (height <= 0)
 161         height = 30;
 162     if (x < 0)
 163         x = 0;
 164     if (y < 0)
 165         y = 0;
 166
 167     m_windowId = (id == -1) ? NewControlId() : id;
 168
 169     DWORD wstyle = WS_VISIBLE | WS_CHILD | WS_TABSTOP |
 170                    LVS_SHAREIMAGELISTS | LVS_SHOWSELALWAYS;
 171     if ( wxStyleHasBorder(m_windowStyle) )
 172         wstyle |= WS_BORDER;
 173     m_baseStyle = wstyle;
 174
 175     if ( !DoCreateControl(x, y, width, height) )
 176         return FALSE;
 177
 178     if (parent)
 179         parent->AddChild(this);
 180
 181     return TRUE;
 182 }
 183
 184 bool wxListCtrl::DoCreateControl(int x, int y, int w, int h)
 185 {
 186     DWORD wstyle = m_baseStyle;
 187
 188     bool want3D;
 189     WXDWORD exStyle = Determine3DEffects(WS_EX_CLIENTEDGE, &want3D);
 190
 191     // Even with extended styles, need to combine with WS_BORDER
 192     // for them to look right.
 193     if ( want3D )
 194         wstyle |= WS_BORDER;
 195
 196     long oldStyle = 0; // Dummy
 197     wstyle |= ConvertToMSWStyle(oldStyle, m_windowStyle);
 198
 199     // Create the ListView control.
 200     m_hWnd = (WXHWND)CreateWindowEx(exStyle,
 201                                     WC_LISTVIEW,
 202                                     wxT(""),
 203                                     wstyle,
 204                                     x, y, w, h,
 205                                     GetWinHwnd(GetParent()),
 206                                     (HMENU)m_windowId,
 207                                     wxGetInstance(),
 208                                     NULL);
 209
 210     if ( !m_hWnd )
 211     {
 212         wxLogError(_("Can't create list control window, check that comctl32.dll is installed."));
 213
 214         return FALSE;
 215     }
 216
 217     // for comctl32.dll v 4.70+ we want to have this attribute because it's
 218     // prettier (and also because wxGTK does it like this)
 219     if ( (wstyle & LVS_REPORT) && wxTheApp->GetComCtl32Version() >= 470 )
 220     {
 221         ::SendMessage(GetHwnd(), LVM_SETEXTENDEDLISTVIEWSTYLE,
 222                       0, LVS_EX_FULLROWSELECT);
 223     }
 224
 225     SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_WINDOW));
 226     SetForegroundColour(GetParent()->GetForegroundColour());
 227
 228     SubclassWin(m_hWnd);
 229
 230     return TRUE;
 231 }
 232
 233 void wxListCtrl::UpdateStyle()
 234 {
 235     if ( GetHWND() )
 236     {
 237         // The new window view style
 238         long dummy;
 239         DWORD dwStyleNew = ConvertToMSWStyle(dummy, m_windowStyle);
 240         dwStyleNew |= m_baseStyle;
 241
 242         // Get the current window style.
 243         DWORD dwStyleOld = ::GetWindowLong(GetHwnd(), GWL_STYLE);
 244
 245         // Only set the window style if the view bits have changed.
 246         if ( dwStyleOld != dwStyleNew )
 247         {
 248             ::SetWindowLong(GetHwnd(), GWL_STYLE, dwStyleNew);
 249         }
 250     }
 251 }
 252
 253 void wxListCtrl::FreeAllAttrs(bool dontRecreate)
 254 {
 255     if ( m_hasAnyAttr )
 256     {
 257         for ( wxNode *node = m_attrs.Next(); node; node = m_attrs.Next() )
 258         {
 259             delete (wxListItemAttr *)node->Data();
 260         }
 261
 262         m_attrs.Destroy();
 263         if ( !dontRecreate )
 264         {
 265             m_attrs.Create(wxKEY_INTEGER, 1000);        // just as def ctor
 266         }
 267
 268         m_hasAnyAttr = FALSE;
 269     }
 270 }
 271
 272 wxListCtrl::~wxListCtrl()
 273 {
 274     FreeAllAttrs(TRUE /* no need to recreate hash any more */);
 275
 276     if ( m_textCtrl )
 277     {
 278         m_textCtrl->UnsubclassWin();
 279         m_textCtrl->SetHWND(0);
 280         delete m_textCtrl;
 281         m_textCtrl = NULL;
 282     }
 283 }
 284
 285 // ----------------------------------------------------------------------------
 286 // set/get/change style
 287 // ----------------------------------------------------------------------------
 288
 289 // Add or remove a single window style
 290 void wxListCtrl::SetSingleStyle(long style, bool add)
 291 {
 292     long flag = GetWindowStyleFlag();
 293
 294     // Get rid of conflicting styles
 295     if ( add )
 296     {
 297         if ( style & wxLC_MASK_TYPE)
 298             flag = flag & ~wxLC_MASK_TYPE;
 299         if ( style & wxLC_MASK_ALIGN )
 300             flag = flag & ~wxLC_MASK_ALIGN;
 301         if ( style & wxLC_MASK_SORT )
 302             flag = flag & ~wxLC_MASK_SORT;
 303     }
 304
 305     if ( flag & style )
 306     {
 307         if ( !add )
 308             flag -= style;
 309     }
 310     else
 311     {
 312         if ( add )
 313         {
 314             flag |= style;
 315         }
 316     }
 317
 318     m_windowStyle = flag;
 319
 320     UpdateStyle();
 321 }
 322
 323 // Set the whole window style
 324 void wxListCtrl::SetWindowStyleFlag(long flag)
 325 {
 326     m_windowStyle = flag;
 327
 328     UpdateStyle();
 329 }
 330
 331 // Can be just a single style, or a bitlist
 332 long wxListCtrl::ConvertToMSWStyle(long& oldStyle, long style) const
 333 {
 334     long wstyle = 0;
 335     if ( style & wxLC_ICON )
 336     {
 337         if ( (oldStyle & LVS_TYPEMASK) == LVS_SMALLICON )
 338             oldStyle -= LVS_SMALLICON;
 339         if ( (oldStyle & LVS_TYPEMASK) == LVS_REPORT )
 340             oldStyle -= LVS_REPORT;
 341         if ( (oldStyle & LVS_TYPEMASK) == LVS_LIST )
 342             oldStyle -= LVS_LIST;
 343         wstyle |= LVS_ICON;
 344     }
 345
 346     if ( style & wxLC_SMALL_ICON )
 347     {
 348         if ( (oldStyle & LVS_TYPEMASK) == LVS_ICON )
 349             oldStyle -= LVS_ICON;
 350         if ( (oldStyle & LVS_TYPEMASK) == LVS_REPORT )
 351             oldStyle -= LVS_REPORT;
 352         if ( (oldStyle & LVS_TYPEMASK) == LVS_LIST )
 353             oldStyle -= LVS_LIST;
 354         wstyle |= LVS_SMALLICON;
 355     }
 356
 357     if ( style & wxLC_LIST )
 358     {
 359         if ( (oldStyle & LVS_TYPEMASK) == LVS_ICON )
 360             oldStyle -= LVS_ICON;
 361         if ( (oldStyle & LVS_TYPEMASK) == LVS_REPORT )
 362             oldStyle -= LVS_REPORT;
 363         if ( (oldStyle & LVS_TYPEMASK) == LVS_SMALLICON )
 364             oldStyle -= LVS_SMALLICON;
 365         wstyle |= LVS_LIST;
 366     }
 367
 368     if ( style & wxLC_REPORT )
 369     {
 370         if ( (oldStyle & LVS_TYPEMASK) == LVS_ICON )
 371             oldStyle -= LVS_ICON;
 372         if ( (oldStyle & LVS_TYPEMASK) == LVS_LIST )
 373             oldStyle -= LVS_LIST;
 374         if ( (oldStyle & LVS_TYPEMASK) == LVS_SMALLICON )
 375             oldStyle -= LVS_SMALLICON;
 376
 377         wstyle |= LVS_REPORT;
 378     }
 379
 380     if ( style & wxLC_ALIGN_LEFT )
 381     {
 382         if ( oldStyle & LVS_ALIGNTOP )
 383             oldStyle -= LVS_ALIGNTOP;
 384         wstyle |= LVS_ALIGNLEFT;
 385     }
 386
 387     if ( style & wxLC_ALIGN_TOP )
 388     {
 389         if ( oldStyle & LVS_ALIGNLEFT )
 390             oldStyle -= LVS_ALIGNLEFT;
 391         wstyle |= LVS_ALIGNTOP;
 392     }
 393
 394     if ( style & wxLC_AUTOARRANGE )
 395         wstyle |= LVS_AUTOARRANGE;
 396
 397     // Apparently, no such style (documentation wrong?)
 398     /*
 399        if ( style & wxLC_BUTTON )
 400        wstyle |= LVS_BUTTON;
 401      */
 402
 403     if ( style & wxLC_NO_SORT_HEADER )
 404         wstyle |= LVS_NOSORTHEADER;
 405
 406     if ( style & wxLC_NO_HEADER )
 407         wstyle |= LVS_NOCOLUMNHEADER;
 408
 409     if ( style & wxLC_EDIT_LABELS )
 410         wstyle |= LVS_EDITLABELS;
 411
 412     if ( style & wxLC_SINGLE_SEL )
 413         wstyle |= LVS_SINGLESEL;
 414
 415     if ( style & wxLC_SORT_ASCENDING )
 416     {
 417         if ( oldStyle & LVS_SORTDESCENDING )
 418             oldStyle -= LVS_SORTDESCENDING;
 419         wstyle |= LVS_SORTASCENDING;
 420     }
 421
 422     if ( style & wxLC_SORT_DESCENDING )
 423     {
 424         if ( oldStyle & LVS_SORTASCENDING )
 425             oldStyle -= LVS_SORTASCENDING;
 426         wstyle |= LVS_SORTDESCENDING;
 427     }
 428
 429     return wstyle;
 430 }
 431
 432 // ----------------------------------------------------------------------------
 433 // accessors
 434 // ----------------------------------------------------------------------------
 435
 436 // Sets the foreground, i.e. text, colour
 437 bool wxListCtrl::SetForegroundColour(const wxColour& col)
 438 {
 439     if ( !wxWindow::SetForegroundColour(col) )
 440         return FALSE;
 441
 442     ListView_SetTextColor(GetHwnd(), wxColourToRGB(col));
 443
 444     return TRUE;
 445 }
 446
 447 // Sets the background colour
 448 bool wxListCtrl::SetBackgroundColour(const wxColour& col)
 449 {
 450     if ( !wxWindow::SetBackgroundColour(col) )
 451         return FALSE;
 452
 453     // we set the same colour for both the "empty" background and the items
 454     // background
 455     COLORREF color = wxColourToRGB(col);
 456     ListView_SetBkColor(GetHwnd(), color);
 457     ListView_SetTextBkColor(GetHwnd(), color);
 458
 459     return TRUE;
 460 }
 461
 462 // Gets information about this column
 463 bool wxListCtrl::GetColumn(int col, wxListItem& item) const
 464 {
 465     LV_COLUMN lvCol;
 466     lvCol.mask = 0;
 467     lvCol.fmt = 0;
 468     lvCol.pszText = NULL;
 469
 470     if ( item.m_mask & wxLIST_MASK_TEXT )
 471     {
 472         lvCol.mask |= LVCF_TEXT;
 473         lvCol.pszText = new wxChar[513];
 474         lvCol.cchTextMax = 512;
 475     }
 476
 477     bool success = (ListView_GetColumn(GetHwnd(), col, & lvCol) != 0);
 478
 479     //  item.m_subItem = lvCol.iSubItem;
 480     item.m_width = lvCol.cx;
 481
 482     if ( (item.m_mask & wxLIST_MASK_TEXT) && lvCol.pszText )
 483     {
 484         item.m_text = lvCol.pszText;
 485         delete[] lvCol.pszText;
 486     }
 487
 488     if ( item.m_mask & wxLIST_MASK_FORMAT )
 489     {
 490         if (lvCol.fmt == LVCFMT_LEFT)
 491             item.m_format = wxLIST_FORMAT_LEFT;
 492         else if (lvCol.fmt == LVCFMT_RIGHT)
 493             item.m_format = wxLIST_FORMAT_RIGHT;
 494         else if (lvCol.fmt == LVCFMT_CENTER)
 495             item.m_format = wxLIST_FORMAT_CENTRE;
 496     }
 497
 498     return success;
 499 }
 500
 501 // Sets information about this column
 502 bool wxListCtrl::SetColumn(int col, wxListItem& item)
 503 {
 504     LV_COLUMN lvCol;
 505     lvCol.mask = 0;
 506     lvCol.fmt = 0;
 507     lvCol.pszText = NULL;
 508
 509     if ( item.m_mask & wxLIST_MASK_TEXT )
 510     {
 511         lvCol.mask |= LVCF_TEXT;
 512         lvCol.pszText = WXSTRINGCAST item.m_text;
 513         lvCol.cchTextMax = 0; // Ignored
 514     }
 515     if ( item.m_mask & wxLIST_MASK_FORMAT )
 516     {
 517         lvCol.mask |= LVCF_FMT;
 518
 519         if ( item.m_format == wxLIST_FORMAT_LEFT )
 520             lvCol.fmt = LVCFMT_LEFT;
 521         if ( item.m_format == wxLIST_FORMAT_RIGHT )
 522             lvCol.fmt = LVCFMT_RIGHT;
 523         if ( item.m_format == wxLIST_FORMAT_CENTRE )
 524             lvCol.fmt = LVCFMT_CENTER;
 525     }
 526
 527     if ( item.m_mask & wxLIST_MASK_WIDTH )
 528     {
 529         lvCol.mask |= LVCF_WIDTH;
 530         lvCol.cx = item.m_width;
 531
 532         if ( lvCol.cx == wxLIST_AUTOSIZE)
 533             lvCol.cx = LVSCW_AUTOSIZE;
 534         else if ( lvCol.cx == wxLIST_AUTOSIZE_USEHEADER)
 535             lvCol.cx = LVSCW_AUTOSIZE_USEHEADER;
 536     }
 537     lvCol.mask |= LVCF_SUBITEM;
 538     lvCol.iSubItem = col;
 539     return (ListView_SetColumn(GetHwnd(), col, & lvCol) != 0);
 540 }
 541
 542 // Gets the column width
 543 int wxListCtrl::GetColumnWidth(int col) const
 544 {
 545     return ListView_GetColumnWidth(GetHwnd(), col);
 546 }
 547
 548 // Sets the column width
 549 bool wxListCtrl::SetColumnWidth(int col, int width)
 550 {
 551     int col2 = col;
 552     if ( m_windowStyle & wxLC_LIST )
 553         col2 = -1;
 554
 555     int width2 = width;
 556     if ( width2 == wxLIST_AUTOSIZE)
 557         width2 = LVSCW_AUTOSIZE;
 558     else if ( width2 == wxLIST_AUTOSIZE_USEHEADER)
 559         width2 = LVSCW_AUTOSIZE_USEHEADER;
 560
 561     return (ListView_SetColumnWidth(GetHwnd(), col2, width2) != 0);
 562 }
 563
 564 // Gets the number of items that can fit vertically in the
 565 // visible area of the list control (list or report view)
 566 // or the total number of items in the list control (icon
 567 // or small icon view)
 568 int wxListCtrl::GetCountPerPage() const
 569 {
 570     return ListView_GetCountPerPage(GetHwnd());
 571 }
 572
 573 // Gets the edit control for editing labels.
 574 wxTextCtrl* wxListCtrl::GetEditControl() const
 575 {
 576     return m_textCtrl;
 577 }
 578
 579 // Gets information about the item
 580 bool wxListCtrl::GetItem(wxListItem& info) const
 581 {
 582     LV_ITEM lvItem;
 583     wxZeroMemory(lvItem);
 584
 585     lvItem.iItem = info.m_itemId;
 586     lvItem.iSubItem = info.m_col;
 587
 588     if ( info.m_mask & wxLIST_MASK_TEXT )
 589     {
 590         lvItem.mask |= LVIF_TEXT;
 591         lvItem.pszText = new wxChar[513];
 592         lvItem.cchTextMax = 512;
 593     }
 594     else
 595     {
 596         lvItem.pszText = NULL;
 597     }
 598
 599     if (info.m_mask & wxLIST_MASK_DATA)
 600         lvItem.mask |= LVIF_PARAM;
 601
 602     if ( info.m_mask & wxLIST_MASK_STATE )
 603     {
 604         lvItem.mask |= LVIF_STATE;
 605         // the other bits are hardly interesting anyhow
 606         lvItem.stateMask = LVIS_SELECTED | LVIS_FOCUSED;
 607     }
 608
 609     bool success = ListView_GetItem((HWND)GetHWND(), &lvItem) != 0;
 610     if ( !success )
 611     {
 612         wxLogError(_("Couldn't retrieve information about list control item %d."),
 613                 lvItem.iItem);
 614     }
 615     else
 616     {
 617         wxConvertFromMSWListItem(this, info, lvItem);
 618     }
 619
 620     if (lvItem.pszText)
 621         delete[] lvItem.pszText;
 622
 623     return success;
 624 }
 625
 626 // Sets information about the item
 627 bool wxListCtrl::SetItem(wxListItem& info)
 628 {
 629     LV_ITEM item;
 630     wxConvertToMSWListItem(this, info, item);
 631
 632     // check whether it has any custom attributes
 633     if ( info.HasAttributes() )
 634     {
 635         wxListItemAttr *attr;
 636         attr = (wxListItemAttr*) m_attrs.Get(item.iItem);
 637         if (attr == NULL)
 638             m_attrs.Put(item.iItem, (wxObject *)new wxListItemAttr(*info.GetAttributes()));
 639         else *attr = *info.GetAttributes();
 640
 641         m_hasAnyAttr = TRUE;
 642     }
 643
 644     item.cchTextMax = 0;
 645     bool ok = ListView_SetItem(GetHwnd(), &item) != 0;
 646     if ( ok && (info.m_mask & wxLIST_MASK_IMAGE) )
 647     {
 648         // make the change visible
 649         ListView_Update(GetHwnd(), item.iItem);
 650     }
 651
 652     return ok;
 653 }
 654
 655 long wxListCtrl::SetItem(long index, int col, const wxString& label, int imageId)
 656 {
 657     wxListItem info;
 658     info.m_text = label;
 659     info.m_mask = wxLIST_MASK_TEXT;
 660     info.m_itemId = index;
 661     info.m_col = col;
 662     if ( imageId > -1 )
 663     {
 664         info.m_image = imageId;
 665         info.m_mask |= wxLIST_MASK_IMAGE;
 666     }
 667     return SetItem(info);
 668 }
 669
 670
 671 // Gets the item state
 672 int wxListCtrl::GetItemState(long item, long stateMask) const
 673 {
 674     wxListItem info;
 675
 676     info.m_mask = wxLIST_MASK_STATE;
 677     info.m_stateMask = stateMask;
 678     info.m_itemId = item;
 679
 680     if (!GetItem(info))
 681         return 0;
 682
 683     return info.m_state;
 684 }
 685
 686 // Sets the item state
 687 bool wxListCtrl::SetItemState(long item, long state, long stateMask)
 688 {
 689     wxListItem info;
 690
 691     info.m_mask = wxLIST_MASK_STATE;
 692     info.m_state = state;
 693     info.m_stateMask = stateMask;
 694     info.m_itemId = item;
 695
 696     return SetItem(info);
 697 }
 698
 699 // Sets the item image
 700 bool wxListCtrl::SetItemImage(long item, int image, int selImage)
 701 {
 702     wxListItem info;
 703
 704     info.m_mask = wxLIST_MASK_IMAGE;
 705     info.m_image = image;
 706     info.m_itemId = item;
 707
 708     return SetItem(info);
 709 }
 710
 711 // Gets the item text
 712 wxString wxListCtrl::GetItemText(long item) const
 713 {
 714     wxListItem info;
 715
 716     info.m_mask = wxLIST_MASK_TEXT;
 717     info.m_itemId = item;
 718
 719     if (!GetItem(info))
 720         return wxString("");
 721     return info.m_text;
 722 }
 723
 724 // Sets the item text
 725 void wxListCtrl::SetItemText(long item, const wxString& str)
 726 {
 727     wxListItem info;
 728
 729     info.m_mask = wxLIST_MASK_TEXT;
 730     info.m_itemId = item;
 731     info.m_text = str;
 732
 733     SetItem(info);
 734 }
 735
 736 // Gets the item data
 737 long wxListCtrl::GetItemData(long item) const
 738 {
 739     wxListItem info;
 740
 741     info.m_mask = wxLIST_MASK_DATA;
 742     info.m_itemId = item;
 743
 744     if (!GetItem(info))
 745         return 0;
 746     return info.m_data;
 747 }
 748
 749 // Sets the item data
 750 bool wxListCtrl::SetItemData(long item, long data)
 751 {
 752     wxListItem info;
 753
 754     info.m_mask = wxLIST_MASK_DATA;
 755     info.m_itemId = item;
 756     info.m_data = data;
 757
 758     return SetItem(info);
 759 }
 760
 761 // Gets the item rectangle
 762 bool wxListCtrl::GetItemRect(long item, wxRect& rect, int code) const
 763 {
 764     RECT rect2;
 765
 766     int code2 = LVIR_BOUNDS;
 767     if ( code == wxLIST_RECT_BOUNDS )
 768         code2 = LVIR_BOUNDS;
 769     else if ( code == wxLIST_RECT_ICON )
 770         code2 = LVIR_ICON;
 771     else if ( code == wxLIST_RECT_LABEL )
 772         code2 = LVIR_LABEL;
 773
 774 #ifdef __WXWINE__
 775     bool success = (ListView_GetItemRect(GetHwnd(), (int) item, &rect2 ) != 0);
 776 #else
 777     bool success = (ListView_GetItemRect(GetHwnd(), (int) item, &rect2, code2) != 0);
 778 #endif
 779
 780     rect.x = rect2.left;
 781     rect.y = rect2.top;
 782     rect.width = rect2.right - rect2.left;
 783     rect.height = rect2.bottom - rect2.top;
 784     return success;
 785 }
 786
 787 // Gets the item position
 788 bool wxListCtrl::GetItemPosition(long item, wxPoint& pos) const
 789 {
 790     POINT pt;
 791
 792     bool success = (ListView_GetItemPosition(GetHwnd(), (int) item, &pt) != 0);
 793
 794     pos.x = pt.x; pos.y = pt.y;
 795     return success;
 796 }
 797
 798 // Sets the item position.
 799 bool wxListCtrl::SetItemPosition(long item, const wxPoint& pos)
 800 {
 801     return (ListView_SetItemPosition(GetHwnd(), (int) item, pos.x, pos.y) != 0);
 802 }
 803
 804 // Gets the number of items in the list control
 805 int wxListCtrl::GetItemCount() const
 806 {
 807     return ListView_GetItemCount(GetHwnd());
 808 }
 809
 810 // Retrieves the spacing between icons in pixels.
 811 // If small is TRUE, gets the spacing for the small icon
 812 // view, otherwise the large icon view.
 813 int wxListCtrl::GetItemSpacing(bool isSmall) const
 814 {
 815     return ListView_GetItemSpacing(GetHwnd(), (BOOL) isSmall);
 816 }
 817
 818 // Gets the number of selected items in the list control
 819 int wxListCtrl::GetSelectedItemCount() const
 820 {
 821     return ListView_GetSelectedCount(GetHwnd());
 822 }
 823
 824 // Gets the text colour of the listview
 825 wxColour wxListCtrl::GetTextColour() const
 826 {
 827     COLORREF ref = ListView_GetTextColor(GetHwnd());
 828     wxColour col(GetRValue(ref), GetGValue(ref), GetBValue(ref));
 829     return col;
 830 }
 831
 832 // Sets the text colour of the listview
 833 void wxListCtrl::SetTextColour(const wxColour& col)
 834 {
 835     ListView_SetTextColor(GetHwnd(), PALETTERGB(col.Red(), col.Green(), col.Blue()));
 836 }
 837
 838 // Gets the index of the topmost visible item when in
 839 // list or report view
 840 long wxListCtrl::GetTopItem() const
 841 {
 842     return (long) ListView_GetTopIndex(GetHwnd());
 843 }
 844
 845 // Searches for an item, starting from 'item'.
 846 // 'geometry' is one of
 847 // wxLIST_NEXT_ABOVE/ALL/BELOW/LEFT/RIGHT.
 848 // 'state' is a state bit flag, one or more of
 849 // wxLIST_STATE_DROPHILITED/FOCUSED/SELECTED/CUT.
 850 // item can be -1 to find the first item that matches the
 851 // specified flags.
 852 // Returns the item or -1 if unsuccessful.
 853 long wxListCtrl::GetNextItem(long item, int geom, int state) const
 854 {
 855     long flags = 0;
 856
 857     if ( geom == wxLIST_NEXT_ABOVE )
 858         flags |= LVNI_ABOVE;
 859     if ( geom == wxLIST_NEXT_ALL )
 860         flags |= LVNI_ALL;
 861     if ( geom == wxLIST_NEXT_BELOW )
 862         flags |= LVNI_BELOW;
 863     if ( geom == wxLIST_NEXT_LEFT )
 864         flags |= LVNI_TOLEFT;
 865     if ( geom == wxLIST_NEXT_RIGHT )
 866         flags |= LVNI_TORIGHT;
 867
 868     if ( state & wxLIST_STATE_CUT )
 869         flags |= LVNI_CUT;
 870     if ( state & wxLIST_STATE_DROPHILITED )
 871         flags |= LVNI_DROPHILITED;
 872     if ( state & wxLIST_STATE_FOCUSED )
 873         flags |= LVNI_FOCUSED;
 874     if ( state & wxLIST_STATE_SELECTED )
 875         flags |= LVNI_SELECTED;
 876
 877     return (long) ListView_GetNextItem(GetHwnd(), item, flags);
 878 }
 879
 880
 881 wxImageList *wxListCtrl::GetImageList(int which) const
 882 {
 883     if ( which == wxIMAGE_LIST_NORMAL )
 884     {
 885         return m_imageListNormal;
 886     }
 887     else if ( which == wxIMAGE_LIST_SMALL )
 888     {
 889         return m_imageListSmall;
 890     }
 891     else if ( which == wxIMAGE_LIST_STATE )
 892     {
 893         return m_imageListState;
 894     }
 895     return NULL;
 896 }
 897
 898 void wxListCtrl::SetImageList(wxImageList *imageList, int which)
 899 {
 900     int flags = 0;
 901     if ( which == wxIMAGE_LIST_NORMAL )
 902     {
 903         flags = LVSIL_NORMAL;
 904         m_imageListNormal = imageList;
 905     }
 906     else if ( which == wxIMAGE_LIST_SMALL )
 907     {
 908         flags = LVSIL_SMALL;
 909         m_imageListSmall = imageList;
 910     }
 911     else if ( which == wxIMAGE_LIST_STATE )
 912     {
 913         flags = LVSIL_STATE;
 914         m_imageListState = imageList;
 915     }
 916     ListView_SetImageList(GetHwnd(), (HIMAGELIST) imageList ? imageList->GetHIMAGELIST() : 0, flags);
 917 }
 918
 919 // ----------------------------------------------------------------------------
 920 // Operations
 921 // ----------------------------------------------------------------------------
 922
 923 // Arranges the items
 924 bool wxListCtrl::Arrange(int flag)
 925 {
 926     UINT code = 0;
 927     if ( flag == wxLIST_ALIGN_LEFT )
 928         code = LVA_ALIGNLEFT;
 929     else if ( flag == wxLIST_ALIGN_TOP )
 930         code = LVA_ALIGNTOP;
 931     else if ( flag == wxLIST_ALIGN_DEFAULT )
 932         code = LVA_DEFAULT;
 933     else if ( flag == wxLIST_ALIGN_SNAP_TO_GRID )
 934         code = LVA_SNAPTOGRID;
 935
 936     return (ListView_Arrange(GetHwnd(), code) != 0);
 937 }
 938
 939 // Deletes an item
 940 bool wxListCtrl::DeleteItem(long item)
 941 {
 942     return (ListView_DeleteItem(GetHwnd(), (int) item) != 0);
 943 }
 944
 945 // Deletes all items
 946 bool wxListCtrl::DeleteAllItems()
 947 {
 948     return (ListView_DeleteAllItems(GetHwnd()) != 0);
 949 }
 950
 951 // Deletes all items
 952 bool wxListCtrl::DeleteAllColumns()
 953 {
 954     while ( m_colCount > 0 )
 955     {
 956         if ( ListView_DeleteColumn(GetHwnd(), 0) == 0 )
 957         {
 958             wxLogLastError(wxT("ListView_DeleteColumn"));
 959
 960             return FALSE;
 961         }
 962
 963         m_colCount--;
 964     }
 965
 966     wxASSERT_MSG( m_colCount == 0, wxT("no columns should be left") );
 967
 968     return TRUE;
 969 }
 970
 971 // Deletes a column
 972 bool wxListCtrl::DeleteColumn(int col)
 973 {
 974     bool success = (ListView_DeleteColumn(GetHwnd(), col) != 0);
 975
 976     if ( success && (m_colCount > 0) )
 977         m_colCount --;
 978     return success;
 979 }
 980
 981 // Clears items, and columns if there are any.
 982 void wxListCtrl::ClearAll()
 983 {
 984     DeleteAllItems();
 985     if ( m_colCount > 0 )
 986         DeleteAllColumns();
 987 }
 988
 989 wxTextCtrl* wxListCtrl::EditLabel(long item, wxClassInfo* textControlClass)
 990 {
 991     wxASSERT( (textControlClass->IsKindOf(CLASSINFO(wxTextCtrl))) );
 992
 993     HWND hWnd = (HWND) ListView_EditLabel(GetHwnd(), item);
 994
 995     if (m_textCtrl)
 996     {
 997         m_textCtrl->UnsubclassWin();
 998         m_textCtrl->SetHWND(0);
 999         delete m_textCtrl;
1000         m_textCtrl = NULL;
1001     }
1002
1003     m_textCtrl = (wxTextCtrl*) textControlClass->CreateObject();
1004     m_textCtrl->SetHWND((WXHWND) hWnd);
1005     m_textCtrl->SubclassWin((WXHWND) hWnd);
1006
1007     return m_textCtrl;
1008 }
1009
1010 // End label editing, optionally cancelling the edit
1011 bool wxListCtrl::EndEditLabel(bool cancel)
1012 {
1013     wxFAIL;
1014
1015     /* I don't know how to implement this: there's no such macro as ListView_EndEditLabelNow.
1016      * ???
1017      bool success = (ListView_EndEditLabelNow(GetHwnd(), cancel) != 0);
1018
1019      if (m_textCtrl)
1020      {
1021      m_textCtrl->UnsubclassWin();
1022      m_textCtrl->SetHWND(0);
1023      delete m_textCtrl;
1024      m_textCtrl = NULL;
1025      }
1026      return success;
1027      */
1028     return FALSE;
1029 }
1030
1031
1032 // Ensures this item is visible
1033 bool wxListCtrl::EnsureVisible(long item)
1034 {
1035     return (ListView_EnsureVisible(GetHwnd(), (int) item, FALSE) != 0);
1036 }
1037
1038 // Find an item whose label matches this string, starting from the item after 'start'
1039 // or the beginning if 'start' is -1.
1040 long wxListCtrl::FindItem(long start, const wxString& str, bool partial)
1041 {
1042     LV_FINDINFO findInfo;
1043
1044     findInfo.flags = LVFI_STRING;
1045     if ( partial )
1046         findInfo.flags |= LVFI_PARTIAL;
1047     findInfo.psz = str;
1048
1049     // ListView_FindItem() excludes the first item from search and to look
1050     // through all the items you need to start from -1 which is unnatural and
1051     // inconsitent with the generic version - so we adjust the index
1052     return ListView_FindItem(GetHwnd(), (int) start - 1, &findInfo);
1053 }
1054
1055 // Find an item whose data matches this data, starting from the item after 'start'
1056 // or the beginning if 'start' is -1.
1057 long wxListCtrl::FindItem(long start, long data)
1058 {
1059     LV_FINDINFO findInfo;
1060
1061     findInfo.flags = LVFI_PARAM;
1062     findInfo.lParam = data;
1063
1064     return ListView_FindItem(GetHwnd(), (int) start, & findInfo);
1065 }
1066
1067 // Find an item nearest this position in the specified direction, starting from
1068 // the item after 'start' or the beginning if 'start' is -1.
1069 long wxListCtrl::FindItem(long start, const wxPoint& pt, int direction)
1070 {
1071     LV_FINDINFO findInfo;
1072
1073     findInfo.flags = LVFI_NEARESTXY;
1074     findInfo.pt.x = pt.x;
1075     findInfo.pt.y = pt.y;
1076     findInfo.vkDirection = VK_RIGHT;
1077
1078     if ( direction == wxLIST_FIND_UP )
1079         findInfo.vkDirection = VK_UP;
1080     else if ( direction == wxLIST_FIND_DOWN )
1081         findInfo.vkDirection = VK_DOWN;
1082     else if ( direction == wxLIST_FIND_LEFT )
1083         findInfo.vkDirection = VK_LEFT;
1084     else if ( direction == wxLIST_FIND_RIGHT )
1085         findInfo.vkDirection = VK_RIGHT;
1086
1087     return ListView_FindItem(GetHwnd(), (int) start, & findInfo);
1088 }
1089
1090 // Determines which item (if any) is at the specified point,
1091 // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
1092 long wxListCtrl::HitTest(const wxPoint& point, int& flags)
1093 {
1094     LV_HITTESTINFO hitTestInfo;
1095     hitTestInfo.pt.x = (int) point.x;
1096     hitTestInfo.pt.y = (int) point.y;
1097
1098     ListView_HitTest(GetHwnd(), & hitTestInfo);
1099
1100     flags = 0;
1101     if ( hitTestInfo.flags & LVHT_ABOVE )
1102         flags |= wxLIST_HITTEST_ABOVE;
1103     if ( hitTestInfo.flags & LVHT_BELOW )
1104         flags |= wxLIST_HITTEST_BELOW;
1105     if ( hitTestInfo.flags & LVHT_NOWHERE )
1106         flags |= wxLIST_HITTEST_NOWHERE;
1107     if ( hitTestInfo.flags & LVHT_ONITEMICON )
1108         flags |= wxLIST_HITTEST_ONITEMICON;
1109     if ( hitTestInfo.flags & LVHT_ONITEMLABEL )
1110         flags |= wxLIST_HITTEST_ONITEMLABEL;
1111     if ( hitTestInfo.flags & LVHT_ONITEMSTATEICON )
1112         flags |= wxLIST_HITTEST_ONITEMSTATEICON;
1113     if ( hitTestInfo.flags & LVHT_TOLEFT )
1114         flags |= wxLIST_HITTEST_TOLEFT;
1115     if ( hitTestInfo.flags & LVHT_TORIGHT )
1116         flags |= wxLIST_HITTEST_TORIGHT;
1117
1118     return (long) hitTestInfo.iItem;
1119 }
1120
1121 // Inserts an item, returning the index of the new item if successful,
1122 // -1 otherwise.
1123 long wxListCtrl::InsertItem(wxListItem& info)
1124 {
1125     LV_ITEM item;
1126     wxConvertToMSWListItem(this, info, item);
1127
1128     // check whether it has any custom attributes
1129     if ( info.HasAttributes() )
1130     {
1131         wxListItemAttr *attr;
1132         attr = (wxListItemAttr*) m_attrs.Get(item.iItem);
1133         if (attr == NULL)
1134             m_attrs.Put(item.iItem, (wxObject *)new wxListItemAttr(*info.GetAttributes()));
1135         else *attr = *info.GetAttributes();
1136
1137         m_hasAnyAttr = TRUE;
1138     }
1139
1140     return (long) ListView_InsertItem(GetHwnd(), & item);
1141 }
1142
1143 long wxListCtrl::InsertItem(long index, const wxString& label)
1144 {
1145     wxListItem info;
1146     info.m_text = label;
1147     info.m_mask = wxLIST_MASK_TEXT;
1148     info.m_itemId = index;
1149     return InsertItem(info);
1150 }
1151
1152 // Inserts an image item
1153 long wxListCtrl::InsertItem(long index, int imageIndex)
1154 {
1155     wxListItem info;
1156     info.m_image = imageIndex;
1157     info.m_mask = wxLIST_MASK_IMAGE;
1158     info.m_itemId = index;
1159     return InsertItem(info);
1160 }
1161
1162 // Inserts an image/string item
1163 long wxListCtrl::InsertItem(long index, const wxString& label, int imageIndex)
1164 {
1165     wxListItem info;
1166     info.m_image = imageIndex;
1167     info.m_text = label;
1168     info.m_mask = wxLIST_MASK_IMAGE | wxLIST_MASK_TEXT;
1169     info.m_itemId = index;
1170     return InsertItem(info);
1171 }
1172
1173 // For list view mode (only), inserts a column.
1174 long wxListCtrl::InsertColumn(long col, wxListItem& item)
1175 {
1176     LV_COLUMN lvCol;
1177     lvCol.mask = 0;
1178     lvCol.fmt = 0;
1179     lvCol.pszText = NULL;
1180
1181     if ( item.m_mask & wxLIST_MASK_TEXT )
1182     {
1183         lvCol.mask |= LVCF_TEXT;
1184         lvCol.pszText = WXSTRINGCAST item.m_text;
1185         lvCol.cchTextMax = 0; // Ignored
1186     }
1187     if ( item.m_mask & wxLIST_MASK_FORMAT )
1188     {
1189         lvCol.mask |= LVCF_FMT;
1190
1191         if ( item.m_format == wxLIST_FORMAT_LEFT )
1192             lvCol.fmt = LVCFMT_LEFT;
1193         if ( item.m_format == wxLIST_FORMAT_RIGHT )
1194             lvCol.fmt = LVCFMT_RIGHT;
1195         if ( item.m_format == wxLIST_FORMAT_CENTRE )
1196             lvCol.fmt = LVCFMT_CENTER;
1197     }
1198
1199     lvCol.mask |= LVCF_WIDTH;
1200     if ( item.m_mask & wxLIST_MASK_WIDTH )
1201     {
1202         if ( item.m_width == wxLIST_AUTOSIZE)
1203             lvCol.cx = LVSCW_AUTOSIZE;
1204         else if ( item.m_width == wxLIST_AUTOSIZE_USEHEADER)
1205             lvCol.cx = LVSCW_AUTOSIZE_USEHEADER;
1206         else
1207             lvCol.cx = item.m_width;
1208     }
1209     else
1210     {
1211         // always give some width to the new column: this one is compatible
1212         // with wxGTK
1213         lvCol.cx = 80;
1214     }
1215
1216     lvCol.mask |= LVCF_SUBITEM;
1217     lvCol.iSubItem = col;
1218
1219     bool success = ListView_InsertColumn(GetHwnd(), col, & lvCol) != -1;
1220     if ( success )
1221     {
1222         m_colCount++;
1223     }
1224     else
1225     {
1226         wxLogDebug(wxT("Failed to insert the column '%s' into listview!"),
1227                    lvCol.pszText);
1228     }
1229
1230     return success;
1231 }
1232
1233 long wxListCtrl::InsertColumn(long col,
1234                               const wxString& heading,
1235                               int format,
1236                               int width)
1237 {
1238     wxListItem item;
1239     item.m_mask = wxLIST_MASK_TEXT | wxLIST_MASK_FORMAT;
1240     item.m_text = heading;
1241     if ( width > -1 )
1242     {
1243         item.m_mask |= wxLIST_MASK_WIDTH;
1244         item.m_width = width;
1245     }
1246     item.m_format = format;
1247
1248     return InsertColumn(col, item);
1249 }
1250
1251 // Scrolls the list control. If in icon, small icon or report view mode,
1252 // x specifies the number of pixels to scroll. If in list view mode, x
1253 // specifies the number of columns to scroll.
1254 // If in icon, small icon or list view mode, y specifies the number of pixels
1255 // to scroll. If in report view mode, y specifies the number of lines to scroll.
1256 bool wxListCtrl::ScrollList(int dx, int dy)
1257 {
1258     return (ListView_Scroll(GetHwnd(), dx, dy) != 0);
1259 }
1260
1261 // Sort items.
1262
1263 // fn is a function which takes 3 long arguments: item1, item2, data.
1264 // item1 is the long data associated with a first item (NOT the index).
1265 // item2 is the long data associated with a second item (NOT the index).
1266 // data is the same value as passed to SortItems.
1267 // The return value is a negative number if the first item should precede the second
1268 // item, a positive number of the second item should precede the first,
1269 // or zero if the two items are equivalent.
1270
1271 // data is arbitrary data to be passed to the sort function.
1272 bool wxListCtrl::SortItems(wxListCtrlCompare fn, long data)
1273 {
1274     return (ListView_SortItems(GetHwnd(), (PFNLVCOMPARE) fn, data) != 0);
1275 }
1276
1277 // ----------------------------------------------------------------------------
1278 // message processing
1279 // ----------------------------------------------------------------------------
1280
1281 bool wxListCtrl::MSWCommand(WXUINT cmd, WXWORD id)
1282 {
1283     if (cmd == EN_UPDATE)
1284     {
1285         wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, id);
1286         event.SetEventObject( this );
1287         ProcessCommand(event);
1288         return TRUE;
1289     }
1290     else if (cmd == EN_KILLFOCUS)
1291     {
1292         wxCommandEvent event(wxEVT_KILL_FOCUS, id);
1293         event.SetEventObject( this );
1294         ProcessCommand(event);
1295         return TRUE;
1296     }
1297     else
1298         return FALSE;
1299 }
1300
1301 bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
1302 {
1303     // prepare the event
1304     // -----------------
1305
1306     wxListEvent event(wxEVT_NULL, m_windowId);
1307     wxEventType eventType = wxEVT_NULL;
1308
1309     NMHDR *nmhdr = (NMHDR *)lParam;
1310
1311     // almost all messages use NM_LISTVIEW
1312     NM_LISTVIEW *nmLV = (NM_LISTVIEW *)nmhdr;
1313
1314     // this is true for almost all events
1315     event.m_item.m_data = nmLV->lParam;
1316
1317     switch ( nmhdr->code )
1318     {
1319         case LVN_BEGINRDRAG:
1320             eventType = wxEVT_COMMAND_LIST_BEGIN_RDRAG;
1321             // fall through
1322
1323         case LVN_BEGINDRAG:
1324             if ( eventType == wxEVT_NULL )
1325             {
1326                 eventType = wxEVT_COMMAND_LIST_BEGIN_DRAG;
1327             }
1328
1329             event.m_itemIndex = nmLV->iItem;
1330             event.m_pointDrag.x = nmLV->ptAction.x;
1331             event.m_pointDrag.y = nmLV->ptAction.y;
1332             break;
1333
1334         case LVN_BEGINLABELEDIT:
1335             {
1336                 eventType = wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT;
1337                 LV_DISPINFO *info = (LV_DISPINFO *)lParam;
1338                 wxConvertFromMSWListItem(this, event.m_item, info->item, GetHwnd());
1339             }
1340             break;
1341
1342         case LVN_COLUMNCLICK:
1343             eventType = wxEVT_COMMAND_LIST_COL_CLICK;
1344             event.m_itemIndex = -1;
1345             event.m_col = nmLV->iSubItem;
1346             break;
1347
1348         case LVN_DELETEALLITEMS:
1349             eventType = wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS;
1350             event.m_itemIndex = -1;
1351
1352             FreeAllAttrs();
1353
1354             break;
1355
1356         case LVN_DELETEITEM:
1357             eventType = wxEVT_COMMAND_LIST_DELETE_ITEM;
1358             event.m_itemIndex = nmLV->iItem;
1359
1360             if ( m_hasAnyAttr )
1361             {
1362                 delete (wxListItemAttr *)m_attrs.Delete(nmLV->iItem);
1363             }
1364             break;
1365
1366         case LVN_ENDLABELEDIT:
1367             {
1368                 eventType = wxEVT_COMMAND_LIST_END_LABEL_EDIT;
1369                 LV_DISPINFO *info = (LV_DISPINFO *)lParam;
1370                 wxConvertFromMSWListItem(this, event.m_item, info->item);
1371                 if ( info->item.pszText == NULL || info->item.iItem == -1 )
1372                     return FALSE;
1373             }
1374             break;
1375
1376         case LVN_SETDISPINFO:
1377             {
1378                 eventType = wxEVT_COMMAND_LIST_SET_INFO;
1379                 LV_DISPINFO *info = (LV_DISPINFO *)lParam;
1380                 wxConvertFromMSWListItem(this, event.m_item, info->item, GetHwnd());
1381             }
1382             break;
1383
1384         case LVN_GETDISPINFO:
1385                 // this provokes stack overflow: indeed, wxConvertFromMSWListItem()
1386                 // sends us WM_NOTIFY! As it doesn't do anything for now, just leave
1387                 // it out.
1388 #if 0
1389             {
1390                 // TODO: some text buffering here, I think
1391                 // TODO: API for getting Windows to retrieve values
1392                 // on demand.
1393                 eventType = wxEVT_COMMAND_LIST_GET_INFO;
1394                 LV_DISPINFO *info = (LV_DISPINFO *)lParam;
1395                 wxConvertFromMSWListItem(this, event.m_item, info->item, GetHwnd());
1396                 break;
1397             }
1398 #endif // 0
1399                 return FALSE;
1400
1401
1402         case LVN_INSERTITEM:
1403             eventType = wxEVT_COMMAND_LIST_INSERT_ITEM;
1404             event.m_itemIndex = nmLV->iItem;
1405             break;
1406
1407         case LVN_ITEMCHANGED:
1408             // This needs to be sent to wxListCtrl as a rather more concrete
1409             // event. For now, just detect a selection or deselection.
1410             if ( (nmLV->uNewState & LVIS_SELECTED) && !(nmLV->uOldState & LVIS_SELECTED) )
1411             {
1412                 eventType = wxEVT_COMMAND_LIST_ITEM_SELECTED;
1413                 event.m_itemIndex = nmLV->iItem;
1414             }
1415             else if ( !(nmLV->uNewState & LVIS_SELECTED) && (nmLV->uOldState & LVIS_SELECTED) )
1416             {
1417                 eventType = wxEVT_COMMAND_LIST_ITEM_DESELECTED;
1418                 event.m_itemIndex = nmLV->iItem;
1419             }
1420             else
1421             {
1422                 return FALSE;
1423             }
1424             break;
1425
1426         case LVN_KEYDOWN:
1427             {
1428                 LV_KEYDOWN *info = (LV_KEYDOWN *)lParam;
1429                 WORD wVKey = info->wVKey;
1430
1431                 // get the current selection
1432                 long lItem = GetNextItem(-1,
1433                                          wxLIST_NEXT_ALL,
1434                                          wxLIST_STATE_SELECTED);
1435
1436                 // <Enter> or <Space> activate the selected item if any
1437                 if ( lItem != -1 && (wVKey == VK_RETURN || wVKey == VK_SPACE) )
1438                 {
1439                     // TODO this behaviour probably should be optional
1440                     eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED;
1441                     event.m_itemIndex = lItem;
1442                 }
1443                 else
1444                 {
1445                     eventType = wxEVT_COMMAND_LIST_KEY_DOWN;
1446                     event.m_code = wxCharCodeMSWToWX(wVKey);
1447                 }
1448
1449                 if ( lItem != -1 )
1450                 {
1451                     // fill the other fields too
1452                     event.m_item.m_text = GetItemText(lItem);
1453                     event.m_item.m_data = GetItemData(lItem);
1454                 }
1455             }
1456             break;
1457
1458         case NM_DBLCLK:
1459             // if the user processes it in wxEVT_COMMAND_LEFT_CLICK(), don't do
1460             // anything else
1461             if ( wxControl::MSWOnNotify(idCtrl, lParam, result) )
1462             {
1463                 return TRUE;
1464             }
1465
1466             // else translate it into wxEVT_COMMAND_LIST_ITEM_ACTIVATED event
1467             // if it happened on an item (and not on empty place)
1468             if ( nmLV->iItem == -1 )
1469             {
1470                 // not on item
1471                 return FALSE;
1472             }
1473
1474             eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED;
1475             event.m_itemIndex = nmLV->iItem;
1476             event.m_item.m_text = GetItemText(nmLV->iItem);
1477             event.m_item.m_data = GetItemData(nmLV->iItem);
1478             break;
1479
1480         case NM_RCLICK:
1481             /* TECH NOTE: NM_RCLICK isn't really good enough here. We want to
1482                subclass and check for the actual WM_RBUTTONDOWN message,
1483                because NM_RCLICK waits for the WM_RBUTTONUP message as well
1484                before firing off. We want to have notify events for both down
1485                -and- up. */
1486             {
1487                 // if the user processes it in wxEVT_COMMAND_RIGHT_CLICK(),
1488                 // don't do anything else
1489                 if ( wxControl::MSWOnNotify(idCtrl, lParam, result) )
1490                 {
1491                     return TRUE;
1492                 }
1493
1494                 // else translate it into wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK event
1495                 LV_HITTESTINFO lvhti;
1496                 wxZeroMemory(lvhti);
1497
1498                 ::GetCursorPos(&(lvhti.pt));
1499                 ::ScreenToClient(GetHwnd(),&(lvhti.pt));
1500                 if ( ListView_HitTest(GetHwnd(),&lvhti) != -1 )
1501                 {
1502                     if ( lvhti.flags & LVHT_ONITEM )
1503                     {
1504                         eventType = wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK;
1505                         event.m_itemIndex = lvhti.iItem;
1506                     }
1507                 }
1508             }
1509             break;
1510
1511 #if 0
1512         case NM_MCLICK: // ***** THERE IS NO NM_MCLICK. Subclass anyone? ******
1513             {
1514                 // if the user processes it in wxEVT_COMMAND_MIDDLE_CLICK(), don't do
1515                 // anything else
1516                 if ( wxControl::MSWOnNotify(idCtrl, lParam, result) )
1517                 {
1518                     return TRUE;
1519                 }
1520
1521                 // else translate it into wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK event
1522                 eventType = wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK;
1523                 NMITEMACTIVATE* hdr = (NMITEMACTIVATE*)lParam;
1524                 event.m_itemIndex = hdr->iItem;
1525             }
1526             break;
1527 #endif // 0
1528
1529 #if defined(_WIN32_IE) && _WIN32_IE >= 0x300
1530         case NM_CUSTOMDRAW:
1531             {
1532                 LPNMLVCUSTOMDRAW lplvcd = (LPNMLVCUSTOMDRAW)lParam;
1533                 NMCUSTOMDRAW& nmcd = lplvcd->nmcd;
1534                 switch( nmcd.dwDrawStage )
1535                 {
1536                     case CDDS_PREPAINT:
1537                         // if we've got any items with non standard attributes,
1538                         // notify us before painting each item
1539                         *result = m_hasAnyAttr ? CDRF_NOTIFYITEMDRAW
1540                                                : CDRF_DODEFAULT;
1541                         return TRUE;
1542
1543                     case CDDS_ITEMPREPAINT:
1544                         {
1545                             wxListItemAttr *attr =
1546                                 (wxListItemAttr *)m_attrs.Get(nmcd.dwItemSpec);
1547
1548                             if ( !attr )
1549                             {
1550                                 // nothing to do for this item
1551                                 return CDRF_DODEFAULT;
1552                             }
1553
1554                             HFONT hFont;
1555                             wxColour colText, colBack;
1556                             if ( attr->HasFont() )
1557                             {
1558                                 wxFont font = attr->GetFont();
1559                                 hFont = (HFONT)font.GetResourceHandle();
1560                             }
1561                             else
1562                             {
1563                                 hFont = 0;
1564                             }
1565
1566                             if ( attr->HasTextColour() )
1567                             {
1568                                 colText = attr->GetTextColour();
1569                             }
1570                             else
1571                             {
1572                                 colText = GetTextColour();
1573                             }
1574
1575                             if ( attr->HasBackgroundColour() )
1576                             {
1577                                 colBack = attr->GetBackgroundColour();
1578                             }
1579                             else
1580                             {
1581                                 colBack = GetBackgroundColour();
1582                             }
1583
1584                             // note that if we wanted to set colours for
1585                             // individual columns (subitems), we would have
1586                             // returned CDRF_NOTIFYSUBITEMREDRAW from here
1587                             if ( hFont )
1588                             {
1589                                 ::SelectObject(nmcd.hdc, hFont);
1590
1591                                 *result = CDRF_NEWFONT;
1592                             }
1593                             else
1594                             {
1595                                 *result = CDRF_DODEFAULT;
1596                             }
1597
1598                             lplvcd->clrText = wxColourToRGB(colText);
1599                             lplvcd->clrTextBk = wxColourToRGB(colBack);
1600
1601                             return TRUE;
1602                         }
1603
1604                     default:
1605                         *result = CDRF_DODEFAULT;
1606                         return TRUE;
1607                 }
1608             }
1609             break;
1610 #endif // _WIN32_IE >= 0x300
1611
1612         default:
1613             return wxControl::MSWOnNotify(idCtrl, lParam, result);
1614     }
1615
1616     // process the event
1617     // -----------------
1618
1619     event.SetEventObject( this );
1620     event.SetEventType(eventType);
1621
1622     if ( !GetEventHandler()->ProcessEvent(event) )
1623         return FALSE;
1624
1625     // post processing
1626     // ---------------
1627
1628     switch ( nmhdr->code )
1629     {
1630         case LVN_DELETEALLITEMS:
1631             // always return TRUE to suppress all additional LVN_DELETEITEM
1632             // notifications - this makes deleting all items from a list ctrl
1633             // much faster
1634             *result = TRUE;
1635
1636             return TRUE;
1637
1638         case LVN_GETDISPINFO:
1639             {
1640                 LV_DISPINFO *info = (LV_DISPINFO *)lParam;
1641                 if ( info->item.mask & LVIF_TEXT )
1642                 {
1643                     if ( !event.m_item.m_text.IsNull() )
1644                     {
1645                         info->item.pszText = AddPool(event.m_item.m_text);
1646                         info->item.cchTextMax = wxStrlen(info->item.pszText) + 1;
1647                     }
1648                 }
1649                 //    wxConvertToMSWListItem(this, event.m_item, info->item);
1650                 break;
1651             }
1652         case LVN_ENDLABELEDIT:
1653             {
1654                 *result = event.IsAllowed();
1655                 return TRUE;
1656             }
1657     }
1658
1659     *result = !event.IsAllowed();
1660
1661     return TRUE;
1662 }
1663
1664 wxChar *wxListCtrl::AddPool(const wxString& str)
1665 {
1666     // Remove the first element if 3 strings exist
1667     if ( m_stringPool.Number() == 3 )
1668     {
1669         wxNode *node = m_stringPool.First();
1670         delete[] (char *)node->Data();
1671         delete node;
1672     }
1673     wxNode *node = m_stringPool.Add(WXSTRINGCAST str);
1674     return (wxChar *)node->Data();
1675 }
1676
1677 // ----------------------------------------------------------------------------
1678 // wxListItem
1679 // ----------------------------------------------------------------------------
1680
1681 // List item structure
1682 wxListItem::wxListItem()
1683 {
1684     m_mask = 0;
1685     m_itemId = 0;
1686     m_col = 0;
1687     m_state = 0;
1688     m_stateMask = 0;
1689     m_image = 0;
1690     m_data = 0;
1691
1692     m_format = wxLIST_FORMAT_CENTRE;
1693     m_width = 0;
1694
1695     m_attr = NULL;
1696 }
1697
1698 void wxListItem::Clear()
1699 {
1700     m_mask = 0;
1701     m_itemId = 0;
1702     m_col = 0;
1703     m_state = 0;
1704     m_stateMask = 0;
1705     m_image = 0;
1706     m_data = 0;
1707     m_format = wxLIST_FORMAT_CENTRE;
1708     m_width = 0;
1709     m_text = wxEmptyString;
1710
1711     if (m_attr) delete m_attr;
1712     m_attr = NULL;
1713 }
1714
1715 void wxListItem::ClearAttributes()
1716 {
1717     if (m_attr) delete m_attr;
1718     m_attr = NULL;
1719 }
1720
1721 static void wxConvertFromMSWListItem(const wxListCtrl *ctrl, wxListItem& info, LV_ITEM& lvItem, HWND getFullInfo)
1722 {
1723     info.m_data = lvItem.lParam;
1724     info.m_mask = 0;
1725     info.m_state = 0;
1726     info.m_stateMask = 0;
1727     info.m_itemId = lvItem.iItem;
1728
1729     long oldMask = lvItem.mask;
1730
1731     bool needText = FALSE;
1732     if (getFullInfo != 0)
1733     {
1734         if ( lvItem.mask & LVIF_TEXT )
1735             needText = FALSE;
1736         else
1737             needText = TRUE;
1738
1739         if ( needText )
1740         {
1741             lvItem.pszText = new wxChar[513];
1742             lvItem.cchTextMax = 512;
1743         }
1744         //    lvItem.mask |= TVIF_HANDLE | TVIF_STATE | TVIF_TEXT | TVIF_IMAGE | TVIF_SELECTEDIMAGE | TVIF_CHILDREN | TVIF_PARAM;
1745         lvItem.mask |= LVIF_TEXT | LVIF_IMAGE | LVIF_PARAM;
1746         ::SendMessage(getFullInfo, LVM_GETITEM, 0, (LPARAM)& lvItem);
1747     }
1748
1749     if ( lvItem.mask & LVIF_STATE )
1750     {
1751         info.m_mask |= wxLIST_MASK_STATE;
1752
1753         if ( lvItem.stateMask & LVIS_CUT)
1754         {
1755             info.m_stateMask |= wxLIST_STATE_CUT;
1756             if ( lvItem.state & LVIS_CUT )
1757                 info.m_state |= wxLIST_STATE_CUT;
1758         }
1759         if ( lvItem.stateMask & LVIS_DROPHILITED)
1760         {
1761             info.m_stateMask |= wxLIST_STATE_DROPHILITED;
1762             if ( lvItem.state & LVIS_DROPHILITED )
1763                 info.m_state |= wxLIST_STATE_DROPHILITED;
1764         }
1765         if ( lvItem.stateMask & LVIS_FOCUSED)
1766         {
1767             info.m_stateMask |= wxLIST_STATE_FOCUSED;
1768             if ( lvItem.state & LVIS_FOCUSED )
1769                 info.m_state |= wxLIST_STATE_FOCUSED;
1770         }
1771         if ( lvItem.stateMask & LVIS_SELECTED)
1772         {
1773             info.m_stateMask |= wxLIST_STATE_SELECTED;
1774             if ( lvItem.state & LVIS_SELECTED )
1775                 info.m_state |= wxLIST_STATE_SELECTED;
1776         }
1777     }
1778
1779     if ( lvItem.mask & LVIF_TEXT )
1780     {
1781         info.m_mask |= wxLIST_MASK_TEXT;
1782         info.m_text = lvItem.pszText;
1783     }
1784     if ( lvItem.mask & LVIF_IMAGE )
1785     {
1786         info.m_mask |= wxLIST_MASK_IMAGE;
1787         info.m_image = lvItem.iImage;
1788     }
1789     if ( lvItem.mask & LVIF_PARAM )
1790         info.m_mask |= wxLIST_MASK_DATA;
1791     if ( lvItem.mask & LVIF_DI_SETITEM )
1792         info.m_mask |= wxLIST_SET_ITEM;
1793     info.m_col = lvItem.iSubItem;
1794
1795     if (needText)
1796     {
1797         if (lvItem.pszText)
1798             delete[] lvItem.pszText;
1799     }
1800     lvItem.mask = oldMask;
1801 }
1802
1803 static void wxConvertToMSWListItem(const wxListCtrl *ctrl, wxListItem& info, LV_ITEM& lvItem)
1804 {
1805     lvItem.iItem = (int) info.m_itemId;
1806
1807     lvItem.iImage = info.m_image;
1808     lvItem.lParam = info.m_data;
1809     lvItem.stateMask = 0;
1810     lvItem.state = 0;
1811     lvItem.mask = 0;
1812     lvItem.iSubItem = info.m_col;
1813
1814     if (info.m_mask & wxLIST_MASK_STATE)
1815     {
1816         lvItem.mask |= LVIF_STATE;
1817         if (info.m_stateMask & wxLIST_STATE_CUT)
1818         {
1819             lvItem.stateMask |= LVIS_CUT;
1820             if (info.m_state & wxLIST_STATE_CUT)
1821                 lvItem.state |= LVIS_CUT;
1822         }
1823         if (info.m_stateMask & wxLIST_STATE_DROPHILITED)
1824         {
1825             lvItem.stateMask |= LVIS_DROPHILITED;
1826             if (info.m_state & wxLIST_STATE_DROPHILITED)
1827                 lvItem.state |= LVIS_DROPHILITED;
1828         }
1829         if (info.m_stateMask & wxLIST_STATE_FOCUSED)
1830         {
1831             lvItem.stateMask |= LVIS_FOCUSED;
1832             if (info.m_state & wxLIST_STATE_FOCUSED)
1833                 lvItem.state |= LVIS_FOCUSED;
1834         }
1835         if (info.m_stateMask & wxLIST_STATE_SELECTED)
1836         {
1837             lvItem.stateMask |= LVIS_SELECTED;
1838             if (info.m_state & wxLIST_STATE_SELECTED)
1839                 lvItem.state |= LVIS_SELECTED;
1840         }
1841     }
1842
1843     if (info.m_mask & wxLIST_MASK_TEXT)
1844     {
1845         lvItem.mask |= LVIF_TEXT;
1846         if ( ctrl->GetWindowStyleFlag() & wxLC_USER_TEXT )
1847         {
1848             lvItem.pszText = LPSTR_TEXTCALLBACK;
1849         }
1850         else
1851         {
1852             lvItem.pszText = WXSTRINGCAST info.m_text;
1853             if ( lvItem.pszText )
1854                 lvItem.cchTextMax = info.m_text.Length();
1855             else
1856                 lvItem.cchTextMax = 0;
1857         }
1858     }
1859     if (info.m_mask & wxLIST_MASK_IMAGE)
1860         lvItem.mask |= LVIF_IMAGE;
1861     if (info.m_mask & wxLIST_MASK_DATA)
1862         lvItem.mask |= LVIF_PARAM;
1863 }
1864
1865 // ----------------------------------------------------------------------------
1866 // List event
1867 // ----------------------------------------------------------------------------
1868
1869 IMPLEMENT_DYNAMIC_CLASS(wxListEvent, wxNotifyEvent)
1870
1871 wxListEvent::wxListEvent(wxEventType commandType, int id)
1872            : wxNotifyEvent(commandType, id)
1873 {
1874     m_code = 0;
1875     m_itemIndex = 0;
1876     m_oldItemIndex = 0;
1877     m_col = 0;
1878     m_cancelled = FALSE;
1879 }
1880
1881 #endif // __WIN95__
1882