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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  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 #if wxUSE_EXTENDED_RTTI
  57 WX_DEFINE_FLAGS( wxComboBoxStyle )
  58
  59 wxBEGIN_FLAGS( wxComboBoxStyle )
  60     // new style border flags, we put them first to
  61     // use them for streaming out
  62     wxFLAGS_MEMBER(wxBORDER_SIMPLE)
  63     wxFLAGS_MEMBER(wxBORDER_SUNKEN)
  64     wxFLAGS_MEMBER(wxBORDER_DOUBLE)
  65     wxFLAGS_MEMBER(wxBORDER_RAISED)
  66     wxFLAGS_MEMBER(wxBORDER_STATIC)
  67     wxFLAGS_MEMBER(wxBORDER_NONE)
  68
  69     // old style border flags
  70     wxFLAGS_MEMBER(wxSIMPLE_BORDER)
  71     wxFLAGS_MEMBER(wxSUNKEN_BORDER)
  72     wxFLAGS_MEMBER(wxDOUBLE_BORDER)
  73     wxFLAGS_MEMBER(wxRAISED_BORDER)
  74     wxFLAGS_MEMBER(wxSTATIC_BORDER)
  75     wxFLAGS_MEMBER(wxBORDER)
  76
  77     // standard window styles
  78     wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
  79     wxFLAGS_MEMBER(wxCLIP_CHILDREN)
  80     wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
  81     wxFLAGS_MEMBER(wxWANTS_CHARS)
  82     wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
  83     wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
  84     wxFLAGS_MEMBER(wxVSCROLL)
  85     wxFLAGS_MEMBER(wxHSCROLL)
  86
  87     wxFLAGS_MEMBER(wxCB_SIMPLE)
  88     wxFLAGS_MEMBER(wxCB_SORT)
  89     wxFLAGS_MEMBER(wxCB_READONLY)
  90     wxFLAGS_MEMBER(wxCB_DROPDOWN)
  91
  92 wxEND_FLAGS( wxComboBoxStyle )
  93
  94 IMPLEMENT_DYNAMIC_CLASS_XTI(wxComboBox, wxControl,"wx/combobox.h")
  95
  96 wxBEGIN_PROPERTIES_TABLE(wxComboBox)
  97     wxEVENT_PROPERTY( Select , wxEVT_COMMAND_COMBOBOX_SELECTED , wxCommandEvent )
  98     wxEVENT_PROPERTY( TextEnter , wxEVT_COMMAND_TEXT_ENTER , wxCommandEvent )
  99
 100     // TODO DELEGATES
 101     wxPROPERTY( Font , wxFont , SetFont , GetFont  , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 102     wxPROPERTY_COLLECTION( Choices , wxArrayString , wxString , AppendString , GetStrings , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 103     wxPROPERTY( Value ,wxString, SetValue, GetValue, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 104     wxPROPERTY( Selection ,int, SetSelection, GetSelection, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 105     wxPROPERTY_FLAGS( WindowStyle , wxComboBoxStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
 106 wxEND_PROPERTIES_TABLE()
 107
 108 wxBEGIN_HANDLERS_TABLE(wxComboBox)
 109 wxEND_HANDLERS_TABLE()
 110
 111 wxCONSTRUCTOR_5( wxComboBox , wxWindow* , Parent , wxWindowID , Id , wxString , Value , wxPoint , Position , wxSize , Size )
 112 #else
 113 IMPLEMENT_DYNAMIC_CLASS(wxComboBox, wxControl)
 114 #endif
 115
 116 // ----------------------------------------------------------------------------
 117 // function prototypes
 118 // ----------------------------------------------------------------------------
 119
 120 LRESULT APIENTRY _EXPORT wxComboEditWndProc(HWND hWnd,
 121                                             UINT message,
 122                                             WPARAM wParam,
 123                                             LPARAM lParam);
 124
 125 // ---------------------------------------------------------------------------
 126 // global vars
 127 // ---------------------------------------------------------------------------
 128
 129 // the pointer to standard radio button wnd proc
 130 static WNDPROC gs_wndprocEdit = (WNDPROC)NULL;
 131
 132 // ============================================================================
 133 // implementation
 134 // ============================================================================
 135
 136 // ----------------------------------------------------------------------------
 137 // wnd proc for subclassed edit control
 138 // ----------------------------------------------------------------------------
 139
 140 LRESULT APIENTRY _EXPORT wxComboEditWndProc(HWND hWnd,
 141                                             UINT message,
 142                                             WPARAM wParam,
 143                                             LPARAM lParam)
 144 {
 145     HWND hwndCombo = ::GetParent(hWnd);
 146     wxWindow *win = wxFindWinFromHandle((WXHWND)hwndCombo);
 147
 148     switch ( message )
 149     {
 150         // forward some messages to the combobox to generate the appropriate
 151         // wxEvents from them
 152         case WM_KEYUP:
 153         case WM_KEYDOWN:
 154         case WM_CHAR:
 155         case WM_SETFOCUS:
 156         case WM_KILLFOCUS:
 157             {
 158                 wxComboBox *combo = wxDynamicCast(win, wxComboBox);
 159                 if ( !combo )
 160                 {
 161                     // we can get WM_KILLFOCUS while our parent is already half
 162                     // destroyed and hence doesn't look like a combobx any
 163                     // longer, check for it to avoid bogus assert failures
 164                     if ( !win->IsBeingDeleted() )
 165                     {
 166                         wxFAIL_MSG( _T("should have combo as parent") );
 167                     }
 168                 }
 169                 else if ( combo->MSWProcessEditMsg(message, wParam, lParam) )
 170                 {
 171                     // handled by parent
 172                     return 0;
 173                 }
 174             }
 175             break;
 176
 177         case WM_GETDLGCODE:
 178             {
 179                 wxCHECK_MSG( win, 0, _T("should have a parent") );
 180
 181                 if ( win->GetWindowStyle() & wxPROCESS_ENTER )
 182                 {
 183                     // need to return a custom dlg code or we'll never get it
 184                     return DLGC_WANTMESSAGE;
 185                 }
 186             }
 187             break;
 188
 189         // deal with tooltips here
 190 #if wxUSE_TOOLTIPS && defined(TTN_NEEDTEXT)
 191         case WM_NOTIFY:
 192             {
 193                 wxCHECK_MSG( win, 0, _T("should have a parent") );
 194
 195                 NMHDR* hdr = (NMHDR *)lParam;
 196                 if ( hdr->code == TTN_NEEDTEXT )
 197                 {
 198                     wxToolTip *tooltip = win->GetToolTip();
 199                     if ( tooltip )
 200                     {
 201                         TOOLTIPTEXT *ttt = (TOOLTIPTEXT *)lParam;
 202                         ttt->lpszText = (wxChar *)tooltip->GetTip().c_str();
 203                     }
 204
 205                     // processed
 206                     return 0;
 207                 }
 208             }
 209             break;
 210 #endif // wxUSE_TOOLTIPS
 211     }
 212
 213     return ::CallWindowProc(CASTWNDPROC gs_wndprocEdit, hWnd, message, wParam, lParam);
 214 }
 215
 216 WXHBRUSH wxComboBox::OnCtlColor(WXHDC pDC,
 217                                 WXHWND WXUNUSED(pWnd),
 218                                 WXUINT WXUNUSED(nCtlColor),
 219                                 WXUINT WXUNUSED(message),
 220                                 WXWPARAM WXUNUSED(wParam),
 221                                 WXLPARAM WXUNUSED(lParam))
 222 {
 223     HDC hdc = (HDC)pDC;
 224     wxColour colBack = GetBackgroundColour();
 225
 226     if (!IsEnabled())
 227         colBack = wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE);
 228
 229     ::SetBkColor(hdc, wxColourToRGB(colBack));
 230     ::SetTextColor(hdc, wxColourToRGB(GetForegroundColour()));
 231
 232     wxBrush *brush = wxTheBrushList->FindOrCreateBrush(colBack, wxSOLID);
 233
 234     return (WXHBRUSH)brush->GetResourceHandle();
 235 }
 236
 237 // ----------------------------------------------------------------------------
 238 // wxComboBox callbacks
 239 // ----------------------------------------------------------------------------
 240
 241 WXLRESULT wxComboBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 242 {
 243     // handle WM_CTLCOLOR messages from our EDIT control to be able to set its
 244     // colour correctly (to be the same as our own one)
 245     switch ( nMsg )
 246     {
 247         // we have to handle both: one for the normal case and the other for
 248         // wxCB_READONLY
 249         case WM_CTLCOLOREDIT:
 250         case WM_CTLCOLORSTATIC:
 251             WXHDC hdc;
 252             WXHWND hwnd;
 253             UnpackCtlColor(wParam, lParam, &hdc, &hwnd);
 254
 255             return (WXLRESULT)OnCtlColor(hdc, hwnd, 0, nMsg, wParam, lParam);
 256
 257         case CB_SETCURSEL:
 258             // Selection was set with SetSelection.  Update the value too.
 259             if ((int)wParam > GetCount())
 260                 m_value = wxEmptyString;
 261             else
 262                 m_value = GetString(wParam);
 263             break;
 264
 265     }
 266
 267     return wxChoice::MSWWindowProc(nMsg, wParam, lParam);
 268 }
 269
 270 bool wxComboBox::MSWProcessEditMsg(WXUINT msg, WXWPARAM wParam, WXLPARAM lParam)
 271 {
 272     switch ( msg )
 273     {
 274         case WM_CHAR:
 275             // for compatibility with wxTextCtrl, generate a special message
 276             // when Enter is pressed
 277             if ( wParam == VK_RETURN )
 278             {
 279                 wxCommandEvent event(wxEVT_COMMAND_TEXT_ENTER, m_windowId);
 280                 InitCommandEvent(event);
 281                 event.SetString(GetValue());
 282                 event.SetInt(GetSelection());
 283                 ProcessCommand(event);
 284             }
 285
 286             return HandleChar(wParam, lParam, true /* isASCII */);
 287
 288         case WM_KEYDOWN:
 289             return HandleKeyDown(wParam, lParam);
 290
 291         case WM_KEYUP:
 292             return HandleKeyUp(wParam, lParam);
 293
 294         case WM_SETFOCUS:
 295             return HandleSetFocus((WXHWND)wParam);
 296
 297         case WM_KILLFOCUS:
 298             return HandleKillFocus((WXHWND)wParam);
 299     }
 300
 301     return false;
 302 }
 303
 304 bool wxComboBox::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
 305 {
 306     wxString value;
 307     int sel = -1;
 308     switch ( param )
 309     {
 310         case CBN_SELCHANGE:
 311             sel = GetSelection();
 312
 313             // somehow we get 2 CBN_SELCHANGE events with the same index when
 314             // the user selects an item in the combobox -- ignore duplicates
 315             if ( sel > -1 && sel != m_selectionOld )
 316             {
 317                 m_selectionOld = sel;
 318
 319                 // GetValue() would still return the old value from here but
 320                 // according to the docs we should return the new value if the
 321                 // user calls it in his event handler, so update internal
 322                 // m_value
 323                 m_value = GetString(sel);
 324
 325                 wxCommandEvent event(wxEVT_COMMAND_COMBOBOX_SELECTED, GetId());
 326                 event.SetInt(sel);
 327                 event.SetEventObject(this);
 328                 event.SetString(m_value);
 329                 ProcessCommand(event);
 330             }
 331             else // no valid selection
 332             {
 333                 m_selectionOld = sel;
 334
 335                 // hence no EVT_TEXT neither
 336                 break;
 337             }
 338
 339             // fall through: for compability with wxGTK, also send the text
 340             // update event when the selection changes (this also seems more
 341             // logical as the text does change)
 342
 343         case CBN_EDITCHANGE:
 344             {
 345                 wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, GetId());
 346
 347                 // if sel != -1, value was initialized above (and we can't use
 348                 // GetValue() here as it would return the old selection and we
 349                 // want the new one)
 350                 if ( sel == -1 )
 351                 {
 352                     m_value = wxGetWindowText(GetHwnd());
 353                 }
 354                 else // we're synthesizing text updated event from sel change
 355                 {
 356                     // We need to retrieve the current selection because the
 357                     // user may have changed it in the previous handler (for
 358                     // CBN_SELCHANGE above).
 359                     sel = GetSelection();
 360                     if ( sel > -1 )
 361                     {
 362                         m_value = GetString(sel);
 363                     }
 364                 }
 365
 366                 event.SetString(m_value);
 367                 event.SetEventObject(this);
 368                 ProcessCommand(event);
 369             }
 370             break;
 371     }
 372
 373     // there is no return value for the CBN_ notifications, so always return
 374     // false from here to pass the message to DefWindowProc()
 375     return false;
 376 }
 377
 378 WXHWND wxComboBox::GetEditHWND() const
 379 {
 380     // this function should not be called for wxCB_READONLY controls, it is
 381     // the callers responsability to check this
 382     wxASSERT_MSG( !(GetWindowStyle() & wxCB_READONLY),
 383                   _T("read-only combobox doesn't have any edit control") );
 384
 385     POINT pt;
 386     pt.x = pt.y = 4;
 387     HWND hwndEdit = ::ChildWindowFromPoint(GetHwnd(), pt);
 388     if ( !hwndEdit || hwndEdit == GetHwnd() )
 389     {
 390         wxFAIL_MSG(_T("not read only combobox without edit control?"));
 391     }
 392
 393     return (WXHWND)hwndEdit;
 394 }
 395
 396 // ----------------------------------------------------------------------------
 397 // wxComboBox creation
 398 // ----------------------------------------------------------------------------
 399
 400 bool wxComboBox::Create(wxWindow *parent, wxWindowID id,
 401                         const wxString& value,
 402                         const wxPoint& pos,
 403                         const wxSize& size,
 404                         int n, const wxString choices[],
 405                         long style,
 406                         const wxValidator& validator,
 407                         const wxString& name)
 408 {
 409     // pretend that wxComboBox is hidden while it is positioned and resized and
 410     // show it only right before leaving this method because otherwise there is
 411     // some noticeable flicker while the control rearranges itself
 412     m_isShown = false;
 413
 414     if ( !CreateAndInit(parent, id, pos, size, n, choices, style,
 415                         validator, name) )
 416         return false;
 417
 418     // we shouldn't call SetValue() for an empty string because this would
 419     // (correctly) result in an assert with a read only combobox and is useless
 420     // for the other ones anyhow
 421     if ( !value.empty() )
 422         SetValue(value);
 423
 424     // a (not read only) combobox is, in fact, 2 controls: the combobox itself
 425     // and an edit control inside it and if we want to catch events from this
 426     // edit control, we must subclass it as well
 427     if ( !(style & wxCB_READONLY) )
 428     {
 429         gs_wndprocEdit = wxSetWindowProc((HWND)GetEditHWND(),
 430                                          wxComboEditWndProc);
 431     }
 432
 433     // and finally, show the control
 434     Show(true);
 435
 436     return true;
 437 }
 438
 439 bool wxComboBox::Create(wxWindow *parent, wxWindowID id,
 440                         const wxString& value,
 441                         const wxPoint& pos,
 442                         const wxSize& size,
 443                         const wxArrayString& choices,
 444                         long style,
 445                         const wxValidator& validator,
 446                         const wxString& name)
 447 {
 448     wxCArrayString chs(choices);
 449     return Create(parent, id, value, pos, size, chs.GetCount(),
 450                   chs.GetStrings(), style, validator, name);
 451 }
 452
 453 WXDWORD wxComboBox::MSWGetStyle(long style, WXDWORD *exstyle) const
 454 {
 455     // we never have an external border
 456     WXDWORD msStyle = wxChoice::MSWGetStyle
 457                       (
 458                         (style & ~wxBORDER_MASK) | wxBORDER_NONE, exstyle
 459                       );
 460
 461     // remove the style always added by wxChoice
 462     msStyle &= ~CBS_DROPDOWNLIST;
 463
 464     if ( style & wxCB_READONLY )
 465         msStyle |= CBS_DROPDOWNLIST;
 466 #ifndef __WXWINCE__
 467     else if ( style & wxCB_SIMPLE )
 468         msStyle |= CBS_SIMPLE; // A list (shown always) and edit control
 469 #endif
 470     else
 471         msStyle |= CBS_DROPDOWN;
 472
 473     // there is no reason to not always use CBS_AUTOHSCROLL, so do use it
 474     msStyle |= CBS_AUTOHSCROLL;
 475
 476     // NB: we used to also add CBS_NOINTEGRALHEIGHT here but why?
 477
 478     return msStyle;
 479 }
 480
 481 // ----------------------------------------------------------------------------
 482 // wxComboBox text control-like methods
 483 // ----------------------------------------------------------------------------
 484
 485 void wxComboBox::SetValue(const wxString& value)
 486 {
 487     if ( HasFlag(wxCB_READONLY) )
 488         SetStringSelection(value);
 489     else
 490         SetWindowText(GetHwnd(), value.c_str());
 491
 492     m_value = value;
 493     m_selectionOld = GetSelection();
 494 }
 495
 496 // Clipboard operations
 497 void wxComboBox::Copy()
 498 {
 499   SendMessage(GetHwnd(), WM_COPY, 0, 0L);
 500 }
 501
 502 void wxComboBox::Cut()
 503 {
 504   SendMessage(GetHwnd(), WM_CUT, 0, 0L);
 505 }
 506
 507 void wxComboBox::Paste()
 508 {
 509   SendMessage(GetHwnd(), WM_PASTE, 0, 0L);
 510 }
 511
 512 void wxComboBox::SetEditable(bool WXUNUSED(editable))
 513 {
 514   // Can't implement in MSW?
 515 //  HWND hWnd = GetHwnd();
 516 //  SendMessage(hWnd, EM_SETREADONLY, (WPARAM)!editable, (LPARAM)0L);
 517 }
 518
 519 void wxComboBox::SetInsertionPoint(long pos)
 520 {
 521     if ( GetWindowStyle() & wxCB_READONLY )
 522         return;
 523
 524 #ifdef __WIN32__
 525     HWND hWnd = GetHwnd();
 526     ::SendMessage(hWnd, CB_SETEDITSEL, 0, MAKELPARAM(pos, pos));
 527     HWND hEditWnd = (HWND) GetEditHWND() ;
 528     if ( hEditWnd )
 529     {
 530         // Scroll insertion point into view
 531         SendMessage(hEditWnd, EM_SCROLLCARET, (WPARAM)0, (LPARAM)0);
 532         // Why is this necessary? (Copied from wxTextCtrl::SetInsertionPoint)
 533         SendMessage(hEditWnd, EM_REPLACESEL, 0, (LPARAM) wxEmptyString);
 534     }
 535 #endif // __WIN32__
 536 }
 537
 538 void wxComboBox::SetInsertionPointEnd()
 539 {
 540     // setting insertion point doesn't make sense for read only comboboxes
 541     if ( !(GetWindowStyle() & wxCB_READONLY) )
 542     {
 543         long pos = GetLastPosition();
 544         SetInsertionPoint(pos);
 545     }
 546 }
 547
 548 long wxComboBox::GetInsertionPoint() const
 549 {
 550 #ifdef __WIN32__
 551     DWORD Pos=(DWORD)SendMessage(GetHwnd(), CB_GETEDITSEL, 0, 0L);
 552     return Pos&0xFFFF;
 553 #else
 554     return 0;
 555 #endif
 556 }
 557
 558 long wxComboBox::GetLastPosition() const
 559 {
 560     HWND hEditWnd = (HWND) GetEditHWND();
 561
 562     // Get number of characters in the last (only) line. We'll add this to the character
 563     // index for the last line, 1st position.
 564     int lineLength = (int)SendMessage(hEditWnd, EM_LINELENGTH, (WPARAM) 0, (LPARAM)0L);
 565
 566     return (long)(lineLength);
 567 }
 568
 569 void wxComboBox::Replace(long from, long to, const wxString& value)
 570 {
 571 #if wxUSE_CLIPBOARD
 572     Remove(from, to);
 573
 574     // Now replace with 'value', by pasting.
 575     wxSetClipboardData(wxDF_TEXT, (wxObject *)(const wxChar *)value, 0, 0);
 576
 577     // Paste into edit control
 578     SendMessage(GetHwnd(), WM_PASTE, (WPARAM)0, (LPARAM)0L);
 579 #endif
 580 }
 581
 582 void wxComboBox::Remove(long from, long to)
 583 {
 584     // Set selection and remove it
 585     SetSelection(from, to);
 586     SendMessage(GetHwnd(), WM_CUT, (WPARAM)0, (LPARAM)0);
 587 }
 588
 589 void wxComboBox::SetSelection(long from, long to)
 590 {
 591     HWND hWnd = GetHwnd();
 592     long fromChar = from;
 593     long toChar = to;
 594     // if from and to are both -1, it means
 595     // (in wxWidgets) that all text should be selected.
 596     // This translates into Windows convention
 597     if ((from == -1) && (to == -1))
 598     {
 599       fromChar = 0;
 600       toChar = -1;
 601     }
 602
 603     if ( SendMessage(hWnd, CB_SETEDITSEL, (WPARAM)0, (LPARAM)MAKELONG(fromChar, toChar)) == CB_ERR )
 604     {
 605         wxLogDebug(_T("CB_SETEDITSEL failed"));
 606     }
 607 }
 608
 609 void wxComboBox::GetSelection(long* from, long* to) const
 610 {
 611     DWORD dwStart, dwEnd;
 612     ::SendMessage(GetHwnd(), CB_GETEDITSEL, (WPARAM)&dwStart, (LPARAM)&dwEnd);
 613
 614     *from = dwStart;
 615     *to = dwEnd;
 616 }
 617
 618 int wxComboBox::GetSelection() const
 619 {
 620     return wxChoice::GetSelection();
 621 }
 622
 623 #endif // wxUSE_COMBOBOX
 624