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