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