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& sizeOrig,
 134                              int n, const wxString choices[],
 135                              long style,
 136                              const wxValidator& validator,
 137                              const wxString& name)
 138 {
 139     // this is a bit hackish but we want to prevent MSWCreateControl() from
 140     // calling SetBestSize() (which it would do if any of the size components
 141     // is not given) because it wouldn't calculate it correctly if we have any
 142     // strings as they're not yet added to the control when it is called
 143     //
 144     // so: if we have any strings, we fudge the size parameter so that
 145     // SetBestSize() is not called by MSWCreateControl() but then we do call it
 146     // manually below
 147     bool autoSize = false;
 148     wxSize size = sizeOrig;
 149     if ( n )
 150     {
 151         if ( size.x < 0 )
 152         {
 153             size.x = 1;
 154             autoSize = true;
 155         }
 156         if ( size.y < 0 )
 157         {
 158             size.y = 1;
 159             autoSize = true;
 160         }
 161     }
 162
 163     // initialize wxControl
 164     if ( !CreateControl(parent, id, pos, size, style, validator, name) )
 165         return FALSE;
 166
 167     // now create the real HWND
 168     if ( !MSWCreateControl(wxT("COMBOBOX"), _T(""), pos, size) )
 169         return FALSE;
 170
 171
 172     // choice/combobox normally has "white" (depends on colour scheme, of
 173     // course) background rather than inheriting the parent's background
 174     SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
 175
 176     // initialize the controls contents
 177     for ( int i = 0; i < n; i++ )
 178     {
 179         Append(choices[i]);
 180     }
 181
 182     // and now we may finally size the control properly (if needed)
 183     if ( autoSize )
 184     {
 185         // we do the same thing as SetBestSize() but we need sizeBest here
 186         wxSize sizeBest = DoGetBestSize();
 187         if ( size.x != -1 )
 188             sizeBest.x = sizeOrig.x;
 189         if ( size.y != -1 )
 190             sizeBest.y = sizeOrig.y;
 191
 192         SetSize(sizeBest);
 193
 194         // this is our true initial size, not the (1, 1) we had during
 195         // CreateControl() call above: this is especially important if we're
 196         // added to a sizer as we don't want to be shrunk to nothing by it
 197         m_initialSize = sizeBest;
 198     }
 199
 200     return TRUE;
 201 }
 202
 203 bool wxChoice::Create(wxWindow *parent,
 204                       wxWindowID id,
 205                       const wxPoint& pos,
 206                       const wxSize& size,
 207                       const wxArrayString& choices,
 208                       long style,
 209                       const wxValidator& validator,
 210                       const wxString& name)
 211 {
 212     wxCArrayString chs(choices);
 213     return Create(parent, id, pos, size, chs.GetCount(), chs.GetStrings(),
 214                   style, validator, name);
 215 }
 216
 217 WXDWORD wxChoice::MSWGetStyle(long style, WXDWORD *exstyle) const
 218 {
 219     // we never have an external border
 220     WXDWORD msStyle = wxControl::MSWGetStyle
 221                       (
 222                         (style & ~wxBORDER_MASK) | wxBORDER_NONE, exstyle
 223                       );
 224
 225     // WS_CLIPSIBLINGS is useful with wxChoice and doesn't seem to result in
 226     // any problems
 227     msStyle |= WS_CLIPSIBLINGS;
 228
 229     // wxChoice-specific styles
 230     msStyle |= CBS_DROPDOWNLIST | WS_HSCROLL | WS_VSCROLL;
 231     if ( style & wxCB_SORT )
 232         msStyle |= CBS_SORT;
 233
 234     return msStyle;
 235 }
 236
 237 wxChoice::~wxChoice()
 238 {
 239     Free();
 240 }
 241
 242 // ----------------------------------------------------------------------------
 243 // adding/deleting items to/from the list
 244 // ----------------------------------------------------------------------------
 245
 246 int wxChoice::DoAppend(const wxString& item)
 247 {
 248     int n = (int)SendMessage(GetHwnd(), CB_ADDSTRING, 0, (LPARAM)item.c_str());
 249     if ( n == CB_ERR )
 250     {
 251         wxLogLastError(wxT("SendMessage(CB_ADDSTRING)"));
 252     }
 253     else // ok
 254     {
 255         // we need to refresh our size in order to have enough space for the
 256         // newly added items
 257         UpdateVisibleHeight();
 258     }
 259
 260     return n;
 261 }
 262
 263 int wxChoice::DoInsert(const wxString& item, int pos)
 264 {
 265     wxCHECK_MSG(!(GetWindowStyle() & wxCB_SORT), -1, wxT("can't insert into sorted list"));
 266     wxCHECK_MSG((pos>=0) && (pos<=GetCount()), -1, wxT("invalid index"));
 267
 268     int n = (int)SendMessage(GetHwnd(), CB_INSERTSTRING, pos, (LPARAM)item.c_str());
 269     if ( n == CB_ERR )
 270     {
 271         wxLogLastError(wxT("SendMessage(CB_INSERTSTRING)"));
 272     }
 273     else // ok
 274     {
 275         UpdateVisibleHeight();
 276     }
 277
 278     return n;
 279 }
 280
 281 void wxChoice::Delete(int n)
 282 {
 283     wxCHECK_RET( n < GetCount(), wxT("invalid item index in wxChoice::Delete") );
 284
 285     if ( HasClientObjectData() )
 286     {
 287         delete GetClientObject(n);
 288     }
 289
 290     SendMessage(GetHwnd(), CB_DELETESTRING, n, 0);
 291
 292     UpdateVisibleHeight();
 293 }
 294
 295 void wxChoice::Clear()
 296 {
 297     Free();
 298
 299     SendMessage(GetHwnd(), CB_RESETCONTENT, 0, 0);
 300
 301     UpdateVisibleHeight();
 302 }
 303
 304 void wxChoice::Free()
 305 {
 306     if ( HasClientObjectData() )
 307     {
 308         size_t count = GetCount();
 309         for ( size_t n = 0; n < count; n++ )
 310         {
 311             delete GetClientObject(n);
 312         }
 313     }
 314 }
 315
 316 // ----------------------------------------------------------------------------
 317 // selection
 318 // ----------------------------------------------------------------------------
 319
 320 int wxChoice::GetSelection() const
 321 {
 322     return (int)SendMessage(GetHwnd(), CB_GETCURSEL, 0, 0);
 323 }
 324
 325 void wxChoice::SetSelection(int n)
 326 {
 327     SendMessage(GetHwnd(), CB_SETCURSEL, n, 0);
 328 }
 329
 330 // ----------------------------------------------------------------------------
 331 // string list functions
 332 // ----------------------------------------------------------------------------
 333
 334 int wxChoice::GetCount() const
 335 {
 336     return (int)SendMessage(GetHwnd(), CB_GETCOUNT, 0, 0);
 337 }
 338
 339 int wxChoice::FindString(const wxString& s) const
 340 {
 341 #if defined(__WATCOMC__) && defined(__WIN386__)
 342     // For some reason, Watcom in WIN386 mode crashes in the CB_FINDSTRINGEXACT message.
 343     // wxChoice::Do it the long way instead.
 344     int count = GetCount();
 345     for ( int i = 0; i < count; i++ )
 346     {
 347         // as CB_FINDSTRINGEXACT is case insensitive, be case insensitive too
 348         if ( GetString(i).IsSameAs(s, FALSE) )
 349             return i;
 350     }
 351
 352     return wxNOT_FOUND;
 353 #else // !Watcom
 354     int pos = (int)SendMessage(GetHwnd(), CB_FINDSTRINGEXACT,
 355                                (WPARAM)-1, (LPARAM)s.c_str());
 356
 357     return pos == LB_ERR ? wxNOT_FOUND : pos;
 358 #endif // Watcom/!Watcom
 359 }
 360
 361 void wxChoice::SetString(int n, const wxString& s)
 362 {
 363     wxCHECK_RET( n >= 0 && n < GetCount(),
 364                  wxT("invalid item index in wxChoice::SetString") );
 365
 366     // we have to delete and add back the string as there is no way to change a
 367     // string in place
 368
 369     // we need to preserve the client data
 370     void *data;
 371     if ( m_clientDataItemsType != wxClientData_None )
 372     {
 373         data = DoGetItemClientData(n);
 374     }
 375     else // no client data
 376     {
 377         data = NULL;
 378     }
 379
 380     ::SendMessage(GetHwnd(), CB_DELETESTRING, n, 0);
 381     ::SendMessage(GetHwnd(), CB_INSERTSTRING, n, (LPARAM)s.c_str() );
 382
 383     if ( data )
 384     {
 385         DoSetItemClientData(n, data);
 386     }
 387     //else: it's already NULL by default
 388 }
 389
 390 wxString wxChoice::GetString(int n) const
 391 {
 392     int len = (int)::SendMessage(GetHwnd(), CB_GETLBTEXTLEN, n, 0);
 393
 394     wxString str;
 395     if ( len != CB_ERR && len > 0 )
 396     {
 397         if ( ::SendMessage
 398                (
 399                 GetHwnd(),
 400                 CB_GETLBTEXT,
 401                 n,
 402                 (LPARAM)(wxChar *)wxStringBuffer(str, len)
 403                ) == CB_ERR )
 404         {
 405             wxLogLastError(wxT("SendMessage(CB_GETLBTEXT)"));
 406         }
 407     }
 408
 409     return str;
 410 }
 411
 412 // ----------------------------------------------------------------------------
 413 // client data
 414 // ----------------------------------------------------------------------------
 415
 416 void wxChoice::DoSetItemClientData( int n, void* clientData )
 417 {
 418     if ( ::SendMessage(GetHwnd(), CB_SETITEMDATA,
 419                        n, (LPARAM)clientData) == CB_ERR )
 420     {
 421         wxLogLastError(wxT("CB_SETITEMDATA"));
 422     }
 423 }
 424
 425 void* wxChoice::DoGetItemClientData( int n ) const
 426 {
 427     LPARAM rc = SendMessage(GetHwnd(), CB_GETITEMDATA, n, 0);
 428     if ( rc == CB_ERR )
 429     {
 430         wxLogLastError(wxT("CB_GETITEMDATA"));
 431
 432         // unfortunately, there is no way to return an error code to the user
 433         rc = (LPARAM) NULL;
 434     }
 435
 436     return (void *)rc;
 437 }
 438
 439 void wxChoice::DoSetItemClientObject( int n, wxClientData* clientData )
 440 {
 441     DoSetItemClientData(n, clientData);
 442 }
 443
 444 wxClientData* wxChoice::DoGetItemClientObject( int n ) const
 445 {
 446     return (wxClientData *)DoGetItemClientData(n);
 447 }
 448
 449 // ----------------------------------------------------------------------------
 450 // wxMSW specific helpers
 451 // ----------------------------------------------------------------------------
 452
 453 void wxChoice::UpdateVisibleHeight()
 454 {
 455     // be careful to not change the width here
 456     DoSetSize(-1, -1, -1, GetSize().y, wxSIZE_USE_EXISTING);
 457 }
 458
 459 void wxChoice::DoMoveWindow(int x, int y, int width, int height)
 460 {
 461     // here is why this is necessary: if the width is negative, the combobox
 462     // window proc makes the window of the size width*height instead of
 463     // interpreting height in the usual manner (meaning the height of the drop
 464     // down list - usually the height specified in the call to MoveWindow()
 465     // will not change the height of combo box per se)
 466     //
 467     // this behaviour is not documented anywhere, but this is just how it is
 468     // here (NT 4.4) and, anyhow, the check shouldn't hurt - however without
 469     // the check, constraints/sizers using combos may break the height
 470     // constraint will have not at all the same value as expected
 471     if ( width < 0 )
 472         return;
 473
 474     wxControl::DoMoveWindow(x, y, width, height);
 475 }
 476
 477 void wxChoice::DoGetSize(int *w, int *h) const
 478 {
 479     // this is weird: sometimes, the height returned by Windows is clearly the
 480     // total height of the control including the drop down list -- but only
 481     // sometimes, and normally it isn't... I have no idea about what to do with
 482     // this
 483     wxControl::DoGetSize(w, h);
 484 }
 485
 486 void wxChoice::DoSetSize(int x, int y,
 487                          int width, int height,
 488                          int sizeFlags)
 489 {
 490     int heightOrig = height;
 491
 492     // the height which we must pass to Windows should be the total height of
 493     // the control including the drop down list while the height given to us
 494     // is, of course, just the height of the permanently visible part of it
 495     if ( height != -1 )
 496     {
 497         // don't make the drop down list too tall, arbitrarily limit it to 40
 498         // items max and also don't leave it empty
 499         size_t nItems = GetCount();
 500         if ( !nItems )
 501             nItems = 9;
 502         else if ( nItems > 39 )
 503             nItems = 39;
 504
 505         // add space for the drop down list
 506         const int hItem = SendMessage(GetHwnd(), CB_GETITEMHEIGHT, 0, 0);
 507         height += hItem*(nItems + 1);
 508     }
 509
 510     wxControl::DoSetSize(x, y, width, height, sizeFlags);
 511
 512     // if the height specified for the visible part of the control is
 513     // different from the current one, we need to change it separately
 514     // as it is not affected by normal WM_SETSIZE
 515     if ( height != -1 )
 516     {
 517         const int delta = heightOrig - GetSize().y;
 518         if ( delta )
 519         {
 520             int h = ::SendMessage(GetHwnd(), CB_GETITEMHEIGHT, (WPARAM)-1, 0);
 521             SendMessage(GetHwnd(), CB_SETITEMHEIGHT, (WPARAM)-1, h + delta);
 522         }
 523     }
 524 }
 525
 526 wxSize wxChoice::DoGetBestSize() const
 527 {
 528     // find the widest string
 529     int wChoice = 0;
 530     const size_t nItems = GetCount();
 531     for ( size_t i = 0; i < nItems; i++ )
 532     {
 533         int wLine;
 534         GetTextExtent(GetString(i), &wLine, NULL);
 535         if ( wLine > wChoice )
 536             wChoice = wLine;
 537     }
 538
 539     // give it some reasonable default value if there are no strings in the
 540     // list
 541     if ( wChoice == 0 )
 542         wChoice = 100;
 543
 544     // the combobox should be slightly larger than the widest string
 545     wChoice += 5*GetCharWidth();
 546
 547     return wxSize(wChoice, EDIT_HEIGHT_FROM_CHAR_HEIGHT(GetCharHeight()));
 548 }
 549
 550 WXLRESULT wxChoice::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 551 {
 552     if ( nMsg == WM_LBUTTONUP )
 553     {
 554         int x = (int)LOWORD(lParam);
 555         int y = (int)HIWORD(lParam);
 556
 557         // Ok, this is truly weird, but if a panel with a wxChoice loses the
 558         // focus, then you get a *fake* WM_LBUTTONUP message with x = 65535 and
 559         // y = 65535. Filter out this nonsense.
 560         //
 561         // VZ: I'd like to know how to reproduce this please...
 562         if ( x == 65535 && y == 65535 )
 563             return 0;
 564     }
 565
 566     return wxWindow::MSWWindowProc(nMsg, wParam, lParam);
 567 }
 568
 569 bool wxChoice::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
 570 {
 571     if ( param != CBN_SELCHANGE)
 572     {
 573         // "selection changed" is the only event we're after
 574         return FALSE;
 575     }
 576
 577     int n = GetSelection();
 578     if (n > -1)
 579     {
 580         wxCommandEvent event(wxEVT_COMMAND_CHOICE_SELECTED, m_windowId);
 581         event.SetInt(n);
 582         event.SetEventObject(this);
 583         event.SetString(GetStringSelection());
 584         if ( HasClientObjectData() )
 585             event.SetClientObject( GetClientObject(n) );
 586         else if ( HasClientUntypedData() )
 587             event.SetClientData( GetClientData(n) );
 588         ProcessCommand(event);
 589     }
 590
 591     return TRUE;
 592 }
 593
 594 WXHBRUSH wxChoice::OnCtlColor(WXHDC pDC, WXHWND WXUNUSED(pWnd), WXUINT WXUNUSED(nCtlColor),
 595                                WXUINT WXUNUSED(message),
 596                                WXWPARAM WXUNUSED(wParam),
 597                                WXLPARAM WXUNUSED(lParam)
 598      )
 599 {
 600     HDC hdc = (HDC)pDC;
 601     wxColour colBack = GetBackgroundColour();
 602
 603     if (!IsEnabled())
 604         colBack = wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE);
 605
 606     ::SetBkColor(hdc, wxColourToRGB(colBack));
 607     ::SetTextColor(hdc, wxColourToRGB(GetForegroundColour()));
 608
 609     wxBrush *brush = wxTheBrushList->FindOrCreateBrush(colBack, wxSOLID);
 610
 611     return (WXHBRUSH)brush->GetResourceHandle();
 612 }
 613
 614 #endif // wxUSE_CHOICE