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