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