src/msw/combobox.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/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 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #if wxUSE_COMBOBOX
  28
  29 #include "wx/combobox.h"
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
  33     #include "wx/settings.h"
  34     #include "wx/log.h"
  35     // for wxEVT_COMMAND_TEXT_ENTER
  36     #include "wx/textctrl.h"
  37     #include "wx/app.h"
  38     #include "wx/brush.h"
  39 #endif
  40
  41 #include "wx/clipbrd.h"
  42 #include "wx/msw/private.h"
  43
  44 #if wxUSE_TOOLTIPS
  45     #include "wx/tooltip.h"
  46 #endif // wxUSE_TOOLTIPS
  47
  48 // ----------------------------------------------------------------------------
  49 // wxWin macros
  50 // ----------------------------------------------------------------------------
  51
  52 #if wxUSE_EXTENDED_RTTI
  53 WX_DEFINE_FLAGS( wxComboBoxStyle )
  54
  55 wxBEGIN_FLAGS( wxComboBoxStyle )
  56     // new style border flags, we put them first to
  57     // use them for streaming out
  58     wxFLAGS_MEMBER(wxBORDER_SIMPLE)
  59     wxFLAGS_MEMBER(wxBORDER_SUNKEN)
  60     wxFLAGS_MEMBER(wxBORDER_DOUBLE)
  61     wxFLAGS_MEMBER(wxBORDER_RAISED)
  62     wxFLAGS_MEMBER(wxBORDER_STATIC)
  63     wxFLAGS_MEMBER(wxBORDER_NONE)
  64
  65     // old style border flags
  66     wxFLAGS_MEMBER(wxSIMPLE_BORDER)
  67     wxFLAGS_MEMBER(wxSUNKEN_BORDER)
  68     wxFLAGS_MEMBER(wxDOUBLE_BORDER)
  69     wxFLAGS_MEMBER(wxRAISED_BORDER)
  70     wxFLAGS_MEMBER(wxSTATIC_BORDER)
  71     wxFLAGS_MEMBER(wxBORDER)
  72
  73     // standard window styles
  74     wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
  75     wxFLAGS_MEMBER(wxCLIP_CHILDREN)
  76     wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
  77     wxFLAGS_MEMBER(wxWANTS_CHARS)
  78     wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
  79     wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
  80     wxFLAGS_MEMBER(wxVSCROLL)
  81     wxFLAGS_MEMBER(wxHSCROLL)
  82
  83     wxFLAGS_MEMBER(wxCB_SIMPLE)
  84     wxFLAGS_MEMBER(wxCB_SORT)
  85     wxFLAGS_MEMBER(wxCB_READONLY)
  86     wxFLAGS_MEMBER(wxCB_DROPDOWN)
  87
  88 wxEND_FLAGS( wxComboBoxStyle )
  89
  90 IMPLEMENT_DYNAMIC_CLASS_XTI(wxComboBox, wxChoice,"wx/combobox.h")
  91
  92 wxBEGIN_PROPERTIES_TABLE(wxComboBox)
  93     wxEVENT_PROPERTY( Select , wxEVT_COMMAND_COMBOBOX_SELECTED , wxCommandEvent )
  94     wxEVENT_PROPERTY( TextEnter , wxEVT_COMMAND_TEXT_ENTER , wxCommandEvent )
  95
  96     // TODO DELEGATES
  97     wxPROPERTY( Font , wxFont , SetFont , GetFont  , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
  98     wxPROPERTY_COLLECTION( Choices , wxArrayString , wxString , AppendString , GetStrings , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
  99     wxPROPERTY( Value ,wxString, SetValue, GetValue, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 100     wxPROPERTY( Selection ,int, SetSelection, GetSelection, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 101     wxPROPERTY_FLAGS( WindowStyle , wxComboBoxStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
 102 wxEND_PROPERTIES_TABLE()
 103
 104 wxBEGIN_HANDLERS_TABLE(wxComboBox)
 105 wxEND_HANDLERS_TABLE()
 106
 107 wxCONSTRUCTOR_5( wxComboBox , wxWindow* , Parent , wxWindowID , Id , wxString , Value , wxPoint , Position , wxSize , Size )
 108
 109 #else
 110
 111 IMPLEMENT_DYNAMIC_CLASS(wxComboBox, wxChoice)
 112
 113 #endif
 114
 115 BEGIN_EVENT_TABLE(wxComboBox, wxControl)
 116     EVT_MENU(wxID_CUT, wxComboBox::OnCut)
 117     EVT_MENU(wxID_COPY, wxComboBox::OnCopy)
 118     EVT_MENU(wxID_PASTE, wxComboBox::OnPaste)
 119     EVT_MENU(wxID_UNDO, wxComboBox::OnUndo)
 120     EVT_MENU(wxID_REDO, wxComboBox::OnRedo)
 121     EVT_MENU(wxID_CLEAR, wxComboBox::OnDelete)
 122     EVT_MENU(wxID_SELECTALL, wxComboBox::OnSelectAll)
 123
 124     EVT_UPDATE_UI(wxID_CUT, wxComboBox::OnUpdateCut)
 125     EVT_UPDATE_UI(wxID_COPY, wxComboBox::OnUpdateCopy)
 126     EVT_UPDATE_UI(wxID_PASTE, wxComboBox::OnUpdatePaste)
 127     EVT_UPDATE_UI(wxID_UNDO, wxComboBox::OnUpdateUndo)
 128     EVT_UPDATE_UI(wxID_REDO, wxComboBox::OnUpdateRedo)
 129     EVT_UPDATE_UI(wxID_CLEAR, wxComboBox::OnUpdateDelete)
 130     EVT_UPDATE_UI(wxID_SELECTALL, wxComboBox::OnUpdateSelectAll)
 131 END_EVENT_TABLE()
 132
 133 // ----------------------------------------------------------------------------
 134 // function prototypes
 135 // ----------------------------------------------------------------------------
 136
 137 LRESULT APIENTRY _EXPORT wxComboEditWndProc(HWND hWnd,
 138                                             UINT message,
 139                                             WPARAM wParam,
 140                                             LPARAM lParam);
 141
 142 // ---------------------------------------------------------------------------
 143 // global vars
 144 // ---------------------------------------------------------------------------
 145
 146 // the pointer to standard radio button wnd proc
 147 static WNDPROC gs_wndprocEdit = (WNDPROC)NULL;
 148
 149 // ============================================================================
 150 // implementation
 151 // ============================================================================
 152
 153 // ----------------------------------------------------------------------------
 154 // wnd proc for subclassed edit control
 155 // ----------------------------------------------------------------------------
 156
 157 LRESULT APIENTRY _EXPORT wxComboEditWndProc(HWND hWnd,
 158                                             UINT message,
 159                                             WPARAM wParam,
 160                                             LPARAM lParam)
 161 {
 162     HWND hwndCombo = ::GetParent(hWnd);
 163     wxWindow *win = wxFindWinFromHandle((WXHWND)hwndCombo);
 164
 165     switch ( message )
 166     {
 167         // forward some messages to the combobox to generate the appropriate
 168         // wxEvents from them
 169         case WM_KEYUP:
 170         case WM_KEYDOWN:
 171         case WM_CHAR:
 172         case WM_SYSCHAR:
 173         case WM_SYSKEYDOWN:
 174         case WM_SYSKEYUP:
 175         case WM_SETFOCUS:
 176         case WM_KILLFOCUS:
 177             {
 178                 wxComboBox *combo = wxDynamicCast(win, wxComboBox);
 179                 if ( !combo )
 180                 {
 181                     // we can get WM_KILLFOCUS while our parent is already half
 182                     // destroyed and hence doesn't look like a combobx any
 183                     // longer, check for it to avoid bogus assert failures
 184                     if ( !win->IsBeingDeleted() )
 185                     {
 186                         wxFAIL_MSG( _T("should have combo as parent") );
 187                     }
 188                 }
 189                 else if ( combo->MSWProcessEditMsg(message, wParam, lParam) )
 190                 {
 191                     // handled by parent
 192                     return 0;
 193                 }
 194             }
 195             break;
 196
 197         case WM_GETDLGCODE:
 198             {
 199                 wxCHECK_MSG( win, 0, _T("should have a parent") );
 200
 201                 if ( win->GetWindowStyle() & wxTE_PROCESS_ENTER )
 202                 {
 203                     // need to return a custom dlg code or we'll never get it
 204                     return DLGC_WANTMESSAGE;
 205                 }
 206             }
 207             break;
 208
 209         case WM_CUT:
 210         case WM_COPY:
 211         case WM_PASTE:
 212             if( win->HandleClipboardEvent( message ) )
 213                 return 0;
 214             break;
 215     }
 216
 217     return ::CallWindowProc(CASTWNDPROC gs_wndprocEdit, hWnd, message, wParam, lParam);
 218 }
 219
 220 // ----------------------------------------------------------------------------
 221 // wxComboBox callbacks
 222 // ----------------------------------------------------------------------------
 223
 224 WXLRESULT wxComboBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 225 {
 226     // TODO: handle WM_CTLCOLOR messages from our EDIT control to be able to
 227     //       set its colour correctly (to be the same as our own one)
 228
 229     switch ( nMsg )
 230     {
 231         case WM_SIZE:
 232         // wxStaticBox can generate this message, when modifying the control's style.
 233         // This causes the content of the combobox to be selected, for some reason.
 234         case WM_STYLECHANGED:
 235             {
 236                 // combobox selection sometimes spontaneously changes when its
 237                 // size changes, restore it to the old value if necessary
 238                 long fromOld, toOld;
 239                 GetSelection(&fromOld, &toOld);
 240                 WXLRESULT result = wxChoice::MSWWindowProc(nMsg, wParam, lParam);
 241
 242                 long fromNew, toNew;
 243                 GetSelection(&fromNew, &toNew);
 244
 245                 if ( fromOld != fromNew || toOld != toNew )
 246                 {
 247                     SetSelection(fromOld, toOld);
 248                 }
 249
 250                 return result;
 251             }
 252     }
 253
 254     return wxChoice::MSWWindowProc(nMsg, wParam, lParam);
 255 }
 256
 257 bool wxComboBox::MSWProcessEditMsg(WXUINT msg, WXWPARAM wParam, WXLPARAM lParam)
 258 {
 259     switch ( msg )
 260     {
 261         case WM_CHAR:
 262             // for compatibility with wxTextCtrl, generate a special message
 263             // when Enter is pressed
 264             if ( wParam == VK_RETURN )
 265             {
 266                 if (SendMessage(GetHwnd(), CB_GETDROPPEDSTATE, 0, 0))
 267                     return false;
 268
 269                 wxCommandEvent event(wxEVT_COMMAND_TEXT_ENTER, m_windowId);
 270
 271                 const int sel = GetSelection();
 272                 event.SetInt(sel);
 273                 event.SetString(GetValue());
 274                 InitCommandEventWithItems(event, sel);
 275
 276                 if ( ProcessCommand(event) )
 277                 {
 278                     // don't let the event through to the native control
 279                     // because it doesn't need it and may generate an annoying
 280                     // beep if it gets it
 281                     return true;
 282                 }
 283             }
 284             // fall through
 285
 286         case WM_SYSCHAR:
 287             return HandleChar(wParam, lParam, true /* isASCII */);
 288
 289         case WM_SYSKEYDOWN:
 290         case WM_KEYDOWN:
 291             return HandleKeyDown(wParam, lParam);
 292
 293         case WM_SYSKEYUP:
 294         case WM_KEYUP:
 295             return HandleKeyUp(wParam, lParam);
 296
 297         case WM_SETFOCUS:
 298             return HandleSetFocus((WXHWND)wParam);
 299
 300         case WM_KILLFOCUS:
 301             return HandleKillFocus((WXHWND)wParam);
 302     }
 303
 304     return false;
 305 }
 306
 307 bool wxComboBox::MSWCommand(WXUINT param, WXWORD id)
 308 {
 309     int sel = -1;
 310     wxString value;
 311
 312     switch ( param )
 313     {
 314         case CBN_SELENDOK:
 315 #ifndef __SMARTPHONE__
 316             // we need to reset this to prevent the selection from being undone
 317             // by wxChoice, see wxChoice::MSWCommand() and comments there
 318             m_lastAcceptedSelection = wxID_NONE;
 319 #endif
 320
 321             // set these variables so that they could be also fixed in
 322             // CBN_EDITCHANGE below
 323             sel = GetSelection();
 324             value = GetStringSelection();
 325
 326             // this string is going to become the new combobox value soon but
 327             // we need it to be done right now, otherwise the event handler
 328             // could get a wrong value when it calls our GetValue()
 329             ::SetWindowText(GetHwnd(), value.wx_str());
 330
 331             {
 332                 wxCommandEvent event(wxEVT_COMMAND_COMBOBOX_SELECTED, GetId());
 333                 event.SetInt(sel);
 334                 event.SetString(value);
 335                 InitCommandEventWithItems(event, sel);
 336
 337                 ProcessCommand(event);
 338             }
 339
 340             // fall through: for compability with wxGTK, also send the text
 341             // update event when the selection changes (this also seems more
 342             // logical as the text does change)
 343
 344         case CBN_EDITCHANGE:
 345             {
 346                 wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, GetId());
 347
 348                 // if sel != -1, value was already initialized above
 349                 if ( sel == -1 )
 350                 {
 351                     value = wxGetWindowText(GetHwnd());
 352                 }
 353
 354                 event.SetString(value);
 355                 InitCommandEventWithItems(event, sel);
 356
 357                 ProcessCommand(event);
 358             }
 359             break;
 360
 361         default:
 362             return wxChoice::MSWCommand(param, id);
 363     }
 364
 365     // skip wxChoice version as it would generate its own events for
 366     // CBN_SELENDOK
 367     return true;
 368 }
 369
 370 bool wxComboBox::MSWShouldPreProcessMessage(WXMSG *pMsg)
 371 {
 372     // prevent command accelerators from stealing editing
 373     // hotkeys when we have the focus
 374     if (wxIsCtrlDown())
 375     {
 376         WPARAM vkey = pMsg->wParam;
 377
 378         switch (vkey)
 379         {
 380             case 'C':
 381             case 'V':
 382             case 'X':
 383             case VK_INSERT:
 384             case VK_DELETE:
 385             case VK_HOME:
 386             case VK_END:
 387                 return false;
 388         }
 389     }
 390
 391     return wxChoice::MSWShouldPreProcessMessage(pMsg);
 392 }
 393
 394 WXHWND wxComboBox::GetEditHWND() const
 395 {
 396     // this function should not be called for wxCB_READONLY controls, it is
 397     // the callers responsability to check this
 398     wxASSERT_MSG( !HasFlag(wxCB_READONLY),
 399                   _T("read-only combobox doesn't have any edit control") );
 400
 401     POINT pt;
 402     pt.x = pt.y = 4;
 403     HWND hwndEdit = ::ChildWindowFromPoint(GetHwnd(), pt);
 404     if ( !hwndEdit || hwndEdit == GetHwnd() )
 405     {
 406         wxFAIL_MSG(_T("combobox without edit control?"));
 407     }
 408
 409     return (WXHWND)hwndEdit;
 410 }
 411
 412 // ----------------------------------------------------------------------------
 413 // wxComboBox creation
 414 // ----------------------------------------------------------------------------
 415
 416 bool wxComboBox::Create(wxWindow *parent, wxWindowID id,
 417                         const wxString& value,
 418                         const wxPoint& pos,
 419                         const wxSize& size,
 420                         int n, const wxString choices[],
 421                         long style,
 422                         const wxValidator& validator,
 423                         const wxString& name)
 424 {
 425     // pretend that wxComboBox is hidden while it is positioned and resized and
 426     // show it only right before leaving this method because otherwise there is
 427     // some noticeable flicker while the control rearranges itself
 428     m_isShown = false;
 429
 430     if ( !CreateAndInit(parent, id, pos, size, n, choices, style,
 431                         validator, name) )
 432         return false;
 433
 434     // we shouldn't call SetValue() for an empty string because this would
 435     // (correctly) result in an assert with a read only combobox and is useless
 436     // for the other ones anyhow
 437     if ( !value.empty() )
 438         SetValue(value);
 439
 440     // a (not read only) combobox is, in fact, 2 controls: the combobox itself
 441     // and an edit control inside it and if we want to catch events from this
 442     // edit control, we must subclass it as well
 443     if ( !(style & wxCB_READONLY) )
 444     {
 445         gs_wndprocEdit = wxSetWindowProc((HWND)GetEditHWND(), wxComboEditWndProc);
 446     }
 447
 448     // and finally, show the control
 449     Show(true);
 450
 451     return true;
 452 }
 453
 454 bool wxComboBox::Create(wxWindow *parent, wxWindowID id,
 455                         const wxString& value,
 456                         const wxPoint& pos,
 457                         const wxSize& size,
 458                         const wxArrayString& choices,
 459                         long style,
 460                         const wxValidator& validator,
 461                         const wxString& name)
 462 {
 463     wxCArrayString chs(choices);
 464     return Create(parent, id, value, pos, size, chs.GetCount(),
 465                   chs.GetStrings(), style, validator, name);
 466 }
 467
 468 WXDWORD wxComboBox::MSWGetStyle(long style, WXDWORD *exstyle) const
 469 {
 470     // we never have an external border
 471     WXDWORD msStyle = wxChoice::MSWGetStyle
 472                       (
 473                         (style & ~wxBORDER_MASK) | wxBORDER_NONE, exstyle
 474                       );
 475
 476     // usually WS_TABSTOP is added by wxControl::MSWGetStyle() but as we're
 477     // created hidden (see Create() above), it is not done for us but we still
 478     // want to have this style
 479     msStyle |= WS_TABSTOP;
 480
 481     // remove the style always added by wxChoice
 482     msStyle &= ~CBS_DROPDOWNLIST;
 483
 484     if ( style & wxCB_READONLY )
 485         msStyle |= CBS_DROPDOWNLIST;
 486 #ifndef __WXWINCE__
 487     else if ( style & wxCB_SIMPLE )
 488         msStyle |= CBS_SIMPLE; // A list (shown always) and edit control
 489 #endif
 490     else
 491         msStyle |= CBS_DROPDOWN;
 492
 493     // there is no reason to not always use CBS_AUTOHSCROLL, so do use it
 494     msStyle |= CBS_AUTOHSCROLL;
 495
 496     // NB: we used to also add CBS_NOINTEGRALHEIGHT here but why?
 497
 498     return msStyle;
 499 }
 500
 501 // ----------------------------------------------------------------------------
 502 // wxComboBox text control-like methods
 503 // ----------------------------------------------------------------------------
 504
 505 void wxComboBox::SetValue(const wxString& value)
 506 {
 507     if ( HasFlag(wxCB_READONLY) )
 508         SetStringSelection(value);
 509     else
 510         wxTextEntry::SetValue(value);
 511 }
 512
 513 void wxComboBox::Clear()
 514 {
 515     wxChoice::Clear();
 516     if ( !HasFlag(wxCB_READONLY) )
 517         wxTextEntry::Clear();
 518 }
 519
 520 bool wxComboBox::IsEditable() const
 521 {
 522     return !HasFlag(wxCB_READONLY) && wxTextEntry::IsEditable();
 523 }
 524
 525 // ----------------------------------------------------------------------------
 526 // standard event handling
 527 // ----------------------------------------------------------------------------
 528
 529 void wxComboBox::OnCut(wxCommandEvent& WXUNUSED(event))
 530 {
 531     Cut();
 532 }
 533
 534 void wxComboBox::OnCopy(wxCommandEvent& WXUNUSED(event))
 535 {
 536     Copy();
 537 }
 538
 539 void wxComboBox::OnPaste(wxCommandEvent& WXUNUSED(event))
 540 {
 541     Paste();
 542 }
 543
 544 void wxComboBox::OnUndo(wxCommandEvent& WXUNUSED(event))
 545 {
 546     Undo();
 547 }
 548
 549 void wxComboBox::OnRedo(wxCommandEvent& WXUNUSED(event))
 550 {
 551     Redo();
 552 }
 553
 554 void wxComboBox::OnDelete(wxCommandEvent& WXUNUSED(event))
 555 {
 556     long from, to;
 557     GetSelection(& from, & to);
 558     if (from != -1 && to != -1)
 559         Remove(from, to);
 560 }
 561
 562 void wxComboBox::OnSelectAll(wxCommandEvent& WXUNUSED(event))
 563 {
 564     SetSelection(-1, -1);
 565 }
 566
 567 void wxComboBox::OnUpdateCut(wxUpdateUIEvent& event)
 568 {
 569     event.Enable( CanCut() );
 570 }
 571
 572 void wxComboBox::OnUpdateCopy(wxUpdateUIEvent& event)
 573 {
 574     event.Enable( CanCopy() );
 575 }
 576
 577 void wxComboBox::OnUpdatePaste(wxUpdateUIEvent& event)
 578 {
 579     event.Enable( CanPaste() );
 580 }
 581
 582 void wxComboBox::OnUpdateUndo(wxUpdateUIEvent& event)
 583 {
 584     event.Enable( CanUndo() );
 585 }
 586
 587 void wxComboBox::OnUpdateRedo(wxUpdateUIEvent& event)
 588 {
 589     event.Enable( CanRedo() );
 590 }
 591
 592 void wxComboBox::OnUpdateDelete(wxUpdateUIEvent& event)
 593 {
 594     event.Enable(IsEditable() && HasSelection());
 595 }
 596
 597 void wxComboBox::OnUpdateSelectAll(wxUpdateUIEvent& event)
 598 {
 599     event.Enable(IsEditable() && GetLastPosition() > 0);
 600 }
 601
 602 #if wxUSE_TOOLTIPS
 603
 604 void wxComboBox::DoSetToolTip(wxToolTip *tip)
 605 {
 606     wxChoice::DoSetToolTip(tip);
 607
 608     if ( tip && !HasFlag(wxCB_READONLY) )
 609         tip->Add(GetEditHWND());
 610 }
 611
 612 #endif // wxUSE_TOOLTIPS
 613
 614 #endif // wxUSE_COMBOBOX