src/msw/choice.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        choice.cpp
   3 // Purpose:     wxChoice
   4 // Author:      Julian Smart
   5 // Modified by: Vadim Zeitlin to derive from wxChoiceBase
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  21     #pragma implementation "choice.h"
  22 #endif
  23
  24 // For compilers that support precompilation, includes "wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #ifdef __BORLANDC__
  28     #pragma hdrstop
  29 #endif
  30
  31 #if wxUSE_CHOICE && !(defined(__SMARTPHONE__) && defined(__WXWINCE__))
  32
  33 #ifndef WX_PRECOMP
  34     #include "wx/choice.h"
  35     #include "wx/utils.h"
  36     #include "wx/log.h"
  37     #include "wx/brush.h"
  38     #include "wx/settings.h"
  39 #endif
  40
  41 #include "wx/msw/private.h"
  42
  43 #if wxUSE_EXTENDED_RTTI
  44 WX_DEFINE_FLAGS( wxChoiceStyle )
  45
  46 wxBEGIN_FLAGS( wxChoiceStyle )
  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 wxEND_FLAGS( wxChoiceStyle )
  75
  76 IMPLEMENT_DYNAMIC_CLASS_XTI(wxChoice, wxControl,"wx/choice.h")
  77
  78 wxBEGIN_PROPERTIES_TABLE(wxChoice)
  79     wxEVENT_PROPERTY( Select , wxEVT_COMMAND_CHOICE_SELECTED , wxCommandEvent )
  80
  81     wxPROPERTY( Font , wxFont , SetFont , GetFont  , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
  82     wxPROPERTY_COLLECTION( Choices , wxArrayString , wxString , AppendString , GetStrings , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
  83     wxPROPERTY( Selection ,int, SetSelection, GetSelection, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
  84     wxPROPERTY_FLAGS( WindowStyle , wxChoiceStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
  85 wxEND_PROPERTIES_TABLE()
  86
  87 wxBEGIN_HANDLERS_TABLE(wxChoice)
  88 wxEND_HANDLERS_TABLE()
  89
  90 wxCONSTRUCTOR_4( wxChoice , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size )
  91 #else
  92 IMPLEMENT_DYNAMIC_CLASS(wxChoice, wxControl)
  93 #endif
  94 /*
  95     TODO PROPERTIES
  96         selection (long)
  97         content (list)
  98             item
  99 */
 100
 101 // ============================================================================
 102 // implementation
 103 // ============================================================================
 104
 105 // ----------------------------------------------------------------------------
 106 // creation
 107 // ----------------------------------------------------------------------------
 108
 109 bool wxChoice::Create(wxWindow *parent,
 110                       wxWindowID id,
 111                       const wxPoint& pos,
 112                       const wxSize& size,
 113                       int n, const wxString choices[],
 114                       long style,
 115                       const wxValidator& validator,
 116                       const wxString& name)
 117 {
 118     // Experience shows that wxChoice vs. wxComboBox distinction confuses
 119     // quite a few people - try to help them
 120     wxASSERT_MSG( !(style & wxCB_DROPDOWN) &&
 121                   !(style & wxCB_READONLY) &&
 122                   !(style & wxCB_SIMPLE),
 123                   _T("this style flag is ignored by wxChoice, you ")
 124                   _T("probably want to use a wxComboBox") );
 125
 126     return CreateAndInit(parent, id, pos, size, n, choices, style,
 127                          validator, name);
 128 }
 129
 130 bool wxChoice::CreateAndInit(wxWindow *parent,
 131                              wxWindowID id,
 132                              const wxPoint& pos,
 133                              const wxSize& size,
 134                              int n, const wxString choices[],
 135                              long style,
 136                              const wxValidator& validator,
 137                              const wxString& name)
 138 {
 139     // initialize wxControl
 140     if ( !CreateControl(parent, id, pos, size, style, validator, name) )
 141         return false;
 142
 143     // now create the real HWND
 144     if ( !MSWCreateControl(wxT("COMBOBOX"), wxEmptyString, pos, size) )
 145         return false;
 146
 147
 148     // choice/combobox normally has "white" (depends on colour scheme, of
 149     // course) background rather than inheriting the parent's background
 150     SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
 151
 152     // initialize the controls contents
 153     for ( int i = 0; i < n; i++ )
 154     {
 155         Append(choices[i]);
 156     }
 157
 158     // and now we may finally size the control properly (if needed)
 159     SetBestSize(size);
 160
 161     return true;
 162 }
 163
 164 bool wxChoice::Create(wxWindow *parent,
 165                       wxWindowID id,
 166                       const wxPoint& pos,
 167                       const wxSize& size,
 168                       const wxArrayString& choices,
 169                       long style,
 170                       const wxValidator& validator,
 171                       const wxString& name)
 172 {
 173     wxCArrayString chs(choices);
 174     return Create(parent, id, pos, size, chs.GetCount(), chs.GetStrings(),
 175                   style, validator, name);
 176 }
 177
 178 bool wxChoice::MSWShouldPreProcessMessage(WXMSG *pMsg)
 179 {
 180     MSG *msg = (MSG *) pMsg;
 181
 182     // if the dropdown list is visible, don't preprocess certain keys
 183     if ( msg->message == WM_KEYDOWN
 184         && (msg->wParam == VK_ESCAPE || msg->wParam == VK_RETURN) )
 185     {
 186         if (::SendMessage(GetHwndOf(this), CB_GETDROPPEDSTATE, 0, 0))
 187         {
 188             return false;
 189         }
 190     }
 191
 192     return wxControl::MSWShouldPreProcessMessage(pMsg);
 193 }
 194
 195 WXDWORD wxChoice::MSWGetStyle(long style, WXDWORD *exstyle) const
 196 {
 197     // we never have an external border
 198     WXDWORD msStyle = wxControl::MSWGetStyle
 199                       (
 200                         (style & ~wxBORDER_MASK) | wxBORDER_NONE, exstyle
 201                       );
 202
 203     // WS_CLIPSIBLINGS is useful with wxChoice and doesn't seem to result in
 204     // any problems
 205     msStyle |= WS_CLIPSIBLINGS;
 206
 207     // wxChoice-specific styles
 208     msStyle |= CBS_DROPDOWNLIST | WS_HSCROLL | WS_VSCROLL;
 209     if ( style & wxCB_SORT )
 210         msStyle |= CBS_SORT;
 211
 212     return msStyle;
 213 }
 214
 215 wxChoice::~wxChoice()
 216 {
 217     Free();
 218 }
 219
 220 // ----------------------------------------------------------------------------
 221 // adding/deleting items to/from the list
 222 // ----------------------------------------------------------------------------
 223
 224 int wxChoice::DoAppend(const wxString& item)
 225 {
 226     int n = (int)SendMessage(GetHwnd(), CB_ADDSTRING, 0, (LPARAM)item.c_str());
 227     if ( n == CB_ERR )
 228     {
 229         wxLogLastError(wxT("SendMessage(CB_ADDSTRING)"));
 230     }
 231     else // ok
 232     {
 233         // we need to refresh our size in order to have enough space for the
 234         // newly added items
 235         if ( !IsFrozen() )
 236             UpdateVisibleHeight();
 237     }
 238
 239     InvalidateBestSize();
 240     return n;
 241 }
 242
 243 int wxChoice::DoInsert(const wxString& item, int pos)
 244 {
 245     wxCHECK_MSG(!(GetWindowStyle() & wxCB_SORT), -1, wxT("can't insert into sorted list"));
 246     wxCHECK_MSG((pos>=0) && (pos<=GetCount()), -1, wxT("invalid index"));
 247
 248     int n = (int)SendMessage(GetHwnd(), CB_INSERTSTRING, pos, (LPARAM)item.c_str());
 249     if ( n == CB_ERR )
 250     {
 251         wxLogLastError(wxT("SendMessage(CB_INSERTSTRING)"));
 252     }
 253     else // ok
 254     {
 255         if ( !IsFrozen() )
 256             UpdateVisibleHeight();
 257     }
 258
 259     InvalidateBestSize();
 260     return n;
 261 }
 262
 263 void wxChoice::Delete(int n)
 264 {
 265     wxCHECK_RET( n < GetCount(), wxT("invalid item index in wxChoice::Delete") );
 266
 267     if ( HasClientObjectData() )
 268     {
 269         delete GetClientObject(n);
 270     }
 271
 272     SendMessage(GetHwnd(), CB_DELETESTRING, n, 0);
 273
 274     if ( !IsFrozen() )
 275         UpdateVisibleHeight();
 276
 277     InvalidateBestSize();
 278 }
 279
 280 void wxChoice::Clear()
 281 {
 282     Free();
 283
 284     SendMessage(GetHwnd(), CB_RESETCONTENT, 0, 0);
 285
 286     if ( !IsFrozen() )
 287         UpdateVisibleHeight();
 288
 289     InvalidateBestSize();
 290 }
 291
 292 void wxChoice::Free()
 293 {
 294     if ( HasClientObjectData() )
 295     {
 296         size_t count = GetCount();
 297         for ( size_t n = 0; n < count; n++ )
 298         {
 299             delete GetClientObject(n);
 300         }
 301     }
 302 }
 303
 304 // ----------------------------------------------------------------------------
 305 // selection
 306 // ----------------------------------------------------------------------------
 307
 308 int wxChoice::GetSelection() const
 309 {
 310     return (int)SendMessage(GetHwnd(), CB_GETCURSEL, 0, 0);
 311 }
 312
 313 void wxChoice::SetSelection(int n)
 314 {
 315     SendMessage(GetHwnd(), CB_SETCURSEL, n, 0);
 316 }
 317
 318 // ----------------------------------------------------------------------------
 319 // string list functions
 320 // ----------------------------------------------------------------------------
 321
 322 int wxChoice::GetCount() const
 323 {
 324     return (int)SendMessage(GetHwnd(), CB_GETCOUNT, 0, 0);
 325 }
 326
 327 int wxChoice::FindString(const wxString& s) const
 328 {
 329 #if defined(__WATCOMC__) && defined(__WIN386__)
 330     // For some reason, Watcom in WIN386 mode crashes in the CB_FINDSTRINGEXACT message.
 331     // wxChoice::Do it the long way instead.
 332     int count = GetCount();
 333     for ( int i = 0; i < count; i++ )
 334     {
 335         // as CB_FINDSTRINGEXACT is case insensitive, be case insensitive too
 336         if ( GetString(i).IsSameAs(s, false) )
 337             return i;
 338     }
 339
 340     return wxNOT_FOUND;
 341 #else // !Watcom
 342    //TODO:  Evidently some MSW versions (all?) don't like empty strings
 343    //passed to SendMessage, so we have to do it ourselves in that case
 344    if ( s.empty() )
 345    {
 346      int count = GetCount();
 347      for ( int i = 0; i < count; i++ )
 348      {
 349        if ( GetString(i).empty() )
 350            return i;
 351      }
 352
 353      return wxNOT_FOUND;
 354    }
 355    else
 356    {
 357      int pos = (int)SendMessage(GetHwnd(), CB_FINDSTRINGEXACT,
 358                                 (WPARAM)-1, (LPARAM)s.c_str());
 359
 360      return pos == LB_ERR ? wxNOT_FOUND : pos;
 361    }
 362 #endif // Watcom/!Watcom
 363 }
 364
 365 void wxChoice::SetString(int n, const wxString& s)
 366 {
 367     wxCHECK_RET( n >= 0 && n < GetCount(),
 368                  wxT("invalid item index in wxChoice::SetString") );
 369
 370     // we have to delete and add back the string as there is no way to change a
 371     // string in place
 372
 373     // we need to preserve the client data
 374     void *data;
 375     if ( m_clientDataItemsType != wxClientData_None )
 376     {
 377         data = DoGetItemClientData(n);
 378     }
 379     else // no client data
 380     {
 381         data = NULL;
 382     }
 383
 384     ::SendMessage(GetHwnd(), CB_DELETESTRING, n, 0);
 385     ::SendMessage(GetHwnd(), CB_INSERTSTRING, n, (LPARAM)s.c_str() );
 386
 387     if ( data )
 388     {
 389         DoSetItemClientData(n, data);
 390     }
 391     //else: it's already NULL by default
 392
 393     InvalidateBestSize();
 394 }
 395
 396 wxString wxChoice::GetString(int n) const
 397 {
 398     int len = (int)::SendMessage(GetHwnd(), CB_GETLBTEXTLEN, n, 0);
 399
 400     wxString str;
 401     if ( len != CB_ERR && len > 0 )
 402     {
 403         if ( ::SendMessage
 404                (
 405                 GetHwnd(),
 406                 CB_GETLBTEXT,
 407                 n,
 408                 (LPARAM)(wxChar *)wxStringBuffer(str, len)
 409                ) == CB_ERR )
 410         {
 411             wxLogLastError(wxT("SendMessage(CB_GETLBTEXT)"));
 412         }
 413     }
 414
 415     return str;
 416 }
 417
 418 // ----------------------------------------------------------------------------
 419 // client data
 420 // ----------------------------------------------------------------------------
 421
 422 void wxChoice::DoSetItemClientData( int n, void* clientData )
 423 {
 424     if ( ::SendMessage(GetHwnd(), CB_SETITEMDATA,
 425                        n, (LPARAM)clientData) == CB_ERR )
 426     {
 427         wxLogLastError(wxT("CB_SETITEMDATA"));
 428     }
 429 }
 430
 431 void* wxChoice::DoGetItemClientData( int n ) const
 432 {
 433     LPARAM rc = SendMessage(GetHwnd(), CB_GETITEMDATA, n, 0);
 434     if ( rc == CB_ERR )
 435     {
 436         wxLogLastError(wxT("CB_GETITEMDATA"));
 437
 438         // unfortunately, there is no way to return an error code to the user
 439         rc = (LPARAM) NULL;
 440     }
 441
 442     return (void *)rc;
 443 }
 444
 445 void wxChoice::DoSetItemClientObject( int n, wxClientData* clientData )
 446 {
 447     DoSetItemClientData(n, clientData);
 448 }
 449
 450 wxClientData* wxChoice::DoGetItemClientObject( int n ) const
 451 {
 452     return (wxClientData *)DoGetItemClientData(n);
 453 }
 454
 455 // ----------------------------------------------------------------------------
 456 // wxMSW specific helpers
 457 // ----------------------------------------------------------------------------
 458
 459 void wxChoice::UpdateVisibleHeight()
 460 {
 461     // be careful to not change the width here
 462     DoSetSize(wxDefaultCoord, wxDefaultCoord, wxDefaultCoord, GetSize().y, wxSIZE_USE_EXISTING);
 463 }
 464
 465 void wxChoice::DoMoveWindow(int x, int y, int width, int height)
 466 {
 467     // here is why this is necessary: if the width is negative, the combobox
 468     // window proc makes the window of the size width*height instead of
 469     // interpreting height in the usual manner (meaning the height of the drop
 470     // down list - usually the height specified in the call to MoveWindow()
 471     // will not change the height of combo box per se)
 472     //
 473     // this behaviour is not documented anywhere, but this is just how it is
 474     // here (NT 4.4) and, anyhow, the check shouldn't hurt - however without
 475     // the check, constraints/sizers using combos may break the height
 476     // constraint will have not at all the same value as expected
 477     if ( width < 0 )
 478         return;
 479
 480     wxControl::DoMoveWindow(x, y, width, height);
 481 }
 482
 483 void wxChoice::DoGetSize(int *w, int *h) const
 484 {
 485     // this is weird: sometimes, the height returned by Windows is clearly the
 486     // total height of the control including the drop down list -- but only
 487     // sometimes, and normally it isn't... I have no idea about what to do with
 488     // this
 489     wxControl::DoGetSize(w, h);
 490 }
 491
 492 void wxChoice::DoSetSize(int x, int y,
 493                          int width, int height,
 494                          int sizeFlags)
 495 {
 496     int heightOrig = height;
 497
 498     // the height which we must pass to Windows should be the total height of
 499     // the control including the drop down list while the height given to us
 500     // is, of course, just the height of the permanently visible part of it
 501     if ( height != wxDefaultCoord )
 502     {
 503         // don't make the drop down list too tall, arbitrarily limit it to 40
 504         // items max and also don't leave it empty
 505         size_t nItems = GetCount();
 506         if ( !nItems )
 507             nItems = 9;
 508         else if ( nItems > 24 )
 509             nItems = 24;
 510
 511         // add space for the drop down list
 512         const int hItem = SendMessage(GetHwnd(), CB_GETITEMHEIGHT, 0, 0);
 513         height += hItem*(nItems + 1);
 514     }
 515     else
 516     {
 517         // We cannot pass wxDefaultCoord as height to wxControl. wxControl uses
 518         // wxGetWindowRect() to determine the current height of the combobox,
 519         // and then again sets the combobox's height to that value. Unfortunately,
 520         // wxGetWindowRect doesn't include the dropdown list's height (at least
 521         // on Win2K), so this would result in a combobox with dropdown height of
 522         // 1 pixel. We have to determine the default height ourselves and call
 523         // wxControl with that value instead.
 524         int w, h;
 525         RECT r;
 526         DoGetSize(&w, &h);
 527         if (::SendMessage(GetHwnd(), CB_GETDROPPEDCONTROLRECT, 0, (LPARAM) &r) != 0)
 528         {
 529             height = h + r.bottom - r.top;
 530         }
 531     }
 532
 533     wxControl::DoSetSize(x, y, width, height, sizeFlags);
 534
 535     // I'm commenting this out since the code appears to make choices
 536     // and comboxes too high when they have associated sizers. I'm sure this
 537     // is not the end of the story, which is why I'm leaving it #if'ed out for
 538     // now. JACS.
 539 #if 0
 540     // if the height specified for the visible part of the control is
 541     // different from the current one, we need to change it separately
 542     // as it is not affected by normal WM_SETSIZE
 543     if ( height != wxDefaultCoord )
 544     {
 545         const int delta = heightOrig - GetSize().y;
 546         if ( delta )
 547         {
 548             int h = ::SendMessage(GetHwnd(), CB_GETITEMHEIGHT, (WPARAM)-1, 0);
 549             SendMessage(GetHwnd(), CB_SETITEMHEIGHT, (WPARAM)-1, h + delta);
 550         }
 551     }
 552 #else
 553     wxUnusedVar(heightOrig);
 554 #endif
 555 }
 556
 557 wxSize wxChoice::DoGetBestSize() const
 558 {
 559     // find the widest string
 560     int wChoice = 0;
 561     const size_t nItems = GetCount();
 562     for ( size_t i = 0; i < nItems; i++ )
 563     {
 564         int wLine;
 565         GetTextExtent(GetString(i), &wLine, NULL);
 566         if ( wLine > wChoice )
 567             wChoice = wLine;
 568     }
 569
 570     // give it some reasonable default value if there are no strings in the
 571     // list
 572     if ( wChoice == 0 )
 573         wChoice = 100;
 574
 575     // the combobox should be slightly larger than the widest string
 576     wChoice += 5*GetCharWidth();
 577
 578     wxSize best(wChoice, EDIT_HEIGHT_FROM_CHAR_HEIGHT(GetCharHeight()));
 579     CacheBestSize(best);
 580     return best;
 581 }
 582
 583 WXLRESULT wxChoice::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 584 {
 585     switch ( nMsg )
 586     {
 587         case WM_LBUTTONUP:
 588             {
 589                 int x = (int)LOWORD(lParam);
 590                 int y = (int)HIWORD(lParam);
 591
 592                 // Ok, this is truly weird, but if a panel with a wxChoice
 593                 // loses the focus, then you get a *fake* WM_LBUTTONUP message
 594                 // with x = 65535 and y = 65535. Filter out this nonsense.
 595                 //
 596                 // VZ: I'd like to know how to reproduce this please...
 597                 if ( x == 65535 && y == 65535 )
 598                     return 0;
 599             }
 600             break;
 601
 602             // we have to handle both: one for the normal case and the other
 603             // for readonly
 604         case WM_CTLCOLOREDIT:
 605         case WM_CTLCOLORLISTBOX:
 606         case WM_CTLCOLORSTATIC:
 607             {
 608                 WXHDC hdc;
 609                 WXHWND hwnd;
 610                 UnpackCtlColor(wParam, lParam, &hdc, &hwnd);
 611
 612                 WXHBRUSH hbr = MSWControlColor((WXHDC)hdc, hwnd);
 613                 if ( hbr )
 614                     return (WXLRESULT)hbr;
 615                 //else: fall through to default window proc
 616             }
 617     }
 618
 619     return wxWindow::MSWWindowProc(nMsg, wParam, lParam);
 620 }
 621
 622 bool wxChoice::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
 623 {
 624     if ( param != CBN_SELCHANGE)
 625     {
 626         // "selection changed" is the only event we're after
 627         return false;
 628     }
 629
 630     int n = GetSelection();
 631     if (n > -1)
 632     {
 633         wxCommandEvent event(wxEVT_COMMAND_CHOICE_SELECTED, m_windowId);
 634         event.SetInt(n);
 635         event.SetEventObject(this);
 636         event.SetString(GetStringSelection());
 637         if ( HasClientObjectData() )
 638             event.SetClientObject( GetClientObject(n) );
 639         else if ( HasClientUntypedData() )
 640             event.SetClientData( GetClientData(n) );
 641         ProcessCommand(event);
 642     }
 643
 644     return true;
 645 }
 646
 647 WXHBRUSH wxChoice::MSWControlColor(WXHDC hDC, WXHWND hWnd)
 648 {
 649     if ( !IsEnabled() )
 650         return MSWControlColorDisabled(hDC);
 651
 652     return wxChoiceBase::MSWControlColor(hDC, hWnd);
 653 }
 654
 655 #endif // wxUSE_CHOICE && !(__SMARTPHONE__ && __WXWINCE__)
 656