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