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
   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     // for wxEVT_COMMAND_TEXT_ENTER
  37     #include "wx/textctrl.h"
  38 #endif
  39
  40 #include "wx/combobox.h"
  41 #include "wx/brush.h"
  42 #include "wx/clipbrd.h"
  43 #include "wx/msw/private.h"
  44
  45 #if wxUSE_TOOLTIPS
  46     #if !defined(__GNUWIN32_OLD__) || defined(__CYGWIN10__)
  47         #include <commctrl.h>
  48     #endif
  49     #include "wx/tooltip.h"
  50 #endif // wxUSE_TOOLTIPS
  51
  52 // ----------------------------------------------------------------------------
  53 // wxWin macros
  54 // ----------------------------------------------------------------------------
  55
  56 IMPLEMENT_DYNAMIC_CLASS(wxComboBox, wxControl)
  57
  58 // ----------------------------------------------------------------------------
  59 // function prototypes
  60 // ----------------------------------------------------------------------------
  61
  62 LRESULT APIENTRY _EXPORT wxComboEditWndProc(HWND hWnd,
  63                                             UINT message,
  64                                             WPARAM wParam,
  65                                             LPARAM lParam);
  66
  67 // ---------------------------------------------------------------------------
  68 // global vars
  69 // ---------------------------------------------------------------------------
  70
  71 // the pointer to standard radio button wnd proc
  72 static WXFARPROC gs_wndprocEdit = (WXFARPROC)NULL;
  73
  74 // ============================================================================
  75 // implementation
  76 // ============================================================================
  77
  78 // ----------------------------------------------------------------------------
  79 // wnd proc for subclassed edit control
  80 // ----------------------------------------------------------------------------
  81
  82 LRESULT APIENTRY _EXPORT wxComboEditWndProc(HWND hWnd,
  83                                             UINT message,
  84                                             WPARAM wParam,
  85                                             LPARAM lParam)
  86 {
  87     HWND hwndCombo = ::GetParent(hWnd);
  88     wxWindow *win = wxFindWinFromHandle((WXHWND)hwndCombo);
  89
  90     switch ( message )
  91     {
  92         // forward some messages to the combobox to generate the appropriate
  93         // wxEvents from them
  94         case WM_KEYUP:
  95         case WM_KEYDOWN:
  96         case WM_CHAR:
  97         case WM_SETFOCUS:
  98         case WM_KILLFOCUS:
  99             {
 100                 wxComboBox *combo = wxDynamicCast(win, wxComboBox);
 101                 if ( !combo )
 102                 {
 103                     // we can get WM_KILLFOCUS while our parent is already half
 104                     // destroyed and hence doesn't look like a combobx any
 105                     // longer, check for it to avoid bogus assert failures
 106                     if ( !win->IsBeingDeleted() )
 107                     {
 108                         wxFAIL_MSG( _T("should have combo as parent") );
 109                     }
 110                 }
 111                 else if ( combo->MSWProcessEditMsg(message, wParam, lParam) )
 112                 {
 113                     // handled by parent
 114                     return 0;
 115                 }
 116             }
 117             break;
 118
 119         case WM_GETDLGCODE:
 120             {
 121                 wxCHECK_MSG( win, 0, _T("should have a parent") );
 122
 123                 if ( win->GetWindowStyle() & wxPROCESS_ENTER )
 124                 {
 125                     // need to return a custom dlg code or we'll never get it
 126                     return DLGC_WANTMESSAGE;
 127                 }
 128             }
 129             break;
 130
 131         // deal with tooltips here
 132 #if wxUSE_TOOLTIPS && defined(TTN_NEEDTEXT)
 133         case WM_NOTIFY:
 134             {
 135                 wxCHECK_MSG( win, 0, _T("should have a parent") );
 136
 137                 NMHDR* hdr = (NMHDR *)lParam;
 138                 if ( hdr->code == TTN_NEEDTEXT )
 139                 {
 140                     wxToolTip *tooltip = win->GetToolTip();
 141                     if ( tooltip )
 142                     {
 143                         TOOLTIPTEXT *ttt = (TOOLTIPTEXT *)lParam;
 144                         ttt->lpszText = (wxChar *)tooltip->GetTip().c_str();
 145                     }
 146
 147                     // processed
 148                     return 0;
 149                 }
 150             }
 151             break;
 152 #endif // wxUSE_TOOLTIPS
 153     }
 154
 155     return ::CallWindowProc(CASTWNDPROC gs_wndprocEdit, hWnd, message, wParam, lParam);
 156 }
 157
 158 WXHBRUSH wxComboBox::OnCtlColor(WXHDC pDC, WXHWND WXUNUSED(pWnd), WXUINT WXUNUSED(nCtlColor),
 159                                WXUINT WXUNUSED(message),
 160                                WXWPARAM WXUNUSED(wParam),
 161                                WXLPARAM WXUNUSED(lParam)
 162     )
 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::GetColour(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             // for compatibility with wxTextCtrl, generate a special message
 193             // when Enter is pressed
 194             if ( wParam == VK_RETURN )
 195             {
 196                 wxCommandEvent event(wxEVT_COMMAND_TEXT_ENTER, m_windowId);
 197                 InitCommandEvent(event);
 198                 event.SetString(GetValue());
 199                 event.SetInt(GetSelection());
 200                 ProcessCommand(event);
 201             }
 202
 203             return HandleChar(wParam, lParam, TRUE /* isASCII */);
 204
 205         case WM_KEYDOWN:
 206             return HandleKeyDown(wParam, lParam);
 207
 208         case WM_KEYUP:
 209             return HandleKeyUp(wParam, lParam);
 210
 211         case WM_SETFOCUS:
 212             return HandleSetFocus((WXHWND)wParam);
 213
 214         case WM_KILLFOCUS:
 215             return HandleKillFocus((WXHWND)wParam);
 216     }
 217
 218     return FALSE;
 219 }
 220
 221 bool wxComboBox::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
 222 {
 223     wxString value;
 224     int sel = -1;
 225     switch ( param )
 226     {
 227         case CBN_SELCHANGE:
 228             sel = GetSelection();
 229             if ( sel > -1 )
 230             {
 231                 value = GetString(sel);
 232
 233                 wxCommandEvent event(wxEVT_COMMAND_COMBOBOX_SELECTED, GetId());
 234                 event.SetInt(sel);
 235                 event.SetEventObject(this);
 236                 event.SetString(value);
 237                 ProcessCommand(event);
 238             }
 239             else
 240             {
 241                 break;
 242             }
 243
 244             // fall through: for compability with wxGTK, also send the text
 245             // update event when the selection changes (this also seems more
 246             // logical as the text does change)
 247
 248         case CBN_EDITCHANGE:
 249             {
 250                 wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, GetId());
 251
 252                 // if sel != -1, value was initialized above (and we can't use
 253                 // GetValue() here as it would return the old selection and we
 254                 // want the new one)
 255                 if ( sel == -1 )
 256                 {
 257                     value = GetValue();
 258                 }
 259                 else // we're synthesizing text updated event from sel change
 260                 {
 261                     // we need to do this because the user code expects
 262                     // wxComboBox::GetValue() to return the new value from
 263                     // "text updated" handler but it hadn't been updated yet
 264                     SetValue(value);
 265                 }
 266
 267                 event.SetString(value);
 268                 event.SetEventObject(this);
 269                 ProcessCommand(event);
 270             }
 271             break;
 272     }
 273
 274     // there is no return value for the CBN_ notifications, so always return
 275     // FALSE from here to pass the message to DefWindowProc()
 276     return FALSE;
 277 }
 278
 279 WXHWND wxComboBox::GetEditHWND() const
 280 {
 281     // this function should not be called for wxCB_READONLY controls, it is
 282     // the callers responsability to check this
 283     wxASSERT_MSG( !(GetWindowStyle() & wxCB_READONLY),
 284                   _T("read-only combobox doesn't have any edit control") );
 285
 286     POINT pt;
 287     pt.x = pt.y = 4;
 288     HWND hwndEdit = ::ChildWindowFromPoint(GetHwnd(), pt);
 289     if ( !hwndEdit || hwndEdit == GetHwnd() )
 290     {
 291         wxFAIL_MSG(_T("not read only combobox without edit control?"));
 292     }
 293
 294     return (WXHWND)hwndEdit;
 295 }
 296
 297 bool wxComboBox::Create(wxWindow *parent, wxWindowID id,
 298                         const wxString& value,
 299                         const wxPoint& pos,
 300                         const wxSize& size,
 301                         int n, const wxString choices[],
 302                         long style,
 303                         const wxValidator& validator,
 304                         const wxString& name)
 305 {
 306     // pretend that wxComboBox is hidden while it is positioned and resized and
 307     // show it only right before leaving this method because otherwise there is
 308     // some noticeable flicker while the control rearranges itself
 309     m_isShown = FALSE;
 310
 311     // first create wxWin object
 312     if ( !CreateControl(parent, id, pos, size, style, validator, name) )
 313         return FALSE;
 314
 315     // get the right style
 316     long msStyle = WS_TABSTOP | WS_VSCROLL | WS_HSCROLL |
 317                    CBS_AUTOHSCROLL | CBS_NOINTEGRALHEIGHT /* | WS_CLIPSIBLINGS */;
 318     if ( style & wxCB_READONLY )
 319         msStyle |= CBS_DROPDOWNLIST;
 320     else if ( style & wxCB_SIMPLE )
 321         msStyle |= CBS_SIMPLE; // A list (shown always) and edit control
 322     else
 323         msStyle |= CBS_DROPDOWN;
 324
 325     if ( style & wxCB_SORT )
 326         msStyle |= CBS_SORT;
 327
 328     if ( style & wxCLIP_SIBLINGS )
 329         msStyle |= WS_CLIPSIBLINGS;
 330
 331
 332     // and now create the MSW control
 333     if ( !MSWCreateControl(_T("COMBOBOX"), msStyle) )
 334         return FALSE;
 335
 336     // A choice/combobox normally has a white background (or other, depending
 337     // on global settings) rather than inheriting the parent's background colour.
 338     SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
 339
 340     for ( int i = 0; i < n; i++ )
 341     {
 342         Append(choices[i]);
 343     }
 344
 345     if ( !value.IsEmpty() )
 346     {
 347         SetValue(value);
 348     }
 349
 350     // do this after appending the values to the combobox so that autosizing
 351     // works correctly
 352     SetSize(pos.x, pos.y, size.x, size.y);
 353
 354     // a (not read only) combobox is, in fact, 2 controls: the combobox itself
 355     // and an edit control inside it and if we want to catch events from this
 356     // edit control, we must subclass it as well
 357     if ( !(style & wxCB_READONLY) )
 358     {
 359         gs_wndprocEdit = (WXFARPROC)::SetWindowLong
 360                                       (
 361                                         (HWND)GetEditHWND(),
 362                                         GWL_WNDPROC,
 363                                         (LPARAM)wxComboEditWndProc
 364                                       );
 365     }
 366
 367     // and finally, show the control
 368     Show(TRUE);
 369
 370     return TRUE;
 371 }
 372
 373 void wxComboBox::SetValue(const wxString& value)
 374 {
 375     if ( HasFlag(wxCB_READONLY) )
 376         SetStringSelection(value);
 377     else
 378         SetWindowText(GetHwnd(), value.c_str());
 379 }
 380
 381 // Clipboard operations
 382 void wxComboBox::Copy()
 383 {
 384   SendMessage(GetHwnd(), WM_COPY, 0, 0L);
 385 }
 386
 387 void wxComboBox::Cut()
 388 {
 389   SendMessage(GetHwnd(), WM_CUT, 0, 0L);
 390 }
 391
 392 void wxComboBox::Paste()
 393 {
 394   SendMessage(GetHwnd(), WM_PASTE, 0, 0L);
 395 }
 396
 397 void wxComboBox::SetEditable(bool WXUNUSED(editable))
 398 {
 399   // Can't implement in MSW?
 400 //  HWND hWnd = GetHwnd();
 401 //  SendMessage(hWnd, EM_SETREADONLY, (WPARAM)!editable, (LPARAM)0L);
 402 }
 403
 404 void wxComboBox::SetInsertionPoint(long pos)
 405 {
 406     if ( GetWindowStyle() & wxCB_READONLY )
 407         return;
 408
 409 #ifdef __WIN32__
 410     HWND hWnd = GetHwnd();
 411     ::SendMessage(hWnd, CB_SETEDITSEL, 0, MAKELPARAM(pos, pos));
 412     HWND hEditWnd = (HWND) GetEditHWND() ;
 413     if ( hEditWnd )
 414     {
 415         // Scroll insertion point into view
 416         SendMessage(hEditWnd, EM_SCROLLCARET, (WPARAM)0, (LPARAM)0);
 417         // Why is this necessary? (Copied from wxTextCtrl::SetInsertionPoint)
 418         SendMessage(hEditWnd, EM_REPLACESEL, 0, (LPARAM)_T(""));
 419     }
 420 #endif // __WIN32__
 421 }
 422
 423 void wxComboBox::SetInsertionPointEnd()
 424 {
 425     // setting insertion point doesn't make sense for read only comboboxes
 426     if ( !(GetWindowStyle() & wxCB_READONLY) )
 427     {
 428         long pos = GetLastPosition();
 429         SetInsertionPoint(pos);
 430     }
 431 }
 432
 433 long wxComboBox::GetInsertionPoint() const
 434 {
 435 #ifdef __WIN32__
 436     DWORD Pos=(DWORD)SendMessage(GetHwnd(), CB_GETEDITSEL, 0, 0L);
 437     return Pos&0xFFFF;
 438 #else
 439     return 0;
 440 #endif
 441 }
 442
 443 long wxComboBox::GetLastPosition() const
 444 {
 445     HWND hEditWnd = (HWND) GetEditHWND();
 446
 447     // Get number of characters in the last (only) line. We'll add this to the character
 448     // index for the last line, 1st position.
 449     int lineLength = (int)SendMessage(hEditWnd, EM_LINELENGTH, (WPARAM) 0, (LPARAM)0L);
 450
 451     return (long)(lineLength);
 452 }
 453
 454 void wxComboBox::Replace(long from, long to, const wxString& value)
 455 {
 456 #if wxUSE_CLIPBOARD
 457     Remove(from, to);
 458
 459     // Now replace with 'value', by pasting.
 460     wxSetClipboardData(wxDF_TEXT, (wxObject *)(const wxChar *)value, 0, 0);
 461
 462     // Paste into edit control
 463     SendMessage(GetHwnd(), WM_PASTE, (WPARAM)0, (LPARAM)0L);
 464 #endif
 465 }
 466
 467 void wxComboBox::Remove(long from, long to)
 468 {
 469     // Set selection and remove it
 470     SetSelection(from, to);
 471     SendMessage(GetHwnd(), WM_CUT, (WPARAM)0, (LPARAM)0);
 472 }
 473
 474 void wxComboBox::SetSelection(long from, long to)
 475 {
 476     HWND hWnd = GetHwnd();
 477     long fromChar = from;
 478     long toChar = to;
 479     // if from and to are both -1, it means
 480     // (in wxWindows) that all text should be selected.
 481     // This translates into Windows convention
 482     if ((from == -1) && (to == -1))
 483     {
 484       fromChar = 0;
 485       toChar = -1;
 486     }
 487
 488     if (
 489 #ifdef __WIN32__
 490     SendMessage(hWnd, CB_SETEDITSEL, (WPARAM)0, (LPARAM)MAKELONG(fromChar, toChar))
 491 #else // Win16
 492     SendMessage(hWnd, CB_SETEDITSEL, (WPARAM)fromChar, (LPARAM)toChar)
 493 #endif
 494         == CB_ERR )
 495     {
 496         wxLogDebug(_T("CB_SETEDITSEL failed"));
 497     }
 498 }
 499
 500 #endif
 501  // wxUSE_COMBOBOX
 502