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 and Markus Holzem
   9 // Licence:     wxWindows license
  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 void wxChoice::Delete(int n)
 119 {
 120     wxCHECK_RET( n < GetCount(), wxT("invalid item index in wxChoice::Delete") );
 121
 122     if ( HasClientObjectData() )
 123     {
 124         delete GetClientObject(n);
 125     }
 126
 127     SendMessage(GetHwnd(), CB_DELETESTRING, n, 0);
 128 }
 129
 130 void wxChoice::Clear()
 131 {
 132     Free();
 133
 134     SendMessage(GetHwnd(), CB_RESETCONTENT, 0, 0);
 135 }
 136
 137 void wxChoice::Free()
 138 {
 139     if ( HasClientObjectData() )
 140     {
 141         size_t count = GetCount();
 142         for ( size_t n = 0; n < count; n++ )
 143         {
 144             delete GetClientObject(n);
 145         }
 146     }
 147 }
 148
 149 // ----------------------------------------------------------------------------
 150 // selection
 151 // ----------------------------------------------------------------------------
 152
 153 int wxChoice::GetSelection() const
 154 {
 155     return (int)SendMessage(GetHwnd(), CB_GETCURSEL, 0, 0);
 156 }
 157
 158 void wxChoice::SetSelection(int n)
 159 {
 160     SendMessage(GetHwnd(), CB_SETCURSEL, n, 0);
 161 }
 162
 163 // ----------------------------------------------------------------------------
 164 // string list functions
 165 // ----------------------------------------------------------------------------
 166
 167 int wxChoice::GetCount() const
 168 {
 169     return (int)SendMessage(GetHwnd(), CB_GETCOUNT, 0, 0);
 170 }
 171
 172 int wxChoice::FindString(const wxString& s) const
 173 {
 174 #if defined(__WATCOMC__) && defined(__WIN386__)
 175     // For some reason, Watcom in WIN386 mode crashes in the CB_FINDSTRINGEXACT message.
 176     // wxChoice::Do it the long way instead.
 177     int count = GetCount();
 178     for ( int i = 0; i < count; i++ )
 179     {
 180         // as CB_FINDSTRINGEXACT is case insensitive, be case insensitive too
 181         if ( GetString(i).IsSameAs(s, FALSE) )
 182             return i;
 183     }
 184
 185     return wxNOT_FOUND;
 186 #else // !Watcom
 187     int pos = (int)SendMessage(GetHwnd(), CB_FINDSTRINGEXACT,
 188                                (WPARAM)-1, (LPARAM)s.c_str());
 189
 190     return pos == LB_ERR ? wxNOT_FOUND : pos;
 191 #endif // Watcom/!Watcom
 192 }
 193
 194 void wxChoice::SetString(int n, const wxString& s)
 195 {
 196     wxCHECK_RET( (n>=0)&&(n<GetCount()), wxT("invalid item index in wxChoice::SetString") );
 197     SendMessage(GetHwnd(), CB_DELETESTRING, n, 0);
 198     SendMessage(GetHwnd(), CB_INSERTSTRING, n, (LONG)s.c_str() );
 199 }
 200
 201 wxString wxChoice::GetString(int n) const
 202 {
 203     size_t len = (size_t)::SendMessage(GetHwnd(), CB_GETLBTEXTLEN, n, 0);
 204     wxString str;
 205     if (len != CB_ERR && len > 0) {
 206         if ( ::SendMessage(GetHwnd(), CB_GETLBTEXT, n,
 207                            (LPARAM)str.GetWriteBuf(len)) == CB_ERR ) {
 208             wxLogLastError(wxT("SendMessage(CB_GETLBTEXT)"));
 209         }
 210         str.UngetWriteBuf();
 211     }
 212
 213     return str;
 214 }
 215
 216 // ----------------------------------------------------------------------------
 217 // client data
 218 // ----------------------------------------------------------------------------
 219
 220 void wxChoice::DoSetItemClientData( int n, void* clientData )
 221 {
 222     if ( SendMessage(GetHwnd(), CB_SETITEMDATA, n, (LPARAM)clientData) == CB_ERR )
 223     {
 224         wxLogLastError(wxT("CB_SETITEMDATA"));
 225     }
 226 }
 227
 228 void* wxChoice::DoGetItemClientData( int n ) const
 229 {
 230     LPARAM rc = SendMessage(GetHwnd(), CB_GETITEMDATA, n, 0);
 231     if ( rc == CB_ERR )
 232     {
 233         wxLogLastError(wxT("CB_GETITEMDATA"));
 234
 235         // unfortunately, there is no way to return an error code to the user
 236         rc = (LPARAM) NULL;
 237     }
 238
 239     return (void *)rc;
 240 }
 241
 242 void wxChoice::DoSetItemClientObject( int n, wxClientData* clientData )
 243 {
 244     DoSetItemClientData(n, clientData);
 245 }
 246
 247 wxClientData* wxChoice::DoGetItemClientObject( int n ) const
 248 {
 249     return (wxClientData *)DoGetItemClientData(n);
 250 }
 251
 252 // ----------------------------------------------------------------------------
 253 // wxMSW specific helpers
 254 // ----------------------------------------------------------------------------
 255
 256 void wxChoice::DoMoveWindow(int x, int y, int width, int height)
 257 {
 258     // here is why this is necessary: if the width is negative, the combobox
 259     // window proc makes the window of the size width*height instead of
 260     // interpreting height in the usual manner (meaning the height of the drop
 261     // down list - usually the height specified in the call to MoveWindow()
 262     // will not change the height of combo box per se)
 263     //
 264     // this behaviour is not documented anywhere, but this is just how it is
 265     // here (NT 4.4) and, anyhow, the check shouldn't hurt - however without
 266     // the check, constraints/sizers using combos may break the height
 267     // constraint will have not at all the same value as expected
 268     if ( width < 0 )
 269         return;
 270
 271     wxControl::DoMoveWindow(x, y, width, height);
 272 }
 273
 274 void wxChoice::DoSetSize(int x, int y,
 275                          int width, int WXUNUSED(height),
 276                          int sizeFlags)
 277 {
 278     // Ignore height parameter because height doesn't mean 'initially
 279     // displayed' height, it refers to the drop-down menu as well. The
 280     // wxWindows interpretation is different; also, getting the size returns
 281     // the _displayed_ size (NOT the drop down menu size) so
 282     // setting-getting-setting size would not work.
 283
 284     wxControl::DoSetSize(x, y, width, -1, sizeFlags);
 285 }
 286
 287 wxSize wxChoice::DoGetBestSize() const
 288 {
 289     // find the widest string
 290     int wLine;
 291     int wChoice = 0;
 292     int nItems = GetCount();
 293     for ( int i = 0; i < nItems; i++ )
 294     {
 295         wxString str(GetString(i));
 296         GetTextExtent(str, &wLine, NULL);
 297         if ( wLine > wChoice )
 298             wChoice = wLine;
 299     }
 300
 301     // give it some reasonable default value if there are no strings in the
 302     // list
 303     if ( wChoice == 0 )
 304         wChoice = 100;
 305
 306     // the combobox should be larger than the widest string
 307     int cx, cy;
 308     wxGetCharSize(GetHWND(), &cx, &cy, &GetFont());
 309
 310     wChoice += 5*cx;
 311
 312     // Choice drop-down list depends on number of items (limited to 10)
 313     size_t nStrings = nItems == 0 ? 10 : wxMin(10, nItems) + 1;
 314     int hChoice = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy)*nStrings;
 315
 316     return wxSize(wChoice, hChoice);
 317 }
 318
 319 long wxChoice::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 320 {
 321     if ( nMsg == WM_LBUTTONUP )
 322     {
 323         int x = (int)LOWORD(lParam);
 324         int y = (int)HIWORD(lParam);
 325
 326         // Ok, this is truly weird, but if a panel with a wxChoice loses the
 327         // focus, then you get a *fake* WM_LBUTTONUP message with x = 65535 and
 328         // y = 65535. Filter out this nonsense.
 329         //
 330         // VZ: I'd like to know how to reproduce this please...
 331         if ( x == 65535 && y == 65535 )
 332             return 0;
 333     }
 334
 335     return wxWindow::MSWWindowProc(nMsg, wParam, lParam);
 336 }
 337
 338 bool wxChoice::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
 339 {
 340     if ( param != CBN_SELCHANGE)
 341     {
 342         // "selection changed" is the only event we're after
 343         return FALSE;
 344     }
 345
 346     int n = GetSelection();
 347     if (n > -1)
 348     {
 349         wxCommandEvent event(wxEVT_COMMAND_CHOICE_SELECTED, m_windowId);
 350         event.SetInt(n);
 351         event.SetEventObject(this);
 352         event.SetString(GetStringSelection());
 353         if ( HasClientObjectData() )
 354             event.SetClientObject( GetClientObject(n) );
 355         else if ( HasClientUntypedData() )
 356             event.SetClientData( GetClientData(n) );
 357         ProcessCommand(event);
 358     }
 359
 360     return TRUE;
 361 }
 362
 363 WXHBRUSH wxChoice::OnCtlColor(WXHDC pDC, WXHWND WXUNUSED(pWnd), WXUINT WXUNUSED(nCtlColor),
 364 #if wxUSE_CTL3D
 365                                WXUINT message,
 366                                WXWPARAM wParam,
 367                                WXLPARAM lParam
 368 #else
 369                                WXUINT WXUNUSED(message),
 370                                WXWPARAM WXUNUSED(wParam),
 371                                WXLPARAM WXUNUSED(lParam)
 372 #endif
 373      )
 374 {
 375 #if wxUSE_CTL3D
 376     if ( m_useCtl3D )
 377     {
 378         HBRUSH hbrush = Ctl3dCtlColorEx(message, wParam, lParam);
 379         return (WXHBRUSH) hbrush;
 380     }
 381 #endif // wxUSE_CTL3D
 382
 383     HDC hdc = (HDC)pDC;
 384     if (GetParent()->GetTransparentBackground())
 385         SetBkMode(hdc, TRANSPARENT);
 386     else
 387         SetBkMode(hdc, OPAQUE);
 388
 389     wxColour colBack = GetBackgroundColour();
 390
 391     if (!IsEnabled())
 392         colBack = wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE);
 393
 394     ::SetBkColor(hdc, wxColourToRGB(colBack));
 395     ::SetTextColor(hdc, wxColourToRGB(GetForegroundColour()));
 396
 397     wxBrush *brush = wxTheBrushList->FindOrCreateBrush(colBack, wxSOLID);
 398
 399     return (WXHBRUSH)brush->GetResourceHandle();
 400 }
 401
 402 #endif // wxUSE_CHOICE