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     return n;
 240 }
 241
 242 int wxChoice::DoInsert(const wxString& item, int pos)
 243 {
 244     wxCHECK_MSG(!(GetWindowStyle() & wxCB_SORT), -1, wxT("can't insert into sorted list"));
 245     wxCHECK_MSG((pos>=0) && (pos<=GetCount()), -1, wxT("invalid index"));
 246
 247     int n = (int)SendMessage(GetHwnd(), CB_INSERTSTRING, pos, (LPARAM)item.c_str());
 248     if ( n == CB_ERR )
 249     {
 250         wxLogLastError(wxT("SendMessage(CB_INSERTSTRING)"));
 251     }
 252     else // ok
 253     {
 254         if ( !IsFrozen() )
 255             UpdateVisibleHeight();
 256     }
 257
 258     return n;
 259 }
 260
 261 void wxChoice::Delete(int n)
 262 {
 263     wxCHECK_RET( n < GetCount(), wxT("invalid item index in wxChoice::Delete") );
 264
 265     if ( HasClientObjectData() )
 266     {
 267         delete GetClientObject(n);
 268     }
 269
 270     SendMessage(GetHwnd(), CB_DELETESTRING, n, 0);
 271
 272     if ( !IsFrozen() )
 273         UpdateVisibleHeight();
 274 }
 275
 276 void wxChoice::Clear()
 277 {
 278     Free();
 279
 280     SendMessage(GetHwnd(), CB_RESETCONTENT, 0, 0);
 281
 282     if ( !IsFrozen() )
 283         UpdateVisibleHeight();
 284 }
 285
 286 void wxChoice::Free()
 287 {
 288     if ( HasClientObjectData() )
 289     {
 290         size_t count = GetCount();
 291         for ( size_t n = 0; n < count; n++ )
 292         {
 293             delete GetClientObject(n);
 294         }
 295     }
 296 }
 297
 298 // ----------------------------------------------------------------------------
 299 // selection
 300 // ----------------------------------------------------------------------------
 301
 302 int wxChoice::GetSelection() const
 303 {
 304     return (int)SendMessage(GetHwnd(), CB_GETCURSEL, 0, 0);
 305 }
 306
 307 void wxChoice::SetSelection(int n)
 308 {
 309     SendMessage(GetHwnd(), CB_SETCURSEL, n, 0);
 310 }
 311
 312 // ----------------------------------------------------------------------------
 313 // string list functions
 314 // ----------------------------------------------------------------------------
 315
 316 int wxChoice::GetCount() const
 317 {
 318     return (int)SendMessage(GetHwnd(), CB_GETCOUNT, 0, 0);
 319 }
 320
 321 int wxChoice::FindString(const wxString& s) const
 322 {
 323 #if defined(__WATCOMC__) && defined(__WIN386__)
 324     // For some reason, Watcom in WIN386 mode crashes in the CB_FINDSTRINGEXACT message.
 325     // wxChoice::Do it the long way instead.
 326     int count = GetCount();
 327     for ( int i = 0; i < count; i++ )
 328     {
 329         // as CB_FINDSTRINGEXACT is case insensitive, be case insensitive too
 330         if ( GetString(i).IsSameAs(s, false) )
 331             return i;
 332     }
 333
 334     return wxNOT_FOUND;
 335 #else // !Watcom
 336    //TODO:  Evidently some MSW versions (all?) don't like empty strings
 337    //passed to SendMessage, so we have to do it ourselves in that case
 338    if ( s.empty() )
 339    {
 340      int count = GetCount();
 341      for ( int i = 0; i < count; i++ )
 342      {
 343        if ( GetString(i).empty() )
 344            return i;
 345      }
 346
 347      return wxNOT_FOUND;
 348    }
 349    else
 350    {
 351      int pos = (int)SendMessage(GetHwnd(), CB_FINDSTRINGEXACT,
 352                                 (WPARAM)-1, (LPARAM)s.c_str());
 353
 354      return pos == LB_ERR ? wxNOT_FOUND : pos;
 355    }
 356 #endif // Watcom/!Watcom
 357 }
 358
 359 void wxChoice::SetString(int n, const wxString& s)
 360 {
 361     wxCHECK_RET( n >= 0 && n < GetCount(),
 362                  wxT("invalid item index in wxChoice::SetString") );
 363
 364     // we have to delete and add back the string as there is no way to change a
 365     // string in place
 366
 367     // we need to preserve the client data
 368     void *data;
 369     if ( m_clientDataItemsType != wxClientData_None )
 370     {
 371         data = DoGetItemClientData(n);
 372     }
 373     else // no client data
 374     {
 375         data = NULL;
 376     }
 377
 378     ::SendMessage(GetHwnd(), CB_DELETESTRING, n, 0);
 379     ::SendMessage(GetHwnd(), CB_INSERTSTRING, n, (LPARAM)s.c_str() );
 380
 381     if ( data )
 382     {
 383         DoSetItemClientData(n, data);
 384     }
 385     //else: it's already NULL by default
 386 }
 387
 388 wxString wxChoice::GetString(int n) const
 389 {
 390     int len = (int)::SendMessage(GetHwnd(), CB_GETLBTEXTLEN, n, 0);
 391
 392     wxString str;
 393     if ( len != CB_ERR && len > 0 )
 394     {
 395         if ( ::SendMessage
 396                (
 397                 GetHwnd(),
 398                 CB_GETLBTEXT,
 399                 n,
 400                 (LPARAM)(wxChar *)wxStringBuffer(str, len)
 401                ) == CB_ERR )
 402         {
 403             wxLogLastError(wxT("SendMessage(CB_GETLBTEXT)"));
 404         }
 405     }
 406
 407     return str;
 408 }
 409
 410 // ----------------------------------------------------------------------------
 411 // client data
 412 // ----------------------------------------------------------------------------
 413
 414 void wxChoice::DoSetItemClientData( int n, void* clientData )
 415 {
 416     if ( ::SendMessage(GetHwnd(), CB_SETITEMDATA,
 417                        n, (LPARAM)clientData) == CB_ERR )
 418     {
 419         wxLogLastError(wxT("CB_SETITEMDATA"));
 420     }
 421 }
 422
 423 void* wxChoice::DoGetItemClientData( int n ) const
 424 {
 425     LPARAM rc = SendMessage(GetHwnd(), CB_GETITEMDATA, n, 0);
 426     if ( rc == CB_ERR )
 427     {
 428         wxLogLastError(wxT("CB_GETITEMDATA"));
 429
 430         // unfortunately, there is no way to return an error code to the user
 431         rc = (LPARAM) NULL;
 432     }
 433
 434     return (void *)rc;
 435 }
 436
 437 void wxChoice::DoSetItemClientObject( int n, wxClientData* clientData )
 438 {
 439     DoSetItemClientData(n, clientData);
 440 }
 441
 442 wxClientData* wxChoice::DoGetItemClientObject( int n ) const
 443 {
 444     return (wxClientData *)DoGetItemClientData(n);
 445 }
 446
 447 // ----------------------------------------------------------------------------
 448 // wxMSW specific helpers
 449 // ----------------------------------------------------------------------------
 450
 451 void wxChoice::UpdateVisibleHeight()
 452 {
 453     // be careful to not change the width here
 454     DoSetSize(wxDefaultCoord, wxDefaultCoord, wxDefaultCoord, GetSize().y, wxSIZE_USE_EXISTING);
 455 }
 456
 457 void wxChoice::DoMoveWindow(int x, int y, int width, int height)
 458 {
 459     // here is why this is necessary: if the width is negative, the combobox
 460     // window proc makes the window of the size width*height instead of
 461     // interpreting height in the usual manner (meaning the height of the drop
 462     // down list - usually the height specified in the call to MoveWindow()
 463     // will not change the height of combo box per se)
 464     //
 465     // this behaviour is not documented anywhere, but this is just how it is
 466     // here (NT 4.4) and, anyhow, the check shouldn't hurt - however without
 467     // the check, constraints/sizers using combos may break the height
 468     // constraint will have not at all the same value as expected
 469     if ( width < 0 )
 470         return;
 471
 472     wxControl::DoMoveWindow(x, y, width, height);
 473 }
 474
 475 void wxChoice::DoGetSize(int *w, int *h) const
 476 {
 477     // this is weird: sometimes, the height returned by Windows is clearly the
 478     // total height of the control including the drop down list -- but only
 479     // sometimes, and normally it isn't... I have no idea about what to do with
 480     // this
 481     wxControl::DoGetSize(w, h);
 482 }
 483
 484 void wxChoice::DoSetSize(int x, int y,
 485                          int width, int height,
 486                          int sizeFlags)
 487 {
 488     int heightOrig = height;
 489
 490     // the height which we must pass to Windows should be the total height of
 491     // the control including the drop down list while the height given to us
 492     // is, of course, just the height of the permanently visible part of it
 493     if ( height != wxDefaultCoord )
 494     {
 495         // don't make the drop down list too tall, arbitrarily limit it to 40
 496         // items max and also don't leave it empty
 497         size_t nItems = GetCount();
 498         if ( !nItems )
 499             nItems = 9;
 500         else if ( nItems > 24 )
 501             nItems = 24;
 502
 503         // add space for the drop down list
 504         const int hItem = SendMessage(GetHwnd(), CB_GETITEMHEIGHT, 0, 0);
 505         height += hItem*(nItems + 1);
 506     }
 507     else
 508     {
 509         // We cannot pass wxDefaultCoord as height to wxControl. wxControl uses
 510         // wxGetWindowRect() to determine the current height of the combobox,
 511         // and then again sets the combobox's height to that value. Unfortunately,
 512         // wxGetWindowRect doesn't include the dropdown list's height (at least
 513         // on Win2K), so this would result in a combobox with dropdown height of
 514         // 1 pixel. We have to determine the default height ourselves and call
 515         // wxControl with that value instead.
 516         int w, h;
 517         RECT r;
 518         DoGetSize(&w, &h);
 519         if (::SendMessage(GetHwnd(), CB_GETDROPPEDCONTROLRECT, 0, (LPARAM) &r) != 0)
 520         {
 521             height = h + r.bottom - r.top;
 522         }
 523     }
 524
 525     wxControl::DoSetSize(x, y, width, height, sizeFlags);
 526
 527     // I'm commenting this out since the code appears to make choices
 528     // and comboxes too high when they have associated sizers. I'm sure this
 529     // is not the end of the story, which is why I'm leaving it #if'ed out for
 530     // now. JACS.
 531 #if 0
 532     // if the height specified for the visible part of the control is
 533     // different from the current one, we need to change it separately
 534     // as it is not affected by normal WM_SETSIZE
 535     if ( height != wxDefaultCoord )
 536     {
 537         const int delta = heightOrig - GetSize().y;
 538         if ( delta )
 539         {
 540             int h = ::SendMessage(GetHwnd(), CB_GETITEMHEIGHT, (WPARAM)-1, 0);
 541             SendMessage(GetHwnd(), CB_SETITEMHEIGHT, (WPARAM)-1, h + delta);
 542         }
 543     }
 544 #else
 545     wxUnusedVar(heightOrig);
 546 #endif
 547 }
 548
 549 wxSize wxChoice::DoGetBestSize() const
 550 {
 551     // find the widest string
 552     int wChoice = 0;
 553     const size_t nItems = GetCount();
 554     for ( size_t i = 0; i < nItems; i++ )
 555     {
 556         int wLine;
 557         GetTextExtent(GetString(i), &wLine, NULL);
 558         if ( wLine > wChoice )
 559             wChoice = wLine;
 560     }
 561
 562     // give it some reasonable default value if there are no strings in the
 563     // list
 564     if ( wChoice == 0 )
 565         wChoice = 100;
 566
 567     // the combobox should be slightly larger than the widest string
 568     wChoice += 5*GetCharWidth();
 569
 570     return wxSize(wChoice, EDIT_HEIGHT_FROM_CHAR_HEIGHT(GetCharHeight()));
 571 }
 572
 573 WXLRESULT wxChoice::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 574 {
 575     switch ( nMsg )
 576     {
 577         case WM_LBUTTONUP:
 578             {
 579                 int x = (int)LOWORD(lParam);
 580                 int y = (int)HIWORD(lParam);
 581
 582                 // Ok, this is truly weird, but if a panel with a wxChoice
 583                 // loses the focus, then you get a *fake* WM_LBUTTONUP message
 584                 // with x = 65535 and y = 65535. Filter out this nonsense.
 585                 //
 586                 // VZ: I'd like to know how to reproduce this please...
 587                 if ( x == 65535 && y == 65535 )
 588                     return 0;
 589             }
 590             break;
 591
 592             // we have to handle both: one for the normal case and the other
 593             // for readonly
 594         case WM_CTLCOLOREDIT:
 595         case WM_CTLCOLORLISTBOX:
 596         case WM_CTLCOLORSTATIC:
 597             {
 598                 WXHDC hdc;
 599                 WXHWND hwnd;
 600                 UnpackCtlColor(wParam, lParam, &hdc, &hwnd);
 601
 602                 WXHBRUSH hbr = MSWControlColor((WXHDC)hdc);
 603                 if ( hbr )
 604                     return (WXLRESULT)hbr;
 605                 //else: fall through to default window proc
 606             }
 607     }
 608
 609     return wxWindow::MSWWindowProc(nMsg, wParam, lParam);
 610 }
 611
 612 bool wxChoice::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
 613 {
 614     if ( param != CBN_SELCHANGE)
 615     {
 616         // "selection changed" is the only event we're after
 617         return false;
 618     }
 619
 620     int n = GetSelection();
 621     if (n > -1)
 622     {
 623         wxCommandEvent event(wxEVT_COMMAND_CHOICE_SELECTED, m_windowId);
 624         event.SetInt(n);
 625         event.SetEventObject(this);
 626         event.SetString(GetStringSelection());
 627         if ( HasClientObjectData() )
 628             event.SetClientObject( GetClientObject(n) );
 629         else if ( HasClientUntypedData() )
 630             event.SetClientData( GetClientData(n) );
 631         ProcessCommand(event);
 632     }
 633
 634     return true;
 635 }
 636
 637 WXHBRUSH wxChoice::MSWControlColor(WXHDC hDC)
 638 {
 639     if ( !IsEnabled() )
 640         return MSWControlColorDisabled(hDC);
 641
 642     return wxChoiceBase::MSWControlColorSolid(hDC);
 643 }
 644
 645 #endif // wxUSE_CHOICE && !(__SMARTPHONE__ && __WXWINCE__)
 646