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