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(wxNO_BORDER)
  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(wxNO_FULL_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 /* | WS_CLIPSIBLINGS */;
 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 wxChoice::~wxChoice()
 155 {
 156     Free();
 157 }
 158
 159 // ----------------------------------------------------------------------------
 160 // adding/deleting items to/from the list
 161 // ----------------------------------------------------------------------------
 162
 163 int wxChoice::DoAppend(const wxString& item)
 164 {
 165     int n = (int)SendMessage(GetHwnd(), CB_ADDSTRING, 0, (LONG)item.c_str());
 166     if ( n == CB_ERR )
 167     {
 168         wxLogLastError(wxT("SendMessage(CB_ADDSTRING)"));
 169     }
 170
 171     return n;
 172 }
 173
 174 int wxChoice::DoInsert(const wxString& item, int pos)
 175 {
 176     wxCHECK_MSG(!(GetWindowStyle() & wxCB_SORT), -1, wxT("can't insert into sorted list"));
 177     wxCHECK_MSG((pos>=0) && (pos<=GetCount()), -1, wxT("invalid index"));
 178
 179     int n = (int)SendMessage(GetHwnd(), CB_INSERTSTRING, pos, (LONG)item.c_str());
 180     if ( n == CB_ERR )
 181     {
 182         wxLogLastError(wxT("SendMessage(CB_INSERTSTRING)"));
 183     }
 184
 185     return n;
 186 }
 187
 188 void wxChoice::Delete(int n)
 189 {
 190     wxCHECK_RET( n < GetCount(), wxT("invalid item index in wxChoice::Delete") );
 191
 192     if ( HasClientObjectData() )
 193     {
 194         delete GetClientObject(n);
 195     }
 196
 197     SendMessage(GetHwnd(), CB_DELETESTRING, n, 0);
 198 }
 199
 200 void wxChoice::Clear()
 201 {
 202     Free();
 203
 204     SendMessage(GetHwnd(), CB_RESETCONTENT, 0, 0);
 205 }
 206
 207 void wxChoice::Free()
 208 {
 209     if ( HasClientObjectData() )
 210     {
 211         size_t count = GetCount();
 212         for ( size_t n = 0; n < count; n++ )
 213         {
 214             delete GetClientObject(n);
 215         }
 216     }
 217 }
 218
 219 // ----------------------------------------------------------------------------
 220 // selection
 221 // ----------------------------------------------------------------------------
 222
 223 int wxChoice::GetSelection() const
 224 {
 225     return (int)SendMessage(GetHwnd(), CB_GETCURSEL, 0, 0);
 226 }
 227
 228 void wxChoice::SetSelection(int n)
 229 {
 230     SendMessage(GetHwnd(), CB_SETCURSEL, n, 0);
 231 }
 232
 233 // ----------------------------------------------------------------------------
 234 // string list functions
 235 // ----------------------------------------------------------------------------
 236
 237 int wxChoice::GetCount() const
 238 {
 239     return (int)SendMessage(GetHwnd(), CB_GETCOUNT, 0, 0);
 240 }
 241
 242 int wxChoice::FindString(const wxString& s) const
 243 {
 244 #if defined(__WATCOMC__) && defined(__WIN386__)
 245     // For some reason, Watcom in WIN386 mode crashes in the CB_FINDSTRINGEXACT message.
 246     // wxChoice::Do it the long way instead.
 247     int count = GetCount();
 248     for ( int i = 0; i < count; i++ )
 249     {
 250         // as CB_FINDSTRINGEXACT is case insensitive, be case insensitive too
 251         if ( GetString(i).IsSameAs(s, FALSE) )
 252             return i;
 253     }
 254
 255     return wxNOT_FOUND;
 256 #else // !Watcom
 257     int pos = (int)SendMessage(GetHwnd(), CB_FINDSTRINGEXACT,
 258                                (WPARAM)-1, (LPARAM)s.c_str());
 259
 260     return pos == LB_ERR ? wxNOT_FOUND : pos;
 261 #endif // Watcom/!Watcom
 262 }
 263
 264 void wxChoice::SetString(int n, const wxString& s)
 265 {
 266     wxCHECK_RET( n >= 0 && n < GetCount(),
 267                  wxT("invalid item index in wxChoice::SetString") );
 268
 269     // we have to delete and add back the string as there is no way to change a
 270     // string in place
 271
 272     // we need to preserve the client data
 273     void *data;
 274     if ( m_clientDataItemsType != wxClientData_None )
 275     {
 276         data = DoGetItemClientData(n);
 277     }
 278     else // no client data
 279     {
 280         data = NULL;
 281     }
 282
 283     ::SendMessage(GetHwnd(), CB_DELETESTRING, n, 0);
 284     ::SendMessage(GetHwnd(), CB_INSERTSTRING, n, (LPARAM)s.c_str() );
 285
 286     if ( data )
 287     {
 288         DoSetItemClientData(n, data);
 289     }
 290     //else: it's already NULL by default
 291 }
 292
 293 wxString wxChoice::GetString(int n) const
 294 {
 295     int len = (int)::SendMessage(GetHwnd(), CB_GETLBTEXTLEN, n, 0);
 296
 297     wxString str;
 298     if ( len != CB_ERR && len > 0 )
 299     {
 300         if ( ::SendMessage
 301                (
 302                 GetHwnd(),
 303                 CB_GETLBTEXT,
 304                 n,
 305                 (LPARAM)(wxChar *)wxStringBuffer(str, len)
 306                ) == CB_ERR )
 307         {
 308             wxLogLastError(wxT("SendMessage(CB_GETLBTEXT)"));
 309         }
 310     }
 311
 312     return str;
 313 }
 314
 315 // ----------------------------------------------------------------------------
 316 // client data
 317 // ----------------------------------------------------------------------------
 318
 319 void wxChoice::DoSetItemClientData( int n, void* clientData )
 320 {
 321     if ( ::SendMessage(GetHwnd(), CB_SETITEMDATA,
 322                        n, (LPARAM)clientData) == CB_ERR )
 323     {
 324         wxLogLastError(wxT("CB_SETITEMDATA"));
 325     }
 326 }
 327
 328 void* wxChoice::DoGetItemClientData( int n ) const
 329 {
 330     LPARAM rc = SendMessage(GetHwnd(), CB_GETITEMDATA, n, 0);
 331     if ( rc == CB_ERR )
 332     {
 333         wxLogLastError(wxT("CB_GETITEMDATA"));
 334
 335         // unfortunately, there is no way to return an error code to the user
 336         rc = (LPARAM) NULL;
 337     }
 338
 339     return (void *)rc;
 340 }
 341
 342 void wxChoice::DoSetItemClientObject( int n, wxClientData* clientData )
 343 {
 344     DoSetItemClientData(n, clientData);
 345 }
 346
 347 wxClientData* wxChoice::DoGetItemClientObject( int n ) const
 348 {
 349     return (wxClientData *)DoGetItemClientData(n);
 350 }
 351
 352 // ----------------------------------------------------------------------------
 353 // wxMSW specific helpers
 354 // ----------------------------------------------------------------------------
 355
 356 void wxChoice::DoMoveWindow(int x, int y, int width, int height)
 357 {
 358     // here is why this is necessary: if the width is negative, the combobox
 359     // window proc makes the window of the size width*height instead of
 360     // interpreting height in the usual manner (meaning the height of the drop
 361     // down list - usually the height specified in the call to MoveWindow()
 362     // will not change the height of combo box per se)
 363     //
 364     // this behaviour is not documented anywhere, but this is just how it is
 365     // here (NT 4.4) and, anyhow, the check shouldn't hurt - however without
 366     // the check, constraints/sizers using combos may break the height
 367     // constraint will have not at all the same value as expected
 368     if ( width < 0 )
 369         return;
 370
 371     wxControl::DoMoveWindow(x, y, width, height);
 372 }
 373
 374 void wxChoice::DoSetSize(int x, int y,
 375                          int width, int WXUNUSED(height),
 376                          int sizeFlags)
 377 {
 378     // Ignore height parameter because height doesn't mean 'initially
 379     // displayed' height, it refers to the drop-down menu as well. The
 380     // wxWindows interpretation is different; also, getting the size returns
 381     // the _displayed_ size (NOT the drop down menu size) so
 382     // setting-getting-setting size would not work.
 383
 384     wxControl::DoSetSize(x, y, width, -1, sizeFlags);
 385 }
 386
 387 wxSize wxChoice::DoGetBestSize() const
 388 {
 389     // find the widest string
 390     int wLine;
 391     int wChoice = 0;
 392     int nItems = GetCount();
 393     for ( int i = 0; i < nItems; i++ )
 394     {
 395         wxString str(GetString(i));
 396         GetTextExtent(str, &wLine, NULL);
 397         if ( wLine > wChoice )
 398             wChoice = wLine;
 399     }
 400
 401     // give it some reasonable default value if there are no strings in the
 402     // list
 403     if ( wChoice == 0 )
 404         wChoice = 100;
 405
 406     // the combobox should be larger than the widest string
 407     int cx, cy;
 408     wxGetCharSize(GetHWND(), &cx, &cy, &GetFont());
 409
 410     wChoice += 5*cx;
 411
 412     // Choice drop-down list depends on number of items (limited to 10)
 413     size_t nStrings = nItems == 0 ? 10 : wxMin(10, nItems) + 1;
 414     int hChoice = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy)*nStrings;
 415
 416     return wxSize(wChoice, hChoice);
 417 }
 418
 419 long wxChoice::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 420 {
 421     if ( nMsg == WM_LBUTTONUP )
 422     {
 423         int x = (int)LOWORD(lParam);
 424         int y = (int)HIWORD(lParam);
 425
 426         // Ok, this is truly weird, but if a panel with a wxChoice loses the
 427         // focus, then you get a *fake* WM_LBUTTONUP message with x = 65535 and
 428         // y = 65535. Filter out this nonsense.
 429         //
 430         // VZ: I'd like to know how to reproduce this please...
 431         if ( x == 65535 && y == 65535 )
 432             return 0;
 433     }
 434
 435     return wxWindow::MSWWindowProc(nMsg, wParam, lParam);
 436 }
 437
 438 bool wxChoice::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
 439 {
 440     if ( param != CBN_SELCHANGE)
 441     {
 442         // "selection changed" is the only event we're after
 443         return FALSE;
 444     }
 445
 446     int n = GetSelection();
 447     if (n > -1)
 448     {
 449         wxCommandEvent event(wxEVT_COMMAND_CHOICE_SELECTED, m_windowId);
 450         event.SetInt(n);
 451         event.SetEventObject(this);
 452         event.SetString(GetStringSelection());
 453         if ( HasClientObjectData() )
 454             event.SetClientObject( GetClientObject(n) );
 455         else if ( HasClientUntypedData() )
 456             event.SetClientData( GetClientData(n) );
 457         ProcessCommand(event);
 458     }
 459
 460     return TRUE;
 461 }
 462
 463 WXHBRUSH wxChoice::OnCtlColor(WXHDC pDC, WXHWND WXUNUSED(pWnd), WXUINT WXUNUSED(nCtlColor),
 464                                WXUINT WXUNUSED(message),
 465                                WXWPARAM WXUNUSED(wParam),
 466                                WXLPARAM WXUNUSED(lParam)
 467      )
 468 {
 469     HDC hdc = (HDC)pDC;
 470     wxColour colBack = GetBackgroundColour();
 471
 472     if (!IsEnabled())
 473         colBack = wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE);
 474
 475     ::SetBkColor(hdc, wxColourToRGB(colBack));
 476     ::SetTextColor(hdc, wxColourToRGB(GetForegroundColour()));
 477
 478     wxBrush *brush = wxTheBrushList->FindOrCreateBrush(colBack, wxSOLID);
 479
 480     return (WXHBRUSH)brush->GetResourceHandle();
 481 }
 482
 483 #endif // wxUSE_CHOICE