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