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 // ----------------------------------------------------------------------------
 217 // wxComboBox callbacks
 218 // ----------------------------------------------------------------------------
 219
 220 WXLRESULT wxComboBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 221 {
 222     // handle WM_CTLCOLOR messages from our EDIT control to be able to set its
 223     // colour correctly (to be the same as our own one)
 224     switch ( nMsg )
 225     {
 226         case CB_SETCURSEL:
 227             // Selection was set with SetSelection.  Update the value too.
 228             if ((int)wParam > GetCount())
 229                 m_value = wxEmptyString;
 230             else
 231                 m_value = GetString(wParam);
 232             break;
 233     }
 234
 235     return wxChoice::MSWWindowProc(nMsg, wParam, lParam);
 236 }
 237
 238 bool wxComboBox::MSWProcessEditMsg(WXUINT msg, WXWPARAM wParam, WXLPARAM lParam)
 239 {
 240     switch ( msg )
 241     {
 242         case WM_CHAR:
 243             // for compatibility with wxTextCtrl, generate a special message
 244             // when Enter is pressed
 245             if ( wParam == VK_RETURN )
 246             {
 247                 wxCommandEvent event(wxEVT_COMMAND_TEXT_ENTER, m_windowId);
 248                 InitCommandEvent(event);
 249                 event.SetString(GetValue());
 250                 event.SetInt(GetSelection());
 251                 ProcessCommand(event);
 252             }
 253
 254             return HandleChar(wParam, lParam, true /* isASCII */);
 255
 256         case WM_KEYDOWN:
 257             return HandleKeyDown(wParam, lParam);
 258
 259         case WM_KEYUP:
 260             return HandleKeyUp(wParam, lParam);
 261
 262         case WM_SETFOCUS:
 263             return HandleSetFocus((WXHWND)wParam);
 264
 265         case WM_KILLFOCUS:
 266             return HandleKillFocus((WXHWND)wParam);
 267     }
 268
 269     return false;
 270 }
 271
 272 bool wxComboBox::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
 273 {
 274     wxString value;
 275     int sel = -1;
 276     switch ( param )
 277     {
 278         case CBN_SELCHANGE:
 279             sel = GetSelection();
 280
 281             // somehow we get 2 CBN_SELCHANGE events with the same index when
 282             // the user selects an item in the combobox -- ignore duplicates
 283             if ( sel > -1 && sel != m_selectionOld )
 284             {
 285                 m_selectionOld = sel;
 286
 287                 // GetValue() would still return the old value from here but
 288                 // according to the docs we should return the new value if the
 289                 // user calls it in his event handler, so update internal
 290                 // m_value
 291                 m_value = GetString(sel);
 292
 293                 wxCommandEvent event(wxEVT_COMMAND_COMBOBOX_SELECTED, GetId());
 294                 event.SetInt(sel);
 295                 event.SetEventObject(this);
 296                 event.SetString(m_value);
 297                 ProcessCommand(event);
 298             }
 299             else // no valid selection
 300             {
 301                 m_selectionOld = sel;
 302
 303                 // hence no EVT_TEXT neither
 304                 break;
 305             }
 306
 307             // fall through: for compability with wxGTK, also send the text
 308             // update event when the selection changes (this also seems more
 309             // logical as the text does change)
 310
 311         case CBN_EDITCHANGE:
 312             {
 313                 wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, GetId());
 314
 315                 // if sel != -1, value was initialized above (and we can't use
 316                 // GetValue() here as it would return the old selection and we
 317                 // want the new one)
 318                 if ( sel == -1 )
 319                 {
 320                     m_value = wxGetWindowText(GetHwnd());
 321                 }
 322                 else // we're synthesizing text updated event from sel change
 323                 {
 324                     // We need to retrieve the current selection because the
 325                     // user may have changed it in the previous handler (for
 326                     // CBN_SELCHANGE above).
 327                     sel = GetSelection();
 328                     if ( sel > -1 )
 329                     {
 330                         m_value = GetString(sel);
 331                     }
 332                 }
 333
 334                 event.SetString(m_value);
 335                 event.SetEventObject(this);
 336                 ProcessCommand(event);
 337             }
 338             break;
 339     }
 340
 341     // there is no return value for the CBN_ notifications, so always return
 342     // false from here to pass the message to DefWindowProc()
 343     return false;
 344 }
 345
 346 WXHWND wxComboBox::GetEditHWND() const
 347 {
 348     // this function should not be called for wxCB_READONLY controls, it is
 349     // the callers responsability to check this
 350     wxASSERT_MSG( !(GetWindowStyle() & wxCB_READONLY),
 351                   _T("read-only combobox doesn't have any edit control") );
 352
 353     POINT pt;
 354     pt.x = pt.y = 4;
 355     HWND hwndEdit = ::ChildWindowFromPoint(GetHwnd(), pt);
 356     if ( !hwndEdit || hwndEdit == GetHwnd() )
 357     {
 358         wxFAIL_MSG(_T("not read only combobox without edit control?"));
 359     }
 360
 361     return (WXHWND)hwndEdit;
 362 }
 363
 364 // ----------------------------------------------------------------------------
 365 // wxComboBox creation
 366 // ----------------------------------------------------------------------------
 367
 368 bool wxComboBox::Create(wxWindow *parent, wxWindowID id,
 369                         const wxString& value,
 370                         const wxPoint& pos,
 371                         const wxSize& size,
 372                         int n, const wxString choices[],
 373                         long style,
 374                         const wxValidator& validator,
 375                         const wxString& name)
 376 {
 377     // pretend that wxComboBox is hidden while it is positioned and resized and
 378     // show it only right before leaving this method because otherwise there is
 379     // some noticeable flicker while the control rearranges itself
 380     m_isShown = false;
 381
 382     if ( !CreateAndInit(parent, id, pos, size, n, choices, style,
 383                         validator, name) )
 384         return false;
 385
 386     // we shouldn't call SetValue() for an empty string because this would
 387     // (correctly) result in an assert with a read only combobox and is useless
 388     // for the other ones anyhow
 389     if ( !value.empty() )
 390         SetValue(value);
 391
 392     // a (not read only) combobox is, in fact, 2 controls: the combobox itself
 393     // and an edit control inside it and if we want to catch events from this
 394     // edit control, we must subclass it as well
 395     if ( !(style & wxCB_READONLY) )
 396     {
 397         gs_wndprocEdit = wxSetWindowProc((HWND)GetEditHWND(),
 398                                          wxComboEditWndProc);
 399     }
 400
 401     // and finally, show the control
 402     Show(true);
 403
 404     return true;
 405 }
 406
 407 bool wxComboBox::Create(wxWindow *parent, wxWindowID id,
 408                         const wxString& value,
 409                         const wxPoint& pos,
 410                         const wxSize& size,
 411                         const wxArrayString& choices,
 412                         long style,
 413                         const wxValidator& validator,
 414                         const wxString& name)
 415 {
 416     wxCArrayString chs(choices);
 417     return Create(parent, id, value, pos, size, chs.GetCount(),
 418                   chs.GetStrings(), style, validator, name);
 419 }
 420
 421 WXDWORD wxComboBox::MSWGetStyle(long style, WXDWORD *exstyle) const
 422 {
 423     // we never have an external border
 424     WXDWORD msStyle = wxChoice::MSWGetStyle
 425                       (
 426                         (style & ~wxBORDER_MASK) | wxBORDER_NONE, exstyle
 427                       );
 428
 429     // remove the style always added by wxChoice
 430     msStyle &= ~CBS_DROPDOWNLIST;
 431
 432     if ( style & wxCB_READONLY )
 433         msStyle |= CBS_DROPDOWNLIST;
 434 #ifndef __WXWINCE__
 435     else if ( style & wxCB_SIMPLE )
 436         msStyle |= CBS_SIMPLE; // A list (shown always) and edit control
 437 #endif
 438     else
 439         msStyle |= CBS_DROPDOWN;
 440
 441     // there is no reason to not always use CBS_AUTOHSCROLL, so do use it
 442     msStyle |= CBS_AUTOHSCROLL;
 443
 444     // NB: we used to also add CBS_NOINTEGRALHEIGHT here but why?
 445
 446     return msStyle;
 447 }
 448
 449 // ----------------------------------------------------------------------------
 450 // wxComboBox text control-like methods
 451 // ----------------------------------------------------------------------------
 452
 453 void wxComboBox::SetValue(const wxString& value)
 454 {
 455     if ( HasFlag(wxCB_READONLY) )
 456         SetStringSelection(value);
 457     else
 458         SetWindowText(GetHwnd(), value.c_str());
 459
 460     m_value = value;
 461     m_selectionOld = GetSelection();
 462 }
 463
 464 // Clipboard operations
 465 void wxComboBox::Copy()
 466 {
 467   SendMessage(GetHwnd(), WM_COPY, 0, 0L);
 468 }
 469
 470 void wxComboBox::Cut()
 471 {
 472   SendMessage(GetHwnd(), WM_CUT, 0, 0L);
 473 }
 474
 475 void wxComboBox::Paste()
 476 {
 477   SendMessage(GetHwnd(), WM_PASTE, 0, 0L);
 478 }
 479
 480 void wxComboBox::SetEditable(bool WXUNUSED(editable))
 481 {
 482   // Can't implement in MSW?
 483 //  HWND hWnd = GetHwnd();
 484 //  SendMessage(hWnd, EM_SETREADONLY, (WPARAM)!editable, (LPARAM)0L);
 485 }
 486
 487 void wxComboBox::SetInsertionPoint(long pos)
 488 {
 489     if ( GetWindowStyle() & wxCB_READONLY )
 490         return;
 491
 492 #ifdef __WIN32__
 493     HWND hWnd = GetHwnd();
 494     ::SendMessage(hWnd, CB_SETEDITSEL, 0, MAKELPARAM(pos, pos));
 495     HWND hEditWnd = (HWND) GetEditHWND() ;
 496     if ( hEditWnd )
 497     {
 498         // Scroll insertion point into view
 499         SendMessage(hEditWnd, EM_SCROLLCARET, (WPARAM)0, (LPARAM)0);
 500         // Why is this necessary? (Copied from wxTextCtrl::SetInsertionPoint)
 501         SendMessage(hEditWnd, EM_REPLACESEL, 0, (LPARAM) wxEmptyString);
 502     }
 503 #endif // __WIN32__
 504 }
 505
 506 void wxComboBox::SetInsertionPointEnd()
 507 {
 508     // setting insertion point doesn't make sense for read only comboboxes
 509     if ( !(GetWindowStyle() & wxCB_READONLY) )
 510     {
 511         long pos = GetLastPosition();
 512         SetInsertionPoint(pos);
 513     }
 514 }
 515
 516 long wxComboBox::GetInsertionPoint() const
 517 {
 518 #ifdef __WIN32__
 519     DWORD Pos=(DWORD)SendMessage(GetHwnd(), CB_GETEDITSEL, 0, 0L);
 520     return Pos&0xFFFF;
 521 #else
 522     return 0;
 523 #endif
 524 }
 525
 526 long wxComboBox::GetLastPosition() const
 527 {
 528     HWND hEditWnd = (HWND) GetEditHWND();
 529
 530     // Get number of characters in the last (only) line. We'll add this to the character
 531     // index for the last line, 1st position.
 532     int lineLength = (int)SendMessage(hEditWnd, EM_LINELENGTH, (WPARAM) 0, (LPARAM)0L);
 533
 534     return (long)(lineLength);
 535 }
 536
 537 void wxComboBox::Replace(long from, long to, const wxString& value)
 538 {
 539 #if wxUSE_CLIPBOARD
 540     Remove(from, to);
 541
 542     // Now replace with 'value', by pasting.
 543     wxSetClipboardData(wxDF_TEXT, (wxObject *)(const wxChar *)value, 0, 0);
 544
 545     // Paste into edit control
 546     SendMessage(GetHwnd(), WM_PASTE, (WPARAM)0, (LPARAM)0L);
 547 #endif
 548 }
 549
 550 void wxComboBox::Remove(long from, long to)
 551 {
 552     // Set selection and remove it
 553     SetSelection(from, to);
 554     SendMessage(GetHwnd(), WM_CUT, (WPARAM)0, (LPARAM)0);
 555 }
 556
 557 void wxComboBox::SetSelection(long from, long to)
 558 {
 559     HWND hWnd = GetHwnd();
 560     long fromChar = from;
 561     long toChar = to;
 562     // if from and to are both -1, it means
 563     // (in wxWidgets) that all text should be selected.
 564     // This translates into Windows convention
 565     if ((from == -1) && (to == -1))
 566     {
 567       fromChar = 0;
 568       toChar = -1;
 569     }
 570
 571     if ( SendMessage(hWnd, CB_SETEDITSEL, (WPARAM)0, (LPARAM)MAKELONG(fromChar, toChar)) == CB_ERR )
 572     {
 573         wxLogDebug(_T("CB_SETEDITSEL failed"));
 574     }
 575 }
 576
 577 void wxComboBox::GetSelection(long* from, long* to) const
 578 {
 579     DWORD dwStart, dwEnd;
 580     ::SendMessage(GetHwnd(), CB_GETEDITSEL, (WPARAM)&dwStart, (LPARAM)&dwEnd);
 581
 582     *from = dwStart;
 583     *to = dwEnd;
 584 }
 585
 586 int wxComboBox::GetSelection() const
 587 {
 588     return wxChoice::GetSelection();
 589 }
 590
 591 #endif // wxUSE_COMBOBOX
 592