src/msw/combobox.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        msw/combobox.cpp
   3 // Purpose:     wxComboBox class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart and Markus Holzem
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #ifdef __GNUG__
  21 #pragma implementation "combobox.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_COMBOBOX
  32
  33 #ifndef WX_PRECOMP
  34     #include "wx/settings.h"
  35     #include "wx/log.h"
  36 #endif
  37
  38 #include "wx/combobox.h"
  39 #include "wx/brush.h"
  40 #include "wx/clipbrd.h"
  41 #include "wx/msw/private.h"
  42
  43 #if wxUSE_TOOLTIPS
  44     #ifndef __GNUWIN32_OLD__
  45         #include <commctrl.h>
  46     #endif
  47     #include "wx/tooltip.h"
  48 #endif // wxUSE_TOOLTIPS
  49
  50 // ----------------------------------------------------------------------------
  51 // wxWin macros
  52 // ----------------------------------------------------------------------------
  53
  54 IMPLEMENT_DYNAMIC_CLASS(wxComboBox, wxControl)
  55
  56 // ----------------------------------------------------------------------------
  57 // function prototypes
  58 // ----------------------------------------------------------------------------
  59
  60 LRESULT APIENTRY _EXPORT wxComboEditWndProc(HWND hWnd,
  61                                             UINT message,
  62                                             WPARAM wParam,
  63                                             LPARAM lParam);
  64
  65 // ---------------------------------------------------------------------------
  66 // global vars
  67 // ---------------------------------------------------------------------------
  68
  69 // the pointer to standard radio button wnd proc
  70 static WXFARPROC gs_wndprocEdit = (WXFARPROC)NULL;
  71
  72 // ============================================================================
  73 // implementation
  74 // ============================================================================
  75
  76 // ----------------------------------------------------------------------------
  77 // wnd proc for subclassed edit control
  78 // ----------------------------------------------------------------------------
  79
  80 LRESULT APIENTRY _EXPORT wxComboEditWndProc(HWND hWnd,
  81                                             UINT message,
  82                                             WPARAM wParam,
  83                                             LPARAM lParam)
  84 {
  85     HWND hwndCombo = ::GetParent(hWnd);
  86     wxWindow *win = wxFindWinFromHandle((WXHWND)hwndCombo);
  87
  88     switch ( message )
  89     {
  90         // forward some messages to the combobox
  91         case WM_KEYUP:
  92         case WM_KEYDOWN:
  93         case WM_CHAR:
  94             {
  95                 wxComboBox *combo = wxDynamicCast(win, wxComboBox);
  96                 wxCHECK_MSG( combo, 0, _T("should have combo as parent") );
  97
  98                 if ( combo->MSWProcessEditMsg(message, wParam, lParam) )
  99                     return 0;
 100             }
 101             break;
 102
 103 #if 0
 104         case WM_GETDLGCODE:
 105             {
 106                 wxCHECK_MSG( win, 0, _T("should have a parent") );
 107
 108                 if ( win->GetWindowStyle() & wxPROCESS_ENTER )
 109                 {
 110                     // need to return a custom dlg code or we'll never get it
 111                     return DLGC_WANTMESSAGE;
 112                 }
 113             }
 114             break;
 115 #endif // 0
 116
 117         // deal with tooltips here
 118 #if wxUSE_TOOLTIPS
 119         case WM_NOTIFY:
 120             {
 121                 wxCHECK_MSG( win, 0, _T("should have a parent") );
 122
 123                 NMHDR* hdr = (NMHDR *)lParam;
 124                 if ( (int)hdr->code == TTN_NEEDTEXT )
 125                 {
 126                     wxToolTip *tooltip = win->GetToolTip();
 127                     if ( tooltip )
 128                     {
 129                         TOOLTIPTEXT *ttt = (TOOLTIPTEXT *)lParam;
 130                         ttt->lpszText = (wxChar *)tooltip->GetTip().c_str();
 131                     }
 132
 133                     // processed
 134                     return 0;
 135                 }
 136             }
 137             break;
 138 #endif // wxUSE_TOOLTIPS
 139     }
 140
 141     return ::CallWindowProc(CASTWNDPROC gs_wndprocEdit, hWnd, message, wParam, lParam);
 142 }
 143
 144 WXHBRUSH wxComboBox::OnCtlColor(WXHDC pDC, WXHWND WXUNUSED(pWnd), WXUINT WXUNUSED(nCtlColor),
 145 #if wxUSE_CTL3D
 146                                WXUINT message,
 147                                WXWPARAM wParam,
 148                                WXLPARAM lParam
 149 #else
 150                                WXUINT WXUNUSED(message),
 151                                WXWPARAM WXUNUSED(wParam),
 152                                WXLPARAM WXUNUSED(lParam)
 153 #endif
 154     )
 155 {
 156 #if wxUSE_CTL3D
 157     if ( m_useCtl3D )
 158     {
 159         HBRUSH hbrush = Ctl3dCtlColorEx(message, wParam, lParam);
 160         return (WXHBRUSH) hbrush;
 161     }
 162 #endif // wxUSE_CTL3D
 163
 164     HDC hdc = (HDC)pDC;
 165     if (GetParent()->GetTransparentBackground())
 166         SetBkMode(hdc, TRANSPARENT);
 167     else
 168         SetBkMode(hdc, OPAQUE);
 169
 170     wxColour colBack = GetBackgroundColour();
 171
 172     if (!IsEnabled())
 173         colBack = wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DFACE);
 174
 175     ::SetBkColor(hdc, wxColourToRGB(colBack));
 176     ::SetTextColor(hdc, wxColourToRGB(GetForegroundColour()));
 177
 178     wxBrush *brush = wxTheBrushList->FindOrCreateBrush(colBack, wxSOLID);
 179
 180     return (WXHBRUSH)brush->GetResourceHandle();
 181 }
 182
 183 // ----------------------------------------------------------------------------
 184 // wxComboBox
 185 // ----------------------------------------------------------------------------
 186
 187 bool wxComboBox::MSWProcessEditMsg(WXUINT msg, WXWPARAM wParam, WXLPARAM lParam)
 188 {
 189     switch ( msg )
 190     {
 191         case WM_CHAR:
 192             return HandleChar(wParam, lParam, TRUE /* isASCII */);
 193
 194         case WM_KEYDOWN:
 195             return HandleKeyDown(wParam, lParam);
 196
 197         case WM_KEYUP:
 198             return HandleKeyUp(wParam, lParam);
 199     }
 200
 201     return FALSE;
 202 }
 203
 204 bool wxComboBox::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
 205 {
 206     wxString value;
 207     int sel = -1;
 208     switch ( param )
 209     {
 210         case CBN_SELCHANGE:
 211             sel = GetSelection();
 212             if ( sel > -1 )
 213             {
 214                 value = GetString(sel);
 215
 216                 wxCommandEvent event(wxEVT_COMMAND_COMBOBOX_SELECTED, GetId());
 217                 event.SetInt(sel);
 218                 event.SetEventObject(this);
 219                 event.SetString(value);
 220                 ProcessCommand(event);
 221             }
 222             else
 223             {
 224                 break;
 225             }
 226
 227             // fall through: for compability with wxGTK, also send the text
 228             // update event when the selection changes (this also seems more
 229             // logical as the text does change)
 230
 231         case CBN_EDITCHANGE:
 232             {
 233                 // if sel != -1, value was initialized above (and we can't use
 234                 // GetValue() here as it would return the old selection and we
 235                 // want the new one)
 236                 wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, GetId());
 237                 event.SetString(sel == -1 ? GetValue() : value);
 238                 event.SetEventObject(this);
 239                 ProcessCommand(event);
 240             }
 241             break;
 242     }
 243
 244     // there is no return value for the CBN_ notifications, so always return
 245     // FALSE from here to pass the message to DefWindowProc()
 246     return FALSE;
 247 }
 248
 249 WXHWND wxComboBox::GetEditHWND() const
 250 {
 251     // this function should not be called for wxCB_READONLY controls, it is
 252     // the callers responsability to check this
 253     wxASSERT_MSG( !(GetWindowStyle() & wxCB_READONLY),
 254                   _T("read-only combobox doesn't have any edit control") );
 255
 256     POINT pt;
 257     pt.x = pt.y = 4;
 258     HWND hwndEdit = ::ChildWindowFromPoint(GetHwnd(), pt);
 259     if ( !hwndEdit || hwndEdit == GetHwnd() )
 260     {
 261         wxFAIL_MSG(_T("not read only combobox without edit control?"));
 262     }
 263
 264     return (WXHWND)hwndEdit;
 265 }
 266
 267 bool wxComboBox::Create(wxWindow *parent, wxWindowID id,
 268                         const wxString& value,
 269                         const wxPoint& pos,
 270                         const wxSize& size,
 271                         int n, const wxString choices[],
 272                         long style,
 273                         const wxValidator& validator,
 274                         const wxString& name)
 275 {
 276     // first create wxWin object
 277     if ( !CreateControl(parent, id, pos, size, style, validator, name) )
 278         return FALSE;
 279
 280     // get the right style
 281     long msStyle = WS_TABSTOP | WS_VSCROLL | WS_HSCROLL |
 282                    CBS_AUTOHSCROLL | CBS_NOINTEGRALHEIGHT /* | WS_CLIPSIBLINGS */;
 283     if ( style & wxCB_READONLY )
 284         msStyle |= CBS_DROPDOWNLIST;
 285     else if ( style & wxCB_SIMPLE )
 286         msStyle |= CBS_SIMPLE; // A list (shown always) and edit control
 287     else
 288         msStyle |= CBS_DROPDOWN;
 289
 290     if ( style & wxCB_SORT )
 291         msStyle |= CBS_SORT;
 292
 293     // and now create the MSW control
 294     if ( !MSWCreateControl(_T("COMBOBOX"), msStyle) )
 295         return FALSE;
 296
 297     SetSize(pos.x, pos.y, size.x, size.y);
 298
 299     // A choice/combobox normally has a white background (or other, depending
 300     // on global settings) rather than inheriting the parent's background colour.
 301     SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_WINDOW));
 302
 303     for ( int i = 0; i < n; i++ )
 304     {
 305         Append(choices[i]);
 306     }
 307
 308     if ( !value.IsEmpty() )
 309     {
 310         SetValue(value);
 311     }
 312
 313     // a (not read only) combobox is, in fact, 2 controls: the combobox itself
 314     // and an edit control inside it and if we want to catch events from this
 315     // edit control, we must subclass it as well
 316     if ( !(style & wxCB_READONLY) )
 317     {
 318         gs_wndprocEdit = (WXFARPROC)::SetWindowLong
 319                                       (
 320                                         (HWND)GetEditHWND(),
 321                                         GWL_WNDPROC,
 322                                         (LPARAM)wxComboEditWndProc
 323                                       );
 324     }
 325
 326     return TRUE;
 327 }
 328
 329 // TODO: update and clear all this horrible mess (VZ)
 330
 331 void wxComboBox::SetValue(const wxString& value)
 332 {
 333   // If newlines are denoted by just 10, must stick 13 in front.
 334   int singletons = 0;
 335   int len = value.Length();
 336   int i;
 337   for (i = 0; i < len; i ++)
 338   {
 339     if ((i > 0) && (value[i] == 10) && (value[i-1] != 13))
 340       singletons ++;
 341   }
 342   if (singletons > 0)
 343   {
 344     wxChar *tmp = new wxChar[len + singletons + 1];
 345     int j = 0;
 346     for (i = 0; i < len; i ++)
 347     {
 348       if ((i > 0) && (value[i] == 10) && (value[i-1] != 13))
 349       {
 350         tmp[j] = 13;
 351         j ++;
 352       }
 353       tmp[j] = value[i];
 354       j ++;
 355     }
 356     tmp[j] = 0;
 357     SetWindowText(GetHwnd(), tmp);
 358     delete[] tmp;
 359   }
 360   else
 361     SetWindowText(GetHwnd(), value);
 362 }
 363
 364 // Clipboard operations
 365 void wxComboBox::Copy()
 366 {
 367   HWND hWnd = GetHwnd();
 368   SendMessage(hWnd, WM_COPY, 0, 0L);
 369 }
 370
 371 void wxComboBox::Cut()
 372 {
 373   HWND hWnd = GetHwnd();
 374   SendMessage(hWnd, WM_CUT, 0, 0L);
 375 }
 376
 377 void wxComboBox::Paste()
 378 {
 379   HWND hWnd = GetHwnd();
 380   SendMessage(hWnd, WM_PASTE, 0, 0L);
 381 }
 382
 383 void wxComboBox::SetEditable(bool WXUNUSED(editable))
 384 {
 385   // Can't implement in MSW?
 386 //  HWND hWnd = GetHwnd();
 387 //  SendMessage(hWnd, EM_SETREADONLY, (WPARAM)!editable, (LPARAM)0L);
 388 }
 389
 390 void wxComboBox::SetInsertionPoint(long pos)
 391 {
 392     if ( GetWindowStyle() & wxCB_READONLY )
 393         return;
 394
 395 #ifdef __WIN32__
 396     HWND hWnd = GetHwnd();
 397     ::SendMessage(hWnd, CB_SETEDITSEL, 0, MAKELPARAM(pos, pos));
 398     HWND hEditWnd = (HWND) GetEditHWND() ;
 399     if ( hEditWnd )
 400     {
 401         // Scroll insertion point into view
 402         SendMessage(hEditWnd, EM_SCROLLCARET, (WPARAM)0, (LPARAM)0);
 403         // Why is this necessary? (Copied from wxTextCtrl::SetInsertionPoint)
 404         SendMessage(hEditWnd, EM_REPLACESEL, 0, (LPARAM)_T(""));
 405     }
 406 #endif // __WIN32__
 407 }
 408
 409 void wxComboBox::SetInsertionPointEnd()
 410 {
 411     // setting insertion point doesn't make sense for read only comboboxes
 412     if ( !(GetWindowStyle() & wxCB_READONLY) )
 413     {
 414         long pos = GetLastPosition();
 415         SetInsertionPoint(pos);
 416     }
 417 }
 418
 419 long wxComboBox::GetInsertionPoint() const
 420 {
 421 #ifdef __WIN32__
 422     DWORD Pos=(DWORD)SendMessage(GetHwnd(), CB_GETEDITSEL, 0, 0L);
 423     return Pos&0xFFFF;
 424 #else
 425     return 0;
 426 #endif
 427 }
 428
 429 long wxComboBox::GetLastPosition() const
 430 {
 431     HWND hEditWnd = (HWND) GetEditHWND();
 432
 433     // Get number of characters in the last (only) line. We'll add this to the character
 434     // index for the last line, 1st position.
 435     int lineLength = (int)SendMessage(hEditWnd, EM_LINELENGTH, (WPARAM) 0, (LPARAM)0L);
 436
 437     return (long)(lineLength);
 438 }
 439
 440 void wxComboBox::Replace(long from, long to, const wxString& value)
 441 {
 442 #if wxUSE_CLIPBOARD
 443     Remove(from, to);
 444
 445     // Now replace with 'value', by pasting.
 446     wxSetClipboardData(wxDF_TEXT, (wxObject *)(const wxChar *)value, 0, 0);
 447
 448     // Paste into edit control
 449     SendMessage(GetHwnd(), WM_PASTE, (WPARAM)0, (LPARAM)0L);
 450 #endif
 451 }
 452
 453 void wxComboBox::Remove(long from, long to)
 454 {
 455     // Set selection and remove it
 456     SetSelection(from, to);
 457     SendMessage(GetHwnd(), WM_CUT, (WPARAM)0, (LPARAM)0);
 458 }
 459
 460 void wxComboBox::SetSelection(long from, long to)
 461 {
 462     HWND hWnd = GetHwnd();
 463     long fromChar = from;
 464     long toChar = to;
 465     // if from and to are both -1, it means
 466     // (in wxWindows) that all text should be selected.
 467     // This translates into Windows convention
 468     if ((from == -1) && (to == -1))
 469     {
 470       fromChar = 0;
 471       toChar = -1;
 472     }
 473
 474     if (
 475 #ifdef __WIN32__
 476     SendMessage(hWnd, CB_SETEDITSEL, (WPARAM)0, (LPARAM)MAKELONG(fromChar, toChar))
 477 #else // Win16
 478     SendMessage(hWnd, CB_SETEDITSEL, (WPARAM)fromChar, (LPARAM)toChar)
 479 #endif
 480         == CB_ERR )
 481     {
 482         wxLogDebug(_T("CB_SETEDITSEL failed"));
 483     }
 484 }
 485
 486 void wxComboBox::DoMoveWindow(int x, int y, int width, int height)
 487 {
 488     // here is why this is necessary: if the width is negative, the combobox
 489     // window proc makes the window of the size width*height instead of
 490     // interpreting height in the usual manner (meaning the height of the drop
 491     // down list - usually the height specified in the call to MoveWindow()
 492     // will not change the height of combo box per se)
 493     //
 494     // this behaviour is not documented anywhere, but this is just how it is
 495     // here (NT 4.4) and, anyhow, the check shouldn't hurt - however without
 496     // the check, constraints/sizers using combos may break the height
 497     // constraint will have not at all the same value as expected
 498     if ( width < 0 )
 499         return;
 500
 501     int cx, cy;
 502     wxGetCharSize(GetHWND(), &cx, &cy, &GetFont());
 503
 504     // what should the height of the drop down list be? we choose 10 items by
 505     // default and also 10 items max (if we always use n, the list will never
 506     // have vertical scrollbar)
 507     int n = GetCount();
 508     if ( !n || (n > 10) )
 509         n = 10;
 510
 511     height = (n + 1)* EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy);
 512
 513     wxControl::DoMoveWindow(x, y, width, height);
 514 }
 515
 516 wxSize wxComboBox::DoGetBestSize() const
 517 {
 518     // the choice calculates the horz size correctly, but not the vertical
 519     // component: correct it
 520     wxSize size = wxChoice::DoGetBestSize();
 521
 522     int cx, cy;
 523     wxGetCharSize(GetHWND(), &cx, &cy, &GetFont());
 524     size.y = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy);
 525
 526     return size;
 527 }
 528
 529 #endif
 530  // wxUSE_COMBOBOX
 531