src/msw/listbox.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/msw/listbox.cpp
   3 // Purpose:     wxListBox
   4 // Author:      Julian Smart
   5 // Modified by: Vadim Zeitlin (owner drawn stuff)
   6 // Created:
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // For compilers that support precompilation, includes "wx.h".
  13 #include "wx/wxprec.h"
  14
  15 #ifdef __BORLANDC__
  16     #pragma hdrstop
  17 #endif
  18
  19 #if wxUSE_LISTBOX
  20
  21 #include "wx/listbox.h"
  22
  23 #ifndef WX_PRECOMP
  24     #include "wx/dynarray.h"
  25     #include "wx/settings.h"
  26     #include "wx/brush.h"
  27     #include "wx/font.h"
  28     #include "wx/dc.h"
  29     #include "wx/utils.h"
  30     #include "wx/log.h"
  31     #include "wx/window.h"
  32 #endif
  33
  34 #include "wx/msw/private.h"
  35 #include "wx/msw/dc.h"
  36
  37 #include <windowsx.h>
  38
  39 #if wxUSE_OWNER_DRAWN
  40     #include  "wx/ownerdrw.h"
  41 #endif
  42
  43 #if wxUSE_EXTENDED_RTTI
  44 WX_DEFINE_FLAGS( wxListBoxStyle )
  45
  46 wxBEGIN_FLAGS( wxListBoxStyle )
  47     // new style border flags, we put them first to
  48     // use them for streaming out
  49     wxFLAGS_MEMBER(wxBORDER_SIMPLE)
  50     wxFLAGS_MEMBER(wxBORDER_SUNKEN)
  51     wxFLAGS_MEMBER(wxBORDER_DOUBLE)
  52     wxFLAGS_MEMBER(wxBORDER_RAISED)
  53     wxFLAGS_MEMBER(wxBORDER_STATIC)
  54     wxFLAGS_MEMBER(wxBORDER_NONE)
  55
  56     // old style border flags
  57     wxFLAGS_MEMBER(wxSIMPLE_BORDER)
  58     wxFLAGS_MEMBER(wxSUNKEN_BORDER)
  59     wxFLAGS_MEMBER(wxDOUBLE_BORDER)
  60     wxFLAGS_MEMBER(wxRAISED_BORDER)
  61     wxFLAGS_MEMBER(wxSTATIC_BORDER)
  62     wxFLAGS_MEMBER(wxBORDER)
  63
  64     // standard window styles
  65     wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
  66     wxFLAGS_MEMBER(wxCLIP_CHILDREN)
  67     wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
  68     wxFLAGS_MEMBER(wxWANTS_CHARS)
  69     wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
  70     wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
  71     wxFLAGS_MEMBER(wxVSCROLL)
  72     wxFLAGS_MEMBER(wxHSCROLL)
  73
  74     wxFLAGS_MEMBER(wxLB_SINGLE)
  75     wxFLAGS_MEMBER(wxLB_MULTIPLE)
  76     wxFLAGS_MEMBER(wxLB_EXTENDED)
  77     wxFLAGS_MEMBER(wxLB_HSCROLL)
  78     wxFLAGS_MEMBER(wxLB_ALWAYS_SB)
  79     wxFLAGS_MEMBER(wxLB_NEEDED_SB)
  80     wxFLAGS_MEMBER(wxLB_NO_SB)
  81     wxFLAGS_MEMBER(wxLB_SORT)
  82
  83 wxEND_FLAGS( wxListBoxStyle )
  84
  85 IMPLEMENT_DYNAMIC_CLASS_XTI(wxListBox, wxControlWithItems,"wx/listbox.h")
  86
  87 wxBEGIN_PROPERTIES_TABLE(wxListBox)
  88     wxEVENT_PROPERTY( Select , wxEVT_COMMAND_LISTBOX_SELECTED , wxCommandEvent )
  89     wxEVENT_PROPERTY( DoubleClick , wxEVT_COMMAND_LISTBOX_DOUBLECLICKED , wxCommandEvent )
  90
  91     wxPROPERTY( Font , wxFont , SetFont , GetFont  , EMPTY_MACROVALUE, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
  92     wxPROPERTY_COLLECTION( Choices , wxArrayString , wxString , AppendString , GetStrings, 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
  93     wxPROPERTY( Selection ,int, SetSelection, GetSelection, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
  94     wxPROPERTY_FLAGS( WindowStyle , wxListBoxStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
  95 wxEND_PROPERTIES_TABLE()
  96
  97 wxBEGIN_HANDLERS_TABLE(wxListBox)
  98 wxEND_HANDLERS_TABLE()
  99
 100 wxCONSTRUCTOR_4( wxListBox , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size )
 101 #else
 102 IMPLEMENT_DYNAMIC_CLASS(wxListBox, wxControlWithItems)
 103 #endif
 104
 105 /*
 106 TODO PROPERTIES
 107     selection
 108     content
 109         item
 110 */
 111
 112 // ============================================================================
 113 // list box item declaration and implementation
 114 // ============================================================================
 115
 116 #if wxUSE_OWNER_DRAWN
 117
 118 class wxListBoxItem : public wxOwnerDrawn
 119 {
 120 public:
 121     wxListBoxItem(wxListBox *parent)
 122         { m_parent = parent; }
 123
 124     wxListBox *GetParent() const
 125         { return m_parent; }
 126
 127     int GetIndex() const
 128         { return m_parent->GetItemIndex(const_cast<wxListBoxItem*>(this)); }
 129
 130     wxString GetName() const
 131         { return m_parent->GetString(GetIndex()); }
 132
 133 private:
 134     wxListBox *m_parent;
 135 };
 136
 137 wxOwnerDrawn *wxListBox::CreateLboxItem(size_t WXUNUSED(n))
 138 {
 139     return new wxListBoxItem(this);
 140 }
 141
 142 #endif  //USE_OWNER_DRAWN
 143
 144 // ============================================================================
 145 // list box control implementation
 146 // ============================================================================
 147
 148 // ----------------------------------------------------------------------------
 149 // creation
 150 // ----------------------------------------------------------------------------
 151
 152 void wxListBox::Init()
 153 {
 154     m_noItems = 0;
 155     m_updateHorizontalExtent = false;
 156     m_selectedByKeyboard = false;
 157 }
 158
 159 bool wxListBox::Create(wxWindow *parent,
 160                        wxWindowID id,
 161                        const wxPoint& pos,
 162                        const wxSize& size,
 163                        int n, const wxString choices[],
 164                        long style,
 165                        const wxValidator& validator,
 166                        const wxString& name)
 167 {
 168     // initialize base class fields
 169     if ( !CreateControl(parent, id, pos, size, style, validator, name) )
 170         return false;
 171
 172     // create the native control
 173     if ( !MSWCreateControl(wxT("LISTBOX"), wxEmptyString, pos, size) )
 174     {
 175         // control creation failed
 176         return false;
 177     }
 178
 179     // initialize the contents
 180     for ( int i = 0; i < n; i++ )
 181     {
 182         Append(choices[i]);
 183     }
 184
 185     // now we can compute our best size correctly, so do it again
 186     SetInitialSize(size);
 187
 188     return true;
 189 }
 190
 191 bool wxListBox::Create(wxWindow *parent,
 192                        wxWindowID id,
 193                        const wxPoint& pos,
 194                        const wxSize& size,
 195                        const wxArrayString& choices,
 196                        long style,
 197                        const wxValidator& validator,
 198                        const wxString& name)
 199 {
 200     wxCArrayString chs(choices);
 201     return Create(parent, id, pos, size, chs.GetCount(), chs.GetStrings(),
 202                   style, validator, name);
 203 }
 204
 205 wxListBox::~wxListBox()
 206 {
 207     Clear();
 208 }
 209
 210 WXDWORD wxListBox::MSWGetStyle(long style, WXDWORD *exstyle) const
 211 {
 212     WXDWORD msStyle = wxControl::MSWGetStyle(style, exstyle);
 213
 214     // we always want to get the notifications
 215     msStyle |= LBS_NOTIFY;
 216
 217     // without this style, you get unexpected heights, so e.g. constraint
 218     // layout doesn't work properly
 219     msStyle |= LBS_NOINTEGRALHEIGHT;
 220
 221     wxASSERT_MSG( !(style & wxLB_MULTIPLE) || !(style & wxLB_EXTENDED),
 222                   wxT("only one of listbox selection modes can be specified") );
 223
 224     if ( style & wxLB_MULTIPLE )
 225         msStyle |= LBS_MULTIPLESEL;
 226     else if ( style & wxLB_EXTENDED )
 227         msStyle |= LBS_EXTENDEDSEL;
 228
 229     wxASSERT_MSG( !(style & wxLB_ALWAYS_SB) || !(style & wxLB_NO_SB),
 230                   wxT( "Conflicting styles wxLB_ALWAYS_SB and wxLB_NO_SB." ) );
 231
 232     if ( !(style & wxLB_NO_SB) )
 233     {
 234         msStyle |= WS_VSCROLL;
 235         if ( style & wxLB_ALWAYS_SB )
 236             msStyle |= LBS_DISABLENOSCROLL;
 237     }
 238
 239     if ( m_windowStyle & wxLB_HSCROLL )
 240         msStyle |= WS_HSCROLL;
 241     if ( m_windowStyle & wxLB_SORT )
 242         msStyle |= LBS_SORT;
 243
 244 #if wxUSE_OWNER_DRAWN && !defined(__WXWINCE__)
 245     if ( m_windowStyle & wxLB_OWNERDRAW )
 246     {
 247         // we don't support LBS_OWNERDRAWVARIABLE yet and we also always put
 248         // the strings in the listbox for simplicity even though we could have
 249         // avoided it in this case
 250         msStyle |= LBS_OWNERDRAWFIXED | LBS_HASSTRINGS;
 251     }
 252 #endif // wxUSE_OWNER_DRAWN
 253
 254     return msStyle;
 255 }
 256
 257 void wxListBox::OnInternalIdle()
 258 {
 259     wxWindow::OnInternalIdle();
 260
 261     if (m_updateHorizontalExtent)
 262     {
 263         SetHorizontalExtent(wxEmptyString);
 264         m_updateHorizontalExtent = false;
 265     }
 266 }
 267
 268 void wxListBox::MSWOnItemsChanged()
 269 {
 270     // we need to do two things when items change: update their max horizontal
 271     // extent so that horizontal scrollbar could be shown or hidden as
 272     // appropriate and also invlaidate the best size
 273     //
 274     // updating the max extent is slow (it's an O(N) operation) and so we defer
 275     // it until the idle time but the best size should be invalidated
 276     // immediately doing it in idle time is too late -- layout using incorrect
 277     // old best size will have been already done by then
 278
 279     m_updateHorizontalExtent = true;
 280
 281     InvalidateBestSize();
 282 }
 283
 284 // ----------------------------------------------------------------------------
 285 // implementation of wxListBoxBase methods
 286 // ----------------------------------------------------------------------------
 287
 288 void wxListBox::DoSetFirstItem(int N)
 289 {
 290     wxCHECK_RET( IsValid(N),
 291                  wxT("invalid index in wxListBox::SetFirstItem") );
 292
 293     SendMessage(GetHwnd(), LB_SETTOPINDEX, (WPARAM)N, (LPARAM)0);
 294 }
 295
 296 void wxListBox::DoDeleteOneItem(unsigned int n)
 297 {
 298     wxCHECK_RET( IsValid(n),
 299                  wxT("invalid index in wxListBox::Delete") );
 300
 301 #if wxUSE_OWNER_DRAWN
 302     if ( HasFlag(wxLB_OWNERDRAW) )
 303     {
 304         delete m_aItems[n];
 305         m_aItems.RemoveAt(n);
 306     }
 307 #endif // wxUSE_OWNER_DRAWN
 308
 309     SendMessage(GetHwnd(), LB_DELETESTRING, n, 0);
 310     m_noItems--;
 311
 312     MSWOnItemsChanged();
 313
 314     UpdateOldSelections();
 315 }
 316
 317 int wxListBox::FindString(const wxString& s, bool bCase) const
 318 {
 319     // back to base class search for not native search type
 320     if (bCase)
 321        return wxItemContainerImmutable::FindString( s, bCase );
 322
 323     int pos = ListBox_FindStringExact(GetHwnd(), -1, s.wx_str());
 324     if (pos == LB_ERR)
 325         return wxNOT_FOUND;
 326     else
 327         return pos;
 328 }
 329
 330 void wxListBox::DoClear()
 331 {
 332 #if wxUSE_OWNER_DRAWN
 333     if ( HasFlag(wxLB_OWNERDRAW) )
 334     {
 335         WX_CLEAR_ARRAY(m_aItems);
 336     }
 337 #endif // wxUSE_OWNER_DRAWN
 338
 339     ListBox_ResetContent(GetHwnd());
 340
 341     m_noItems = 0;
 342     MSWOnItemsChanged();
 343
 344     UpdateOldSelections();
 345 }
 346
 347 void wxListBox::DoSetSelection(int N, bool select)
 348 {
 349     wxCHECK_RET( N == wxNOT_FOUND || IsValid(N),
 350                  wxT("invalid index in wxListBox::SetSelection") );
 351
 352     if ( HasMultipleSelection() )
 353     {
 354         SendMessage(GetHwnd(), LB_SETSEL, select, N);
 355     }
 356     else
 357     {
 358         SendMessage(GetHwnd(), LB_SETCURSEL, select ? N : -1, 0);
 359     }
 360
 361     UpdateOldSelections();
 362 }
 363
 364 bool wxListBox::IsSelected(int N) const
 365 {
 366     wxCHECK_MSG( IsValid(N), false,
 367                  wxT("invalid index in wxListBox::Selected") );
 368
 369     return SendMessage(GetHwnd(), LB_GETSEL, N, 0) == 0 ? false : true;
 370 }
 371
 372 void *wxListBox::DoGetItemClientData(unsigned int n) const
 373 {
 374     wxCHECK_MSG( IsValid(n), NULL,
 375                  wxT("invalid index in wxListBox::GetClientData") );
 376
 377     return (void *)SendMessage(GetHwnd(), LB_GETITEMDATA, n, 0);
 378 }
 379
 380 void wxListBox::DoSetItemClientData(unsigned int n, void *clientData)
 381 {
 382     wxCHECK_RET( IsValid(n),
 383                  wxT("invalid index in wxListBox::SetClientData") );
 384
 385     if ( ListBox_SetItemData(GetHwnd(), n, clientData) == LB_ERR )
 386     {
 387         wxLogDebug(wxT("LB_SETITEMDATA failed"));
 388     }
 389 }
 390
 391 // Return number of selections and an array of selected integers
 392 int wxListBox::GetSelections(wxArrayInt& aSelections) const
 393 {
 394     aSelections.Empty();
 395
 396     if ( HasMultipleSelection() )
 397     {
 398         int countSel = ListBox_GetSelCount(GetHwnd());
 399         if ( countSel == LB_ERR )
 400         {
 401             wxLogDebug(wxT("ListBox_GetSelCount failed"));
 402         }
 403         else if ( countSel != 0 )
 404         {
 405             int *selections = new int[countSel];
 406
 407             if ( ListBox_GetSelItems(GetHwnd(),
 408                                      countSel, selections) == LB_ERR )
 409             {
 410                 wxLogDebug(wxT("ListBox_GetSelItems failed"));
 411                 countSel = -1;
 412             }
 413             else
 414             {
 415                 aSelections.Alloc(countSel);
 416                 for ( int n = 0; n < countSel; n++ )
 417                     aSelections.Add(selections[n]);
 418             }
 419
 420             delete [] selections;
 421         }
 422
 423         return countSel;
 424     }
 425     else  // single-selection listbox
 426     {
 427         if (ListBox_GetCurSel(GetHwnd()) > -1)
 428             aSelections.Add(ListBox_GetCurSel(GetHwnd()));
 429
 430         return aSelections.Count();
 431     }
 432 }
 433
 434 // Get single selection, for single choice list items
 435 int wxListBox::GetSelection() const
 436 {
 437     wxCHECK_MSG( !HasMultipleSelection(),
 438                  -1,
 439                  wxT("GetSelection() can't be used with multiple-selection listboxes, use GetSelections() instead.") );
 440
 441     return ListBox_GetCurSel(GetHwnd());
 442 }
 443
 444 // Find string for position
 445 wxString wxListBox::GetString(unsigned int n) const
 446 {
 447     wxCHECK_MSG( IsValid(n), wxEmptyString,
 448                  wxT("invalid index in wxListBox::GetString") );
 449
 450     int len = ListBox_GetTextLen(GetHwnd(), n);
 451
 452     // +1 for terminating NUL
 453     wxString result;
 454     ListBox_GetText(GetHwnd(), n, (wxChar*)wxStringBuffer(result, len + 1));
 455
 456     return result;
 457 }
 458
 459 int wxListBox::DoInsertItems(const wxArrayStringsAdapter & items,
 460                              unsigned int pos,
 461                              void **clientData,
 462                              wxClientDataType type)
 463 {
 464     MSWAllocStorage(items, LB_INITSTORAGE);
 465
 466     const bool append = pos == GetCount();
 467
 468     // we must use CB_ADDSTRING when appending as only it works correctly for
 469     // the sorted controls
 470     const unsigned msg = append ? LB_ADDSTRING : LB_INSERTSTRING;
 471
 472     if ( append )
 473         pos = 0;
 474
 475     int n = wxNOT_FOUND;
 476
 477     const unsigned int numItems = items.GetCount();
 478     for ( unsigned int i = 0; i < numItems; i++ )
 479     {
 480         n = MSWInsertOrAppendItem(pos, items[i], msg);
 481         if ( n == wxNOT_FOUND )
 482             return n;
 483
 484         if ( !append )
 485             pos++;
 486
 487         ++m_noItems;
 488
 489 #if wxUSE_OWNER_DRAWN
 490         if ( HasFlag(wxLB_OWNERDRAW) )
 491         {
 492             wxOwnerDrawn *pNewItem = CreateLboxItem(n);
 493             pNewItem->SetFont(GetFont());
 494             m_aItems.Insert(pNewItem, n);
 495         }
 496 #endif // wxUSE_OWNER_DRAWN
 497         AssignNewItemClientData(n, clientData, i, type);
 498     }
 499
 500     MSWOnItemsChanged();
 501
 502     UpdateOldSelections();
 503
 504     return n;
 505 }
 506
 507 int wxListBox::DoHitTestList(const wxPoint& point) const
 508 {
 509     LRESULT lRes = ::SendMessage(GetHwnd(), LB_ITEMFROMPOINT,
 510                                  0, MAKELPARAM(point.x, point.y));
 511
 512     // non zero high-order word means that this item is outside of the client
 513     // area, IOW the point is outside of the listbox
 514     return HIWORD(lRes) ? wxNOT_FOUND : LOWORD(lRes);
 515 }
 516
 517 void wxListBox::SetString(unsigned int n, const wxString& s)
 518 {
 519     wxCHECK_RET( IsValid(n),
 520                  wxT("invalid index in wxListBox::SetString") );
 521
 522     // remember the state of the item
 523     bool wasSelected = IsSelected(n);
 524
 525     void *oldData = NULL;
 526     wxClientData *oldObjData = NULL;
 527     if ( HasClientUntypedData() )
 528         oldData = GetClientData(n);
 529     else if ( HasClientObjectData() )
 530         oldObjData = GetClientObject(n);
 531
 532     // delete and recreate it
 533     SendMessage(GetHwnd(), LB_DELETESTRING, n, 0);
 534
 535     int newN = n;
 536     if ( n == (m_noItems - 1) )
 537         newN = -1;
 538
 539     ListBox_InsertString(GetHwnd(), newN, s.wx_str());
 540
 541     // restore the client data
 542     if ( oldData )
 543         SetClientData(n, oldData);
 544     else if ( oldObjData )
 545         SetClientObject(n, oldObjData);
 546
 547     // we may have lost the selection
 548     if ( wasSelected )
 549         Select(n);
 550
 551     MSWOnItemsChanged();
 552 }
 553
 554 unsigned int wxListBox::GetCount() const
 555 {
 556     return m_noItems;
 557 }
 558
 559 // ----------------------------------------------------------------------------
 560 // size-related stuff
 561 // ----------------------------------------------------------------------------
 562
 563 void wxListBox::SetHorizontalExtent(const wxString& s)
 564 {
 565     // the rest is only necessary if we want a horizontal scrollbar
 566     if ( !HasFlag(wxHSCROLL) )
 567         return;
 568
 569
 570     WindowHDC dc(GetHwnd());
 571     SelectInHDC selFont(dc, GetHfontOf(GetFont()));
 572
 573     TEXTMETRIC lpTextMetric;
 574     ::GetTextMetrics(dc, &lpTextMetric);
 575
 576     int largestExtent = 0;
 577     SIZE extentXY;
 578
 579     if ( s.empty() )
 580     {
 581         // set extent to the max length of all strings
 582         for ( unsigned int i = 0; i < m_noItems; i++ )
 583         {
 584             const wxString str = GetString(i);
 585             ::GetTextExtentPoint32(dc, str.c_str(), str.length(), &extentXY);
 586
 587             int extentX = (int)(extentXY.cx + lpTextMetric.tmAveCharWidth);
 588             if ( extentX > largestExtent )
 589                 largestExtent = extentX;
 590         }
 591     }
 592     else // just increase the extent to the length of this string
 593     {
 594         int existingExtent = (int)SendMessage(GetHwnd(),
 595                                               LB_GETHORIZONTALEXTENT, 0, 0L);
 596
 597         ::GetTextExtentPoint32(dc, s.c_str(), s.length(), &extentXY);
 598
 599         int extentX = (int)(extentXY.cx + lpTextMetric.tmAveCharWidth);
 600         if ( extentX > existingExtent )
 601             largestExtent = extentX;
 602     }
 603
 604     if ( largestExtent )
 605         SendMessage(GetHwnd(), LB_SETHORIZONTALEXTENT, LOWORD(largestExtent), 0L);
 606     //else: it shouldn't change
 607 }
 608
 609 wxSize wxListBox::DoGetBestClientSize() const
 610 {
 611     // find the widest string
 612     int wLine;
 613     int wListbox = 0;
 614     for (unsigned int i = 0; i < m_noItems; i++)
 615     {
 616         wxString str(GetString(i));
 617         GetTextExtent(str, &wLine, NULL);
 618         if ( wLine > wListbox )
 619             wListbox = wLine;
 620     }
 621
 622     // give it some reasonable default value if there are no strings in the
 623     // list
 624     if ( wListbox == 0 )
 625         wListbox = 100;
 626
 627     // the listbox should be slightly larger than the widest string
 628     wListbox += 3*GetCharWidth();
 629
 630     // add room for the scrollbar
 631     wListbox += wxSystemSettings::GetMetric(wxSYS_VSCROLL_X);
 632
 633     // don't make the listbox too tall (limit height to 10 items) but don't
 634     // make it too small neither
 635     int hListbox = SendMessage(GetHwnd(), LB_GETITEMHEIGHT, 0, 0)*
 636                     wxMin(wxMax(m_noItems, 3), 10);
 637
 638     return wxSize(wListbox, hListbox);
 639 }
 640
 641 // ----------------------------------------------------------------------------
 642 // callbacks
 643 // ----------------------------------------------------------------------------
 644
 645 bool wxListBox::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
 646 {
 647     wxEventType evtType;
 648     int n = wxNOT_FOUND;
 649     if ( param == LBN_SELCHANGE )
 650     {
 651         if ( HasMultipleSelection() )
 652             return CalcAndSendEvent();
 653
 654         evtType = wxEVT_COMMAND_LISTBOX_SELECTED;
 655
 656         if ( m_selectedByKeyboard )
 657         {
 658             // We shouldn't use the mouse position to find the item as mouse
 659             // can be anywhere, ask the listbox itself. Notice that this can't
 660             // be used when the item is selected using the mouse however as
 661             // LB_GETCARETINDEX will always return a valid item, even if the
 662             // mouse is clicked below all the items, which is why we find the
 663             // item ourselves below in this case.
 664             n = SendMessage(GetHwnd(), LB_GETCARETINDEX, 0, 0);
 665         }
 666         //else: n will be determined below from the mouse position
 667     }
 668     else if ( param == LBN_DBLCLK )
 669     {
 670         evtType = wxEVT_COMMAND_LISTBOX_DOUBLECLICKED;
 671     }
 672     else
 673     {
 674         // some event we're not interested in
 675         return false;
 676     }
 677
 678     // Find the item position if it was a mouse-generated selection event or a
 679     // double click event (which is always generated using the mouse)
 680     if ( n == wxNOT_FOUND )
 681     {
 682         const DWORD pos = ::GetMessagePos();
 683         const wxPoint pt(GET_X_LPARAM(pos), GET_Y_LPARAM(pos));
 684         n = HitTest(ScreenToClient(wxPoint(pt)));
 685     }
 686
 687     // We get events even when mouse is clicked outside of any valid item from
 688     // Windows, just ignore them.
 689     if ( n == wxNOT_FOUND )
 690        return false;
 691
 692     // As we don't use m_oldSelections in single selection mode, we store the
 693     // last item that we notified the user about in it in this case because we
 694     // need to remember it to be able to filter out the dummy LBN_SELCHANGE
 695     // messages that we get when the user clicks on an already selected item.
 696     if ( param == LBN_SELCHANGE )
 697     {
 698         if ( !m_oldSelections.empty() && *m_oldSelections.begin() == n )
 699         {
 700             // Same item as the last time.
 701             return false;
 702         }
 703
 704         m_oldSelections.clear();
 705         m_oldSelections.push_back(n);
 706     }
 707
 708     // Do generate an event otherwise.
 709     return SendEvent(evtType, n, true /* selection */);
 710 }
 711
 712 WXLRESULT
 713 wxListBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 714 {
 715     // Remember whether there was a keyboard or mouse event before
 716     // LBN_SELCHANGE: this allows us to correctly determine the item affected
 717     // by it in MSWCommand() above in any case.
 718     if ( WM_KEYFIRST <= nMsg && nMsg <= WM_KEYLAST )
 719         m_selectedByKeyboard = true;
 720     else if ( WM_MOUSEFIRST <= nMsg && nMsg <= WM_MOUSELAST )
 721         m_selectedByKeyboard = false;
 722
 723     return wxListBoxBase::MSWWindowProc(nMsg, wParam, lParam);
 724 }
 725
 726 // ----------------------------------------------------------------------------
 727 // owner-drawn list boxes support
 728 // ----------------------------------------------------------------------------
 729
 730 #if wxUSE_OWNER_DRAWN
 731
 732 // misc overloaded methods
 733 // -----------------------
 734
 735 bool wxListBox::SetFont(const wxFont &font)
 736 {
 737     if ( HasFlag(wxLB_OWNERDRAW) )
 738     {
 739         const unsigned count = m_aItems.GetCount();
 740         for ( unsigned i = 0; i < count; i++ )
 741             m_aItems[i]->SetFont(font);
 742     }
 743
 744     wxListBoxBase::SetFont(font);
 745
 746     return true;
 747 }
 748
 749 bool wxListBox::GetItemRect(size_t n, wxRect& rect) const
 750 {
 751     wxCHECK_MSG( IsValid(n), false,
 752                  wxT("invalid index in wxListBox::GetItemRect") );
 753
 754     RECT rc;
 755
 756     if ( ListBox_GetItemRect(GetHwnd(), n, &rc) != LB_ERR )
 757     {
 758         rect = wxRectFromRECT(rc);
 759         return true;
 760     }
 761     else
 762     {
 763         // couldn't retrieve rect: for example, item isn't visible
 764         return false;
 765     }
 766 }
 767
 768 bool wxListBox::RefreshItem(size_t n)
 769 {
 770     wxRect rect;
 771     if ( !GetItemRect(n, rect) )
 772         return false;
 773
 774     RECT rc;
 775     wxCopyRectToRECT(rect, rc);
 776
 777     return ::InvalidateRect((HWND)GetHWND(), &rc, FALSE) == TRUE;
 778 }
 779
 780
 781 // drawing
 782 // -------
 783
 784 namespace
 785 {
 786     // space beneath/above each row in pixels
 787     static const int LISTBOX_EXTRA_SPACE = 1;
 788
 789 } // anonymous namespace
 790
 791 // the height is the same for all items
 792 // TODO should be changed for LBS_OWNERDRAWVARIABLE style listboxes
 793
 794 // NB: can't forward this to wxListBoxItem because LB_SETITEMDATA
 795 //     message is not yet sent when we get here!
 796 bool wxListBox::MSWOnMeasure(WXMEASUREITEMSTRUCT *item)
 797 {
 798     // only owner-drawn control should receive this message
 799     wxCHECK( HasFlag(wxLB_OWNERDRAW), false );
 800
 801     MEASUREITEMSTRUCT *pStruct = (MEASUREITEMSTRUCT *)item;
 802
 803 #ifdef __WXWINCE__
 804     HDC hdc = GetDC(NULL);
 805 #else
 806     HDC hdc = CreateIC(wxT("DISPLAY"), NULL, NULL, 0);
 807 #endif
 808
 809     {
 810         wxDCTemp dc((WXHDC)hdc);
 811         dc.SetFont(GetFont());
 812
 813         pStruct->itemHeight = dc.GetCharHeight() + 2 * LISTBOX_EXTRA_SPACE;
 814         pStruct->itemWidth  = dc.GetCharWidth();
 815     }
 816
 817 #ifdef __WXWINCE__
 818     ReleaseDC(NULL, hdc);
 819 #else
 820     DeleteDC(hdc);
 821 #endif
 822
 823     return true;
 824 }
 825
 826 // forward the message to the appropriate item
 827 bool wxListBox::MSWOnDraw(WXDRAWITEMSTRUCT *item)
 828 {
 829     // only owner-drawn control should receive this message
 830     wxCHECK( HasFlag(wxLB_OWNERDRAW), false );
 831
 832     DRAWITEMSTRUCT *pStruct = (DRAWITEMSTRUCT *)item;
 833
 834     // the item may be -1 for an empty listbox
 835     if ( pStruct->itemID == (UINT)-1 )
 836         return false;
 837
 838     wxListBoxItem *pItem = (wxListBoxItem *)m_aItems[pStruct->itemID];
 839
 840     wxDCTemp dc((WXHDC)pStruct->hDC);
 841
 842     return pItem->OnDrawItem(dc, wxRectFromRECT(pStruct->rcItem),
 843                              (wxOwnerDrawn::wxODAction)pStruct->itemAction,
 844                              (wxOwnerDrawn::wxODStatus)(pStruct->itemState | wxOwnerDrawn::wxODHidePrefix));
 845 }
 846
 847 #endif // wxUSE_OWNER_DRAWN
 848
 849 #endif // wxUSE_LISTBOX